text: /***********************************************************************
  	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 "elements/CEGUIListboxItem.h"
  
  
  // Start of CEGUI namespace section
  namespace CEGUI
  {
  /*!
  \brief
  	Class used for textual items in a list box.
  */
  class CEGUIEXPORT ListboxTextItem : public ListboxItem
  {
  public:
  	/*************************************************************************
  		Constants
  	*************************************************************************/
  	static const colour	DefaultTextColour;			//!< Default text colour.
  
  
  	/*************************************************************************
  		Construction and Destruction
  	*************************************************************************/
  	/*!
  	\brief
  		base class constructor
  	*/
  	ListboxTextItem(const String& text, uint item_id = 0, void* item_data = 0, bool disabled = false, bool auto_delete = true);
  
  
  	/*!
  	\brief
  		base class destructor
  	*/
  	virtual ~ListboxTextItem(void) {}
  
  
  	/*************************************************************************
  		Accessor methods
  	*************************************************************************/
  	/*!
  	\brief
  		Return a pointer to the font being used by this ListboxTextItem
  
  		This method will try a number of places to find a font to be used.  If no font can be
  		found, NULL is returned.
  
  	\return
  		Font to be used for rendering this item
  	*/
  	Font*	getFont(void) const;
  
  
  	/*!
  	\brief
  		Return the current colours used for text rendering.
  
  	\return
  		ColourRect object describing the currently set colours
  	*/
  	ColourRect	getTextColours(void) const		{return d_textCols;}
  
  
  	/*************************************************************************
  		Manipulator methods
  	*************************************************************************/
  	/*!
  	\brief
  		Set the font to be used by this ListboxTextItem
  
  	\param font
  		Font to be used for rendering this item
  
  	\return
  		Nothing
  	*/
  	void	setFont(Font* font)		{d_font = font;}
  
  
  	/*!
  	\brief
  		Set the font to be used by this ListboxTextItem
  
  	\param font_name
  		String object containing the name of the Font to be used for rendering this item
  
  	\return
  		Nothing
  	*/
  	void	setFont(const String& font_name);
  
  
  	/*!
  	\brief
  		Set the colours used for text rendering.
  
  	\param cols
  		ColourRect object describing the colours to be used.
  
  	\return
  		Nothing.
  	*/
  	void	setTextColours(const ColourRect& cols)			{d_textCols = cols;}
  
  
  	/*!
  	\brief
  		Set the colours used for text rendering.
  
  	\param top_left_colour
  		Colour (as ARGB value) to be applied to the top-left corner of each text glyph rendered.
  
  	\param top_right_colour
  		Colour (as ARGB value) to be applied to the top-right corner of each text glyph rendered.
  
  	\param bottom_left_colour
  		Colour (as ARGB value) to be applied to the bottom-left corner of each text glyph rendered.
  
  	\param bottom_right_colour
  		Colour (as ARGB value) to be applied to the bottom-right corner of each text glyph rendered.
  
  	\return 
  		Nothing.
  	*/
  	void	setTextColours(colour top_left_colour, colour top_right_colour, colour bottom_left_colour, colour bottom_right_colour);
  
  
  	/*!
  	\brief
  		Set the colours used for text rendering.
  
  	\param col
  		colour value to be used when rendering.
  
  	\return
  		Nothing.
  	*/
  	void	setTextColours(colour col)		{setTextColours(col, col, col, col);}
  
  
  	/*************************************************************************
  		Required implementations of pure virtuals from the base class.
  	*************************************************************************/
      Size getPixelSize(void) const;
      void draw(const Vector3& position, float alpha, const Rect& clipper) const;
      void draw(RenderCache& cache,const Rect& targetRect, float zBase,  float alpha, const Rect* clipper) const;
  
  protected:
  	/*************************************************************************
  		Implementation Data
  	*************************************************************************/
  	ColourRect	d_textCols;			//!< Colours used for rendering the text.
  	Font*		d_font;				//!< Font used for rendering text.
  };
  
  } // End of  CEGUI namespace section
  
  
  #endif	// end of guard _CEGUIListboxTextItem_h_
  