Public Member Functions |
bool | isHit (const Vector2 &position, const bool allow_disabled=false) const |
| check if the given pixel 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.
|
Editbox * | getEditbox () const |
| Return a pointer to the Editbox component widget for this Combobox.
|
PushButton * | getPushButton () const |
| Return a pointer to the PushButton component widget for this Combobox.
|
ComboDropList * | getDropList () const |
| Return a pointer to the ComboDropList component widget for this Combobox.
|
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.
|
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 | initialiseComponents (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 | 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 | WidgetTypeName |
| Window factory name.
|
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.
|
static const String | EditboxNameSuffix |
| Widget name suffix for the editbox component.
|
static const String | DropListNameSuffix |
| Widget name suffix for the drop list component.
|
static const String | ButtonNameSuffix |
| Widget name suffix for the button component.
|
Protected Member Functions |
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 hierarchy.
|
void | itemSelectChangeTextUpdate (const ListboxItem *const item, bool new_state, bool old_state) |
| Update the Combobox text to reflect programmatically made changes to selected list item.
|
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 |
bool | d_singleClickOperation |
| true if user can show and select from list in a single click.
|