Crazy Eddies GUI System  0.7.2
Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
CEGUI::Listbox Class Reference

Base class for standard Listbox widget. More...

+ Inheritance diagram for CEGUI::Listbox:
+ Collaboration diagram for CEGUI::Listbox:

Public Member Functions

size_t getItemCount (void) const
 Return number of items attached to the list box. More...
 
size_t getSelectedCount (void) const
 Return the number of selected items in the list box. More...
 
ListboxItemgetFirstSelectedItem (void) const
 Return a pointer to the first selected item. More...
 
ListboxItemgetNextSelected (const ListboxItem *start_item) const
 Return a pointer to the next selected item after item start_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 isMultiselectEnabled (void) const
 return whether multi-select is enabled More...
 
bool isItemTooltipsEnabled (void) const
 
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 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 before a specified item already in the

list. More...

 
void removeItem (const ListboxItem *item)
 Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted. 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 setMultiselectEnabled (bool setting)
 Set whether the list should allow multiple selections or just a single selection. 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 setItemTooltipsEnabled (bool setting)
 
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 handleUpdatedItemData (void)
 Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem objects. More...
 
void ensureItemIsVisible (size_t item_index)
 Ensure the item at the specified index is visible within the list box. More...
 
void ensureItemIsVisible (const ListboxItem *item)
 Ensure the item at the specified index is visible within the list box. More...
 
virtual Rect getListRenderArea (void) const
 Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. More...
 
ScrollbargetVertScrollbar () const
 Return a pointer to the vertical scrollbar component widget for this Listbox. More...
 
ScrollbargetHorzScrollbar () const
 Return a pointer to the horizontal scrollbar component widget for this Listbox. More...
 
float getTotalItemsHeight (void) const
 Return the sum of all item heights.
 
float getWidestItemWidth (void) const
 Return the width of the widest item.
 
ListboxItemgetItemAtPoint (const Point &pt) const
 
    Return a pointer to the ListboxItem attached to this Listbox at the

given screen pixel co-ordinate. More...

 
 Listbox (const String &type, const String &name)
 Constructor for Listbox base class.
 
virtual ~Listbox (void)
 Destructor for Listbox 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...
 
const StringgetName (void) const
 return a String object holding the name of 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 (bool localOnly=false) const
 return whether the Window is currently disabled More...
 
bool isVisible (bool localOnly=false) 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...
 
size_t getChildCount (void) const
 return the number of child Window objects currently attached to this Window. More...
 
bool isChild (const String &name) const
 returns whether a Window with the specified name is currently attached to this Window as a child. 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...
 
bool isChild (const Window *window) const
 return true if the given Window is a child of this window. More...
 
WindowgetChild (const String &name) const
 return a pointer to the child window with the specified name. More...
 
WindowgetChild (uint ID) const
 return a pointer to the first attached child window with the specified ID value. More...
 
WindowgetChildRecursive (const String &name) const
 return a pointer to the first attached child window with the specified name. Children are traversed recursively. More...
 
WindowgetChildRecursive (uint ID) const
 return a pointer to the first attached child window with the specified ID value. Children are traversed recursively. More...
 
WindowgetChildAtIdx (size_t idx) const
 return a pointer to the child window that is attached to 'this' at the given index. 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 (const String &name) const
 return true if the specified Window is some ancestor of this Window More...
 
bool isAncestor (uint ID) const
 return true if any Window with the given ID is some ancestor of this Window. More...
 
bool isAncestor (const Window *window) const
 return true if the specified Window is some ancestor of this Window. More...
 
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...
 
Rect getUnclippedOuterRect () const
 Return a Rect that describes the unclipped outer rect area of the Window in screen pixels.
 
Rect getUnclippedInnerRect () const
 Return a Rect that describes the unclipped inner rect area of the Window in screen pixels.
 
Rect getUnclippedRect (const bool inner) const
 Return a Rect that describes the unclipped area covered by the Window. More...
 
Rect getOuterRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the outer rect area of the window. More...
 
Rect getInnerRectClipper () const
 Return a Rect that describes the rendering clipping rect based upon the inner rect area of the window. More...
 
