ListboxTextItem.h

/***********************************************************************
        filename:       CEGUIListboxTextItem.h
        created:        12/6/2004
        author:         Paul D Turner
        
        purpose:        Interface for list box text items
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIListboxTextItem_h_
#define _CEGUIListboxTextItem_h_
#include "./ListboxItem.h"
#include "../BasicRenderedStringParser.h"
#include "../DefaultRenderedStringParser.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ListboxTextItem : public ListboxItem
{
public:
        /*************************************************************************
                Constants
        *************************************************************************/
        static const Colour     DefaultTextColour;                      


        /*************************************************************************
                Construction and Destruction
        *************************************************************************/
        ListboxTextItem(const String& text, uint item_id = 0, void* item_data = 0, bool disabled = false, bool auto_delete = true);


        virtual ~ListboxTextItem(void) {}


        /*************************************************************************
                Accessor methods
        *************************************************************************/
        const Font*     getFont(void) const;


        ColourRect      getTextColours(void) const              {return d_textCols;}


        /*************************************************************************
                Manipulator methods
        *************************************************************************/
    void setFont(Font* font);


        void    setFont(const String& font_name);


        void    setTextColours(const ColourRect& cols)                  {d_textCols = cols;}


        void    setTextColours(Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour);


        void    setTextColours(Colour col)              {setTextColours(col, col, col, col);}

    void setTextParsingEnabled(const bool enable);

    bool isTextParsingEnabled() const;

    // base class overrides
    void setText(const String& text);
    bool handleFontRenderSizeChange(const Font* const font);


        /*************************************************************************
                Required implementations of pure virtuals from the base class.
        *************************************************************************/
    Sizef getPixelSize(void) const;
    void draw(GeometryBuffer& buffer, const Rectf& targetRect, float alpha, const Rectf* clipper) const;

protected:
    void parseTextString() const;

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        ColourRect      d_textCols;                     
        Font*           d_font;                         

    static BasicRenderedStringParser d_stringParser;
    mutable RenderedString  d_renderedString;
    mutable bool d_renderedStringValid;
    static DefaultRenderedStringParser d_noTagsStringParser;
    bool d_textParsingEnabled;
};

} // End of  CEGUI namespace section


#endif  // end of guard _CEGUIListboxTextItem_h_