Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::Combobox Class Reference

Base class for the Combobox widget. More...

+ Inheritance diagram for CEGUI::Combobox:
+ Collaboration diagram for CEGUI::Combobox:

Public Types

typedef RegexMatcher::MatchState MatchState
 

Public Member Functions

bool isHit (const Vector2f &position, const bool allow_disabled=false) const
 check if the given pixel position would hit this window. More...
 
bool getSingleClickEnabled (void) const
 returns the mode of operation for the combo box. More...
 
bool isDropDownListVisible (void) const
 returns true if the drop down list is visible. More...
 
EditboxgetEditbox () const
 Return a pointer to the Editbox component widget for this Combobox. More...
 
PushButtongetPushButton () const
 Return a pointer to the PushButton component widget for this Combobox. More...
 
ComboDropListgetDropList () const
 Return a pointer to the ComboDropList component widget for this Combobox. More...
 
bool getAutoSizeListHeightToContent () const
 return whether the drop-list will vertically auto size to content.
 
bool getAutoSizeListWidthToContent () const
 return whether the drop-list will horizontally auto size to content.
 
bool hasInputFocus (void) const
 return true if the Editbox has input focus. More...
 
bool isReadOnly (void) const
 return true if the Editbox is read-only. More...
 
MatchState getTextMatchState () const
 return the validation MatchState for the current Combobox text, given the currently set validation string. More...
 
const StringgetValidationString (void) const
 return the currently set validation string More...
 
size_t getCaretIndex (void) const
 return the current position of the caret. More...
 
size_t getSelectionStartIndex (void) const
 return the current selection start point. More...
 
size_t getSelectionEndIndex (void) const
 return the current selection end point. More...
 
size_t getSelectionLength (void) const
 return the length of the current selection (in code points / characters). More...
 
size_t getMaxTextLength (void) const
 return the maximum text length set for this Editbox. More...
 
size_t getItemCount (void) const
 Return number of items attached to the list box. More...
 
ListboxItemgetSelectedItem (void) const
 Return a pointer to the currently selected item. More...
 
ListboxItemgetListboxItemFromIndex (size_t index) const
 Return the item at index position index. More...
 
size_t getItemIndex (const ListboxItem *item) const
 Return the index of ListboxItem item. More...
 
bool isSortEnabled (void) const
 return whether list sorting is enabled More...
 
bool isItemSelected (size_t index) const
 return whether the string at index position index is selected More...
 
ListboxItemfindItemWithText (const String &text, const ListboxItem *start_item)
 Search the list for an item with the specified text. More...
 
bool isListboxItemInList (const ListboxItem *item) const
 Return whether the specified ListboxItem is in the List. More...
 
bool isVertScrollbarAlwaysShown (void) const
 Return whether the vertical scroll bar is always shown. More...
 
bool isHorzScrollbarAlwaysShown (void) const
 Return whether the horizontal scroll bar is always shown. More...
 
virtual void initialiseComponents (void)
 Initialise the Window based object ready for use. More...
 
void showDropList (void)
 Show the drop-down list. More...
 
void hideDropList (void)
 Hide the drop-down list. More...
 
void setSingleClickEnabled (bool setting)
 Set the mode of operation for the combo box. More...
 
void selectListItemWithEditboxText ()
 Select item in list matching editbox text, clear selection if none match.
 
void setAutoSizeListHeightToContent (bool auto_size)
 Sets whether the Combobox drop-down list will automatically resize it's height according to the total height of items added to the list.
 
void setAutoSizeListWidthToContent (bool auto_size)
 Sets whether the Combobox drop-down list will automatically resize it's width according to the width of the items added to the list.
 
void updateAutoSizedDropList ()
 update drop list size according to auto-size options.
 
void setReadOnly (bool setting)
 Specify whether the Editbox is read-only. More...
 
void setValidationString (const String &validation_string)
 Set the text validation string. More...
 
void setCaretIndex (size_t caret_pos)
 Set the current position of the caret. More...
 
void setSelection (size_t start_pos, size_t end_pos)
 Define the current selection for the Editbox. More...
 
void setSelectionStart (size_t start_pos)
 Define the current selection start for the Editbox. More...
 
void setSelectionLength (size_t length)
 Define the current selection for the Editbox. More...
 
void setMaxTextLength (size_t max_len)
 set the maximum text length for this Editbox. More...
 
void activateEditbox (void)
 Activate the edit box component of the Combobox. More...
 
void resetList (void)
 Remove all items from the list. More...
 
void addItem (ListboxItem *item)
 Add the given ListboxItem to the list. More...
 
void insertItem (ListboxItem *item, const ListboxItem *position)
 Insert an item into the list box after a specified item already in the list. More...
 
void removeItem (const ListboxItem *item)
 Removes the given item from the list box. More...
 
void clearAllSelections (void)
 Clear the selected state for all items. More...
 
void setSortingEnabled (bool setting)
 Set whether the list should be sorted. More...
 
void setShowVertScrollbar (bool setting)
 Set whether the vertical scroll bar should always be shown. More...
 
void setShowHorzScrollbar (bool setting)
 Set whether the horizontal scroll bar should always be shown. More...
 
void setItemSelectState (ListboxItem *item, bool state)
 Set the select state of an attached ListboxItem. More...
 
void setItemSelectState (size_t item_index, bool state)
 Set the select state of an attached ListboxItem. More...
 
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. More...
 
 Combobox (const String &type, const String &name)
 Constructor for Combobox base class.
 
virtual ~Combobox (void)
 Destructor for Combobox base class.
 
- Public Member Functions inherited from CEGUI::Window
 Window (const String &type, const String &name)
 Constructor for Window base class. More...
 
virtual ~Window (void)
 Destructor for Window base class.
 
const StringgetType (void) const
 return a String object holding the type name for this Window. More...
 
bool isDestroyedByParent (void) const
 returns whether or not this Window is set to be destroyed when its parent window is destroyed. More...
 
bool isAlwaysOnTop (void) const
 returns whether or not this Window is an always on top Window. Also known as a top-most window. More...
 
bool isDisabled () const
 return whether the Window is currently disabled More...
 
bool isEffectiveDisabled () const
 return whether the Window is currently disabled More...
 
bool isVisible () const
 return true if the Window is currently visible. More...
 
bool isEffectiveVisible () const
 return true if the Window is currently visible. More...
 
bool isActive (void) const
 return true if this is the active Window. An active window is a window that may receive user inputs. More...
 
bool isClippedByParent (void) const
 return true if this Window is clipped so that its rendering will not pass outside of its parent Window area. More...
 
uint getID (void) const
 return the ID code currently assigned to this Window by client code. More...
 
bool isChild (uint ID) const
 returns whether at least one window with the given ID code is attached to this Window as a child. More...
 
bool isChildRecursive (uint ID) const
 returns whether at least one window with the given ID code is attached to this Window or any of it's children as a child. More...
 
WindowgetChildAtIdx (size_t idx) const
 returns a pointer to the child window at the specified index. Idx is the index of the window in the child window list. It is based on the order in which the children were added and is stable. More...
 
WindowgetChild (const String &name_path) const
 return the attached child window that the given name path references. More...
 
WindowgetChildRecursive (const String &name) const
 return a pointer to the first attached child window with the specified name. Children are traversed recursively. More...
 
WindowgetChild (uint ID) const
 return a pointer to the first attached child window with the specified ID value. More...
 
WindowgetChildRecursive (uint ID) const
 return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. More...
 
WindowgetActiveChild (void)
 return a pointer to the Window that currently has input focus starting with this Window. More...
 
const WindowgetActiveChild (void) const
 
bool isAncestor (uint ID) const
 return true if any Window with the given ID is some ancestor of this Window. More...
 
const FontgetFont (bool useDefault=true) const
 return the active Font object for the Window. More...
 
const StringgetText (void) const
 return the current text for the Window More...
 
const StringgetTextVisual () const
 return text string with visual ordering of glyphs.
 
bool inheritsAlpha (void) const
 return true if the Window inherits alpha from its parent(s). More...
 
float getAlpha (void) const
 return the current alpha value set for this Window More...
 
float getEffectiveAlpha (void) const
 return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha. More...
 
const RectfgetOuterRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window. More...
 
const RectfgetInnerRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window. More...
 
const RectfgetClipRect (const bool non_client=false) const
 Return a Rect that describes the rendering clipping rect for the Window. More...
 
const RectfgetHitTestRect () const
 Return the Rect that descibes the clipped screen area that is used for determining whether this window has been hit by a certain point. More...
 
WindowgetCaptureWindow () const
 return the Window that currently has inputs captured. More...
 
bool isCapturedByThis (void) const
 return true if this Window has input captured. More...
 
bool isCapturedByAncestor (void) const
 return true if an ancestor window has captured inputs. More...
 
