Public Member Functions | |
Size | getItemPixelSize (void) const |
Return the "optimal" size for the item. | |
ItemListBase * | getOwnerList (void) const |
Returns a pointer to the owner ItemListBase. 0 if there is none. | |
bool | isSelected (void) const |
Returns whether this item is selected or not. | |
bool | isSelectable (void) const |
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 (void) |
Selects the item. | |
void | deselect (void) |
Deselects the item. | |
void | setSelected_impl (bool state, bool notify) |
Set the selection state for this ListItem. Internal version. Should NOT be used by client code. | |
void | setSelectable (bool setting) |
Sets whether this item will be selectable. | |
ItemEntry (const String &type, const String &name) | |
Constructor for ItemEntry objects. | |
virtual | ~ItemEntry (void) |
Destructor for ItemEntry objects. | |
Static Public Attributes | |
static const String | WidgetTypeName |
Window factory name. | |
static const String | EventSelectionChanged |
Event fired when selection state changes. | |
Protected Member Functions | |
virtual bool | testClassName_impl (const String &class_name) const |
Return the "optimal" size for the item. | |
virtual bool | validateWindowRenderer (const String &name) const |
Function used in checking if a WindowRenderer is valid for this window. | |
virtual void | onSelectionChanged (WindowEventArgs &e) |
Handles selection state changes. | |
virtual void | onMouseClicked (MouseEventArgs &e) |
Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area. | |
Protected Attributes | |
ItemListBase * | d_ownerList |
< pointer to the owner ItemListBase. 0 if there is none. | |
bool | d_selected |
'true' when the item is selectable. | |
bool | d_selectable |
Friends | |
class | ItemListBase |
Size CEGUI::ItemEntry::getItemPixelSize | ( | void | ) | const |
Return the "optimal" size for the item.
References CEGUI::Window::d_windowRenderer.
Referenced by CEGUI::ScrolledItemListBase::ensureItemIsVisibleHorz(), CEGUI::ScrolledItemListBase::ensureItemIsVisibleVert(), and CEGUI::ItemListbox::layoutItemWidgets().
void CEGUI::ItemEntry::onMouseClicked | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References CEGUI::MouseEventArgs::button, d_ownerList, CEGUI::EventArgs::handled, isSelected(), CEGUI::LeftButton, CEGUI::ItemListBase::notifyItemClicked(), and setSelected().
void CEGUI::ItemEntry::setSelectable | ( | bool | setting | ) |
Sets whether this item will be selectable.
setting | 'true' to allow this item to be selected. 'false' to disallow this item from ever being selected. |
References setSelected().
void CEGUI::ItemEntry::setSelected | ( | bool | setting | ) | [inline] |
Sets the selection state of this item (on/off). If this item is not selectable this function does nothing.
setting | 'true' to select the item. 'false' to deselect the item. |
Referenced by onMouseClicked(), and setSelectable().
virtual bool CEGUI::ItemEntry::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return the "optimal" size for the item.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::MenuItem.
References CEGUI::Window::testClassName_impl().
Referenced by CEGUI::MenuItem::testClassName_impl().
virtual bool CEGUI::ItemEntry::validateWindowRenderer | ( | const String & | name | ) | const [inline, protected, virtual] |
Function used in checking if a WindowRenderer is valid for this window.
Reimplemented from CEGUI::Window.
ItemListBase* CEGUI::ItemEntry::d_ownerList [protected] |
< pointer to the owner ItemListBase. 0 if there is none.
'true' when the item is in the selected state, 'false' if not.
Referenced by CEGUI::ItemListBase::addItem(), CEGUI::MenuItem::closeAllMenuItemPopups(), CEGUI::MenuItem::closePopupMenu(), CEGUI::ItemListBase::insertItem(), CEGUI::ItemListBase::isItemInList(), onMouseClicked(), CEGUI::MenuItem::openPopupMenu(), CEGUI::ItemListBase::removeItem(), setSelected_impl(), and CEGUI::MenuItem::updateInternalState().