Rect getClipRect (const bool non_client=false) const
 Return a Rect that describes the rendering clipping rect for the Window. More...
 
Rect getHitTestRect () 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...
 
Rect getChildWindowContentArea (const bool non_client=false) const
 Return a Rect that describes the area that is used to position and - for scale values - size child content attached to this Window. More...
 
virtual Rect getUnclippedInnerRect_impl (void) const
 Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. 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...
 
virtual bool isHit (const Vector2 &position, const bool allow_disabled=false) const
 check if the given pixel position would hit this window. More...
 
WindowgetChildAtPosition (const Vector2 &position) const
 return the child Window that is hit by the given pixel position More...
 
WindowgetTargetChildAtPosition (const Vector2 &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 (void) 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...
 
Size getPixelSize (void) const
 Return the window size in pixels. 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...
 
bool testClassName (const String &class_name) const
 Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. More...
 
VerticalAlignment getVerticalAlignment () const
 Get the vertical alignment. More...
 
HorizontalAlignment getHorizontalAlignment () const
 Get the horizontal alignment. 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...
 
Size getParentPixelSize (void) const
 Return the pixel size of the parent element. This always returns a valid object. More...
 
float getParentPixelWidth (void) const
 Return the pixel Width of the parent element. This always returns a valid number. More...
 
float getParentPixelHeight (void) const
 Return the pixel Height of the parent element. This always returns a valid number. 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-child window. All auto-child windows have "__auto_" in their name, but this is faster.
 
bool isWritingXMLAllowed (void) const
 Returns whether this window is allowed to write XML.
 
EventSet::Iterator getEventIterator () const
 Helper method that returns an EventSet::Iterator object that can be used to iterate over the events currently added to the EventSet of this Window. More...
 
PropertySet::Iterator getPropertyIterator () const
 Helper method that returns a PropertySet::Iterator object that can be used to iterate over the events currently added to the PropertySet of this Window. More...
 
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 ()
 
const Vector3getRotation () const
 return the rotations set for this window.
 
bool isNonClientWindow () const
 Return whether the Window is a non-client window. More...
 
void rename (const String &new_name)
 Renames the window. More...
 
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 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 (Font *font)
 Set the font used by this Window. More...
 
void setFont (const String &name)
 Set the font used by this Window. More...
 
void addChildWindow (const String &name)
 Add the named Window as a child of this Window. If the Window name is already attached to a Window, it is detached before being added to this Window. More...
 
void addChildWindow (Window *window)
 Add the specified Window as a child of this Window. If the Window window is already attached to a Window, it is detached before being added to this Window. More...
 
void removeChildWindow (const String &name)
 Remove the named Window from this windows child list. More...
 
void removeChildWindow (Window *window)
 Remove the specified Window form this windows child list. More...
 
void removeChildWindow (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...
 
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...
 
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 setRestoreCapture (bool setting)
 Set whether this window will remember and restore the previous window that had inputs captured. More...
 
void setAlpha (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 (MouseCursorImage image)
 Set the mouse cursor image to be used when the mouse enters this window. More...
 
void setMouseCursor (const String &imageset, const String &image_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...
 
void setVerticalAlignment (const VerticalAlignment alignment)
 Set the vertical alignment. More...
 
void setHorizontalAlignment (const HorizontalAlignment alignment)
 Set the horizontal alignment. 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 ()
 method called to perform extended laying out of attached child windows. More...
 
void setUserString (const String &name, const String &value)
 Sets the value a named user string, creating it as required. More...
 
void setArea (const UDim &xpos, const UDim &ypos, const UDim &width, const UDim &height)
 Set the window area. More...
 
void setArea (const UVector2 &pos, const UVector2 &size)
 Set the window area. More...
 
void setArea (const URect &area)
 Set the window area. More...
 
void setPosition (const UVector2 &pos)
 Set the window's position. More...
 
void setXPosition (const UDim &x)
 Set the window's X position. More...
 
void setYPosition (const UDim &y)
 Set the window's Y position. More...
 
void setSize (const UVector2 &size)
 Set the window's size. More...
 
void setWidth (const UDim &width)
 Set the window's width. More...
 
void setHeight (const UDim &height)
 Set the window's height. More...
 
void setMaxSize (const UVector2 &size)
 Set the window's maximum size. More...
 
void setMinSize (const UVector2 &size)
 Set the window's minimum size. More...
 
const URectgetArea () const
 Return the windows area. More...
 
const UVector2getPosition () const
 Get the window's position. More...
 
const UDimgetXPosition () const
 Get the window's X position. More...
 
const UDimgetYPosition () const
 Get the window's Y position. More...
 
UVector2 getSize () const
 Get the window's size. More...
 
UDim getWidth () const
 Get the window's width. More...
 
UDim getHeight () const
 Get the window's height. More...
 
const UVector2getMaxSize () const
 Get the window's maximum size. More...
 
const UVector2getMinSize () const
 Get the window's minimum size. 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 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 to specify the Look'N'Feel specification to be used. More...
 
WindowRenderergetWindowRenderer (void) const
 Get the currently assigned WindowRenderer. (Look'N'Feel specification). More...
 
String getWindowRendererName (void) 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.
 
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...
 
void setRotation (const Vector3 &rotation)
 set the rotations for this window.
 
void setNonClientWindow (const bool setting)
 Set whether the Window is a non-client window. 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
 
Vector2 getUnprojectedPosition (const Vector2 &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.
 
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.
 
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 the given property is banned from XML.
 
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 String &newName, 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
 
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...
 
- 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...
 
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...
 
void setProperty (const String &name, const String &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...
 
Iterator getIterator (void) const
 Return a PropertySet::Iterator 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)
 Add a new Event to the EventSet with the given name. More...
 
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected. More...
 
void removeAllEvents (void)
 Remove all Event objects from the EventSet. More...
 
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in the 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...
 
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...
 
Iterator getIterator (void) const
 Return a EventSet::Iterator 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 EventListContentsChanged
 
static const String EventSelectionChanged
 
static const String EventSortModeChanged
 
static const String EventMultiselectModeChanged
 
static const String EventVertScrollbarModeChanged
 
static const String EventHorzScrollbarModeChanged
 
static const String VertScrollbarNameSuffix
 Widget name suffix for the vertical scrollbar component.
 
static const String HorzScrollbarNameSuffix
 Widget name suffix for the horizontal scrollbar component.
 
- Static Public Attributes inherited from CEGUI::Window
static const String EventNamespace
 Namespace for global events.
 
static const String EventWindowUpdated
 
static const String EventParentSized
 
static const String EventSized
 
static const String EventMoved
 
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 EventRenderingStarted
 
static const String EventRenderingEnded
 
static const String EventChildAdded
 
static const String EventChildRemoved
 
static const String EventDestructionStarted
 
static const String EventZOrderChanged
 
static const String EventDragDropItemEnters
 
static const String EventDragDropItemLeaves
 
static const String EventDragDropItemDropped
 
static const String EventVerticalAlignmentChanged
 
static const String EventHorizontalAlignmentChanged
 
static const String EventWindowRendererAttached
 
static const String EventWindowRendererDetached
 
static const String EventRotated
 
static const String EventNonClientChanged
 
static const String EventTextParsingChanged
 
static const String EventMarginChanged
 
static const String EventMouseEntersArea
 
static const String EventMouseLeavesArea
 
static const String EventMouseEnters
 
static const String EventMouseLeaves
 
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 AutoWidgetNameSuffix
 Something that all generated widgets will have in their names.
 

Protected Types

typedef std::vector
< ListboxItem * > 
LBItemList
 
- Protected Types inherited from CEGUI::Window
typedef std::vector< Window * > ChildList
 definition of type used for the list of attached child windows.
 
typedef std::map< String,
String,
String::FastLessCompare
UserStringMap
 definition of type used for the UserString dictionary.
 
typedef std::set< String,
String::FastLessCompare
BannedXMLPropertySet
 definition of type used to track properties banned from writing XML.
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String,
Event
*, String::FastLessCompare
EventMap
 

Protected Member Functions

void configureScrollbars (void)
 Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. More...
 
void selectRange (size_t start, size_t end)
 select all strings between positions start and end. (inclusive) including end.
 
bool clearAllSelections_impl (void)
 Clear the selected state for all items (implementation) More...
 
bool resetList_impl (void)
 Remove all items from the list. More...
 
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. More...
 
bool handle_scrollChange (const EventArgs &args)
 Internal handler that is triggered when the user interacts with the scrollbars.
 
virtual bool validateWindowRenderer (const String &name) const
 Function used in checking if a WindowRenderer is valid for this window. More...
 
void resortList ()
 Causes the internal list to be (re)sorted.
 
virtual void onListContentsChanged (WindowEventArgs &e)
 Handler called internally when the list contents are changed.
 
virtual void onSelectionChanged (WindowEventArgs &e)
 Handler called internally when the currently selected item or items changes.
 
virtual void onSortModeChanged (WindowEventArgs &e)
 Handler called internally when the sort mode setting changes.
 
virtual void onMultiselectModeChanged (WindowEventArgs &e)
 Handler called internally when the multi-select mode setting changes.
 
virtual void onVertScrollbarModeChanged (WindowEventArgs &e)
 Handler called internally when the forced display of the vertical scroll bar setting changes.
 
virtual void onHorzScrollbarModeChanged (WindowEventArgs &e)
 Handler called internally when the forced display of the horizontal scroll bar setting changes.
 
virtual void onSized (WindowEventArgs &e)
 Handler called when the window's size changes. More...
 
virtual void onMouseButtonDown (MouseEventArgs &e)
 Handler called when a mouse button has been depressed 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 onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area. More...
 
- Protected Member Functions inherited from CEGUI::Window
virtual void onMoved (WindowEventArgs &e)
 Handler called when the window's position changes. More...
 
virtual void onTextChanged (WindowEventArgs &e)
 Handler called when the window's text is changed. More...
 
virtual void onFontChanged (WindowEventArgs &e)
 Handler called when the window's font 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 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 onActivated (ActivationEventArgs &e)
 Handler called when this window has become the active window. More...
 
virtual void onDeactivated (ActivationEventArgs &e)
 Handler called when this window has lost input focus and has been deactivated. More...
 
virtual void onParentSized (WindowEventArgs &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 (WindowEventArgs &e)
 Handler called when a child window is added to this window. More...
 
virtual void onChildRemoved (WindowEventArgs &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 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 onVerticalAlignmentChanged (WindowEventArgs &e)
 Handler called when the vertical alignment setting for the window is changed. More...
 
virtual void onHorizontalAlignmentChanged (WindowEventArgs &e)
 Handler called when the horizontal alignment setting for the window is changed. 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 onRotated (WindowEventArgs &e)
 Handler called when the window's rotation factor is changed. More...
 
virtual void onNonClientChanged (WindowEventArgs &e)
 Handler called when the window's non-client setting, affecting it's position and size relative to it's parent is changed. 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...
 
void setParent (Window *parent)
 Set the parent window for this window object. More...
 
Size getSize_impl (const Window *window) const
 
void generateAutoRepeatEvent (MouseButton button)
 Fires off a repeated mouse button down event for this window.
 
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 cleanupChildren (void)
 Cleanup child windows.
 
virtual void addChild_impl (Window *wnd)
 Add given window to child list at an appropriate position.
 
virtual void removeChild_impl (Window *wnd)
 Remove given window from child list.
 
virtual void onZChange_impl (void)
 Notify 'this' and all siblings of a ZOrder change event.
 
void addStandardProperties (void)
 Add standard CEGUI::Window properties.
 
virtual bool moveToFront_impl (bool wasClicked)
 Implements move to front behavior. More...
 
void setArea_impl (const UVector2 &pos, const UVector2 &size, bool topLeftSizing=false, bool fireEvents=true)
 Implementation method to modify window area while correctly applying min / max size processing, and firing any appropriate events. 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.
 
Rect getParentElementClipIntersection (const Rect &unclipped_area) const
 helper function for calculating clipping rectangles.
 
void invalidate_impl (const bool recursive)
 helper function to invalidate window and optionally child windows.
 
bool isInnerRectSizeChanged () const
 helper to return whether the inner rect size has changed
 
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 Rect getUnclippedOuterRect_impl () const
 Default implementation of function to return Window outer rect area.
 
virtual Rect getOuterRectClipper_impl () const
 Default implementation of function to return Window outer clipper area.
 
virtual Rect getInnerRectClipper_impl () const
 Default implementation of function to return Window inner clipper area.
 
virtual Rect getHitTestRect_impl () const
 Default implementation of function to return Window hit-test area.
 
virtual Rect getNonClientChildWindowContentArea_impl () const
 Default implementation of function to return non-client content area.
 
virtual Rect getClientChildWindowContentArea_impl () const
 Default implementation of function to return client content area.
 
virtual int writePropertiesXML (XMLSerializer &xml_stream) const
 
virtual int writeChildWindowsXML (XMLSerializer &xml_stream) const
 
virtual bool writeAutoChildWindowXML (XMLSerializer &xml_stream) const
 
bool constrainUVector2ToMinSize (const Size &base_sz, UVector2 &sz)
 
bool constrainUVector2ToMaxSize (const Size &base_sz, UVector2 &sz)
 
- Protected Member Functions inherited from CEGUI::EventSet
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...
 
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
 EventSet (EventSet &)
 
EventSetoperator= (EventSet &)
 

Protected Attributes

bool d_sorted
 true if list is sorted
 
bool d_multiselect
 true if multi-select is enabled
 
bool d_forceVertScroll
 true if vertical scrollbar should always be displayed
 
bool d_forceHorzScroll
 true if horizontal scrollbar should always be displayed
 
bool d_itemTooltips
 true if each item should have an individual tooltip
 
LBItemList d_listItems
 list of items in the list box.
 
ListboxItemd_lastSelected
 holds pointer to the last selected item (used in range selections)
 
- Protected Attributes inherited from CEGUI::Window
const String d_type
 type of Window (also the name of the WindowFactory that created us)
 
String d_name
 The name of the window (GUI system unique).
 
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 (it's name contains __auto_)
 
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).
 
ChildList d_children
 The list of child Window objects attached to this.
 
ChildList d_drawList
 Child window objects arranged in rendering order.
 
Windowd_parent
 Holds pointer to the parent window.
 
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.
 
bool d_nonClientContent
 true if Window is in non-client (outside InnerRect) area of parent.
 
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.
 
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
 secons 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.
 
URect d_area
 This Window objects area as defined by a URect.
 
Size d_pixelSize
 Current constrained pixel size of the window.
 
UVector2 d_minSize
 current minimum size for the window.
 
UVector2 d_maxSize
 current maximum size for the window.
 
HorizontalAlignment d_horzAlign
 Specifies the base for horizontal alignment.
 
VerticalAlignment d_vertAlign
 Specifies the base for vertical alignment.
 
Vector3 d_rotation
 Rotation angles for this window.
 
Rect d_outerUnclippedRect
 outer area rect in screen pixels
 
Rect d_innerUnclippedRect
 inner area rect in screen pixels
 
Rect d_outerRectClipper
 outer area clipping rect in screen pixels
 
Rect d_innerRectClipper
 inner area clipping rect in screen pixels
 
Rect d_hitTestRect
 area rect used for hit-testing agains this window
 
bool d_outerUnclippedRectValid
 
bool d_innerUnclippedRectValid
 
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)
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Friends

class ListboxWindowRenderer
 

Additional Inherited Members

- Public Types inherited from CEGUI::PropertySet
typedef ConstBaseIterator
< PropertyRegistry > 
Iterator
 
- Public Types inherited from CEGUI::EventSet
typedef ConstBaseIterator
< EventMap > 
Iterator
 
- Static Public Member Functions inherited from CEGUI::Window
static WindowgetCaptureWindow (void)
 return the Window that currently has inputs captured. More...
 
- Static Protected Attributes inherited from CEGUI::Window
static WindowProperties::Alpha d_alphaProperty
 
static
WindowProperties::AlwaysOnTop 
d_alwaysOnTopProperty
 
static
WindowProperties::ClippedByParent 
d_clippedByParentProperty
 
static
WindowProperties::DestroyedByParent 
d_destroyedByParentProperty
 
static WindowProperties::Disabled d_disabledProperty
 
static WindowProperties::Font d_fontProperty
 
static WindowProperties::ID d_IDProperty
 
static
WindowProperties::InheritsAlpha 
d_inheritsAlphaProperty
 
static
WindowProperties::MouseCursorImage 
d_mouseCursorProperty
 
static
WindowProperties::RestoreOldCapture 
d_restoreOldCaptureProperty
 
static WindowProperties::Text d_textProperty
 
static WindowProperties::Visible d_visibleProperty
 
static
WindowProperties::ZOrderChangeEnabled 
d_zOrderChangeProperty
 
static
WindowProperties::WantsMultiClickEvents 
d_wantsMultiClicksProperty
 
static
WindowProperties::MouseButtonDownAutoRepeat 
d_autoRepeatProperty
 
static
WindowProperties::AutoRepeatDelay 
d_autoRepeatDelayProperty
 
static
WindowProperties::AutoRepeatRate 
d_autoRepeatRateProperty
 
static
WindowProperties::DistributeCapturedInputs 
d_distInputsProperty
 
static
WindowProperties::CustomTooltipType 
d_tooltipTypeProperty
 
static WindowProperties::Tooltip d_tooltipProperty
 
static
WindowProperties::InheritsTooltipText 
d_inheritsTooltipProperty
 
static
WindowProperties::RiseOnClick 
d_riseOnClickProperty
 
static
WindowProperties::VerticalAlignment 
d_vertAlignProperty
 
static
WindowProperties::HorizontalAlignment 
d_horzAlignProperty
 
static
WindowProperties::UnifiedAreaRect 
d_unifiedAreaRectProperty
 
static
WindowProperties::UnifiedPosition 
d_unifiedPositionProperty
 
static
WindowProperties::UnifiedXPosition 
d_unifiedXPositionProperty
 
static
WindowProperties::UnifiedYPosition 
d_unifiedYPositionProperty
 
static
WindowProperties::UnifiedSize 
d_unifiedSizeProperty
 
static
WindowProperties::UnifiedWidth 
d_unifiedWidthProperty
 
static
WindowProperties::UnifiedHeight 
d_unifiedHeightProperty
 
static
WindowProperties::UnifiedMinSize 
d_unifiedMinSizeProperty
 
static
WindowProperties::UnifiedMaxSize 
d_unifiedMaxSizeProperty
 
static
WindowProperties::MousePassThroughEnabled 
d_mousePassThroughEnabledProperty
 
static
WindowProperties::WindowRenderer 
d_windowRendererProperty
 
static WindowProperties::LookNFeel d_lookNFeelProperty
 
static
WindowProperties::DragDropTarget 
d_dragDropTargetProperty
 
static
WindowProperties::AutoRenderingSurface 
d_autoRenderingSurfaceProperty
 
static WindowProperties::Rotation d_rotationProperty
 
static WindowProperties::XRotation d_xRotationProperty
 
static WindowProperties::YRotation d_yRotationProperty
 
static WindowProperties::ZRotation d_zRotationProperty
 
static WindowProperties::NonClient d_nonClientProperty
 
static
WindowProperties::TextParsingEnabled 
d_textParsingEnabledProperty
 
static WindowProperties::Margin d_marginProperty
 
static WindowProperties::UpdateMode d_updateModeProperty
 
static
WindowProperties::MouseInputPropagationEnabled 
d_mouseInputPropagationProperty
 
static Windowd_captureWindow
 Window that has captured inputs.
 
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 standard Listbox widget.

Member Function Documentation

void CEGUI::Listbox::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::Listbox::clearAllSelections ( void  )

Clear the selected state for all items.

Returns
Nothing.
bool CEGUI::Listbox::clearAllSelections_impl ( void  )
protected

Clear the selected state for all items (implementation)

Returns
true if some selections were cleared, false nothing was changed.
void CEGUI::Listbox::configureScrollbars ( void  )
protected

Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.

Returns
Rect object describing the area of the Window to be used for rendering list box items.
    display required integrated scroll bars according to current state of the list box and update their values.
void CEGUI::Listbox::ensureItemIsVisible ( size_t  item_index)

Ensure the item at the specified index is visible within the list box.

Parameters
item_indexZero based index of the item to be made visible in the list box. If this value is out of range, the list is always scrolled to the bottom.
Returns
Nothing.
void CEGUI::Listbox::ensureItemIsVisible ( const ListboxItem item)

Ensure the item at the specified index is visible within the list box.

Parameters
itemPointer to the ListboxItem to be made visible in the list box.
Returns
Nothing.
Exceptions
InvalidRequestExceptionthrown if item is not attached to this list box.
ListboxItem* CEGUI::Listbox::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.
ListboxItem* CEGUI::Listbox::getFirstSelectedItem ( void  ) const

Return a pointer to the first selected item.

Returns
Pointer to a ListboxItem based object that is the first selected item in the list. will return NULL if no item is selected.
Scrollbar* CEGUI::Listbox::getHorzScrollbar ( ) const

Return a pointer to the horizontal scrollbar component widget for this Listbox.

Returns
Pointer to a Scrollbar object.
Exceptions
UnknownObjectExceptionThrown if the horizontal Scrollbar component does not exist.
ListboxItem* CEGUI::Listbox::getItemAtPoint ( const Point pt) const

    Return a pointer to the ListboxItem attached to this Listbox at the

given screen pixel co-ordinate.

Returns
Pointer to the ListboxItem attached to this Listbox that is at screen position pt, or 0 if no ListboxItem attached to this Listbox is at that position.
size_t CEGUI::Listbox::getItemCount ( void  ) const
inline

Return number of items attached to the list box.

Returns
the number of items currently attached to this list box.
size_t CEGUI::Listbox::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::Listbox::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.
virtual Rect CEGUI::Listbox::getListRenderArea ( void  ) const
virtual

Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.

Returns
Rect object describing the area of the Window to be used for rendering list box items.
ListboxItem* CEGUI::Listbox::getNextSelected ( const ListboxItem start_item) const

Return a pointer to the next selected item after item start_item.

Parameters
start_itemPointer to the ListboxItem where the search for the next selected item is to begin. If this parameter is NULL, the search will begin with the first item in the list box.
Returns
Pointer to a ListboxItem based object that is the next selected item in the list after the item specified by start_item. Will return NULL if no further items were selected.
Exceptions
InvalidRequestExceptionthrown if start_item is not attached to this list box.
size_t CEGUI::Listbox::getSelectedCount ( void  ) const

Return the number of selected items in the list box.

Returns
Total number of attached items that are in the selected state.
Scrollbar* CEGUI::Listbox::getVertScrollbar ( ) const

Return a pointer to the vertical scrollbar component widget for this Listbox.

Returns
Pointer to a Scrollbar object.
Exceptions
UnknownObjectExceptionThrown if the vertical Scrollbar component does not exist.
void CEGUI::Listbox::handleUpdatedItemData ( void  )

Causes the list box to update it's internal state after changes have been made to one or more attached ListboxItem objects.

    Client code must call this whenever it has made any changes to ListboxItem objects already attached to the
    list box.  If you are just adding items, or removed items to update them prior to re-adding them, there is
    no need to call this method.
Returns
Nothing.
virtual void CEGUI::Listbox::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.

Reimplemented in CEGUI::ComboDropList.

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

    Insert an item into the list box before a specified item already in the

list.

    Note that if the list is sorted, the item may not end up in the

requested position.

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 before. If this parameter is NULL, the item is inserted at the start of the list.
Returns
Nothing.
Exceptions
InvalidRequestExceptionthrown if no ListboxItem position is attached to this list box.
bool CEGUI::Listbox::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::Listbox::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::Listbox::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::Listbox::isMultiselectEnabled ( void  ) const
inline

return whether multi-select is enabled

Returns
true if multi-select is enabled, false if multi-select is not enabled.
bool CEGUI::Listbox::isSortEnabled ( void  ) const
inline

return whether list sorting is enabled

Returns
true if the list is sorted, false if the list is not sorted
bool CEGUI::Listbox::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::Listbox::onMouseButtonDown ( MouseEventArgs e)
protectedvirtual

Handler called when a mouse button has been depressed within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

Reimplemented in CEGUI::ComboDropList.

virtual void CEGUI::Listbox::onMouseMove ( MouseEventArgs e)
protectedvirtual

Handler called when the mouse cursor has been moved within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

Reimplemented in CEGUI::ComboDropList.

virtual void CEGUI::Listbox::onMouseWheel ( MouseEventArgs e)
protectedvirtual

Handler called when the mouse wheel (z-axis) position changes within this window's area.

Parameters
eMouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

virtual void CEGUI::Listbox::onSized ( WindowEventArgs 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.

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

Removes the given item from the list box. If the item is has the auto delete state set, the item will be deleted.

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::Listbox::resetList ( void  )

Remove all items from the list.

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

bool CEGUI::Listbox::resetList_impl ( void  )
protected

Remove all items from the list.

Note
Note that this will cause 'AutoDelete' items to be deleted.
Returns
  • true if the list contents were changed.
  • false if the list contents were not changed (list already empty).
void CEGUI::Listbox::setItemSelectState ( ListboxItem item,
bool  state 
)

Set the select state of an attached ListboxItem.

    This is the recommended way of selecting and deselecting items attached to a list box as it respects the
    multi-select mode setting.  It is possible to modify the setting on ListboxItems directly, but that approach
    does not respect the settings of the list box.
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::Listbox::setItemSelectState ( size_t  item_index,
bool  state 
)

Set the select state of an attached ListboxItem.

    This is the recommended way of selecting and deselecting items attached to a list box as it respects the
    multi-select mode setting.  It is possible to modify the setting on ListboxItems directly, but that approach
    does not respect the settings of the list box.
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::Listbox::setMultiselectEnabled ( bool  setting)

Set whether the list should allow multiple selections or just a single selection.

Parameters
settingtrue if the widget should allow multiple items to be selected, false if the widget should only allow a single selection.
Returns
Nothing.
void CEGUI::Listbox::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::Listbox::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::Listbox::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.
virtual bool CEGUI::Listbox::testClassName_impl ( const String class_name) const
inlineprotectedvirtual

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

Parameters
class_nameThe class name that is to be checked.
Returns
true if this window was inherited from class_name. false if not.

Reimplemented from CEGUI::Window.

Reimplemented in CEGUI::ComboDropList.

References CEGUI::Window::testClassName_impl().

Referenced by CEGUI::ComboDropList::testClassName_impl().

virtual bool CEGUI::Listbox::validateWindowRenderer ( const String name) const
inlineprotectedvirtual

Function used in checking if a WindowRenderer is valid for this window.

Returns
Returns true if the given WindowRenderer class name is valid for this window. False if not.

Reimplemented from CEGUI::Window.

Member Data Documentation

const String CEGUI::Listbox::EventHorzScrollbarModeChanged
static

Event fired when the mode setting that forces the display of the horizontal scroll bar for the Listbox is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Listbox whose horizontal scrollbar mode has been changed.

const String CEGUI::Listbox::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 Listbox whose content is changed.

const String CEGUI::Listbox::EventMultiselectModeChanged
static

Event fired when the multi-select mode setting changes for the Listbox. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Listbox whose multi-select mode has been changed.

const String CEGUI::Listbox::EventSelectionChanged
static

Event fired when there is a change to the currently selected item(s) within the list. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Litbox that has had a change in the selected items.

const String CEGUI::Listbox::EventSortModeChanged
static

Event fired when the sort mode setting changes for the Listbox. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Listbox whose sort mode has been changed.

const String CEGUI::Listbox::EventVertScrollbarModeChanged
static

Event fired when the mode setting that forces the display of the vertical scroll bar for the Listbox is changed. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the Listbox whose vertical scrollbar mode has been changed.