Public Member Functions | |
size_t | getItemCount (void) const |
Return number of items attached to the list box. | |
size_t | getSelectedCount (void) const |
Return the number of selected items in the list box. | |
ListboxItem * | getFirstSelectedItem (void) const |
Return a pointer to the first selected item. | |
ListboxItem * | getNextSelected (const ListboxItem *start_item) const |
Return a pointer to the next selected item after item start_item. | |
ListboxItem * | getListboxItemFromIndex (size_t index) const |
Return the item at index position index. | |
size_t | getItemIndex (const ListboxItem *item) const |
Return the index of ListboxItem item. | |
bool | isSortEnabled (void) const |
return whether list sorting is enabled | |
bool | isMultiselectEnabled (void) const |
return whether multi-select is enabled | |
bool | isItemTooltipsEnabled (void) const |
bool | isItemSelected (size_t index) const |
return whether the string at index position index is selected | |
ListboxItem * | findItemWithText (const String &text, const ListboxItem *start_item) |
Search the list for an item with the specified text. | |
bool | isListboxItemInList (const ListboxItem *item) const |
Return whether the specified ListboxItem is in the List. | |
bool | isVertScrollbarAlwaysShown (void) const |
Return whether the vertical scroll bar is always shown. | |
bool | isHorzScrollbarAlwaysShown (void) const |
Return whether the horizontal scroll bar is always shown. | |
virtual void | initialiseComponents (void) |
Initialise the Window based object ready for use. | |
void | resetList (void) |
Remove all items from the list. | |
void | addItem (ListboxItem *item) |
Add the given ListboxItem to the list. | |
void | insertItem (ListboxItem *item, const ListboxItem *position) |
Insert an item into the list box before a specified item already in the list. | |
void | removeItem (const ListboxItem *item) |
Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted. | |
void | clearAllSelections (void) |
Clear the selected state for all items. | |
void | setSortingEnabled (bool setting) |
Set whether the list should be sorted. | |
void | setMultiselectEnabled (bool setting) |
Set whether the list should allow multiple selections or just a single selection. | |
void | setShowVertScrollbar (bool setting) |
Set whether the vertical scroll bar should always be shown. | |
void | setShowHorzScrollbar (bool setting) |
Set whether the horizontal scroll bar should always be shown. | |
void | setItemTooltipsEnabled (bool setting) |
void | setItemSelectState (ListboxItem *item, bool state) |
Set the select state of an attached ListboxItem. | |
void | setItemSelectState (size_t item_index, bool state) |
Set the select state of an attached ListboxItem. | |
void | handleUpdatedItemData (void) |
Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem objects. | |
void | ensureItemIsVisible (size_t item_index) |
Ensure the item at the specified index is visible within the list box. | |
void | ensureItemIsVisible (const ListboxItem *item) |
Ensure the item at the specified index is visible within the list box. | |
virtual Rect | getListRenderArea (void) const |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. | |
Scrollbar * | getVertScrollbar () const |
Return a pointer to the vertical scrollbar component widget for this Listbox. | |
Scrollbar * | getHorzScrollbar () const |
Return a pointer to the horizontal scrollbar component widget for this Listbox. | |
float | getTotalItemsHeight (void) const |
Return the sum of all item heights. | |
float | getWidestItemWidth (void) const |
Return the width of the widest item. | |
Listbox (const String &type, const String &name) | |
Constructor for Listbox base class. | |
virtual | ~Listbox (void) |
Destructor for Listbox base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | WidgetTypeName |
Window factory name. | |
static const String | EventListContentsChanged |
Event triggered when the contents of the list is changed. | |
static const String | EventSelectionChanged |
Event triggered when there is a change to the currently selected item(s). | |
static const String | EventSortModeChanged |
Event triggered when the sort mode setting changes. | |
static const String | EventMultiselectModeChanged |
Event triggered when the multi-select mode setting changes. | |
static const String | EventVertScrollbarModeChanged |
Event triggered when the vertical scroll bar 'force' setting changes. | |
static const String | EventHorzScrollbarModeChanged |
Event triggered when the horizontal scroll bar 'force' setting changes. | |
static const String | VertScrollbarNameSuffix |
Widget name suffix for the vertical scrollbar component. | |
static const String | HorzScrollbarNameSuffix |
Widget name suffix for the horizontal scrollbar component. | |
Protected Types | |
typedef std::vector < ListboxItem * > | LBItemList |
Protected Member Functions | |
void | configureScrollbars (void) |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. | |
void | selectRange (size_t start, size_t end) |
select all strings between positions start and end. (inclusive) including end. | |
bool | clearAllSelections_impl (void) |
Clear the selected state for all items (implementation). | |
ListboxItem * | getItemAtPoint (const Point &pt) const |
Return the ListboxItem under the given window local pixel co-ordinate. | |
bool | resetList_impl (void) |
Remove all items from the list. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. | |
bool | handle_scrollChange (const EventArgs &args) |
Internal handler that is triggered when the user interacts with the scrollbars. | |
virtual bool | validateWindowRenderer (const String &name) const |
Function used in checking if a WindowRenderer is valid for this window. | |
void | resortList () |
Causes the internal list to be (re)sorted. | |
virtual void | onListContentsChanged (WindowEventArgs &e) |
Handler called internally when the list contents are changed. | |
virtual void | onSelectionChanged (WindowEventArgs &e) |
Handler called internally when the currently selected item or items changes. | |
virtual void | onSortModeChanged (WindowEventArgs &e) |
Handler called internally when the sort mode setting changes. | |
virtual void | onMultiselectModeChanged (WindowEventArgs &e) |
Handler called internally when the multi-select mode setting changes. | |
virtual void | onVertScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the forced display of the vertical scroll bar setting changes. | |
virtual void | onHorzScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the forced display of the horizontal scroll bar setting changes. | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
virtual void | onMouseButtonDown (MouseEventArgs &e) |
Handler called when a mouse button has been depressed within this window's area. | |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
virtual void | onMouseMove (MouseEventArgs &e) |
Handler called when the mouse cursor has been moved within this window's area. | |
Protected Attributes | |
bool | d_sorted |
true if list is sorted | |
bool | d_multiselect |
true if multi-select is enabled | |
bool | d_forceVertScroll |
true if vertical scrollbar should always be displayed | |
bool | d_forceHorzScroll |
true if horizontal scrollbar should always be displayed | |
bool | d_itemTooltips |
true if each item should have an individual tooltip | |
LBItemList | d_listItems |
list of items in the list box. | |
ListboxItem * | d_lastSelected |
holds pointer to the last selected item (used in range selections) | |
Friends | |
class | ListboxWindowRenderer |
void CEGUI::Listbox::addItem | ( | ListboxItem * | item | ) |
Add the given ListboxItem to the list.
item | Pointer to the ListboxItem to be added to the list. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens. |
References d_listItems, isSortEnabled(), CEGUI::lbi_less(), onListContentsChanged(), and CEGUI::ListboxItem::setOwnerWindow().
Referenced by CEGUI::Combobox::addItem(), and insertItem().
void CEGUI::Listbox::clearAllSelections | ( | void | ) |
Clear the selected state for all items.
References clearAllSelections_impl(), and onSelectionChanged().
Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::clearAllSelections(), CEGUI::Combobox::editbox_MouseDownHandler(), CEGUI::ComboDropList::onMouseButtonDown(), and CEGUI::ComboDropList::onMouseMove().
bool CEGUI::Listbox::clearAllSelections_impl | ( | void | ) | [protected] |
Clear the selected state for all items (implementation).
References d_listItems.
Referenced by clearAllSelections(), CEGUI::ComboDropList::onCaptureLost(), onMouseButtonDown(), and setItemSelectState().
void CEGUI::Listbox::configureScrollbars | ( | void | ) | [protected] |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
display required integrated scroll bars according to current state of the list box and update their values.
References d_forceHorzScroll, d_forceVertScroll, CEGUI::Rect::getHeight(), CEGUI::Window::getHeight(), getHorzScrollbar(), getListRenderArea(), CEGUI::Scrollbar::getScrollPosition(), getTotalItemsHeight(), getVertScrollbar(), getWidestItemWidth(), CEGUI::Rect::getWidth(), CEGUI::Window::getWidth(), CEGUI::Window::hide(), CEGUI::Scrollbar::setDocumentSize(), CEGUI::Scrollbar::setPageSize(), CEGUI::Scrollbar::setScrollPosition(), CEGUI::Scrollbar::setStepSize(), and CEGUI::Window::show().
Referenced by handleUpdatedItemData(), initialiseComponents(), onListContentsChanged(), onSized(), setShowHorzScrollbar(), and setShowVertScrollbar().
void CEGUI::Listbox::ensureItemIsVisible | ( | const ListboxItem * | item | ) |
Ensure the item at the specified index is visible within the list box.
item | Pointer to the ListboxItem to be made visible in the list box. |
InvalidRequestException | thrown if item is not attached to this list box. |
References ensureItemIsVisible(), and getItemIndex().
void CEGUI::Listbox::ensureItemIsVisible | ( | size_t | item_index | ) |
Ensure the item at the specified index is visible within the list box.
item_index | Zero based index of the item to be made visible in the list box. If this value is out of range, the list is always scrolled to the bottom. |
References d_listItems, CEGUI::Scrollbar::getDocumentSize(), CEGUI::Rect::getHeight(), getItemCount(), getListRenderArea(), CEGUI::Scrollbar::getPageSize(), CEGUI::Scrollbar::getScrollPosition(), getVertScrollbar(), and CEGUI::Scrollbar::setScrollPosition().
Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), and ensureItemIsVisible().
ListboxItem * CEGUI::Listbox::findItemWithText | ( | const String & | text, | |
const ListboxItem * | start_item | |||
) |
Search the list for an item with the specified text.
text | String object containing the text to be searched for. | |
start_item | ListboxItem where the search is to begin, the search will not include item. If item is NULL, the search will begin from the first item in the list. |
InvalidRequestException | thrown if item is not attached to this list box. |
References d_listItems, getItemIndex(), and CEGUI::Window::getText().
Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), and CEGUI::Combobox::findItemWithText().
ListboxItem * CEGUI::Listbox::getFirstSelectedItem | ( | void | ) | const |
Return a pointer to the first selected item.
References getNextSelected().
Referenced by CEGUI::Combobox::getSelectedItem(), CEGUI::ComboDropList::onListSelectionAccepted(), CEGUI::ComboDropList::onSelectionChanged(), and setMultiselectEnabled().
Scrollbar * CEGUI::Listbox::getHorzScrollbar | ( | ) | const |
Return a pointer to the horizontal scrollbar component widget for this Listbox.
UnknownObjectException | Thrown if the horizontal Scrollbar component does not exist. |
References CEGUI::Window::getName(), and HorzScrollbarNameSuffix.
Referenced by configureScrollbars(), CEGUI::FalagardListbox::getListRenderArea(), initialiseComponents(), CEGUI::ComboDropList::initialiseComponents(), onMouseWheel(), and CEGUI::FalagardListbox::render().
ListboxItem * CEGUI::Listbox::getItemAtPoint | ( | const Point & | pt | ) | const [protected] |
Return the ListboxItem under the given window local pixel co-ordinate.
References d_listItems, CEGUI::Rect::d_top, CEGUI::Vector2::d_y, getItemCount(), getListRenderArea(), CEGUI::Scrollbar::getScrollPosition(), getVertScrollbar(), and CEGUI::Rect::isPointInRect().
Referenced by onMouseButtonDown(), onMouseMove(), and CEGUI::ComboDropList::onMouseMove().
size_t CEGUI::Listbox::getItemCount | ( | void | ) | const [inline] |
Return number of items attached to the list box.
Referenced by ensureItemIsVisible(), getItemAtPoint(), CEGUI::Combobox::getItemCount(), getTotalItemsHeight(), getWidestItemWidth(), CEGUI::FalagardListbox::render(), resetList_impl(), setItemSelectState(), and CEGUI::Combobox::setItemSelectState().
size_t CEGUI::Listbox::getItemIndex | ( | const ListboxItem * | item | ) | const |
Return the index of ListboxItem item.
item | Pointer to a ListboxItem whos zero based index is to be returned. |
InvalidRequestException | thrown if item is not attached to this list box. |
References d_listItems.
Referenced by ensureItemIsVisible(), findItemWithText(), CEGUI::Combobox::getItemIndex(), getNextSelected(), and onMouseButtonDown().
ListboxItem * CEGUI::Listbox::getListboxItemFromIndex | ( | size_t | index | ) | const |
Return the item at index position index.
index | Zero based index of the item to be returned. |
InvalidRequestException | thrown if index is out of range. |
References d_listItems.
Referenced by CEGUI::Combobox::getListboxItemFromIndex(), CEGUI::FalagardListbox::render(), and CEGUI::Combobox::setItemSelectState().
Rect CEGUI::Listbox::getListRenderArea | ( | void | ) | const [virtual] |
Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
References CEGUI::Window::d_windowRenderer, and CEGUI::ListboxWindowRenderer::getListRenderArea().
Referenced by configureScrollbars(), ensureItemIsVisible(), and getItemAtPoint().
ListboxItem * CEGUI::Listbox::getNextSelected | ( | const ListboxItem * | start_item | ) | const |
Return a pointer to the next selected item after item start_item.
start_item | Pointer to the ListboxItem where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box. |
InvalidRequestException | thrown if start_item is not attached to this list box. |
References d_listItems, and getItemIndex().
Referenced by getFirstSelectedItem(), and setMultiselectEnabled().
size_t CEGUI::Listbox::getSelectedCount | ( | void | ) | const |
Return the number of selected items in the list box.
References d_listItems.
Referenced by CEGUI::ComboDropList::onMouseButtonUp(), and setMultiselectEnabled().
Scrollbar * CEGUI::Listbox::getVertScrollbar | ( | ) | const |
Return a pointer to the vertical scrollbar component widget for this Listbox.
UnknownObjectException | Thrown if the vertical Scrollbar component does not exist. |
References CEGUI::Window::getName(), and VertScrollbarNameSuffix.
Referenced by configureScrollbars(), ensureItemIsVisible(), getItemAtPoint(), CEGUI::FalagardListbox::getListRenderArea(), initialiseComponents(), CEGUI::ComboDropList::initialiseComponents(), onMouseWheel(), and CEGUI::FalagardListbox::render().
void CEGUI::Listbox::handleUpdatedItemData | ( | void | ) |
Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem objects.
Client code must call this whenever it has made any changes to ListboxItem objects already attached to the list box. If you are just adding items, or removed items to update them prior to re-adding them, there is no need to call this method.
References configureScrollbars(), d_sorted, CEGUI::Window::requestRedraw(), and resortList().
Referenced by CEGUI::Combobox::handleUpdatedListItemData().
void CEGUI::Listbox::initialiseComponents | ( | void | ) | [virtual] |
Initialise the Window based object ready for use.
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::ComboDropList.
References configureScrollbars(), CEGUI::Scrollbar::EventScrollPositionChanged, getHorzScrollbar(), getVertScrollbar(), handle_scrollChange(), CEGUI::Window::performChildWindowLayout(), and CEGUI::EventSet::subscribeEvent().
void CEGUI::Listbox::insertItem | ( | ListboxItem * | item, | |
const ListboxItem * | position | |||
) |
Insert an item into the list box before a specified item already in the list.
Note that if the list is sorted, the item may not end up in the requested position.
item | Pointer to the ListboxItem to be inserted. Note that it is the passed object that is added to the list, a copy is not made. If this parameter is NULL, nothing happens. | |
position | Pointer to a ListboxItem that item is to be inserted before. If this parameter is NULL, the item is inserted at the start of the list. |
InvalidRequestException | thrown if no ListboxItem position is attached to this list box. |
References addItem(), d_listItems, isSortEnabled(), onListContentsChanged(), and CEGUI::ListboxItem::setOwnerWindow().
Referenced by CEGUI::Combobox::insertItem().
bool CEGUI::Listbox::isHorzScrollbarAlwaysShown | ( | void | ) | const |
Return whether the horizontal scroll bar is always shown.
References d_forceHorzScroll.
Referenced by CEGUI::Combobox::isHorzScrollbarAlwaysShown().
bool CEGUI::Listbox::isItemSelected | ( | size_t | index | ) | const |
return whether the string at index position index is selected
index | Zero based index of the item to be examined. |
InvalidRequestException | thrown if index is out of range. |
References d_listItems.
Referenced by CEGUI::Combobox::isItemSelected().
bool CEGUI::Listbox::isListboxItemInList | ( | const ListboxItem * | item | ) | const |
Return whether the specified ListboxItem is in the List.
References d_listItems.
Referenced by CEGUI::Combobox::isListboxItemInList(), and CEGUI::ComboDropList::onListContentsChanged().
bool CEGUI::Listbox::isMultiselectEnabled | ( | void | ) | const [inline] |
return whether multi-select is enabled
bool CEGUI::Listbox::isSortEnabled | ( | void | ) | const [inline] |
return whether list sorting is enabled
Referenced by addItem(), insertItem(), and CEGUI::Combobox::isSortEnabled().
bool CEGUI::Listbox::isVertScrollbarAlwaysShown | ( | void | ) | const |
Return whether the vertical scroll bar is always shown.
References d_forceVertScroll.
Referenced by CEGUI::Combobox::isVertScrollbarAlwaysShown().
void CEGUI::Listbox::onMouseButtonDown | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when a mouse button has been depressed within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::ComboDropList.
References CEGUI::MouseEventArgs::button, clearAllSelections_impl(), CEGUI::Control, d_lastSelected, d_multiselect, getItemAtPoint(), getItemIndex(), CEGUI::EventArgs::handled, CEGUI::ListboxItem::isSelected(), CEGUI::LeftButton, onSelectionChanged(), CEGUI::MouseEventArgs::position, CEGUI::CoordConverter::screenToWindow(), selectRange(), CEGUI::ListboxItem::setSelected(), CEGUI::Shift, and CEGUI::MouseEventArgs::sysKeys.
void CEGUI::Listbox::onMouseMove | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse cursor has been moved within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::ComboDropList.
References d_itemTooltips, getItemAtPoint(), CEGUI::Tooltip::getTargetWindow(), CEGUI::Window::getTooltip(), CEGUI::ListboxItem::getTooltipText(), CEGUI::MouseEventArgs::position, CEGUI::Tooltip::positionSelf(), CEGUI::CoordConverter::screenToWindow(), CEGUI::Tooltip::setTargetWindow(), and CEGUI::Window::setTooltipText().
void CEGUI::Listbox::onMouseWheel | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse wheel (z-axis) position changes within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
References CEGUI::Scrollbar::getDocumentSize(), getHorzScrollbar(), CEGUI::Scrollbar::getPageSize(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Scrollbar::getStepSize(), getVertScrollbar(), CEGUI::EventArgs::handled, CEGUI::Window::isVisible(), CEGUI::Scrollbar::setScrollPosition(), and CEGUI::MouseEventArgs::wheelChange.
void CEGUI::Listbox::onSized | ( | WindowEventArgs & | e | ) | [protected, virtual] |
Handler called when the window's size changes.
e | WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'. |
Reimplemented from CEGUI::Window.
References configureScrollbars(), and CEGUI::EventArgs::handled.
void CEGUI::Listbox::removeItem | ( | const ListboxItem * | item | ) |
Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.
item | Pointer to the ListboxItem that is to be removed. If item is not attached to this list box then nothing will happen. |
References d_lastSelected, d_listItems, CEGUI::ListboxItem::isAutoDeleted(), and onListContentsChanged().
Referenced by CEGUI::Combobox::removeItem().
void CEGUI::Listbox::resetList | ( | void | ) |
Remove all items from the list.
Note that this will cause 'AutoDelete' items to be deleted.
References onListContentsChanged(), and resetList_impl().
Referenced by CEGUI::Combobox::resetList().
bool CEGUI::Listbox::resetList_impl | ( | void | ) | [protected] |
Remove all items from the list.
References d_lastSelected, d_listItems, and getItemCount().
Referenced by resetList(), and ~Listbox().
void CEGUI::Listbox::setItemSelectState | ( | size_t | item_index, | |
bool | state | |||
) |
Set the select state of an attached ListboxItem.
This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.
item_index | The zero based index of the ListboxItem to be affected. This must be a valid index (0 <= index < getItemCount()) | |
state | true to select the item, false to de-select the item. |
InvalidRequestException | thrown if item_index is out of range for the list box |
References clearAllSelections_impl(), d_listItems, d_multiselect, getItemCount(), and onSelectionChanged().
void CEGUI::Listbox::setItemSelectState | ( | ListboxItem * | item, | |
bool | state | |||
) |
Set the select state of an attached ListboxItem.
This is the recommended way of selecting and deselecting items attached to a list box as it respects the multi-select mode setting. It is possible to modify the setting on ListboxItems directly, but that approach does not respect the settings of the list box.
item | The ListboxItem to be affected. This item must be attached to the list box. | |
state | true to select the item, false to de-select the item. |
InvalidRequestException | thrown if item is not attached to this list box. |
References d_listItems.
Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), CEGUI::ComboDropList::onCaptureLost(), CEGUI::ComboDropList::onMouseMove(), and CEGUI::Combobox::setItemSelectState().
void CEGUI::Listbox::setMultiselectEnabled | ( | bool | setting | ) |
Set whether the list should allow multiple selections or just a single selection.
setting | true if the widget should allow multiple items to be selected, false if the widget should only allow a single selection. |
References d_multiselect, getFirstSelectedItem(), getNextSelected(), getSelectedCount(), onMultiselectModeChanged(), onSelectionChanged(), and CEGUI::ListboxItem::setSelected().
void CEGUI::Listbox::setShowHorzScrollbar | ( | bool | setting | ) |
Set whether the horizontal scroll bar should always be shown.
setting | true if the horizontal scroll bar should be shown even when it is not required. false if the horizontal scroll bar should only be shown when it is required. |
References configureScrollbars(), d_forceHorzScroll, and onHorzScrollbarModeChanged().
Referenced by CEGUI::Combobox::setShowHorzScrollbar().
void CEGUI::Listbox::setShowVertScrollbar | ( | bool | setting | ) |
Set whether the vertical scroll bar should always be shown.
setting | true if the vertical scroll bar should be shown even when it is not required. false if the vertical scroll bar should only be shown when it is required. |
References configureScrollbars(), d_forceVertScroll, and onVertScrollbarModeChanged().
Referenced by CEGUI::Combobox::setShowVertScrollbar().
void CEGUI::Listbox::setSortingEnabled | ( | bool | setting | ) |
Set whether the list should be sorted.
setting | true if the list should be sorted, false if the list should not be sorted. |
References d_sorted, onSortModeChanged(), and resortList().
Referenced by CEGUI::Combobox::setSortingEnabled().
virtual bool CEGUI::Listbox::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
Reimplemented in CEGUI::ComboDropList.
References CEGUI::Window::testClassName_impl().
Referenced by CEGUI::ComboDropList::testClassName_impl().
virtual bool CEGUI::Listbox::validateWindowRenderer | ( | const String & | name | ) | const [inline, protected, virtual] |
Function used in checking if a WindowRenderer is valid for this window.
Reimplemented from CEGUI::Window.