bool isCapturedByChild (void) const
 return true if a child window has captured inputs. More...
 
WindowgetChildAtPosition (const Vector2f &position) const
 return the child Window that is hit by the given pixel position More...
 
WindowgetTargetChildAtPosition (const Vector2f &position, const bool allow_disabled=false) const
 return the child Window that is 'hit' by the given position, and is allowed to handle mouse events. More...
 
WindowgetParent () const
 return the parent of this Window. More...
 
const ImagegetMouseCursor (bool useDefault=true) const
 Return a pointer to the mouse cursor image to use when the mouse cursor is within this window's area. More...
 
void * getUserData (void) const
 Return the user data set for this Window. More...
 
bool restoresOldCapture (void) const
 Return whether this window is set to restore old input capture when it loses input capture. More...
 
bool isZOrderingEnabled (void) const
 Return whether z-order changes are enabled or disabled for this Window. More...
 
bool wantsMultiClickEvents (void) const
 Return whether this window will receive multi-click events or multiple 'down' events instead. More...
 
bool isMouseAutoRepeatEnabled (void) const
 Return whether mouse button down event autorepeat is enabled for this window. More...
 
float getAutoRepeatDelay (void) const
 Return the current auto-repeat delay setting for this window. More...
 
float getAutoRepeatRate (void) const
 Return the current auto-repeat rate setting for this window. More...
 
bool distributesCapturedInputs (void) const
 Return whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...
 
bool isUsingDefaultTooltip (void) const
 Return whether this Window is using the system default Tooltip for its Tooltip window. More...
 
TooltipgetTooltip (void) const
 Return a pointer to the Tooltip object used by this Window. The value returned may point to the system default Tooltip, a custom Window specific Tooltip, or be NULL. More...
 
String getTooltipType (void) const
 Return the custom tooltip type. More...
 
const StringgetTooltipText (void) const
 Return the current tooltip text set for this Window. More...
 
bool inheritsTooltipText (void) const
 Return whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...
 
bool isRiseOnClickEnabled (void) const
 Return whether this window will rise to the top of the z-order when clicked with the left mouse button. More...
 
GeometryBuffergetGeometryBuffer ()
 Return the GeometryBuffer object for this Window. More...
 
const StringgetLookNFeel () const
 Get the name of the LookNFeel assigned to this window. More...
 
bool getModalState (void) const
 Get whether or not this Window is the modal target. More...
 
const StringgetUserString (const String &name) const
 Returns a named user string. More...
 
bool isUserStringDefined (const String &name) const
 Return whether a user string with the specified name exists. More...
 
WindowgetActiveSibling ()
 Returns the active sibling window. More...
 
bool isMousePassThroughEnabled (void) const
 Returns whether this window should ignore mouse event and pass them through to and other windows behind it. In effect making the window transparent to the mouse. More...
 
bool isAutoWindow (void) const
 Returns whether this window is an auto window. More...
 
bool isWritingXMLAllowed (void) const
 Returns whether this window is allowed to write XML.
 
bool isDragDropTarget () const
 Returns whether this Window object will receive events generated by the drag and drop support in the system. More...
 
void getRenderingContext (RenderingContext &ctx) const
 Fill in the RenderingContext ctx with details of the RenderingSurface where this Window object should normally do it's rendering.
 
virtual void getRenderingContext_impl (RenderingContext &ctx) const
 implementation of the default getRenderingContext logic.
 
RenderingSurfacegetRenderingSurface () const
 return the RenderingSurface currently set for this window. May return 0.
 
RenderingSurfacegetTargetRenderingSurface () const
 return the RenderingSurface that will be used by this window as the target for rendering.
 
bool isUsingAutoRenderingSurface () const
 Returns whether automatic use of an imagery caching RenderingSurface (i.e. a RenderingWindow) is enabled for this window. The reason we emphasise 'automatic' is because the client may manually set a RenderingSurface that does exactly the same job. More...
 
const WindowgetRootWindow () const
 Returns the window at the root of the hierarchy starting at this Window. The root window is defined as the first window back up the hierarchy that has no parent window. More...
 
WindowgetRootWindow ()
 
void setDestroyedByParent (bool setting)
 Set whether or not this Window will automatically be destroyed when its parent Window is destroyed. More...
 
void setAlwaysOnTop (bool setting)
 Set whether this window is always on top, or not. More...
 
void setEnabled (bool setting)
 Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering. More...
 
void setDisabled (bool setting)
 Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering. More...
 
void enable (void)
 enable the Window to allow interaction. More...
 
void disable (void)
 disable the Window to prevent interaction. More...
 
void setVisible (bool setting)
 Set whether the Window is visible or hidden. More...
 
void show (void)
 show the Window. More...
 
void hide (void)
 hide the Window. More...
 
void activate (void)
 Activate the Window giving it input focus and bringing it to the top of all windows with the same always-on-top settig as this Window. More...
 
void deactivate (void)
 Deactivate the window. No further inputs will be received by the window until it is re-activated either programmatically or by the user interacting with the gui. More...
 
void setClippedByParent (bool setting)
 Set whether this Window will be clipped by its parent window(s). More...
 
void setID (uint ID)
 Set the current ID for the Window. More...
 
void setText (const String &text)
 Set the current text string for the Window. More...
 
void insertText (const String &text, const String::size_type position)
 Insert the text string text into the current text string for the Window object at the position specified by position. More...
 
void appendText (const String &text)
 Append the string text to the currect text string for the Window object. More...
 
void setFont (const Font *font)
 Set the font used by this Window. More...
 
void setFont (const String &name)
 Set the font used by this Window. More...
 
void removeChild (uint ID)
 Remove the first child Window with the specified ID. If there is more than one attached Window objects with the specified ID, only the fist one encountered will be removed. More...
 
WindowcreateChild (const String &type, const String &name="")
 Creates a child window attached to this window. More...
 
void destroyChild (Window *wnd)
 Destroys a child window of this window. More...
 
void destroyChild (const String &name_path)
 Destroys a child window of this window. More...
 
void moveToFront ()
 Move the Window to the top of the z order. More...
 
void moveToBack ()
 Move the Window to the bottom of the Z order. More...
 
void moveInFront (const Window *const window)
 Move this window immediately above it's sibling window in the z order. More...
 
void moveBehind (const Window *const window)
 Move this window immediately behind it's sibling window in the z order. More...
 
size_t getZIndex () const
 Return the (visual) z index of the window on it's parent. More...
 
bool isInFront (const Window &wnd) const
 Return whether /a this Window is in front of the given window. More...
 
bool isBehind (const Window &wnd) const
 Return whether /a this Window is behind the given window. More...
 
bool captureInput (void)
 Captures input to this window. More...
 
void releaseInput (void)
 Releases input capture from this Window. If this Window does not have inputs captured, nothing happens. More...
 
void setRestoreOldCapture (bool setting)
 Set whether this window will remember and restore the previous window that had inputs captured. More...
 
void setAlpha (const float alpha)
 Set the current alpha value for this window. More...
 
void setInheritsAlpha (bool setting)
 Sets whether this Window will inherit alpha from its parent windows. More...
 
void invalidate (void)
 Invalidate this window causing at least this window to be redrawn during the next rendering pass. More...
 
void invalidate (const bool recursive)
 Invalidate this window and - dependant upon recursive - all child content, causing affected windows to be redrawn during the next rendering pass. More...
 
void setMouseCursor (const Image *image)
 Set the mouse cursor image to be used when the mouse enters this window. More...
 
void setMouseCursor (const String &name)
 Set the mouse cursor image to be used when the mouse enters this window. More...
 
void setUserData (void *user_data)
 Set the user data set for this Window. More...
 
void setZOrderingEnabled (bool setting)
 Set whether z-order changes are enabled or disabled for this Window. More...
 
void setWantsMultiClickEvents (bool setting)
 Set whether this window will receive multi-click events or multiple 'down' events instead. More...
 
void setMouseAutoRepeatEnabled (bool setting)
 Set whether mouse button down event autorepeat is enabled for this window. More...
 
void setAutoRepeatDelay (float delay)
 Set the current auto-repeat delay setting for this window. More...
 
void setAutoRepeatRate (float rate)
 Set the current auto-repeat rate setting for this window. More...
 
void setDistributesCapturedInputs (bool setting)
 Set whether the window wants inputs passed to its attached child windows when the window has inputs captured. More...
 
