Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIListboxTextItem.h
1 /***********************************************************************
2  filename: CEGUIListboxTextItem.h
3  created: 12/6/2004
4  author: Paul D Turner
5 
6  purpose: Interface for list box text items
7 *************************************************************************/
8 /***************************************************************************
9  * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining
12  * a copy of this software and associated documentation files (the
13  * "Software"), to deal in the Software without restriction, including
14  * without limitation the rights to use, copy, modify, merge, publish,
15  * distribute, sublicense, and/or sell copies of the Software, and to
16  * permit persons to whom the Software is furnished to do so, subject to
17  * the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be
20  * included in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  ***************************************************************************/
30 #ifndef _CEGUIListboxTextItem_h_
31 #define _CEGUIListboxTextItem_h_
32 #include "CEGUIListboxItem.h"
33 #include "../CEGUIBasicRenderedStringParser.h"
34 #include "../CEGUIDefaultRenderedStringParser.h"
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
43 class CEGUIEXPORT ListboxTextItem : public ListboxItem
44 {
45 public:
46  /*************************************************************************
47  Constants
48  *************************************************************************/
49  static const colour DefaultTextColour;
50 
51 
52  /*************************************************************************
53  Construction and Destruction
54  *************************************************************************/
59  ListboxTextItem(const String& text, uint item_id = 0, void* item_data = 0, bool disabled = false, bool auto_delete = true);
60 
61 
66  virtual ~ListboxTextItem(void) {}
67 
68 
69  /*************************************************************************
70  Accessor methods
71  *************************************************************************/
82  Font* getFont(void) const;
83 
84 
92  ColourRect getTextColours(void) const {return d_textCols;}
93 
94 
95  /*************************************************************************
96  Manipulator methods
97  *************************************************************************/
108  void setFont(Font* font);
109 
110 
121  void setFont(const String& font_name);
122 
123 
134  void setTextColours(const ColourRect& cols) {d_textCols = cols;}
135 
136 
156  void setTextColours(colour top_left_colour, colour top_right_colour, colour bottom_left_colour, colour bottom_right_colour);
157 
158 
169  void setTextColours(colour col) {setTextColours(col, col, col, col);}
170 
180  void setTextParsingEnabled(const bool enable);
181 
183  bool isTextParsingEnabled() const;
184 
185  // base class overrides
186  void setText(const String& text);
187 
188 
189  /*************************************************************************
190  Required implementations of pure virtuals from the base class.
191  *************************************************************************/
192  Size getPixelSize(void) const;
193  void draw(GeometryBuffer& buffer, const Rect& targetRect, float alpha, const Rect* clipper) const;
194 
195 protected:
196  void parseTextString() const;
197 
198  /*************************************************************************
199  Implementation Data
200  *************************************************************************/
203  static BasicRenderedStringParser d_stringParser;
208  mutable bool d_renderedStringValid;
213 };
214 
215 } // End of CEGUI namespace section
216 
217 
218 #endif // end of guard _CEGUIListboxTextItem_h_
static DefaultRenderedStringParser d_noTagsStringParser
Parser used when parsing is off. Basically just does linebreaks.
Definition: CEGUIListboxTextItem.h:210
RenderedString d_renderedString
RenderedString drawn by this item.
Definition: CEGUIListboxTextItem.h:206
bool d_renderedStringValid
boolean used to track when item state changes (and needs re-parse)
Definition: CEGUIListboxTextItem.h:208
bool d_textParsingEnabled
boolean that specifies whether text parsing is enabled for the item.
Definition: CEGUIListboxTextItem.h:212
ColourRect getTextColours(void) const
Return the current colours used for text rendering.
Definition: CEGUIListboxTextItem.h:92
Effectively a 'null' parser that returns a RenderedString representation that will draw the input tex...
Definition: CEGUIDefaultRenderedStringParser.h:41
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
Class that holds the size (width & height) of something.
Definition: CEGUISize.h:43
Class representing colour values within the system.
Definition: CEGUIcolour.h:45
Class that holds details of colours for the four corners of a rectangle.
Definition: CEGUIColourRect.h:44
static const colour DefaultTextColour
Default text colour.
Definition: CEGUIListboxTextItem.h:49
Class representing a rendered string of entities.
Definition: CEGUIRenderedString.h:50
virtual ~ListboxTextItem(void)
base class destructor
Definition: CEGUIListboxTextItem.h:66
ColourRect d_textCols
Colours used for rendering the text.
Definition: CEGUIListboxTextItem.h:201
void setTextColours(colour col)
Set the colours used for text rendering.
Definition: CEGUIListboxTextItem.h:169
Class that encapsulates a typeface.
Definition: CEGUIFont.h:58
Font * d_font
Definition: CEGUIListboxTextItem.h:202
Class used for textual items in a list box.
Definition: CEGUIListboxTextItem.h:43
Base class for list box items.
Definition: CEGUIListboxItem.h:50
Basic RenderedStringParser class that offers support for the following tags:
Definition: CEGUIBasicRenderedStringParser.h:65
Class encapsulating operations on a Rectangle.
Definition: CEGUIRect.h:44
String class used within the GUI system.
Definition: CEGUIString.h:57
void setTextColours(const ColourRect &cols)
Set the colours used for text rendering.
Definition: CEGUIListboxTextItem.h:134