Crazy Eddies GUI System  0.6.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.
 
 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...
 
const StringgetPrefix (void) const
 
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...
 
WindowrecursiveChildSearch (const String &name) const
 This is / was intended for internal use only (should have had protected visibility). This function is deprecated - do not use this function at all, ever. The only reason this function is still here is to maintain ABI compatibility for the 0.6.x series of releases. This function will be gone in 0.7.0.
 
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...
 
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 getPixelRect (void) const
 return a Rect object describing the Window area in screen space. More...
 
virtual Rect getPixelRect_impl (void) const
 return a Rect object describing the Window area in screen space. More...
 
Rect getInnerRect (void) const
 return a Rect object describing the clipped inner area for this window. More...
 
Rect getUnclippedPixelRect (void) const
 return a Rect object describing the Window area unclipped, in screen space. More...
 
Rect getUnclippedInnerRect (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...
 
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
 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
 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...
 
RenderCachegetRenderCache ()
 Return the RenderCache 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 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 setPrefix (String prefix)
 
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...
 
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 requestRedraw (void) const
 Signal the System object to redraw (at least) this Window on the next render cycle. 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 (void)
 Causes the Window object to render itself and all of it's attached children. More...
 
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 (void)
 Recursively inform all children that the screen area has changed, and needs to be re-cached.
 
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...
 
- 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
 Event triggered when the contents of the list is changed.
 
static const String EventSelectionChanged
 Event triggered when there is a change to the currently selected item(s).
 
static const String EventSortModeChanged
 Event triggered when the sort mode setting changes.
 
static const String EventMultiselectModeChanged
 Event triggered when the multi-select mode setting changes.
 
static const String EventVertScrollbarModeChanged
 Event triggered when the vertical scroll bar 'force' setting changes.
 
static const String EventHorzScrollbarModeChanged
 Event triggered when the horizontal scroll bar 'force' setting changes.
 
static const String VertScrollbarNameSuffix
 Widget name suffix for the vertical scrollbar component.
 
static const String HorzScrollbarNameSuffix
 Widget name suffix for the horizontal scrollbar component.
 
- Static Public Attributes inherited from CEGUI::Window
static const String EventNamespace
 < Namespace for global events
 
static const String EventWindowUpdated
 
static const String EventParentSized
 Parent of this Window has been re-sized.
 
static const String EventSized
 Window size has changed.
 
static const String EventMoved
 Window position has changed.
 
static const String EventTextChanged
 Text string for the Window has changed.
 
static const String EventFontChanged
 Font object for the Window has been changed.
 
static const String EventAlphaChanged
 Alpha blend value for the Window has changed.
 
static const String EventIDChanged
 Client assigned ID code for the Window has changed.
 
static const String EventActivated
 Window has been activated (has input focus)
 
static const String EventDeactivated
 Window has been deactivated (loses input focus)
 
static const String EventShown
 Window has been made visible.
 
static const String EventHidden
 Window has been hidden from view.
 
static const String EventEnabled
 Window has been enabled (interaction is possible)
 
static const String EventDisabled
 Window has been disabled (interaction is no longer possible)
 
static const String EventClippedByParentChanged
 Clipping by parent mode has been modified.
 
static const String EventDestroyedByParentChanged
 Destruction by parent mode has been modified.
 
static const String EventInheritsAlphaChanged
 Alpha inherited from parent mode has been modified.
 
static const String EventAlwaysOnTopChanged
 Always on top mode has been modified.
 
static const String EventInputCaptureGained
 Window has captured all inputs.
 
static const String EventInputCaptureLost
 Window has lost it's capture on inputs.
 
static const String EventRenderingStarted
 Rendering of the Window has started.
 
static const String EventRenderingEnded
 Rendering for the Window has finished.
 
static const String EventChildAdded
 A child Window has been added.
 
static const String EventChildRemoved
 A child window has been removed.
 
static const String EventDestructionStarted
 Destruction of the Window is about to begin.
 
static const String EventZOrderChanged
 The z-order of the window has changed.
 
static const String EventDragDropItemEnters
 A DragContainer has been dragged over this window.
 
static const String EventDragDropItemLeaves
 A DragContainer has left this window.
 
static const String EventDragDropItemDropped
 A DragContainer was dropped on this Window.
 
static const String EventVerticalAlignmentChanged
 The vertical alignment of the window has changed.
 
static const String EventHorizontalAlignmentChanged
 The vertical alignment of the window has changed.
 
static const String EventWindowRendererAttached
 The a new window renderer was attached.
 
static const String EventWindowRendererDetached
 The currently assigned window renderer was detached.
 
static const String EventMouseEnters
 Mouse cursor has entered the Window.
 
static const String EventMouseLeaves
 Mouse cursor has left the Window.
 
static const String EventMouseMove
 Mouse cursor was moved within the area of the Window.
 
static const String EventMouseWheel
 Mouse wheel was scrolled within the Window.
 
static const String EventMouseButtonDown
 A mouse button was pressed down within the Window.
 
static const String EventMouseButtonUp
 A mouse button was released within the Window.
 
static const String EventMouseClick
 A mouse button was clicked (down then up) within the Window.
 
static const String EventMouseDoubleClick
 A mouse button was double-clicked within the Window.
 
static const String EventMouseTripleClick
 A mouse button was triple-clicked within the Window.
 
static const String EventKeyDown
 A key on the keyboard was pressed.
 
static const String EventKeyUp
 A key on the keyboard was released.
 
static const String EventCharacterKey
 A text character was typed on the keyboard.
 
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
 
typedef std::map< String,
String,
String::FastLessCompare
UserStringMap
 
typedef std::set< String,
String::FastLessCompare
BannedXMLPropertySet
 std::set used to determine whether a window should write a property to XML or not. if the property name is present the property will not be written
 
- 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...
 
ListboxItemgetItemAtPoint (const Point &pt) const
 Return the ListboxItem under the given window local pixel co-ordinate. 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 onMouseEnters (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area. More...
 
virtual void onMouseLeaves (MouseEventArgs &e)
 Handler called when the mouse cursor has left 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 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 updateSelf (float elapsed)
 Perform actual update processing for this Window. More...
 
virtual void drawSelf (float z)
 Perform the actual rendering for this Window. More...
 
virtual void populateRenderCache ()
 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.
 
void banPropertyFromXML (const Property *property)
 Adds a property to the XML ban list.
 
bool isPropertyBannedFromXML (const Property *property) const
 Returns whether a property is banned from XML.
 
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.
 
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...
 
bool doRiseOnClick (void)
 Implementation of rise on click functionality. 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...
 
virtual int writePropertiesXML (XMLSerializer &xml_stream) const
 
virtual int writeChildWindowsXML (XMLSerializer &xml_stream) const
 
virtual bool writeAutoChildWindowXML (XMLSerializer &xml_stream) const
 
 Window (const Window &wnd)
 
Windowoperator= (const Window &wnd)
 
- 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 &e)
 
EventSetoperator= (EventSet &e)
 

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
ChildList d_children
 The list of child Window objects attached to this.
 
ChildList d_drawList
 Child window objects arranged in rendering order.
 
Windowd_oldCapture
 The Window that previously had capture (used for restoreOldCapture mode)
 
Windowd_parent
 Holds pointer to the parent window.
 
Fontd_font
 Holds pointer to the Window objects current Font.
 
String d_text
 Holds the text / label / caption for this Window.
 
uint d_ID
 User ID assigned to this Window.
 
float d_alpha
 Alpha transparency setting for the Window.
 
URect d_area
 This Window objects area as defined by a URect.
 
Size d_pixelSize
 Current constrained pixel size of the window.
 
const Imaged_mouseCursor
 Holds pointer to the Window objects current mouse cursor image.
 
UserStringMap d_userStrings
 Holds a collection of named user string values.
 
void * d_userData
 Holds pointer to some user assigned data.
 
HorizontalAlignment d_horzAlign
 Specifies the base for horizontal alignment.
 
VerticalAlignment d_vertAlign
 Specifies the base for vertical alignment.
 
UVector2 d_minSize
 current minimum size for the window.
 
UVector2 d_maxSize
 current maximum size for the window.
 
bool d_enabled
 true when Window is enabled
 
bool d_visible
 true when Window is visible (that is it will be rendered, but may be obscured so no necesarily really visible)
 
bool d_active
 true when Window is the active Window (receiving inputs).
 
bool d_clippedByParent
 true when Window will be clipped by parent Window area Rect.
 
bool d_destroyedByParent
 true when Window will be auto-destroyed by parent.
 
bool d_alwaysOnTop
 true if Window will be drawn on top of all other Windows
 
bool d_inheritsAlpha
 true if the Window inherits alpha from the parent Window
 
bool d_restoreOldCapture
 true if the Window restores capture to the previous window when it releases capture.
 
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_distCapturedInputs
 true if unhandled captured inputs should be distributed to child windows.
 
bool d_riseOnClick
 True if the window should come to the front of the z order in response to a left mouse button down event.
 
bool d_autoRepeat
 true if button will auto-repeat mouse button down events while mouse button is held down.
 
float d_repeatDelay
 seconds before first repeat event is fired
 
float d_repeatRate
 secons between further repeats after delay has expired.
 
bool d_repeating
 implements repeating - is true after delay has elapsed,
 
float d_repeatElapsed
 implements repeating - tracks time elapsed.
 
MouseButton d_repeatButton
 Button we're tracking (implication of this is that we only support one button at a time).
 
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
 true if the Window inherits tooltip text from its parent (when none set for itself).
 
RenderCache d_renderCache
 Object which acts as a cache for Images to be drawn by this Window.
 
bool d_needsRedraw
 true if window image cache needs to be regenerated.
 
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.
 
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_mousePassThroughEnabled
 true if this window can never be "hit" by the cursor. false for normal mouse event handling.
 
bool d_autoWindow
 true when this window is an auto-window (it's name contains __auto_)
 
BannedXMLPropertySet d_bannedXMLProperties
 
bool d_allowWriteXML
 true if this window is allowed to write XML, false if not
 
Rect d_screenUnclippedRect
 current unclipped screen rect in pixels
 
bool d_screenUnclippedRectValid
 
Rect d_screenUnclippedInnerRect
 current unclipped inner screen rect in pixels
 
bool d_screenUnclippedInnerRectValid
 
Rect d_screenRect
 current fully clipped screen rect in pixels
 
bool d_screenRectValid
 
Rect d_screenInnerRect
 current fully clipped inner screen rect in pixels
 
bool d_screenInnerRectValid
 
const String d_type
 String holding the type name for the Window (is 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.
 
String d_windowPrefix
 The prefix used on this window (if any) when created instanced windows.
 
- 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 Windowd_captureWindow = 0
 Window that has captured inputs.
 
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
 

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.

References d_listItems, isSortEnabled(), CEGUI::lbi_less(), onListContentsChanged(), and CEGUI::ListboxItem::setOwnerWindow().

Referenced by CEGUI::Combobox::addItem(), and insertItem().

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

References d_listItems.

Referenced by clearAllSelections(), CEGUI::ComboDropList::onCaptureLost(), onMouseButtonDown(), and setItemSelectState().

void CEGUI::Listbox::configureScrollbars ( void  )
protected

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

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.

References d_forceHorzScroll, d_forceVertScroll, CEGUI::Rect::getHeight(), CEGUI::Window::getHeight(), getHorzScrollbar(), getListRenderArea(), CEGUI::Scrollbar::getScrollPosition(), getTotalItemsHeight(), getVertScrollbar(), getWidestItemWidth(), CEGUI::Rect::getWidth(), CEGUI::Window::getWidth(), CEGUI::Window::hide(), CEGUI::Scrollbar::setDocumentSize(), CEGUI::Scrollbar::setPageSize(), CEGUI::Scrollbar::setScrollPosition(), CEGUI::Scrollbar::setStepSize(), and CEGUI::Window::show().

Referenced by handleUpdatedItemData(), initialiseComponents(), onListContentsChanged(), onSized(), setShowHorzScrollbar(), and setShowVertScrollbar().

void CEGUI::Listbox::ensureItemIsVisible ( 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.

References d_listItems, CEGUI::Scrollbar::getDocumentSize(), CEGUI::Rect::getHeight(), getItemCount(), getListRenderArea(), CEGUI::Scrollbar::getPageSize(), CEGUI::Scrollbar::getScrollPosition(), getVertScrollbar(), and CEGUI::Scrollbar::setScrollPosition().

Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), and ensureItemIsVisible().

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.

References ensureItemIsVisible(), and getItemIndex().

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.

References d_listItems, getItemIndex(), and CEGUI::Window::getText().

Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), and CEGUI::Combobox::findItemWithText().

ListboxItem * CEGUI::Listbox::getFirstSelectedItem ( void  ) const

Return a pointer to the first selected item.

Returns
Pointer to a ListboxItem based object that is the first selected item in the list. will return NULL if no item is selected.

References getNextSelected().

Referenced by CEGUI::Combobox::getSelectedItem(), CEGUI::ComboDropList::onListSelectionAccepted(), CEGUI::ComboDropList::onSelectionChanged(), and setMultiselectEnabled().

Scrollbar * CEGUI::Listbox::getHorzScrollbar ( ) const

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

Returns
Pointer to a Scrollbar object.
Exceptions
UnknownObjectExceptionThrown if the horizontal Scrollbar component does not exist.

References CEGUI::Window::getName(), and HorzScrollbarNameSuffix.

Referenced by configureScrollbars(), CEGUI::FalagardListbox::getListRenderArea(), CEGUI::ComboDropList::initialiseComponents(), initialiseComponents(), onMouseWheel(), and CEGUI::FalagardListbox::render().

ListboxItem * CEGUI::Listbox::getItemAtPoint ( const Point pt) const
protected

Return the ListboxItem under the given window local pixel co-ordinate.

Returns
ListboxItem that is under window pixel co-ordinate pt, or NULL if no item is under that position.

References d_listItems, getItemCount(), getListRenderArea(), CEGUI::Scrollbar::getScrollPosition(), getVertScrollbar(), and CEGUI::Rect::isPointInRect().

Referenced by onMouseButtonDown(), CEGUI::ComboDropList::onMouseMove(), and onMouseMove().

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.

Referenced by ensureItemIsVisible(), getItemAtPoint(), CEGUI::Combobox::getItemCount(), getTotalItemsHeight(), getWidestItemWidth(), CEGUI::FalagardListbox::render(), resetList_impl(), setItemSelectState(), and CEGUI::Combobox::setItemSelectState().

size_t CEGUI::Listbox::getItemIndex ( const ListboxItem item) const

Return the index of ListboxItem item.

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.

References d_listItems.

Referenced by ensureItemIsVisible(), findItemWithText(), CEGUI::Combobox::getItemIndex(), getNextSelected(), and onMouseButtonDown().

ListboxItem * CEGUI::Listbox::getListboxItemFromIndex ( size_t  index) const

Return the item at index position index.

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.

References d_listItems.

Referenced by CEGUI::Combobox::getListboxItemFromIndex(), CEGUI::FalagardListbox::render(), and CEGUI::Combobox::setItemSelectState().

Rect CEGUI::Listbox::getListRenderArea ( void  ) const
virtual

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

Returns
Rect object describing the area of the Window to be used for rendering list box items.

References CEGUI::Window::d_windowRenderer, and CEGUI::ListboxWindowRenderer::getListRenderArea().

Referenced by configureScrollbars(), ensureItemIsVisible(), and getItemAtPoint().

ListboxItem * CEGUI::Listbox::getNextSelected ( const ListboxItem start_item) const

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

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.

References d_listItems, and getItemIndex().

Referenced by getFirstSelectedItem(), and setMultiselectEnabled().

size_t CEGUI::Listbox::getSelectedCount ( void  ) const

Return the number of selected items in the list box.

Returns
Total number of attached items that are in the selected state.

References d_listItems.

Referenced by CEGUI::ComboDropList::onMouseButtonUp(), and setMultiselectEnabled().

Scrollbar * CEGUI::Listbox::getVertScrollbar ( ) const

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

Returns
Pointer to a Scrollbar object.
Exceptions
UnknownObjectExceptionThrown if the vertical Scrollbar component does not exist.

References CEGUI::Window::getName(), and VertScrollbarNameSuffix.

Referenced by configureScrollbars(), ensureItemIsVisible(), getItemAtPoint(), CEGUI::FalagardListbox::getListRenderArea(), CEGUI::ComboDropList::initialiseComponents(), initialiseComponents(), onMouseWheel(), and CEGUI::FalagardListbox::render().

void CEGUI::Listbox::handleUpdatedItemData ( void  )

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

    Client code must call this whenever it has made any changes to ListboxItem objects already attached to the
    list box.  If you are just adding items, or removed items to update them prior to re-adding them, there is
    no need to call this method.
Returns
Nothing.

References configureScrollbars(), d_sorted, CEGUI::Window::requestRedraw(), and resortList().

Referenced by CEGUI::Combobox::handleUpdatedListItemData().

void CEGUI::Listbox::initialiseComponents ( void  )
virtual

Initialise the Window based object ready for use.

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.

References configureScrollbars(), CEGUI::Scrollbar::EventScrollPositionChanged, getHorzScrollbar(), getVertScrollbar(), handle_scrollChange(), CEGUI::Window::performChildWindowLayout(), and CEGUI::EventSet::subscribeEvent().

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

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.

References addItem(), d_listItems, isSortEnabled(), onListContentsChanged(), and CEGUI::ListboxItem::setOwnerWindow().

Referenced by CEGUI::Combobox::insertItem().

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

Return whether the horizontal scroll bar is always shown.

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.

References d_forceHorzScroll.

Referenced by CEGUI::Combobox::isHorzScrollbarAlwaysShown().

bool CEGUI::Listbox::isItemSelected ( size_t  index) const

return whether the string at index position index is selected

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.

References d_listItems.

Referenced by CEGUI::Combobox::isItemSelected().

bool CEGUI::Listbox::isListboxItemInList ( const ListboxItem item) const

Return whether the specified ListboxItem is in the List.

Returns
true if ListboxItem item is in the list, false if ListboxItem item is not in the list.

References d_listItems.

Referenced by CEGUI::Combobox::isListboxItemInList(), and CEGUI::ComboDropList::onListContentsChanged().

bool CEGUI::Listbox::isMultiselectEnabled ( void  ) const
inline

return whether multi-select is enabled

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

Referenced by addItem(), insertItem(), and CEGUI::Combobox::isSortEnabled().

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.

References d_forceVertScroll.

Referenced by CEGUI::Combobox::isVertScrollbarAlwaysShown().

void CEGUI::Listbox::onMouseButtonDown ( MouseEventArgs e)
protectedvirtual
void CEGUI::Listbox::onMouseMove ( MouseEventArgs e)
protectedvirtual
void CEGUI::Listbox::onMouseWheel ( MouseEventArgs e)
protectedvirtual
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.

References configureScrollbars(), CEGUI::EventArgs::handled, and CEGUI::Window::onSized().

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.

References d_lastSelected, d_listItems, CEGUI::ListboxItem::isAutoDeleted(), and onListContentsChanged().

Referenced by CEGUI::Combobox::removeItem().

void CEGUI::Listbox::resetList ( void  )

Remove all items from the list.

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

References onListContentsChanged(), and resetList_impl().

Referenced by CEGUI::Combobox::resetList().

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

Remove all items from the list.

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).

References d_lastSelected, d_listItems, and getItemCount().

Referenced by resetList(), and ~Listbox().

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.

References d_listItems.

Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::Combobox::editbox_MouseDownHandler(), CEGUI::ComboDropList::onCaptureLost(), CEGUI::ComboDropList::onMouseMove(), and CEGUI::Combobox::setItemSelectState().

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

References clearAllSelections_impl(), d_listItems, d_multiselect, getItemCount(), and onSelectionChanged().

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.

References d_multiselect, getFirstSelectedItem(), getNextSelected(), getSelectedCount(), onMultiselectModeChanged(), onSelectionChanged(), and CEGUI::ListboxItem::setSelected().

void CEGUI::Listbox::setShowHorzScrollbar ( bool  setting)

Set whether the horizontal scroll bar should always be shown.

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.

References configureScrollbars(), d_forceHorzScroll, and onHorzScrollbarModeChanged().

Referenced by CEGUI::Combobox::setShowHorzScrollbar().

void CEGUI::Listbox::setShowVertScrollbar ( bool  setting)

Set whether the vertical scroll bar should always be shown.

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.

References configureScrollbars(), d_forceVertScroll, and onVertScrollbarModeChanged().

Referenced by CEGUI::Combobox::setShowVertScrollbar().

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.

References d_sorted, onSortModeChanged(), and resortList().

Referenced by CEGUI::Combobox::setSortingEnabled().

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.