Inheritance diagram for CEGUI::Combobox:
Public Member Functions | |
virtual bool | isHit (const Point &position) const |
check if the given position would hit this window. | |
bool | getSingleClickEnabled (void) const |
returns the mode of operation for the combo box. | |
bool | isDropDownListVisible (void) const |
returns true if the drop down list is visible. | |
bool | hasInputFocus (void) const |
return true if the Editbox has input focus. | |
bool | isReadOnly (void) const |
return true if the Editbox is read-only. | |
bool | isTextValid (void) const |
return true if the Editbox text is valid given the currently set validation string. | |
const String & | getValidationString (void) const |
return the currently set validation string | |
size_t | getCaratIndex (void) const |
return the current position of the carat. | |
size_t | getSelectionStartIndex (void) const |
return the current selection start point. | |
size_t | getSelectionEndIndex (void) const |
return the current selection end point. | |
size_t | getSelectionLength (void) const |
return the length of the current selection (in code points / characters). | |
size_t | getMaxTextLength (void) const |
return the maximum text length set for this Editbox. | |
colour | getNormalTextColour (void) const |
return the currently set colour to be used for rendering Editbox text in the normal, unselected state. | |
colour | getSelectedTextColour (void) const |
return the currently set colour to be used for rendering the Editbox text when within the selected region. | |
colour | getNormalSelectBrushColour (void) const |
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is active. | |
colour | getInactiveSelectBrushColour (void) const |
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. | |
size_t | getItemCount (void) const |
Return number of items attached to the list box. | |
ListboxItem * | getSelectedItem (void) const |
Return a pointer to the currently selected 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 | 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 | initialise (void) |
Initialise the Window based object ready for use. | |
void | showDropList (void) |
Show the drop-down list. | |
void | hideDropList (void) |
Hide the drop-down list. | |
void | setSingleClickEnabled (bool setting) |
Set the mode of operation for the combo box. | |
void | setReadOnly (bool setting) |
Specify whether the Editbox is read-only. | |
void | setValidationString (const String &validation_string) |
Set the text validation string. | |
void | setCaratIndex (size_t carat_pos) |
Set the current position of the carat. | |
void | setSelection (size_t start_pos, size_t end_pos) |
Define the current selection for the Editbox. | |
void | setMaxTextLength (size_t max_len) |
set the maximum text length for this Editbox. | |
void | setNormalTextColour (colour col) |
Set the colour to be used for rendering Editbox text in the normal, unselected state. | |
void | setSelectedTextColour (colour col) |
Set the colour to be used for rendering the Editbox text when within the selected region. | |
void | setNormalSelectBrushColour (colour col) |
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is active. | |
void | setInactiveSelectBrushColour (colour col) |
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is inactive. | |
void | activateEditbox (void) |
Activate the edit box component of the Combobox. | |
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 after a specified item already in the list. | |
void | removeItem (const ListboxItem *item) |
Removes the given item from the list box. | |
void | clearAllSelections (void) |
Clear the selected state for all items. | |
void | setSortingEnabled (bool setting) |
Set whether the list should be sorted. | |
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 | 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 | handleUpdatedListItemData (void) |
Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem objects. | |
Combobox (const String &type, const String &name) | |
Constructor for Combobox base class. | |
virtual | ~Combobox (void) |
Destructor for Combobox base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventReadOnlyModeChanged |
The read-only mode for the edit box has been changed. | |
static const String | EventValidationStringChanged |
The validation string has been changed. | |
static const String | EventMaximumTextLengthChanged |
The maximum allowable string length has been changed. | |
static const String | EventTextInvalidated |
Some operation has made the current text invalid with regards to the validation string. | |
static const String | EventInvalidEntryAttempted |
The user attempted to modify the text in a way that would have made it invalid. | |
static const String | EventCaratMoved |
The text carat (insert point) has changed. | |
static const String | EventTextSelectionChanged |
The current text selection has changed. | |
static const String | EventEditboxFull |
The number of characters in the edit box has reached the current maximum. | |
static const String | EventTextAccepted |
The user has accepted the current text by pressing Return, Enter, or Tab. | |
static const String | EventListContentsChanged |
Event triggered when the contents of the list is changed. | |
static const String | EventListSelectionChanged |
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 | 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 | EventDropListDisplayed |
Event triggered when the drop-down list is displayed. | |
static const String | EventDropListRemoved |
Event triggered when the drop-down list is removed / hidden. | |
static const String | EventListSelectionAccepted |
Event triggered when the user accepts a selection from the drop-down list. | |
Protected Member Functions | |
void | addComboboxEvents (void) |
Add combo box specific events. | |
virtual Editbox * | createEditbox (const String &name) const =0 |
Create, initialise, and return a pointer to an Editbox widget to be used as part of this Combobox. | |
virtual PushButton * | createPushButton (const String &name) const =0 |
Create, initialise, and return a pointer to a PushButton widget to be used as part of this Combobox. | |
virtual ComboDropList * | createDropList (const String &name) const =0 |
Create, initialise, and return a pointer to a ComboDropList widget to be used as part of this Combobox. | |
bool | button_PressHandler (const EventArgs &e) |
Handler function for button clicks. | |
bool | droplist_SelectionAcceptedHandler (const EventArgs &e) |
Handler for selections made in the drop-list. | |
bool | droplist_HiddenHandler (const EventArgs &e) |
Handler for when drop-list hides itself. | |
bool | editbox_MouseDownHandler (const EventArgs &e) |
Mouse button down handler attached to edit box. | |
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 heirarchy. | |
bool | editbox_ReadOnlyChangedHandler (const EventArgs &e) |
bool | editbox_ValidationStringChangedHandler (const EventArgs &e) |
bool | editbox_MaximumTextLengthChangedHandler (const EventArgs &e) |
bool | editbox_TextInvalidatedEventHandler (const EventArgs &e) |
bool | editbox_InvalidEntryAttemptedHandler (const EventArgs &e) |
bool | editbox_CaratMovedHandler (const EventArgs &e) |
bool | editbox_TextSelectionChangedHandler (const EventArgs &e) |
bool | editbox_EditboxFullEventHandler (const EventArgs &e) |
bool | editbox_TextAcceptedEventHandler (const EventArgs &e) |
bool | editbox_TextChangedEventHandler (const EventArgs &e) |
bool | listbox_ListContentsChangedHandler (const EventArgs &e) |
bool | listbox_ListSelectionChangedHandler (const EventArgs &e) |
bool | listbox_SortModeChangedHandler (const EventArgs &e) |
bool | listbox_VertScrollModeChangedHandler (const EventArgs &e) |
bool | listbox_HorzScrollModeChangedHandler (const EventArgs &e) |
virtual void | onReadOnlyChanged (WindowEventArgs &e) |
Handler called internally when the read only state of the Combobox's Editbox has been changed. | |
virtual void | onValidationStringChanged (WindowEventArgs &e) |
Handler called internally when the Combobox's Editbox validation string has been changed. | |
virtual void | onMaximumTextLengthChanged (WindowEventArgs &e) |
Handler called internally when the Combobox's Editbox maximum text length is changed. | |
virtual void | onTextInvalidatedEvent (WindowEventArgs &e) |
Handler called internally when the Combobox's Editbox text has been invalidated. | |
virtual void | onInvalidEntryAttempted (WindowEventArgs &e) |
Handler called internally when an invalid entry was attempted in the Combobox's Editbox. | |
virtual void | onCaratMoved (WindowEventArgs &e) |
Handler called internally when the carat in the Comboxbox's Editbox moves. | |
virtual void | onTextSelectionChanged (WindowEventArgs &e) |
Handler called internally when the selection within the Combobox's Editbox changes. | |
virtual void | onEditboxFullEvent (WindowEventArgs &e) |
Handler called internally when the maximum length is reached for text in the Combobox's Editbox. | |
virtual void | onTextAcceptedEvent (WindowEventArgs &e) |
Handler called internally when the text in the Combobox's Editbox is accepted (by various means). | |
virtual void | onListContentsChanged (WindowEventArgs &e) |
Handler called internally when the Combobox's Drop-down list contents are changed. | |
virtual void | onListSelectionChanged (WindowEventArgs &e) |
Handler called internally when the selection within the Combobox's drop-down list changes (this is not the 'final' accepted selection, just the currently highlighted item). | |
virtual void | onSortModeChanged (WindowEventArgs &e) |
Handler called fired internally when the sort mode for the Combobox's drop-down list is changed. | |
virtual void | onVertScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the 'force' setting for the vertical scrollbar within the Combobox's drop-down list is changed. | |
virtual void | onHorzScrollbarModeChanged (WindowEventArgs &e) |
Handler called internally when the 'force' setting for the horizontal scrollbar within the Combobox's drop-down list is changed. | |
virtual void | onDropListDisplayed (WindowEventArgs &e) |
Handler called internally when the Combobox's drop-down list has been displayed. | |
virtual void | onDroplistRemoved (WindowEventArgs &e) |
Handler called internally when the Combobox's drop-down list has been hidden. | |
virtual void | onListSelectionAccepted (WindowEventArgs &e) |
Handler called internally when the user has confirmed a selection within the Combobox's drop-down list. | |
virtual void | onFontChanged (WindowEventArgs &e) |
Handler called when the window's font is changed. | |
virtual void | onTextChanged (WindowEventArgs &e) |
Handler called when the window's text is changed. | |
virtual void | onActivated (ActivationEventArgs &e) |
Handler called when this window has become the active window. | |
Protected Attributes | |
Editbox * | d_editbox |
Editbox widget sub-component. | |
ComboDropList * | d_droplist |
ComboDropList widget sub-component. | |
PushButton * | d_button |
PushButton widget sub-component. | |
bool | d_singleClickOperation |
true if user can show and select from list in a single click. |
|
Activate the edit box component of the Combobox.
|
|
Add the given ListboxItem to the list.
|
|
Clear the selected state for all items.
|
|
Create, initialise, and return a pointer to a ComboDropList widget to be used as part of this Combobox.
|
|
Create, initialise, and return a pointer to an Editbox widget to be used as part of this Combobox.
|
|
Create, initialise, and return a pointer to a PushButton widget to be used as part of this Combobox.
|
|
Search the list for an item with the specified text.
|
|
return the current position of the carat.
|
|
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is inactive.
|
|
Return number of items attached to the list box.
|
|
Return the index of ListboxItem item.
|
|
Return the item at index position index.
|
|
return the maximum text length set for this Editbox.
|
|
return the currently set colour to be used for rendering the Editbox selection highlight when the Editbox is active.
|
|
return the currently set colour to be used for rendering Editbox text in the normal, unselected state.
|
|
Return a pointer to the currently selected item.
|
|
return the currently set colour to be used for rendering the Editbox text when within the selected region.
|
|
return the current selection end point.
|
|
return the length of the current selection (in code points / characters).
|
|
return the current selection start point.
|
|
returns the mode of operation for the combo box.
|
|
return the currently set validation string
|
|
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.
|
|
return true if the Editbox has input focus.
|
|
Hide the drop-down list.
|
|
Initialise the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
Insert an item into the list box after a specified item already in the list. Note that if the list is sorted, the item may not end up in the requested position.
|
|
returns true if the drop down list is visible.
|
|
check if the given position would hit this window.
Reimplemented from CEGUI::Window. |
|
Return whether the horizontal scroll bar is always shown.
|
|
return whether the string at index position index is selected
|
|
Return whether the specified ListboxItem is in the List.
|
|
return true if the Editbox is read-only.
|
|
return whether list sorting is enabled
|
|
return true if the Editbox text is valid given the currently set validation string.
|
|
Return whether the vertical scroll bar is always shown.
|
|
Handler called when this window has become the active window.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's font is changed.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's text is changed.
Reimplemented from CEGUI::Window. |
|
Removes the given item from the list box.
|
|
Remove all items from the list. Note that this will cause 'AutoDelete' items to be deleted. |
|
Set the current position of the carat.
|
|
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is inactive.
|
|
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.
|
|
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.
|
|
set the maximum text length for this Editbox.
|
|
Set the colour to be used for rendering the Editbox selection highlight when the Editbox is active.
|
|
Set the colour to be used for rendering Editbox text in the normal, unselected state.
|
|
Specify whether the Editbox is read-only.
|
|
Set the colour to be used for rendering the Editbox text when within the selected region.
|
|
Define the current selection for the Editbox.
|
|
Set whether the horizontal scroll bar should always be shown.
|
|
Set whether the vertical scroll bar should always be shown.
|
|
Set the mode of operation for the combo box.
|
|
Set whether the list should be sorted.
|
|
Set the text validation string.
|
|
Show the drop-down list.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |