CEGUIListboxItem.h

/***********************************************************************
    filename:   CEGUIListboxItem.h
    created:    8/6/2004
    author:     Paul D Turner

    purpose:    Interface to base class for list 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 _CEGUIListboxItem_h_
#define _CEGUIListboxItem_h_

#include "../CEGUIBase.h"
#include "../CEGUIString.h"
#include "../CEGUIColourRect.h"
#include "../CEGUITextUtils.h"

#if defined(_MSC_VER)
#  pragma warning(push)
#  pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ListboxItem
{
public:
    /*************************************************************************
        Constants
    *************************************************************************/
    static const colour DefaultSelectionColour;     


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


    virtual ~ListboxItem(void) {}


    /*************************************************************************
        Accessors
    *************************************************************************/
    const String&   getTooltipText(void) const      {return d_tooltipText;}

    const String& getText(void) const {return d_textLogical;}

    const String& getTextVisual() const;

    uint    getID(void) const           {return d_itemID;}


    void*   getUserData(void) const     {return d_itemData;}


    bool    isSelected(void) const      {return d_selected;}


    bool    isDisabled(void) const      {return d_disabled;}


    bool    isAutoDeleted(void) const   {return d_autoDelete;}


    const Window*   getOwnerWindow() const      {return d_owner;}


    ColourRect  getSelectionColours(void) const     {return d_selectCols;}


    const Image*    getSelectionBrushImage(void) const      {return d_selectBrush;}


    /*************************************************************************
        Manipulators
    *************************************************************************/
    virtual void setText(const String& text);

    void    setTooltipText(const String& text)      {d_tooltipText = text;}

    void    setID(uint item_id)     {d_itemID = item_id;}


    void    setUserData(void* item_data)    {d_itemData = item_data;}


    void    setSelected(bool setting)       {d_selected = setting;}


    void    setDisabled(bool setting)       {d_disabled = setting;}

    void    setAutoDeleted(bool setting)        {d_autoDelete = setting;}


    void    setOwnerWindow(const Window* owner)     {d_owner = owner;}


    void    setSelectionColours(const ColourRect& cols)     {d_selectCols = cols;}


    void    setSelectionColours(colour top_left_colour, colour top_right_colour, colour bottom_left_colour, colour bottom_right_colour);


    void    setSelectionColours(colour col)     {setSelectionColours(col, col, col, col);}


    void    setSelectionBrushImage(const Image* image)      {d_selectBrush = image;}


    void    setSelectionBrushImage(const String& imageset, const String& image);


    /*************************************************************************
        Abstract portion of interface
    *************************************************************************/
    virtual Size    getPixelSize(void) const    = 0;


    virtual void draw(GeometryBuffer& buffer, const Rect& targetRect,
                      float alpha, const Rect* clipper) const = 0;

    /*************************************************************************
        Operators
    *************************************************************************/
    virtual bool    operator<(const ListboxItem& rhs) const     {return getText() < rhs.getText();}


    virtual bool    operator>(const ListboxItem& rhs) const     {return getText() > rhs.getText();}


protected:
    /*************************************************************************
        Implementation methods
    *************************************************************************/
    ColourRect getModulateAlphaColourRect(const ColourRect& cols, float alpha) const;


    colour calculateModulatedAlphaColour(colour col, float alpha) const;


    /*************************************************************************
        Implementation Data
    *************************************************************************/
    String d_textLogical;
    BiDiVisualMapping* d_bidiVisualMapping;
    mutable bool d_bidiDataValid;
    String  d_tooltipText;  
    uint    d_itemID;       
    void*   d_itemData;     
    bool    d_selected;     
    bool    d_disabled;     
    bool    d_autoDelete;   
    const Window*   d_owner;    
    ColourRect      d_selectCols;       
    const Image*    d_selectBrush;      
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#  pragma warning(pop)
#endif

#endif  // end of guard _CEGUIListboxItem_h_