CEGUITreeItem.h

/***********************************************************************
filename:   CEGUITreeItem.h
created:        5-13-07
author:         Jonathan Welch (Based on Code by David Durant)
*************************************************************************/
/***************************************************************************
*   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 _CEGUITreeItem_h_
#define _CEGUITreeItem_h_

#include "CEGUIBase.h"
#include "CEGUIString.h"
#include "CEGUIColourRect.h"
#include "CEGUIRenderCache.h"

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT TreeItem
   {
public:
  typedef std::vector<TreeItem*>  LBItemList;

   /*************************************************************************
      Constants
   *************************************************************************/
   static const colour  DefaultTextColour;         
   static const colour  DefaultSelectionColour;    


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


   virtual ~TreeItem(void) {}


   /*************************************************************************
      Accessors
   *************************************************************************/
   Font* getFont(void) const;


   ColourRect  getTextColours(void) const    {return d_textCols;}


   /*************************************************************************
      Manipulator methods
   *************************************************************************/
   void  setFont(Font* font)     {d_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);}


   const String&  getText(void) const     {return d_itemText;}
   const String&  getTooltipText(void) const    {return d_tooltipText;}

   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 Window* owner)    {return d_owner;}
   const Window*  getOwnerWindow(void)    {return d_owner;}


   ColourRect  getSelectionColours(void) const     {return d_selectCols;}


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


   /*************************************************************************
      Manipulators
   *************************************************************************/
   void  setText(const String& text)      {d_itemText = 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);

   void  setButtonLocation(Rect &buttonOffset) { d_buttonLocation = buttonOffset; }

   Rect &getButtonLocation(void) { return d_buttonLocation; }
   bool  getIsOpen(void) { return d_isOpen; }
   void  toggleIsOpen(void) { d_isOpen = !d_isOpen; }
   TreeItem *getTreeItemFromIndex(size_t itemIndex);
   size_t          getItemCount(void) const {return d_listItems.size();}
   LBItemList &getItemList(void) { return d_listItems; }
   void  addItem(TreeItem* item);
   void  setIcon(const Image &theIcon) { d_iconImage = (Image *)&theIcon; }


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


   virtual  void  draw(const Vector3& position, float alpha, const Rect& clipper) const;

    virtual void    draw(RenderCache& cache,const Rect& targetRect, float zBase,  float alpha, const Rect* clipper) const;

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


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


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


   colour calculateModulatedAlphaColour(colour col, float alpha) const;


   /*************************************************************************
      Implementation Data
   *************************************************************************/
   String   d_itemText;    
   String   d_tooltipText; 
   uint     d_itemID;      
   void *   d_itemData;    
   bool     d_selected;    
   bool     d_disabled;    
   bool     d_autoDelete;  
   Rect     d_buttonLocation; 
   const Window * d_owner; 
   ColourRect     d_selectCols;     
   const Image *  d_selectBrush;    
   ColourRect     d_textCols;       
   Font *   d_font;           
   Image *        d_iconImage;      
   LBItemList     d_listItems;      
   bool           d_isOpen;         
   };

} // End of  CEGUI namespace section


#endif   // end of guard _CEGUITreeItem_h_