void notifyDragDropItemEnters (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
void notifyDragDropItemLeaves (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
void notifyDragDropItemDropped (DragContainer *item)
 Internal support method for drag & drop. You do not normally call this directly from client code. See the DragContainer class.
 
virtual void destroy (void)
 Internal destroy method which actually just adds the window and any parent destructed child windows to the dead pool. More...
 
void setTooltip (Tooltip *tooltip)
 Set the custom Tooltip object for this Window. This value may be 0 to indicate that the Window should use the system default Tooltip object. More...
 
void setTooltipType (const String &tooltipType)
 Set the custom Tooltip to be used by this Window by specifying a Window type. More...
 
void setTooltipText (const String &tip)
 Set the tooltip text for this window. More...
 
void setInheritsTooltipText (bool setting)
 Set whether this window inherits Tooltip text from its parent when its own tooltip text is not set. More...
 
void setRiseOnClickEnabled (bool setting)
 Set whether this window will rise to the top of the z-order when clicked with the left mouse button. More...
 
virtual void setLookNFeel (const String &look)
 Set the LookNFeel that shoule be used for this window. More...
 
void setModalState (bool state)
 Set the modal state for this Window. More...
 
virtual void performChildWindowLayout (bool nonclient_sized_hint=false, bool client_sized_hint=false)
 Layout child window content. More...
 
void setUserString (const String &name, const String &value)
 Sets the value a named user string, creating it as required. More...
 
void render ()
 Causes the Window object to render itself and all of it's attached children. More...
 
virtual void update (float elapsed)
 Cause window to update itself and any attached children. Client code does not need to call this method; to ensure full, and proper updates, call the injectTimePulse methodname method provided by the System class. More...
 
virtual bool performCopy (Clipboard &clipboard)
 Asks the widget to perform a clipboard copy to the provided clipboard. More...
 
virtual bool performCut (Clipboard &clipboard)
 Asks the widget to perform a clipboard cut to the provided clipboard. More...
 
virtual bool performPaste (Clipboard &clipboard)
 Asks the widget to perform a clipboard paste from the provided clipboard. More...
 
virtual void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this window object to out_stream. More...
 
virtual void beginInitialisation (void)
 Sets the internal 'initialising' flag to true. This can be use to optimize initialisation of some widgets, and is called automatically by the layout XML handler when it has created a window. That is just after the window has been created, but before any children or properties are read.
 
virtual void endInitialisation (void)
 Sets the internal 'initialising' flag to false. This is called automatically by the layout XML handler when it is done creating a window. That is after all properties and children have been loaded and just before the next sibling gets created.
 
void setMousePassThroughEnabled (bool setting)
 Sets whether this window should ignore mouse events and pass them through to any windows behind it. In effect making the window transparent to the mouse. More...
 
void setWindowRenderer (const String &name)
 Assign the WindowRenderer type to be used when rendering this window. More...
 
WindowRenderergetWindowRenderer (void) const
 Get the currently assigned WindowRenderer. (Look'N'Feel specification). More...
 
const StringgetWindowRendererName () const
 Get the factory name of the currently assigned WindowRenderer. (Look'N'Feel specification). More...
 
void setWritingXMLAllowed (bool allow)
 Sets whether this window is allowed to write XML.
 
virtual void notifyScreenAreaChanged (bool recursive=true)
 Inform the window, and optionally all children, that screen area rectangles have changed. More...
 
void setFalagardType (const String &type, const String &rendererType="")
 Changes the widget's falagard type, thus changing its look'n'feel and optionally its renderer in the process. More...
 
void setDragDropTarget (bool setting)
 Specifies whether this Window object will receive events generated by the drag and drop support in the system. More...
 
void setRenderingSurface (RenderingSurface *surface)
 Set the RenderingSurface to be associated with this Window, or 0 if none is required. More...
 
void invalidateRenderingSurface ()
 Invalidate the chain of rendering surfaces from this window backwards to ensure they get properly redrawn - but doing the minimum amount of work possibe - next render.
 
void setUsingAutoRenderingSurface (bool setting)
 Sets whether automatic use of an imagery caching RenderingSurface (i.e. a RenderingWindow) is enabled for this window. The reason we emphasise 'atutomatic' is because the client may manually set a RenderingSurface that does exactlythe same job. More...
 
const RenderedStringgetRenderedString () const
 Return the parsed RenderedString object for this window.
 
RenderedStringParsergetCustomRenderedStringParser () const
 Return a pointer to any custom RenderedStringParser set, or 0 if none.
 
void setCustomRenderedStringParser (RenderedStringParser *parser)
 Set a custom RenderedStringParser, or 0 to remove an existing one.
 
virtual RenderedStringParsergetRenderedStringParser () const
 return the active RenderedStringParser to be used
 
bool isTextParsingEnabled () const
 return whether text parsing is enabled for this window.
 
void setTextParsingEnabled (const bool setting)
 set whether text parsing is enabled for this window.
 
virtual void setMargin (const UBox &margin)
 set margin
 
const UBoxgetMargin () const
 retrieves currently set margin
 
Vector2f getUnprojectedPosition (const Vector2f &pos) const
 return Vector2 pos after being fully unprojected for this Window.
 
const BidiVisualMappinggetBidiVisualMapping () const
 return the pointer to the BidiVisualMapping for this window, if any.
 
void banPropertyFromXML (const String &property_name)
 Add the named property to the XML ban list for this window. More...
 
void unbanPropertyFromXML (const String &property_name)
 Remove the named property from the XML ban list for this window.
 
bool isPropertyBannedFromXML (const String &property_name) const
 Return whether the named property is banned from XML. More...
 
void banPropertyFromXML (const Property *property)
 Add the given property to the XML ban list for this window.
 
void unbanPropertyFromXML (const Property *property)
 Remove the given property from the XML ban list for this window.
 
bool isPropertyBannedFromXML (const Property *property) const
 Return whether given property is banned from XML. More...
 
void setUpdateMode (const WindowUpdateMode mode)
 Set the window update mode. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...
 
WindowUpdateMode getUpdateMode () const
 Return the current window update mode that is set for this Window. This mode controls the behaviour of the Window::update member function such that updates are processed for this window (and therefore it's child content) according to the set mode. More...
 
void setMouseInputPropagationEnabled (const bool enabled)
 Set whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...
 
bool isMouseInputPropagationEnabled () const
 Return whether mouse input that is not directly handled by this Window (including it's event subscribers) should be propagated back to the Window's parent. More...
 
Windowclone (const bool deepCopy=true) const
 Clones this Window and returns the result. More...
 
virtual void clonePropertiesTo (Window &target) const
 copies this widget's properties to given target widget
 
virtual void cloneChildWidgetsTo (Window &target) const
 copies this widget's child widgets to given target widget
 
GUIContextgetGUIContext () const
 return the GUIContext this window is associated with.
 
void setGUIContext (GUIContext *context)
 function used internally. Do not call this from client code.
 
void syncTargetSurface ()
 ensure that the window will be rendered to the correct target surface.
 
void setAutoWindow (bool is_auto)
 Set whether this window is marked as an auto window. More...
 
bool isMouseContainedInArea () const
 Return whether Window thinks mouse is currently within its area. More...
 
const SizefgetRootContainerSize () const
 Return the size of the root container (such as screen size). More...
 
- Public Member Functions inherited from CEGUI::NamedElement
 NamedElement (const String &name="")
 Constructor. More...
 
virtual ~NamedElement ()
 Destructor.
 
virtual void setName (const String &name)
 Renames the element. More...
 
const StringgetName () const
 Return a String object holding the name of this Element.
 
String getNamePath () const
 Return a String object that describes the name path for this Element.
 
bool isChild (const String &name_path) const
 Checks whether given name path references a NamedElement that is attached to this Element. More...
 
bool isChildRecursive (const String &name) const
 returns whether at least one window with the given name is attached to this Window or any of it's children as a child. More...
 
bool isAncestor (const String &name) const
 Return true if the specified element name is a name of some ancestor of this Element. More...
 
NamedElementgetChildElement (const String &name_path) const
 Return the attached child element that the given name path references. More...
 
NamedElementgetChildElementRecursive (const String &name) const
 Find the first child with the given name, recursively and breadth-first. More...
 
void removeChild (const String &name_path)
 Remove the Element referenced by the given name path from this Element's child list. More...
 
- Public Member Functions inherited from CEGUI::Element
 Element ()
 Constructor.
 
virtual ~Element ()
 Destructor.
 
ElementgetParentElement () const
 Retrieves parent of this element. More...
 
virtual void setArea (const UVector2 &pos, const USize &size)
 Set the Element area. More...
 
void setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)
 
void setArea (const URect &area)
 
const URectgetArea () const
 Return the element's area. More...
 
void setPosition (const UVector2 &pos)
 Set the element's position. More...
 
void setXPosition (const UDim &pos)
 
void setYPosition (const UDim &pos)
 
const UVector2getPosition () const
 Get the element's position. More...
 
const UDimgetXPosition () const
 
const UDimgetYPosition () const
 
virtual void setHorizontalAlignment (const HorizontalAlignment alignment)
 Set the horizontal alignment. More...
 
HorizontalAlignment getHorizontalAlignment () const
 Get the horizontal alignment. More...
 
virtual void setVerticalAlignment (const VerticalAlignment alignment)
 Set the vertical alignment. More...
 
VerticalAlignment getVerticalAlignment () const
 Get the vertical alignment. More...
 
void setSize (const USize &size)
 Set the element's size. More...
 
void setWidth (const UDim &width)
 
void setHeight (const UDim &height)
 
USize getSize () const
 Get the element's size. More...
 
UDim getWidth () const
 
UDim getHeight () const
 
void setMinSize (const USize &size)
 Set the element's minimum size. More...
 
const USizegetMinSize () const
 Get the element's minimum size. More...
 
void setMaxSize (const USize &size)
 Set the element's maximum size. More...
 
const USizegetMaxSize () const
 Get the element's maximum size. More...
 
void setAspectMode (const AspectMode mode)
 Sets current aspect mode and recalculates the area rect. More...
 
AspectMode getAspectMode () const
 Retrieves currently used aspect mode. More...
 
void setAspectRatio (const float ratio)
 Sets target aspect ratio. More...
 
float getAspectRatio () const
 Retrieves target aspect ratio. More...
 
void setPixelAligned (const bool setting)
 Sets whether this Element is pixel aligned (both position and size, basically the 4 "corners"). More...
 
bool isPixelAligned () const
 Checks whether this Element is pixel aligned. More...
 
const Vector2fgetPixelPosition () const
 Return the element's absolute (or screen, depending on the type of the element) position in pixels. More...
 
const SizefgetPixelSize () const
 Return the element's size in pixels. More...
 
Sizef calculatePixelSize (bool skipAllPixelAlignment=false) const
 Calculates this element's pixel size. More...
 
Sizef getParentPixelSize (bool skipAllPixelAlignment=false) const
 Return the pixel size of the parent element. More...
 
void setRotation (const Quaternion &rotation)
 sets rotation of this widget More...
 
const QuaterniongetRotation () const
 retrieves rotation of this widget More...
 
void addChild (Element *element)
 Add the specified Element as a child of this Element. More...
 
void removeChild (Element *element)
 Remove the Element Element's child list. More...
 
ElementgetChildElementAtIdx (size_t idx) const
 return a pointer to the child element that is attached to 'this' at the given index. More...
 
size_t getChildCount () const
 Returns number of child elements attached to this Element.
 
bool isChild (const Element *element) const
 Checks whether given element is attached to this Element.
 
bool isAncestor (const Element *element) const
 Checks whether the specified Element is an ancestor of this Element. More...
 
void setNonClient (const bool setting)
 Set whether the Element is non-client. More...
 
bool isNonClient () const
 Checks whether this element was set to be non client. More...
 
const CachedRectfgetUnclippedOuterRect () const
 Return a Rect that describes the unclipped outer rect area of the Element. More...
 
const CachedRectfgetUnclippedInnerRect () const
 Return a Rect that describes the unclipped inner rect area of the Element. More...
 
const CachedRectfgetUnclippedRect (const bool inner) const
 Return a Rect that describes the unclipped area covered by the Element. More...
 
virtual const CachedRectfgetClientChildContentArea () const
 Return a Rect that is used by client child elements as content area. More...
 
virtual const CachedRectfgetNonClientChildContentArea () const
 Return a Rect that is used by client child elements as content area. More...
 
const CachedRectfgetChildContentArea (const bool non_client=false) const
 Return a Rect that is used to position and size child elements. More...
 
- Public Member Functions inherited from CEGUI::PropertySet
 PropertySet (void)
 Constructs a new PropertySet object.
 
virtual ~PropertySet (void)
 Destructor for PropertySet objects.
 
void addProperty (Property *property)
 Adds a new Property to the PropertySet. More...
 
void removeProperty (const String &name)
 Removes a Property from the PropertySet. More...
 
PropertygetPropertyInstance (const String &name) const
 Retrieves a property instance (that was previously added) More...
 
void clearProperties (void)
 Removes all Property objects from the PropertySet. More...
 
bool isPropertyPresent (const String &name) const
 Checks to see if a Property with the given name is in the PropertySet. More...
 
const StringgetPropertyHelp (const String &name) const
 Return the help text for the specified Property. More...
 
String getProperty (const String &name) const
 Gets the current value of the specified Property. More...
 
template<typename T >
PropertyHelper< T >::return_type getProperty (const String &name) const
 Gets the current value of the specified Property. More...
 
void setProperty (const String &name, const String &value)
 Sets the current value of a Property. More...
 
template<typename T >
void setProperty (const String &name, typename PropertyHelper< T >::pass_type value)
 Sets the current value of a Property. More...
 
bool isPropertyDefault (const String &name) const
 Returns whether a Property is at it's default value. More...
 
String getPropertyDefault (const String &name) const
 Returns the default value of a Property as a String. More...
 
PropertyIterator getPropertyIterator (void) const
 Return a PropertySet::PropertyIterator object to iterate over the available Properties.
 
- Public Member Functions inherited from CEGUI::EventSet
 EventSet ()
 Constructor for EventSet objects.
 
virtual ~EventSet (void)
 Destructor for EventSet objects.
 
void addEvent (const String &name)
 Creates a new Event object with the given name and adds it to the EventSet. More...
 
void addEvent (Event &event)
 Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
 
void removeEvent (Event &event)
 Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in this EventSet. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
template<typename Arg1 , typename Arg2 >
Event::Connection subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
 Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
 Subscribes the specified group of the named Event to a scripted funtion. More...
 
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object. More...
 
bool isMuted (void) const
 Return whether the EventSet is muted or not. More...
 
void setMutedState (bool setting)
 Set the mute state for this EventSet. More...
 
EventgetEventObject (const String &name, bool autoAdd=false)
 Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
 
EventIterator getEventIterator (void) const
 Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.
 

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
 
static const String WidgetTypeName
 Window factory name.
 
static const String EventReadOnlyModeChanged
 
static const String EventValidationStringChanged
 
static const String EventMaximumTextLengthChanged
 
static const String EventTextValidityChanged
 
static const String EventCaretMoved
 
static const String EventTextSelectionChanged
 
static const String EventEditboxFull
 
static const String EventTextAccepted
 
static const String EventListContentsChanged
 
static const String EventListSelectionChanged
 
static const String EventSortModeChanged
 
static const String EventVertScrollbarModeChanged
 
static const String EventHorzScrollbarModeChanged
 
static const String EventDropListDisplayed
 
static const String EventDropListRemoved
 
static const String EventListSelectionAccepted
 
static const String EditboxName
 Widget name for the editbox component.
 
static const String DropListName
 Widget name for the drop list component.
 
static const String ButtonName
 Widget suffix for the button component.
 
- Static Public Attributes inherited from CEGUI::Window
static const String EventNamespace
 Namespace for global events.
 
static const String EventUpdated
 
static const String EventTextChanged
 
static const String EventFontChanged
 
static const String EventAlphaChanged
 
static const String EventIDChanged
 
static const String EventActivated
 
static const String EventDeactivated
 
static const String EventShown
 
static const String EventHidden
 
static const String EventEnabled
 
static const String EventDisabled
 
static const String EventClippedByParentChanged
 
static const String EventDestroyedByParentChanged
 
static const String EventInheritsAlphaChanged
 
static const String EventAlwaysOnTopChanged
 
static const String EventInputCaptureGained
 
static const String EventInputCaptureLost
 
static const String EventInvalidated
 
static const String EventRenderingStarted
 
static const String EventRenderingEnded
 
static const String EventDestructionStarted
 
static const String EventDragDropItemEnters
 
static const String EventDragDropItemLeaves
 
static const String EventDragDropItemDropped
 
static const String EventWindowRendererAttached
 
static const String EventWindowRendererDetached
 
static const String EventTextParsingChanged
 
static const String EventMarginChanged
 
static const String EventMouseEntersArea
 
static const String EventMouseLeavesArea
 
static const String EventMouseEntersSurface
 
static const String EventMouseLeavesSurface
 
static const String EventMouseMove
 
static const String EventMouseWheel
 
static const String EventMouseButtonDown
 
static const String EventMouseButtonUp
 
static const String EventMouseClick
 
static const String EventMouseDoubleClick
 
static const String EventMouseTripleClick
 
static const String EventKeyDown
 
static const String EventKeyUp
 
static const String EventCharacterKey
 
static const String TooltipNameSuffix
 Widget name suffix for automatically created tooltip widgets.
 
static const String WindowXMLElementName
 
static const String AutoWindowXMLElementName
 
static const String UserStringXMLElementName
 
static const String WindowTypeXMLAttributeName
 
static const String WindowNameXMLAttributeName
 
static const String AutoWindowNamePathXMLAttributeName
 
static const String UserStringNameXMLAttributeName
 
static const String UserStringValueXMLAttributeName
 
- Static Public Attributes inherited from CEGUI::NamedElement
static const String EventNamespace
 Namespace for global events.
 
static const String EventNameChanged
 
- Static Public Attributes inherited from CEGUI::Element
static const String EventNamespace
 Namespace for global events.
 
static const String EventSized
 
static const String EventParentSized
 
static const String EventMoved
 
static const String EventHorizontalAlignmentChanged
 
static const String EventVerticalAlignmentChanged
 
static const String EventRotated
 
static const String EventChildAdded
 
static const String EventChildRemoved
 
static const String EventZOrderChanged
 
static const String EventNonClientChanged
 

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.
 
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_TextValidityChangedHandler (const EventArgs &e)
 
bool editbox_CaretMovedHandler (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 onTextValidityChanged (RegexMatchStateEventArgs &e)
 Handler called when something has caused the validity state of the current text to change.
 
virtual void onCaretMoved (WindowEventArgs &e)
 Handler called internally when the caret 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. More...
 
virtual void onTextChanged (WindowEventArgs &e)
 Handler called when the window's text is changed. More...
 
virtual void onActivated (ActivationEventArgs &e)
 Handler called when this window has become the active window. More...
 
void onSized (ElementEventArgs &e)
 Handler called when the window's size changes. More...
 
- Protected Member Functions inherited from CEGUI::Window
virtual void onMoved (ElementEventArgs &e)
 Handler called when the window's position changes. More...
 
virtual void onRotated (ElementEventArgs &e)
 Handler called when the element's rotation is changed. More...
 
virtual void onAlphaChanged (WindowEventArgs &e)
 Handler called when the window's alpha blend value is changed. More...
 
virtual void onIDChanged (WindowEventArgs &e)
 Handler called when the window's client assigned ID is changed. More...
 
virtual void onShown (WindowEventArgs &e)
 Handler called when the window is shown (made visible). More...
 
virtual void onHidden (WindowEventArgs &e)
 Handler called when the window is hidden. More...
 
virtual void onEnabled (WindowEventArgs &e)
 Handler called when the window is enabled. More...
 
virtual void onDisabled (WindowEventArgs &e)
 Handler called when the window is disabled. More...
 
virtual void onClippingChanged (WindowEventArgs &e)
 Handler called when the window's setting for being clipped by it's parent is changed. More...
 
virtual void onParentDestroyChanged (WindowEventArgs &e)
 Handler called when the window's setting for being destroyed automatically be it's parent is changed. More...
 
virtual void onInheritsAlphaChanged (WindowEventArgs &e)
 Handler called when the window's setting for inheriting alpha-blending is changed. More...
 
virtual void onAlwaysOnTopChanged (WindowEventArgs &e)
 Handler called when the window's always-on-top setting is changed. More...
 
virtual void onCaptureGained (WindowEventArgs &e)
 Handler called when this window gains capture of mouse inputs. More...
 
virtual void onCaptureLost (WindowEventArgs &e)
 Handler called when this window loses capture of mouse inputs. More...
 
virtual void onInvalidated (WindowEventArgs &e)
 Handler called when this window gets invalidated. More...
 
virtual void onRenderingStarted (WindowEventArgs &e)
 Handler called when rendering for this window has started. More...
 
virtual void onRenderingEnded (WindowEventArgs &e)
 Handler called when rendering for this window has ended. More...
 
virtual void onZChanged (WindowEventArgs &e)
 Handler called when the z-order position of this window has changed. More...
 
virtual void onDestructionStarted (WindowEventArgs &e)
 Handler called when this window's destruction sequence has begun. More...
 
virtual void onDeactivated (ActivationEventArgs &e)
 Handler called when this window has lost input focus and has been deactivated. More...
 
virtual void onParentSized (ElementEventArgs &e)
 Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. More...
 
virtual void onChildAdded (ElementEventArgs &e)
 Handler called when a child window is added to this window. More...
 
virtual void onChildRemoved (ElementEventArgs &e)
 Handler called when a child window is removed from this window. More...
 
virtual void onMouseEntersArea (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area. More...
 
virtual void onMouseLeavesArea (MouseEventArgs &e)
 Handler called when the mouse cursor has left this window's area. More...
 
virtual void onMouseEnters (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area and is actually over some part of this windows surface and not, for instance over a child window - even though technically in those cases the mouse is also within this Window's area, the handler will not be called. More...
 
virtual void onMouseLeaves (MouseEventArgs &e)
 Handler called when the mouse cursor is no longer over this window's surface area. This will be called when the mouse is not over a part of this Window's actual surface - even though technically the mouse is still within the Window's area, for example if the mouse moves over a child window. More...
 
virtual void onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area. More...
 
virtual void onMouseWheel (MouseEventArgs &e)
 Handler called when the mouse wheel (z-axis) position changes within this window's area. More...
 
virtual void onMouseButtonDown (MouseEventArgs &e)
 Handler called when a mouse button has been depressed within this window's area. More...
 
virtual void onMouseButtonUp (MouseEventArgs &e)
 Handler called when a mouse button has been released within this window's area. More...
 
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. More...
 
virtual void onMouseDoubleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been double-clicked within this window's area. More...
 
virtual void onMouseTripleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been triple-clicked within this window's area. More...
 
virtual void onKeyDown (KeyEventArgs &e)
 Handler called when a key as been depressed while this window has input focus. More...
 
virtual void onKeyUp (KeyEventArgs &e)
 Handler called when a key as been released while this window has input focus. More...
 
virtual void onCharacter (KeyEventArgs &e)
 Handler called when a character-key has been pressed while this window has input focus. More...
 
virtual void onDragDropItemEnters (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onDragDropItemLeaves (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onDragDropItemDropped (DragDropEventArgs &e)
 Handler called when a DragContainer is dragged over this window. More...
 
virtual void onWindowRendererAttached (WindowEventArgs &e)
 Handler called when a new window renderer object is attached. More...
 
virtual void onWindowRendererDetached (WindowEventArgs &e)
 Handler called when the currently attached window renderer object is detached. More...
 
virtual void onTextParsingChanged (WindowEventArgs &e)
 Handler called when the window's setting for whether text parsing is enabled is changed. More...
 
virtual void onMarginChanged (WindowEventArgs &e)
 
virtual void updateSelf (float elapsed)
 Perform actual update processing for this Window. More...
 
virtual void drawSelf (const RenderingContext &ctx)
 Perform the actual rendering for this Window. More...
 
void bufferGeometry (const RenderingContext &ctx)
 Perform drawing operations concerned with generating and buffering window geometry. More...
 
void queueGeometry (const RenderingContext &ctx)
 Perform drawing operations concerned with positioning, clipping and queueing of window geometry to RenderingSurfaces. More...
 
virtual void populateGeometryBuffer ()
 Update the rendering cache. More...
 
virtual void setParent (Element *parent)
 Set the parent window for this window object. More...
 
void generateAutoRepeatEvent (MouseButton button)
 Fires off a repeated mouse button down event for this window.
 
virtual bool validateWindowRenderer (const WindowRenderer *renderer) const
 Function used in checking if a WindowRenderer is valid for this window. More...
 
bool isPropertyAtDefault (const Property *property) const
 Returns whether a property is at it's default value. This function is different from Property::isDefatult as it takes the assigned look'n'feel (if the is one) into account.
 
void notifyClippingChanged (void)
 Recursively inform all children that the clipping has changed and screen rects needs to be recached.
 
void allocateRenderingWindow ()
 helper to create and setup the auto RenderingWindow surface
 
void releaseRenderingWindow ()
 helper to clean up the auto RenderingWindow surface
 
void initialiseClippers (const RenderingContext &ctx)
 Helper to intialise the needed clipping for geometry and render surface.
 
virtual void setArea_impl (const UVector2 &pos, const USize &size, bool topLeftSizing=false, bool fireEvents=true)
 Implementation method to modify element area while correctly applying min / max size processing, and firing any appropriate events. More...
 
virtual void cleanupChildren (void)
 Cleanup child windows.
 
virtual void addChild_impl (Element *element)
 Add given element to child list at an appropriate position. More...
 
virtual void removeChild_impl (Element *element)
 Remove given element from child list. More...
 
virtual void onZChange_impl (void)
 Notify 'this' and all siblings of a ZOrder change event.
 
void addWindowProperties (void)
 Add standard CEGUI::Window properties.
 
virtual bool moveToFront_impl (bool wasClicked)
 Implements move to front behavior. More...
 
void addWindowToDrawList (Window &wnd, bool at_back=false)
 Add the given window to the drawing list at an appropriate position for it's settings and the required direction. Basically, when at_back is false, the window will appear in front of all other windows with the same 'always on top' setting. When at_back is true, the window will appear behind all other windows wih the same 'always on top' setting. More...
 
void removeWindowFromDrawList (const Window &wnd)
 Removes the window from the drawing list. If the window is not attached to the drawing list then nothing happens. More...
 
bool isTopOfZOrder () const
 Return whether the window is at the top of the Z-Order. This will correctly take into account 'Always on top' windows as needed. More...
 
void updateGeometryRenderSettings ()
 Update position and clip region on this Windows geometry / rendering surface.
 
void transferChildSurfaces ()
 transfer RenderingSurfaces to be owned by our target RenderingSurface.
 
Rectf getParentElementClipIntersection (const Rectf &unclipped_area) const
 helper function for calculating clipping rectangles.
 
void invalidate_impl (const bool recursive)
 helper function to invalidate window and optionally child windows.
 
const WindowgetWindowAttachedToCommonAncestor (const Window &wnd) const
 Helper function to return the ancestor Window of /a wnd that is attached as a child to a window that is also an ancestor of /a this. Returns 0 if /a wnd and /a this are not part of the same hierachy.
 
virtual Rectf getUnclippedInnerRect_impl (bool skipAllPixelAlignment) const
 Default implementation of function to return Element's inner rect area.
 
virtual Rectf getOuterRectClipper_impl () const
 Default implementation of function to return Window outer clipper area.
 
virtual Rectf getInnerRectClipper_impl () const
 Default implementation of function to return Window inner clipper area.
 
virtual Rectf getHitTestRect_impl () const
 Default implementation of function to return Window hit-test area.
 
virtual int writePropertiesXML (XMLSerializer &xml_stream) const
 
virtual int writeChildWindowsXML (XMLSerializer &xml_stream) const
 
virtual bool writeAutoChildWindowXML (XMLSerializer &xml_stream) const
 
virtual void banPropertiesForAutoWindow ()
 
virtual bool handleFontRenderSizeChange (const EventArgs &args)
 handler function for when font render size changes.
 
void markCachedWindowRectsInvalid ()
 
void layoutLookNFeelChildWidgets ()
 
WindowgetChildAtPosition (const Vector2f &position, bool(Window::*hittestfunc)(const Vector2f &, bool) const, bool allow_disabled=false) const
 
bool isHitTargetWindow (const Vector2f &position, bool allow_disabled) const
 
- Protected Member Functions inherited from CEGUI::NamedElement
virtual NamedElementgetChildByNamePath_impl (const String &name_path) const
 Retrieves a child at name_path or 0 if none such exists.
 
virtual NamedElementgetChildByNameRecursive_impl (const String &name) const
 Finds a child by name or 0 if none such exists.
 
void addNamedElementProperties ()
 Add standard CEGUI::NamedElement properties.
 
virtual void onNameChanged (NamedElementEventArgs &e)
 Handler called when the element's name changes. More...
 
- Protected Member Functions inherited from CEGUI::Element
void addElementProperties ()
 Add standard CEGUI::Element properties.
 
bool isInnerRectSizeChanged () const
 helper to return whether the inner rect size has changed
 
virtual Rectf getUnclippedOuterRect_impl (bool skipAllPixelAlignment) const
 Default implementation of function to return Element's outer rect area.
 
void fireAreaChangeEvents (const bool moved, const bool sized)
 helper to fire events based on changes to area rect
 
void notifyChildrenOfSizeChange (const bool non_client, const bool client)
 
virtual void onHorizontalAlignmentChanged (ElementEventArgs &e)
 Handler called when the horizontal alignment setting for the element is changed. More...
 
virtual void onVerticalAlignmentChanged (ElementEventArgs &e)
 Handler called when the vertical alignment setting for the element is changed. More...
 
virtual void onNonClientChanged (ElementEventArgs &e)
 Handler called when the element's non-client setting, affecting it's position and size relative to it's parent is changed. More...
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 

Protected Attributes

bool d_singleClickOperation
 true if user can show and select from list in a single click.
 
bool d_autoSizeHeight
 
bool d_autoSizeWidth
 
- Protected Attributes inherited from CEGUI::Window
const String d_type
 type of Window (also the name of the WindowFactory that created us)
 
String d_falagardType
 Type name of the window as defined in a Falagard mapping.
 
bool d_autoWindow
 true when this window is an auto-window
 
bool d_initialising
 true when this window is currently being initialised (creating children etc)
 
bool d_destructionStarted
 true when this window is being destroyed.
 
bool d_enabled
 true when Window is enabled
 
bool d_visible
 is window visible (i.e. it will be rendered, but may still be obscured)
 
bool d_active
 true when Window is the active Window (receiving inputs).
 
ChildDrawList d_drawList
 Child window objects arranged in rendering order.
 
bool d_destroyedByParent
 true when Window will be auto-destroyed by parent.
 
bool d_clippedByParent
 true when Window will be clipped by parent Window area Rect.
 
String d_lookName
 Name of the Look assigned to this window (if any).
 
WindowRendererd_windowRenderer
 The WindowRenderer module that implements the Look'N'Feel specification.
 
GeometryBufferd_geometry
 Object which acts as a cache of geometry drawn by this Window.
 
RenderingSurfaced_surface
 RenderingSurface owned by this window (may be 0)
 
bool d_needsRedraw
 true if window geometry cache needs to be regenerated.
 
bool d_autoRenderingWindow
 holds setting for automatic creation of of surface (RenderingWindow)
 
const Imaged_mouseCursor
 Holds pointer to the Window objects current mouse cursor image.
 
float d_alpha
 Alpha transparency setting for the Window.
 
bool d_inheritsAlpha
 true if the Window inherits alpha from the parent Window
 
Windowd_oldCapture
 The Window that previously had capture (used for restoreOldCapture mode)
 
bool d_restoreOldCapture
 Restore capture to the previous capture window when releasing capture.
 
bool d_distCapturedInputs
 Whether to distribute captured inputs to child windows.
 
const Fontd_font
 Holds pointer to the Window objects current Font.
 
String d_textLogical
 Holds the text / label / caption for this Window.
 
BidiVisualMappingd_bidiVisualMapping
 pointer to bidirection support object
 
bool d_bidiDataValid
 whether bidi visual mapping has been updated since last text change.
 
RenderedString d_renderedString
 RenderedString representation of text string as ouput from a parser.
 
bool d_renderedStringValid
 true if d_renderedString is valid, false if needs re-parse.
 
RenderedStringParserd_customStringParser
 Pointer to a custom (user assigned) RenderedStringParser object.
 
bool d_textParsingEnabled
 true if use of parser other than d_defaultStringParser is enabled
 
UBox d_margin
 Margin, only used when the Window is inside LayoutContainer class.
 
uint d_ID
 User ID assigned to this Window.
 
void * d_userData
 Holds pointer to some user assigned data.
 
UserStringMap d_userStrings
 Holds a collection of named user string values.
 
bool d_alwaysOnTop
 true if Window will be drawn on top of all other Windows
 
bool d_riseOnClick
 whether window should rise in the z order when left clicked.
 
bool d_zOrderingEnabled
 true if the Window responds to z-order change requests.
 
bool d_wantsMultiClicks
 true if the Window wishes to hear about multi-click mouse events.
 
bool d_mousePassThroughEnabled
 whether (most) mouse events pass through this window
 
bool d_autoRepeat
 whether pressed mouse button will auto-repeat the down event.
 
float d_repeatDelay
 seconds before first repeat event is fired
 
float d_repeatRate
 seconds between further repeats after delay has expired.
 
MouseButton d_repeatButton
 button we're tracking for auto-repeat purposes.
 
bool d_repeating
 implements repeating - is true after delay has elapsed,
 
float d_repeatElapsed
 implements repeating - tracks time elapsed.
 
bool d_dragDropTarget
 true if window will receive drag and drop related notifications
 
String d_tooltipText
 Text string used as tip for this window.
 
Tooltipd_customTip
 Possible custom Tooltip for this window.
 
bool d_weOwnTip
 true if this Window created the custom Tooltip.
 
bool d_inheritsTipText
 whether tooltip text may be inherited from parent.
 
bool d_allowWriteXML
 true if this window is allowed to write XML, false if not
 
BannedXMLPropertySet d_bannedXMLProperties
 collection of properties not to be written to XML for this window.
 
Rectf d_outerRectClipper
 outer area clipping rect in screen pixels
 
Rectf d_innerRectClipper
 inner area clipping rect in screen pixels
 
Rectf d_hitTestRect
 area rect used for hit-testing against this window
 
bool d_outerRectClipperValid
 
bool d_innerRectClipperValid
 
bool d_hitTestRectValid
 
WindowUpdateMode d_updateMode
 The mode to use for calling Window::update.
 
bool d_propagateMouseInputs
 specifies whether mouse inputs should be propagated to parent(s)
 
GUIContextd_guiContext
 GUIContext. Set when this window is used as a root window.
 
bool d_containsMouse
 true when mouse is contained within this Window's area.
 
- Protected Attributes inherited from CEGUI::NamedElement
String d_name
 The name of the element, unique in the parent of this element.
 
- Protected Attributes inherited from CEGUI::Element
ChildList d_children
 The list of child element objects attached to this.
 
Elementd_parent
 Holds pointer to the parent element.
 
bool d_nonClient
 true if element is in non-client (outside InnerRect) area of parent.
 
URect d_area
 This element objects area as defined by a URect.
 
HorizontalAlignment d_horizontalAlignment
 Specifies the base for horizontal alignment.
 
VerticalAlignment d_verticalAlignment
 Specifies the base for vertical alignment.
 
USize d_minSize
 current minimum size for the element.
 
USize d_maxSize
 current maximum size for the element.
 
AspectMode d_aspectMode
 How to satisfy current aspect ratio.
 
float d_aspectRatio
 The target aspect ratio.
 
bool d_pixelAligned
 If true, the position and size are pixel aligned.
 
Sizef d_pixelSize
 Current constrained pixel size of the element.
 
Quaternion d_rotation
 Rotation of this element (relative to the parent)
 
CachedRectf d_unclippedOuterRect
 outer area rect in screen pixels
 
CachedRectf d_unclippedInnerRect
 inner area rect in screen pixels
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Additional Inherited Members

- Protected Types inherited from CEGUI::Window
typedef std::vector< Window
*CEGUI_VECTOR_ALLOC(Window *)> 
ChildDrawList
 definition of type used for the list of child windows to be drawn
 
typedef std::map< String,
String, StringFastLessCompare
CEGUI_MAP_ALLOC(String, String)> 
UserStringMap
 definition of type used for the UserString dictionary.
 
typedef std::set< String,
StringFastLessCompare
CEGUI_SET_ALLOC(String)> 
BannedXMLPropertySet
 definition of type used to track properties banned from writing XML.
 
- Static Protected Attributes inherited from CEGUI::Window
CEGUI::Window::WindowRendererProperty d_windowRendererProperty
 
CEGUI::Window::LookNFeelProperty d_lookNFeelProperty
 
static BasicRenderedStringParser d_basicStringParser
 Shared instance of a parser to be used in most instances.
 
static DefaultRenderedStringParser d_defaultStringParser
 Shared instance of a parser to be used when rendering text verbatim.
 

Detailed Description

Base class for the Combobox widget.

Member Function Documentation

void CEGUI::Combobox::activateEditbox ( void  )

Activate the edit box component of the Combobox.

Returns
Nothing.
void CEGUI::Combobox::addItem ( ListboxItem item)

Add the given ListboxItem to the list.

Parameters
itemPointer 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.
Returns
Nothing.
void CEGUI::Combobox::clearAllSelections ( void  )

Clear the selected state for all items.

Returns
Nothing.
ListboxItem* CEGUI::Combobox::findItemWithText ( const String text,
const ListboxItem start_item 
)

Search the list for an item with the specified text.

Parameters
textString object containing the text to be searched for.
start_itemListboxItem 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.
Returns
Pointer to the first ListboxItem in the list after item that has text matching text. If no item matches the criteria NULL is returned.
Exceptions
InvalidRequestExceptionthrown if item is not attached to this list box.
size_t CEGUI::Combobox::getCaretIndex ( void  ) const

return the current position of the caret.

Returns
Index of the insert caret relative to the start of the text.
ComboDropList* CEGUI::Combobox::getDropList ( ) const

Return a pointer to the ComboDropList component widget for this Combobox.

Returns
Pointer to an ComboDropList object.
Exceptions
UnknownObjectExceptionThrown if the ComboDropList component does not exist.
Editbox* CEGUI::Combobox::getEditbox ( ) const

Return a pointer to the Editbox component widget for this Combobox.

Returns
Pointer to an Editbox object.
Exceptions
UnknownObjectExceptionThrown if the Editbox component does not exist.
size_t CEGUI::Combobox::getItemCount ( void  ) const

Return number of items attached to the list box.

Returns
the number of items currently attached to this list box.
size_t CEGUI::Combobox::getItemIndex ( const ListboxItem item) const

Return the index of ListboxItem item.

Parameters
itemPointer to a ListboxItem whos zero based index is to be returned.
Returns
Zero based index indicating the position of ListboxItem item in the list box.
Exceptions
InvalidRequestExceptionthrown if item is not attached to this list box.
ListboxItem* CEGUI::Combobox::getListboxItemFromIndex ( size_t  index) const

Return the item at index position index.

Parameters
indexZero based index of the item to be returned.
Returns
Pointer to the ListboxItem at index position index in the list box.
Exceptions
InvalidRequestExceptionthrown if index is out of range.
size_t CEGUI::Combobox::getMaxTextLength ( void  ) const

return the maximum text length set for this Editbox.

Returns
The maximum number of code points (characters) that can be entered into this Editbox.
Note
Depending on the validation string set, the actual length of text that can be entered may be less than the value returned here (it will never be more).
PushButton* CEGUI::Combobox::getPushButton ( ) const

Return a pointer to the PushButton component widget for this Combobox.

Returns
Pointer to a PushButton object.
Exceptions
UnknownObjectExceptionThrown if the PushButton component does not exist.
ListboxItem* CEGUI::Combobox::getSelectedItem ( void  ) const

Return a pointer to the currently selected item.

Returns
Pointer to a ListboxItem based object that is the selected item in the list. will return NULL if no item is selected.
size_t CEGUI::Combobox::getSelectionEndIndex ( void  ) const

return the current selection end point.

Returns
Index of the selection end point relative to the start of the text. If no selection is defined this function returns the position of the caret.
size_t CEGUI::Combobox::getSelectionLength ( void  ) const

return the length of the current selection (in code points / characters).

Returns
Number of code points (or characters) contained within the currently defined selection.
size_t CEGUI::Combobox::getSelectionStartIndex ( void  ) const

return the current selection start point.

Returns
Index of the selection start point relative to the start of the text. If no selection is defined this function returns the position of the caret.
bool CEGUI::Combobox::getSingleClickEnabled ( void  ) const

returns the mode of operation for the combo box.

Returns
  • true if the user can show the list and select an item with a single mouse click.
  • false if the user must click to show the list and then click again to select an item.
MatchState CEGUI::Combobox::getTextMatchState ( ) const

return the validation MatchState for the current Combobox text, given the currently set validation string.

Note
Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.
Returns
One of the MatchState enumerated values indicating the current match state.
const String& CEGUI::Combobox::getValidationString ( void  ) const

return the currently set validation string

Note
Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.
Returns
String object containing the current validation regex data
void CEGUI::Combobox::handleUpdatedListItemData ( 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.
Returns
Nothing.
bool CEGUI::Combobox::hasInputFocus ( void  ) const

return true if the Editbox has input focus.

Returns
true if the Editbox has keyboard input focus, false if the Editbox does not have keyboard input focus.
void CEGUI::Combobox::hideDropList ( void  )

Hide the drop-down list.

Returns
Nothing.
virtual void CEGUI::Combobox::initialiseComponents ( void  )
virtual

Initialise the Window based object ready for use.

Note
This must be called for every window created. Normally this is handled automatically by the WindowFactory for each Window type.
Returns
Nothing

Reimplemented from CEGUI::Window.

void CEGUI::Combobox::insertItem ( ListboxItem item,
const ListboxItem position 
)

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.
Parameters
itemPointer 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.
positionPointer to a ListboxItem that item is to be inserted after. If this parameter is NULL, the item is inserted at the start of the list.
Returns
Nothing.
bool CEGUI::Combobox::isDropDownListVisible ( void  ) const

returns true if the drop down list is visible.

Returns
true if the drop down list is visible, false otherwise.
bool CEGUI::Combobox::isHit ( const Vector2f position,
const bool  allow_disabled = false 
) const
virtual

check if the given pixel position would hit this window.

Parameters
positionVector2 object describing the position to check. The position describes a pixel offset from the top-left corner of the display.
allow_disabled
  • true specifies that the window may be 'hit' if it is disabled.
  • false specifies that the window may only be hit if it is enabled.
Returns
  • true if position hits this Window.
  • false if position does not hit this window.

Reimplemented from CEGUI::Window.

bool CEGUI::Combobox::isHorzScrollbarAlwaysShown ( void  ) const

Return whether the horizontal scroll bar is always shown.

Returns
  • true if the scroll bar will always be shown even if it is not required.
  • false if the scroll bar will only be shown when it is required.
bool CEGUI::Combobox::isItemSelected ( size_t  index) const

return whether the string at index position index is selected

Parameters
indexZero based index of the item to be examined.
Returns
true if the item at index is selected, false if the item at index is not selected.
Exceptions
InvalidRequestExceptionthrown if index is out of range.
bool CEGUI::Combobox::isListboxItemInList ( const ListboxItem item) const

Return whether the specified ListboxItem is in the List.

Returns
true if ListboxItem item is in the list, false if ListboxItem item is not in the list.
bool CEGUI::Combobox::isReadOnly ( void  ) const

return true if the Editbox is read-only.

Returns
true if the Editbox is read only and can't be edited by the user, false if the Editbox is not read only and may be edited by the user.
bool CEGUI::Combobox::isSortEnabled ( void  ) const

return whether list sorting is enabled

Returns
true if the list is sorted, false if the list is not sorted
bool CEGUI::Combobox::isVertScrollbarAlwaysShown ( void  ) const

Return whether the vertical scroll bar is always shown.

Returns
  • true if the scroll bar will always be shown even if it is not required.
  • false if the scroll bar will only be shown when it is required.
virtual void CEGUI::Combobox::onActivated ( ActivationEventArgs e)
protectedvirtual

Handler called when this window has become the active window.

Parameters
eActivationEventArgs class whose 'otherWindow' field is set to the window that previously was active, or NULL for none.

Reimplemented from CEGUI::Window.

virtual void CEGUI::Combobox::onFontChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's font is changed.

Parameters
eWindowEventArgs 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.

void CEGUI::Combobox::onSized ( ElementEventArgs e)
protectedvirtual

Handler called when the window's size changes.

Parameters
eWindowEventArgs 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.

virtual void CEGUI::Combobox::onTextChanged ( WindowEventArgs e)
protectedvirtual

Handler called when the window's text is changed.

Parameters
eWindowEventArgs 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.

void CEGUI::Combobox::removeItem ( const ListboxItem item)

Removes the given item from the list box.

Parameters
itemPointer to the ListboxItem that is to be removed. If item is not attached to this list box then nothing will happen.
Returns
Nothing.
void CEGUI::Combobox::resetList ( void  )

Remove all items from the list.

Note that this will cause 'AutoDelete' items to be deleted.

void CEGUI::Combobox::setCaretIndex ( size_t  caret_pos)

Set the current position of the caret.

Parameters
caret_posNew index for the insert caret relative to the start of the text. If the value specified is greater than the number of characters in the Editbox, the caret is positioned at the end of the text.
Returns
Nothing.
void CEGUI::Combobox::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.
Parameters
itemThe ListboxItem to be affected. This item must be attached to the list box.
statetrue to select the item, false to de-select the item.
Returns
Nothing.
Exceptions
InvalidRequestExceptionthrown if item is not attached to this list box.
void CEGUI::Combobox::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.
Parameters
item_indexThe zero based index of the ListboxItem to be affected. This must be a valid index (0 <= index < getItemCount())
statetrue to select the item, false to de-select the item.
Returns
Nothing.
Exceptions
InvalidRequestExceptionthrown if item_index is out of range for the list box
void CEGUI::Combobox::setMaxTextLength ( size_t  max_len)

set the maximum text length for this Editbox.

Parameters
max_lenThe maximum number of code points (characters) that can be entered into this Editbox.
Note
Depending on the validation string set, the actual length of text that can be entered may be less than the value set here (it will never be more).
Returns
Nothing.
void CEGUI::Combobox::setReadOnly ( bool  setting)

Specify whether the Editbox is read-only.

Parameters
settingtrue if the Editbox is read only and can't be edited by the user, false if the Editbox is not read only and may be edited by the user.
Returns
Nothing.
void CEGUI::Combobox::setSelection ( size_t  start_pos,
size_t  end_pos 
)

Define the current selection for the Editbox.

Parameters
start_posIndex of the starting point for the selection. If this value is greater than the number of characters in the Editbox, the selection start will be set to the end of the text.
end_posIndex of the ending point for the selection. If this value is greater than the number of characters in the Editbox, the selection start will be set to the end of the text.
Returns
Nothing.
void CEGUI::Combobox::setSelectionLength ( size_t  length)

Define the current selection for the Editbox.

Parameters
start_posLength of the selection.
Returns
Nothing.
void CEGUI::Combobox::setSelectionStart ( size_t  start_pos)

Define the current selection start for the Editbox.

Parameters
start_posIndex of the starting point for the selection. If this value is greater than the number of characters in the Editbox, the selection start will be set to the end of the text.
Returns
Nothing.
void CEGUI::Combobox::setShowHorzScrollbar ( bool  setting)

Set whether the horizontal scroll bar should always be shown.

Parameters
settingtrue 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.
Returns
Nothing.
void CEGUI::Combobox::setShowVertScrollbar ( bool  setting)

Set whether the vertical scroll bar should always be shown.

Parameters
settingtrue 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.
Returns
Nothing.
void CEGUI::Combobox::setSingleClickEnabled ( bool  setting)

Set the mode of operation for the combo box.

Parameters
setting
  • true if the user should be able to show the list and select an item with a single mouse click.
  • false if the user must click to show the list and then click again to select an item.
Returns
Nothing.
void CEGUI::Combobox::setSortingEnabled ( bool  setting)

Set whether the list should be sorted.

Parameters
settingtrue if the list should be sorted, false if the list should not be sorted.
Returns
Nothing.
void CEGUI::Combobox::setValidationString ( const String validation_string)

Set the text validation string.

Note
Validation is performed by means of a regular expression. If the text matches the regex, the text is said to have passed validation. If the text does not match with the regex then the text fails validation.
Parameters
validation_stringString object containing the validation regex data to be used.
Returns
Nothing.
void CEGUI::Combobox::showDropList ( void  )

Show the drop-down list.

Returns
Nothing

Member Data Documentation

const String CEGUI::Combobox::EventCaretMoved
static

Event fired when the edit box text insertion position is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose caret position has been changed.

const String CEGUI::Combobox::EventDropListDisplayed
static

Event fired when the drop-down list is displayed Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose drop down list has been displayed.

const String CEGUI::Combobox::EventDropListRemoved
static

Event fired when the drop-down list is removed / hidden. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose drop down list has been hidden.

const String CEGUI::Combobox::EventEditboxFull
static

Event fired when the number of characters in the edit box has reached the currently set maximum. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose edit box has become full.

const String CEGUI::Combobox::EventHorzScrollbarModeChanged
static

Event fired when the horizontal scroll bar 'force' setting for the list is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose horizontal scroll bar setting has been changed.

const String CEGUI::Combobox::EventListContentsChanged
static

Event fired when the contents of the list is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose list content has changed.

const String CEGUI::Combobox::EventListSelectionAccepted
static

Event fired when the user accepts a selection from the drop-down list Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox in which the user has confirmed a selection from the drop down list.

const String CEGUI::Combobox::EventListSelectionChanged
static

Event fired when there is a change to the currently selected item in the list.

Note
This change in selection may be temporary (for example, when hovering over an item in the combobox). See also the event CEGUI::Combobox::EventListSelectionAccepted that is fired for a selection that the user has 'confirmed' in some way. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose currently selected list item has changed.
const String CEGUI::Combobox::EventMaximumTextLengthChanged
static

Event fired when the maximum string length is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose maximum edit box string length has been changed.

const String CEGUI::Combobox::EventReadOnlyModeChanged
static

Event fired when the read-only mode for the edit box is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose read only mode has been changed.

const String CEGUI::Combobox::EventSortModeChanged
static

Event fired when the sort mode setting of the list is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose list sorting mode has been changed.

const String CEGUI::Combobox::EventTextAccepted
static

Event fired when the user accepts the current edit box text by pressing Return, Enter, or Tab. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose edit box text has been accepted / confirmed by the user.

const String CEGUI::Combobox::EventTextSelectionChanged
static

Event fired when the current edit box text selection is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose edit box text selection has been changed.

const String CEGUI::Combobox::EventTextValidityChanged
static

Event fired when the validity of the Combobox text (as determined by a RegexMatcher object) has changed. Handlers are passed a const RegexMatchStateEventArgs reference with WindowEventArgs::window set to the Combobox whose text validity has changed and RegexMatchStateEventArgs::matchState set to the new match validity. Handler return is significant, as follows:

  • true indicates the new state - and therfore text - is to be accepted.
  • false indicates the new state is not acceptable, and the previous text should remain in place. NB: This is only possible when the validity change is due to a change in the text, if the validity change is due to a change in the validation regular expression string, then returning false will have no effect.
const String CEGUI::Combobox::EventValidationStringChanged
static

Event fired when the edix box validation string is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose validation string was changed.

const String CEGUI::Combobox::EventVertScrollbarModeChanged
static

Event fired when the vertical scroll bar 'force' setting for the list is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Combobox whose vertical scroll bar setting is changed.