TreeItem_wrapper Struct Reference

Inheritance diagram for TreeItem_wrapper:

Collaboration diagram for TreeItem_wrapper:

Public Member Functions
	TreeItem_wrapper (CEGUI::TreeItem const &arg)
	TreeItem_wrapper (::CEGUI::String const &text,::CEGUI::uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
::CEGUI::Colour	calculateModulatedAlphaColour (::CEGUI::Colour col, float alpha) const
virtual void	draw (::CEGUI::GeometryBuffer &buffer,::CEGUI::Rectf const &targetRect, float alpha,::CEGUI::Rectf const *clipper) const
void	default_draw (::CEGUI::GeometryBuffer &buffer,::CEGUI::Rectf const &targetRect, float alpha,::CEGUI::Rectf const *clipper) const
::CEGUI::ColourRect	getModulateAlphaColourRect (::CEGUI::ColourRect const &cols, float alpha) const
virtual ::CEGUI::Sizef	getPixelSize () const
	Return the rendered pixel size of this tree item. More...
::CEGUI::Sizef	default_getPixelSize () const
virtual bool	handleFontRenderSizeChange (::CEGUI::Font const *const font)
bool	default_handleFontRenderSizeChange (::CEGUI::Font const *const font)
void	parseTextString () const
Public Member Functions inherited from CEGUI::TreeItem
	TreeItem (const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
	base class constructor
virtual	~TreeItem (void)
	base class destructor
const Font *	getFont (void) const
	Return a pointer to the font being used by this TreeItem. More...
ColourRect	getTextColours (void) const
	Return the current colours used for text rendering. More...
void	setFont (const Font *font)
	Set the font to be used by this TreeItem. More...
void	setFont (const String &font_name)
	Set the font to be used by this TreeItem. More...
void	setTextColours (const ColourRect &cols)
	Set the colours used for text rendering. More...
void	setTextColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
	Set the colours used for text rendering. More...
void	setTextColours (Colour col)
	Set the colours used for text rendering. More...
const String &	getText () const
	return the text string set for this tree item. More...
const String &	getTextVisual () const
	return text string with visual ordering of glyphs.
const String &	getTooltipText (void) const
	Return the text string currently set to be used as the tooltip text for this item. More...
uint	getID (void) const
	Return the current ID assigned to this tree item. More...
void *	getUserData (void) const
	Return the pointer to any client assigned user data attached to this tree item. More...
bool	isSelected (void) const
	return whether this item is selected. More...
bool	isDisabled (void) const
	return whether this item is disabled. More...
bool	isAutoDeleted (void) const
	return whether this item will be automatically deleted when it is removed from the tree or when the the tree it is attached to is destroyed. More...
const Window *	getOwnerWindow (void)
	Get the owner window for this TreeItem. More...
ColourRect	getSelectionColours (void) const
	Return the current colours used for selection highlighting. More...
const Image *	getSelectionBrushImage (void) const
	Return the current selection highlighting brush. More...
void	setText (const String &text)
	set the text string for this tree item. More...
void	setTooltipText (const String &text)
	Set the tooltip text to be used for this item. More...
void	setID (uint item_id)
	Set the ID assigned to this tree item. More...
void	setUserData (void *item_data)
	Set the client assigned user data attached to this lis box item. More...
void	setSelected (bool setting)
	Set the selected state for the item. More...
void	setDisabled (bool setting)
	Set the disabled state for the item. More...
void	setAutoDeleted (bool setting)
	Set whether this item will be automatically deleted when it is removed from the tree, or when the tree it is attached to is destroyed. More...
void	setOwnerWindow (const Window *owner)
	Set the owner window for this TreeItem. This is called by the tree widget when an item is added or inserted. More...
void	setSelectionColours (const ColourRect &cols)
	Set the colours used for selection highlighting. More...
void	setSelectionColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
	Set the colours used for selection highlighting. More...
void	setSelectionColours (Colour col)
	Set the colours used for selection highlighting. More...
void	setSelectionBrushImage (const Image *image)
	Set the selection highlighting brush image. More...
void	setSelectionBrushImage (const String &name)
	Set the selection highlighting brush image. More...
void	setButtonLocation (Rectf &buttonOffset)
	Tell the treeItem where its button is located. Calculated and set in Tree.cpp. More...
Rectf &	getButtonLocation (void)
bool	getIsOpen (void)
void	toggleIsOpen (void)
TreeItem *	getTreeItemFromIndex (size_t itemIndex)
size_t	getItemCount (void) const
LBItemList &	getItemList (void)
void	addItem (TreeItem *item)
void	removeItem (const TreeItem *item)
void	setIcon (const Image &theIcon)
virtual void	draw (GeometryBuffer &buffer, const Rectf &targetRect, float alpha, const Rectf *clipper) const
	Draw the tree item in its current state. More...
virtual bool	handleFontRenderSizeChange (const Font *const font)
	Perform any updates needed because the given font's render size has changed. More...
virtual bool	operator< (const TreeItem &rhs) const
	Less-than operator, compares item texts.
virtual bool	operator> (const TreeItem &rhs) const
	Greater-than operator, compares item texts.
	TreeItem (const String &text, uint item_id=0, void *item_data=0, bool disabled=false, bool auto_delete=true)
	base class constructor
virtual	~TreeItem (void)
	base class destructor
const Font *	getFont (void) const
	Return a pointer to the font being used by this TreeItem. More...
ColourRect	getTextColours (void) const
	Return the current colours used for text rendering. More...
void	setFont (const Font *font)
	Set the font to be used by this TreeItem. More...
void	setFont (const String &font_name)
	Set the font to be used by this TreeItem. More...
void	setTextColours (const ColourRect &cols)
	Set the colours used for text rendering. More...
void	setTextColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
	Set the colours used for text rendering. More...
void	setTextColours (Colour col)
	Set the colours used for text rendering. More...
const String &	getText () const
	return the text string set for this tree item. More...
const String &	getTextVisual () const
	return text string with visual ordering of glyphs.
const String &	getTooltipText (void) const
	Return the text string currently set to be used as the tooltip text for this item. More...
uint	getID (void) const
	Return the current ID assigned to this tree item. More...
void *	getUserData (void) const
	Return the pointer to any client assigned user data attached to this tree item. More...
bool	isSelected (void) const
	return whether this item is selected. More...
bool	isDisabled (void) const
	return whether this item is disabled. More...
bool	isAutoDeleted (void) const
	return whether this item will be automatically deleted when it is removed from the tree or when the the tree it is attached to is destroyed. More...
const Window *	getOwnerWindow (void)
	Get the owner window for this TreeItem. More...
ColourRect	getSelectionColours (void) const
	Return the current colours used for selection highlighting. More...
const Image *	getSelectionBrushImage (void) const
	Return the current selection highlighting brush. More...
void	setText (const String &text)
	set the text string for this tree item. More...
void	setTooltipText (const String &text)
	Set the tooltip text to be used for this item. More...
void	setID (uint item_id)
	Set the ID assigned to this tree item. More...
void	setUserData (void *item_data)
	Set the client assigned user data attached to this lis box item. More...
void	setSelected (bool setting)
	Set the selected state for the item. More...
void	setDisabled (bool setting)
	Set the disabled state for the item. More...
void	setAutoDeleted (bool setting)
	Set whether this item will be automatically deleted when it is removed from the tree, or when the tree it is attached to is destroyed. More...
void	setOwnerWindow (const Window *owner)
	Set the owner window for this TreeItem. This is called by the tree widget when an item is added or inserted. More...
void	setSelectionColours (const ColourRect &cols)
	Set the colours used for selection highlighting. More...
void	setSelectionColours (Colour top_left_colour, Colour top_right_colour, Colour bottom_left_colour, Colour bottom_right_colour)
	Set the colours used for selection highlighting. More...
void	setSelectionColours (Colour col)
	Set the colours used for selection highlighting. More...
void	setSelectionBrushImage (const Image *image)
	Set the selection highlighting brush image. More...
void	setSelectionBrushImage (const String &name)
	Set the selection highlighting brush image. More...
void	setButtonLocation (Rectf &buttonOffset)
	Tell the treeItem where its button is located. Calculated and set in Tree.cpp. More...
Rectf &	getButtonLocation (void)
bool	getIsOpen (void)
void	toggleIsOpen (void)
TreeItem *	getTreeItemFromIndex (size_t itemIndex)
size_t	getItemCount (void) const
LBItemList &	getItemList (void)
void	addItem (TreeItem *item)
void	removeItem (const TreeItem *item)
void	setIcon (const Image &theIcon)
virtual void	draw (GeometryBuffer &buffer, const Rectf &targetRect, float alpha, const Rectf *clipper) const
	Draw the tree item in its current state. More...
virtual bool	handleFontRenderSizeChange (const Font *const font)
	Perform any updates needed because the given font's render size has changed. More...
virtual bool	operator< (const TreeItem &rhs) const
	Less-than operator, compares item texts.
virtual bool	operator> (const TreeItem &rhs) const
	Greater-than operator, compares item texts.

Additional Inherited Members
Public Types inherited from CEGUI::TreeItem
typedef std::vector< TreeItem *CEGUI_VECTOR_ALLOC(TreeItem *)>	LBItemList
typedef std::vector< TreeItem *CEGUI_VECTOR_ALLOC(TreeItem *)>	LBItemList
Static Public Attributes inherited from CEGUI::TreeItem
static const Colour	DefaultTextColour = 0xFFFFFFFF
	Default text colour.
static const Colour	DefaultSelectionColour = 0xFF4444AA
	Default selection brush colour.
Protected Member Functions inherited from CEGUI::TreeItem
ColourRect	getModulateAlphaColourRect (const ColourRect &cols, float alpha) const
	Return a ColourRect object describing the colours in cols after having their alpha component modulated by the value alpha.
Colour	calculateModulatedAlphaColour (Colour col, float alpha) const
	Return a colour value describing the colour specified by col after having its alpha component modulated by the value alpha.
void	parseTextString () const
	parse the text visual string into a RenderString representation.
ColourRect	getModulateAlphaColourRect (const ColourRect &cols, float alpha) const
	Return a ColourRect object describing the colours in cols after having their alpha component modulated by the value alpha.
Colour	calculateModulatedAlphaColour (Colour col, float alpha) const
	Return a colour value describing the colour specified by col after having its alpha component modulated by the value alpha.
void	parseTextString () const
	parse the text visual string into a RenderString representation.
Protected Attributes inherited from CEGUI::TreeItem
String	d_textLogical
	Text for this tree item. If not rendered, still used for sorting. More...
BidiVisualMapping *	d_bidiVisualMapping
	pointer to bidirection support object
bool	d_bidiDataValid
	whether bidi visual mapping has been updated since last text change.
String	d_tooltipText
	Text for the individual tooltip of this item.
uint	d_itemID
	ID code assigned by client code.
void *	d_itemData
	Pointer to some client code data.
bool	d_selected
	true if item is selected. false if item is not selected.
bool	d_disabled
	true if item is disabled. false if item is not disabled.
bool	d_autoDelete
	true if the system will destroy this item, false if client code will.
Rectf	d_buttonLocation
	Location of the 'expand' button for the item.
const Window *	d_owner
	Pointer to the window that owns this item.
ColourRect	d_selectCols
	Colours used for selection highlighting.
const Image *	d_selectBrush
	Image used for rendering selection.
ColourRect	d_textCols
	Colours used for rendering the text.
const Font *	d_font
	Font used for rendering text.
const Image *	d_iconImage
	Image for the icon to be displayed with this TreeItem.
LBItemList	d_listItems
	list of items in this item's tree branch.
bool	d_isOpen
	true if the this item's tree branch is opened.
RenderedString	d_renderedString
	RenderedString drawn by this item.
bool	d_renderedStringValid
	boolean used to track when item state changes (and needs re-parse)
Static Protected Attributes inherited from CEGUI::TreeItem
static BasicRenderedStringParser	d_stringParser
	Parser used to produce a final RenderedString from the standard String.

Member Function Documentation

virtual ::CEGUI::Sizef TreeItem_wrapper::getPixelSize ( void  ) const

inlinevirtual

Return the rendered pixel size of this tree item.

Returns

Size object describing the size of the tree item in pixels.

Reimplemented from CEGUI::TreeItem.

References CEGUI::TreeItem::DefaultSelectionColour, CEGUI::TreeItem::DefaultTextColour, CEGUI::TreeItem::draw(), CEGUI::TreeItem::getFont(), CEGUI::TreeItem::getID(), CEGUI::TreeItem::getOwnerWindow(), CEGUI::TreeItem::getPixelSize(), CEGUI::TreeItem::getSelectionBrushImage(), CEGUI::TreeItem::getSelectionColours(), CEGUI::TreeItem::getText(), CEGUI::TreeItem::getTextColours(), CEGUI::TreeItem::getTextVisual(), CEGUI::TreeItem::getTooltipText(), CEGUI::TreeItem::getUserData(), CEGUI::TreeItem::handleFontRenderSizeChange(), CEGUI::TreeItem::isAutoDeleted(), CEGUI::TreeItem::isDisabled(), CEGUI::TreeItem::isSelected(), CEGUI::TreeItem::parseTextString(), CEGUI::TreeItem::setAutoDeleted(), CEGUI::TreeItem::setButtonLocation(), CEGUI::TreeItem::setDisabled(), CEGUI::TreeItem::setFont(), CEGUI::TreeItem::setID(), CEGUI::TreeItem::setOwnerWindow(), CEGUI::TreeItem::setSelected(), CEGUI::TreeItem::setSelectionBrushImage(), CEGUI::TreeItem::setSelectionColours(), CEGUI::TreeItem::setText(), CEGUI::TreeItem::setTextColours(), CEGUI::TreeItem::setTooltipText(), and CEGUI::TreeItem::setUserData().