DigitalSpaces::DICEGUIItemEntry Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
void	getItemPixelSize (out_Pairf *size)
	Return the "optimal" size for the item.
DICEGUIItemListBase *	getOwnerList ()
	Returns a pointer to the owner ItemListBase. 0 if there is none.
bool	isSelected ()
	Returns whether this item is selected or not.
bool	isSelectable ()
	Returns whether this item is selectable or not.
void	setSelected (bool setting)
	Sets the selection state of this item (on/off). If this item is not selectable this function does nothing.
void	select ()
	Selects the item.
void	deselect ()
	Deselects the item.
void	setSelectable (bool setting)
	Sets whether this item will be selectable.

Member Function Documentation

void DigitalSpaces::DICEGUIItemEntry::getItemPixelSize ( out_Pairf * size )

Return the "optimal" size for the item.

Returns:: Size describing the size in pixel that this ItemEntry's content requires for non-clipped rendering

DICEGUIItemListBase* DigitalSpaces::DICEGUIItemEntry::getOwnerList ( )

Returns a pointer to the owner ItemListBase. 0 if there is none.

bool DigitalSpaces::DICEGUIItemEntry::isSelected ( )

Returns whether this item is selected or not.

bool DigitalSpaces::DICEGUIItemEntry::isSelectable ( )

Returns whether this item is selectable or not.

void DigitalSpaces::DICEGUIItemEntry::setSelected ( bool setting )

Sets the selection state of this item (on/off). If this item is not selectable this function does nothing.

Parameters:

setting

'true' to select the item. 'false' to deselect the item.

void DigitalSpaces::DICEGUIItemEntry::select ( )

Selects the item.

void DigitalSpaces::DICEGUIItemEntry::deselect ( )

Deselects the item.

void DigitalSpaces::DICEGUIItemEntry::setSelectable ( bool setting )

Sets whether this item will be selectable.

Parameters:

setting

'true' to allow this item to be selected. 'false' to disallow this item from ever being selected.

Note:: If the item is currently selectable and selected, calling this function with setting as 'false' will first deselect the item and then disable selectability.

The documentation for this struct was generated from the following file: