Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

CEGUI::MultiColumnList Class Reference

Base class for the multi column list widget. More...

#include <CEGUIMultiColumnList.h>

Inheritance diagram for CEGUI::MultiColumnList:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::MultiColumnList:

Collaboration graph
[legend]
List of all members.

Public Types

enum  SelectionMode {
  RowSingle, RowMultiple, CellSingle, CellMultiple,
  NominatedColumnSingle, NominatedColumnMultiple, ColumnSingle, ColumnMultiple,
  NominatedRowSingle, NominatedRowMultiple
}
 Enumerated values for the selection modes possible with a Multi-column list. More...
typedef ConstBaseIterator<
PropertyRegistry > 
PropertyIterator
typedef ConstBaseIterator<
EventMap
EventIterator

Public Member Functions

bool isUserSortControlEnabled (void) const
 Return whether user manipulation of the sort column and direction are enabled.
bool isUserColumnSizingEnabled (void) const
 Return whether the user may size column segments.
bool isUserColumnDraggingEnabled (void) const
 Return whether the user may modify the order of the columns.
uint getColumnCount (void) const
 Return the number of columns in the multi-column list.
uint getRowCount (void) const
 Return the number of rows in the multi-column list.
uint getSortColumn (void) const
 Return the zero based index of the current sort column. There must be at least one column to successfully call this method.
uint getColumnWithID (uint col_id) const
 Return the zero based column index of the column with the specified ID.
uint getColumnWithHeaderText (const String &text) const
 Return the zero based index of the column whos header text matches the specified text.
float getTotalColumnHeadersWidth (void) const
 Return the total width of all column headers.
float getColumnHeaderWidth (uint col_idx) const
 Return the width of the specified column header (and therefore the column itself).
ListHeaderSegment::SortDirection getSortDirection (void) const
 Return the currently set sort direction.
ListHeaderSegmentgetHeaderSegmentForColumn (uint col_idx) const
 Return the ListHeaderSegment object for the specified column.
uint getItemRowIndex (const ListboxItem *item) const
 Return the zero based index of the Row that contains item.
uint getItemColumnIndex (const ListboxItem *item) const
 Return the current zero based index of the column that contains item.
MCLGridRef getItemGridReference (const ListboxItem *item) const
 Return the grid reference for item.
ListboxItemgetItemAtGridReference (const MCLGridRef &grid_ref) const
 Return a pointer to the ListboxItem at the specified grid reference.
bool isListboxItemInColumn (const ListboxItem *item, uint col_idx) const
 return whether ListboxItem item is attached to the column at index col_idx.
bool isListboxItemInRow (const ListboxItem *item, uint row_idx) const
 return whether ListboxItem item is attached to the row at index row_idx.
bool isListboxItemInList (const ListboxItem *item) const
 return whether ListboxItem item is attached to the list box.
ListboxItemfindColumnItemWithText (const String &text, uint col_idx, const ListboxItem *start_item) const
 Return the ListboxItem in column col_idx that has the text string text.
ListboxItemfindRowItemWithText (const String &text, uint row_idx, const ListboxItem *start_item) const
 Return the ListboxItem in row row_idx that has the text string text.
ListboxItemfindListItemWithText (const String &text, const ListboxItem *start_item) const
 Return the ListboxItem that has the text string text.
ListboxItemgetFirstSelectedItem (void) const
 Return a pointer to the first selected ListboxItem attached to this list box.
ListboxItemgetNextSelected (const ListboxItem *start_item) const
 Return a pointer to the next selected ListboxItem after start_item.
uint getSelectedCount (void) const
 Return the number of selected ListboxItems attached to this list box.
bool isItemSelected (const MCLGridRef &grid_ref) const
 Return whether the ListboxItem at grid_ref is selected.
uint getNominatedSelectionColumnID (void) const
 Return the ID of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.
uint getNominatedSelectionColumn (void) const
 Return the index of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.
uint getNominatedSelectionRow (void) const
 Return the index of the currently set nominated selection row to be used when in one of the NominatedRow* selection modes.
MultiColumnList::SelectionMode getSelectionMode (void) const
 Return the currently set selection mode.
bool isVertScrollbarAlwaysShown (void) const
 Return whether the vertical scroll bar is always shown.
bool isHorzScrollbarAlwaysShown (void) const
 Return whether the horizontal scroll bar is always shown.
uint getColumnID (uint col_idx) const
 Return the ID code assigned to the requested column.
virtual void initialise (void)
 Initialise the Window based object ready for use.
void resetList (void)
 Remove all items from the list.
void addColumn (const String &text, uint col_id, float width)
 Add a column to the list box.
void insertColumn (const String &text, uint col_id, float width, uint position)
 Insert a new column in the list.
void removeColumn (uint col_idx)
 Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.
void removeColumnWithID (uint col_id)
 Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.
void moveColumn (uint col_idx, uint position)
 Move the column at index col_idx so it is at index position.
void moveColumnWithID (uint col_id, uint position)
 Move the column with ID col_id so it is at index position.
uint addRow (void)
 Add an empty row to the list box.
uint addRow (ListboxItem *item, uint col_id)
 Add a row to the list box, and set the item in the column with ID col_id to item.
uint insertRow (uint row_idx)
 Insert an empty row into the list box.
uint insertRow (ListboxItem *item, uint col_id, uint row_idx)
 Insert a row into the list box, and set the item in the column with ID col_id to item.
void removeRow (uint row_idx)
 Remove the list box row with index row_idx. Any ListboxItem in row row_idx using autoDelete mode will be deleted.
void setItem (ListboxItem *item, const MCLGridRef &position)
 Set the ListboxItem for grid reference position.
void setItem (ListboxItem *item, uint col_id, uint row_idx)
 Set the ListboxItem for the column with ID col_id in row row_idx.
void setSelectionMode (MultiColumnList::SelectionMode sel_mode)
 Set the selection mode for the list box.
void setNominatedSelectionColumnID (uint col_id)
 Set the column to be used for the NominatedColumn* selection modes.
void setNominatedSelectionColumn (uint col_idx)
 Set the column to be used for the NominatedColumn* selection modes.
void setNominatedSelectionRow (uint row_idx)
 Set the row to be used for the NominatedRow* selection modes.
void setSortDirection (ListHeaderSegment::SortDirection direction)
 Set the sort direction to be used.
void setSortColumn (uint col_idx)
 Set the column to be used as the sort key.
void setSortColumnByID (uint col_id)
 Set the column to be used as the sort key.
void setShowVertScrollbar (bool setting)
 Set whether the vertical scroll bar should always be shown, or just when needed.
void setShowHorzScrollbar (bool setting)
 Set whether the horizontal scroll bar should always be shown, or just when needed.
void clearAllSelections (void)
 Removed the selected state from any currently selected ListboxItem attached to the list.
void setItemSelectState (ListboxItem *item, bool state)
 Sets or clears the selected state of the given ListboxItem which must be attached to the list.
void setItemSelectState (const MCLGridRef &grid_ref, bool state)
 Sets or clears the selected state of the ListboxItem at the given grid reference.
void handleUpdatedItemData (void)
 Inform the list box that one or more attached ListboxItems have been externally modified, and the list should re-sync its internal state and refresh the display as needed.
void setColumnHeaderWidth (uint col_idx, float width)
 Set the width of the specified column header (and therefore the column itself).
void setUserSortControlEnabled (bool setting)
 Set whether user manipulation of the sort column and direction are enabled.
void setUserColumnSizingEnabled (bool setting)
 Set whether the user may size column segments.
void setUserColumnDraggingEnabled (bool setting)
 Set whether the user may modify the order of the columns.
void autoSizeColumnHeader (uint col_idx)
 Automatically determines the "best fit" size for the specified column and sets the column width to the same.
 MultiColumnList (const String &type, const String &name)
 Constructor for the Multi-column list base class.
virtual ~MultiColumnList (void)
 Destructor for the multi-column list base class.
const StringgetType (void) const
 return a String object holding the type name for this Window.
const StringgetName (void) const
 return a String object holding the name of this Window.
bool isDestroyedByParent (void) const
 returns whether or not this Window is set to be destroyed when its parent is destroyed.
bool isAlwaysOnTop (void) const
 returns whether or not this Window is an always on top (a.k.a 'topmost') Window.
bool isDisabled (void) const
 return true if the Window is currently disabled
bool isVisible (void) const
 return true if the Window is currently visible.
bool isActive (void) const
 return true if this is the active Window (the window that receives inputs)
bool isClippedByParent (void) const
 return true if this Window is clipped so that its rendering does not pass outside its parent windows area.
uint getID (void) const
 return the ID code currently assigned to this Window by client code.
uint getChildCount (void) const
 return the number of child Window objects currently attached to this Window.
bool isChild (const String &name) const
 returns whether a Window with the specified name is currently attached to this Window as a child.
bool isChild (uint ID) const
 returns whether at least one window with the given ID code is attached as a child.
bool isChild (const Window *window) const
 return true if the given Window is a child of this window.
WindowgetChild (const String &name) const
 return a pointer to the child window with the specified name.
WindowgetChild (uint ID) const
 return a pointer to the first attached child window with the specified ID.
WindowgetChildAtIdx (uint idx) const
 return a pointer to the child window that is attached to 'this' at the given index.
WindowgetActiveChild (void)
 return a pointer to the Window that currently has input focus starting with this Window.
const WindowgetActiveChild (void) const
bool isAncestor (const String &name) const
 return true if the specified Window is some ancestor of this Window
bool isAncestor (uint ID) const
 return true if any Window with the given ID is some ancestor of this Window.
bool isAncestor (const Window *window) const
 return true if the specified Window is some ancestor of this Window.
const FontgetFont (void) const
 return the Font object active for the Window.
const StringgetText (void) const
 return the current text for the Window
bool inheritsAlpha (void) const
 return true if the Window inherits alpha from its parent(s).
float getAlpha (void) const
 return the current alpha value set for this Window
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.
Rect getRect (void) const
 return a Rect object that describes the Window area.
Rect getRect (MetricsMode mode) const
 return a Rect object that describes the Window area using the specified metrics system.
virtual Rect getPixelRect (void) const
 return a Rect object describing the Window area in screen space.
Rect getInnerRect (void) const
 return a Rect object describing the clipped inner area for this window.
Rect getUnclippedPixelRect (void) const
 return a Rect object describing the Window area unclipped, in screen space.
virtual 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.
bool isCapturedByThis (void) const
 return true if this Window has input captured.
bool isCapturedByAncestor (void) const
 return true if a child window has captured inputs.
bool isCapturedByChild (void) const
 return true if an ancestor window has captured inputs.
virtual bool isHit (const Point &position) const
 check if the given position would hit this window.
WindowgetChildAtPosition (const Point &position) const
 return the child Window that is 'hit' by the given position
MetricsMode getMetricsMode (void) const
 return the current metrics mode employed by the Window
float getXPosition (void) const
 return the x position of the window. Interpretation of return value depends upon the metric type in use by this window.
float getXPosition (MetricsMode mode) const
 return the x position of the window using the specified metrics system.
float getYPosition (void) const
 return the y position of the window. Interpretation of return value depends upon the metric type in use by this window.
float getYPosition (MetricsMode mode) const
 return the y position of the window using the specified metrics system.
Point getPosition (void) const
 return the position of the window. Interpretation of return value depends upon the metric type in use by this window.
Point getPosition (MetricsMode mode) const
 return the position of the window using the specified metrics system.
float getWidth (void) const
 return the width of the Window. Interpretation of return value depends upon the metric type in use by this window.
float getWidth (MetricsMode mode) const
 return the width of the Window using the specified metrics system.
float getHeight (void) const
 return the height of the Window. Interpretation of return value depends upon the metric type in use by this window.
float getHeight (MetricsMode mode) const
 return the height of the Window using the specified metrics system.
Size getSize (void) const
 return the size of the Window. Interpretation of return value depends upon the metric type in use by this window.
Size getSize (MetricsMode mode) const
 return the size of the Window using the specified metrics system.
WindowgetParent (void) const
 return the parent of this Window.
Size getMaximumSize (void) const
 Return the current maximum size for this window.
Size getMinimumSize (void) const
 Return the current minimum size for this window.
const ImagegetMouseCursor (void) const
 Return a pointer to the mouse cursor image to use when the mouse is within this window.
Rect getRelativeRect (void) const
 Return the window area rect in relative metrics.
Point getRelativePosition (void) const
 Return the window position in relative metrics.
float getRelativeXPosition (void) const
 Return the window X position in relative metrics.
float getRelativeYPosition (void) const
 Return the window Y position in relative metrics.
Size getRelativeSize (void) const
 Return the window size in relative metrics.
float getRelativeWidth (void) const
 Return the window width in relative metrics.
float getRelativeHeight (void) const
 Return the window height in relative metrics.
Rect getAbsoluteRect (void) const
 Return the window area rect in absolute metrics.
Point getAbsolutePosition (void) const
 Return the window position in absolute metrics.
float getAbsoluteXPosition (void) const
 Return the window X position in absolute metrics.
float getAbsoluteYPosition (void) const
 Return the window Y position in absolute metrics.
Size getAbsoluteSize (void) const
 Return the window size in absolute metrics.
float getAbsoluteWidth (void) const
 Return the window width in absolute metrics.
float getAbsoluteHeight (void) const
 Return the window height in absolute metrics.
void * getUserData (void) const
 Return the user data set for this Window.
bool restoresOldCapture (void) const
 Return whether this window is set to restore old input capture when it loses input capture.
bool isZOrderingEnabled (void) const
 Return whether z-order changes are enabled or disabled for this Window.
bool wantsMultiClickEvents (void) const
 Return whether this window will receive multi-click events or multiple 'down' events instead.
bool isMouseAutoRepeatEnabled (void) const
 Return whether mouse button down event autorepeat is enabled for this window.
float getAutoRepeatDelay (void) const
 Return the current auto-repeat delay setting for this window.
float getAutoRepeatRate (void) const
 Return the current auto-repeat rate setting for this window.
void setDestroyedByParent (bool setting)
 Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.
void setAlwaysOnTop (bool setting)
 Set whether this window is always on top, or not.
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.
void enable (void)
 enable the Window to allow interaction.
void disable (void)
 disable the Window to prevent interaction.
void setVisible (bool setting)
 Set whether the Window is visible or hidden.
void show (void)
 show the Window
void hide (void)
 hide the Window.
void activate (void)
 Activate the Window giving it input focus and bringing it to the top of all non always-on-top Windows.
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.
void setClippedByParent (bool setting)
 Set whether this Window will be clipped by its parent window(s).
void setID (uint ID)
 Set the current ID for the Window.
void setText (const String &text)
 Set the current text string for the Window.
void setWidth (float width)
 Set the current width of the Window. Interpretation of the input value width is dependant upon the current metrics system set for the Window.
void setWidth (MetricsMode mode, float width)
 set the width of the Window using the specified metrics system.
void setHeight (float height)
 Set the current height of the Window. Interpretation of the input value height is dependant upon the current metrics system set for the Window.
void setHeight (MetricsMode mode, float height)
 set the height of the Window using the specified metrics system.
void setSize (const Size &size)
 Set the current size of the Window. Interpretation of the input value size is dependant upon the current metrics system set for the Window.
void setSize (MetricsMode mode, const Size &size)
 set the size of the Window using the specified metrics system.
void setXPosition (float x)
 Set the current 'x' position of the Window. Interpretation of the input value x is dependant upon the current metrics system set for the Window.
void setXPosition (MetricsMode mode, float x)
 set the x position of the window using the specified metrics system.
void setYPosition (float y)
 Set the current 'y' position of the Window. Interpretation of the input value y is dependant upon the current metrics system set for the Window.
void setYPosition (MetricsMode mode, float y)
 set the y position of the window using the specified metrics system.
void setPosition (const Point &position)
 Set the current position of the Window. Interpretation of the input value position is dependant upon the current metrics system set for the Window.
void setPosition (MetricsMode mode, const Point &position)
 set the position of the window using the specified metrics system.
void setAreaRect (const Rect &area)
 Set the current area for the Window, this allows for setting of position and size at the same time. Interpretation of the input value area is dependant upon the current metrics system set for the Window.
void setFont (const Font *font)
 Set the font used by this Window.
void setFont (const String &name)
 Set the font used by this Window.
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.
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.
void removeChildWindow (const String &name)
 Remove the named Window from this windows child list.
void removeChildWindow (Window *window)
 Remove the specified Window form this windows child list.
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.
void moveToFront ()
 Move the Window to the top of the z order.
void moveToBack ()
 Move the Window to the bottom of the Z order.
bool captureInput (void)
 Captures input to this window.
void releaseInput (void)
 Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.
void setRestoreCapture (bool setting)
 Set whether this window will remember and restore the previous window that had inputs captured.
void setAlpha (float alpha)
 Set the current alpha value for this window.
void setInheritsAlpha (bool setting)
 Sets whether this Window will inherit alpha from its parent windows.
void requestRedraw (void) const
 Signal the System object to redraw (at least) this Window on the next render cycle.
void setMetricsMode (MetricsMode mode)
 set the current metrics mode employed by the Window
void setMinimumSize (const Size &sz)
 Set the minimum size for this window.
void setMaximumSize (const Size &sz)
 Set the maximum size for this window.
void setMouseCursor (const Image *image)
 Set the mouse cursor image to be used when the mouse enters this window.
void setMouseCursor (MouseCursorImage image)
 Set the mouse cursor image to be used when the mouse enters this window.
void setMouseCursor (const String &imageset, const String &image_name)
 Set the mouse cursor image to be used when the mouse enters this window.
void setUserData (void *user_data)
 Set the user data set for this Window.
void setRect (MetricsMode mode, const Rect &area)
 set the Rect that describes the Window area using the specified metrics system.
void setZOrderingEnabled (bool setting)
 Set whether z-order changes are enabled or disabled for this Window.
void setWantsMultiClickEvents (bool setting)
 Set whether this window will receive multi-click events or multiple 'down' events instead.
void setMouseAutoRepeatEnabled (bool setting)
 Set whether mouse button down event autorepeat is enabled for this window.
void setAutoRepeatDelay (float delay)
 Set the current auto-repeat delay setting for this window.
void setAutoRepeatRate (float rate)
 Set the current auto-repeat rate setting for this window.
float absoluteToRelativeX (float val) const
 Convert the given X co-ordinate from absolute to relative metrics.
float absoluteToRelativeY (float val) const
 Convert the given Y co-ordinate from absolute to relative metrics.
Point absoluteToRelative (const Point &pt) const
 Convert the given position from absolute to relative metrics.
Size absoluteToRelative (const Size &sze) const
 Convert the given size from absolute to relative metrics.
Rect absoluteToRelative (const Rect &rect) const
 Convert the given area from absolute to relative metrics.
float relativeToAbsoluteX (float val) const
 Convert the given X co-ordinate from relative to absolute metrics.
float relativeToAbsoluteY (float val) const
 Convert the given Y co-ordinate from relative to absolute metrics.
Point relativeToAbsolute (const Point &pt) const
 Convert the given position from relative to absolute metrics.
Size relativeToAbsolute (const Size &sze) const
 Convert the given size from relative to absolute metrics.
Rect relativeToAbsolute (const Rect &rect) const
 Convert the given area from relative to absolute metrics.
float windowToScreenX (float x) const
 Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.
float windowToScreenY (float y) const
 Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.
Point windowToScreen (const Point &pt) const
 Convert a window co-ordinate position, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate position.
Size windowToScreen (const Size &sze) const
 Convert a window size value, specified in whichever metrics mode is active, to a size in pixels.
Rect windowToScreen (const Rect &rect) const
 Convert a window area, specified in whichever metrics mode is active, to a screen area.
float screenToWindowX (float x) const
 Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
float screenToWindowY (float y) const
 Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.
Point screenToWindow (const Point &pt) const
 Convert a screen relative pixel position to a window co-ordinate position, specified in whichever metrics mode is active.
Size screenToWindow (const Size &sze) const
 Convert a pixel screen size to a window based size, specified in whichever metrics mode is active.
Rect screenToWindow (const Rect &rect) const
 Convert a screen area to a window area, specified in whichever metrics mode is active.
void render (void)
 Causes the Window object to render itself and all of it's attached children.
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.
void addProperty (Property *property)
 Adds a new Property to the PropertySet.
void removeProperty (const String &name)
 Removes a Property from the PropertySet.
void clearProperties (void)
 Removes all Property objects from the PropertySet.
bool isPropertyPresent (const String &name) const
 Checks to see if a Property with the given name is in the PropertySet.
const StringgetPropertyHelp (const String &name) const
 Return the help text for the specified Property.
String getProperty (const String &name) const
 Gets the current value of the specified Property.
void setProperty (const String &name, const String &value)
 Sets the current value of a Property.
bool isPropertyDefault (const String &name) const
 Returns whether a Property is at it's default value.
String getPropertyDefault (const String &name) const
 Returns the default value of a Property as a String.
PropertyIterator getIterator (void) const
 Return a PropertySet::PropertyIterator object to iterate over the available Properties.
EventIterator getIterator (void) const
 Return a EventSet::EventIterator object to iterate over the available events.
void addEvent (const String &name)
 Add a new Event to the EventSet with the given name.
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected.
void removeAllEvents (void)
 Remove all Event objects from the EventSet.
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in the EventSet.
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes the the named Event.
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes the the specified group of the named Event.
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object.
bool isMuted (void) const
 Return whether the EventSet is muted or not.
void setMutedState (bool setting)
 Set the mute state for this EventSet.

Static Public Member Functions

WindowgetCaptureWindow (void)
 return the Window that currently has inputs captured.

Static Public Attributes

const String EventNamespace
 Namespace for global events.
const String EventSelectionModeChanged
 Event fired when the selection mode for the list box changes.
const String EventNominatedSelectColumnChanged
 Event fired when the nominated select column changes.
const String EventNominatedSelectRowChanged
 Event fired when the nominated select row changes.
const String EventVertScrollbarModeChanged
 Event fired when the vertical scroll bar 'force' setting changes.
const String EventHorzScrollbarModeChanged
 Event fired when the horizontal scroll bar 'force' setting changes.
const String EventSelectionChanged
 Event fired when the current selection(s) within the list box changes.
const String EventListContentsChanged
 Event fired when the contents of the list box changes.
const String EventSortColumnChanged
 Event fired when the sort column changes.
const String EventSortDirectionChanged
 Event fired when the sort direction changes.
const String EventListColumnSized
 Event fired when the width of a column in the list changes.
const String EventListColumnMoved
 Event fired when the column order changes.
const String EventParentSized
 Parent of this Window has been re-sized.
const String EventSized
 Window size has changed.
const String EventMoved
 Window position has changed.
const String EventTextChanged
 Text string for the Window has changed.
const String EventFontChanged
 Font object for the Window has been changed.
const String EventAlphaChanged
 Alpha blend value for the Window has changed.
const String EventIDChanged
 Client assigned ID code for the Window has changed.
const String EventActivated
 Window has been activated (has input focus).
const String EventDeactivated
 Window has been deactivated (loses input focus).
const String EventShown
 Window has been made visible.
const String EventHidden
 Window has been hidden from view.
const String EventEnabled
 Window has been enabled (interaction is possible).
const String EventDisabled
 Window has been disabled (interaction is no longer possible).
const String EventMetricsModeChanged
 Active metrics mode has been modified.
const String EventClippedByParentChanged
 Clipping by parent mode has been modified.
const String EventDestroyedByParentChanged
 Destruction by parent mode has been modified.
const String EventInheritsAlphaChanged
 Alpha inherited from parent mode has been modified.
const String EventAlwaysOnTopChanged
 Always on top mode has been modified.
const String EventInputCaptureGained
 Window has captured all inputs.
const String EventInputCaptureLost
 Window has lost it's capture on inputs.
const String EventRenderingStarted
 Rendering of the Window has started.
const String EventRenderingEnded
 Rendering for the Window has finished.
const String EventChildAdded
 A child Window has been added.
const String EventChildRemoved
 A child window has been removed.
const String EventDestructionStarted
 Destruction of the Window is about to begin.
const String EventZOrderChanged
 The z-order of the window has changed.
const String EventMouseEnters
 Mouse cursor has entered the Window.
const String EventMouseLeaves
 Mouse cursor has left the Window.
const String EventMouseMove
 Mouse cursor was moved within the area of the Window.
const String EventMouseWheel
 Mouse wheel was scrolled within the Window.
const String EventMouseButtonDown
 A mouse button was pressed down within the Window.
const String EventMouseButtonUp
 A mouse button was released within the Window.
const String EventMouseClick
 A mouse button was clicked (down then up) within the Window.
const String EventMouseDoubleClick
 A mouse button was double-clicked within the Window.
const String EventMouseTripleClick
 A mouse button was triple-clicked within the Window.
const String EventKeyDown
 A key on the keyboard was pressed.
const String EventKeyUp
 A key on the keyboard was released.
const String EventCharacterKey
 A text character was typed on the keyboard.

Protected Types

typedef std::vector< ListRowListItemGrid
typedef std::vector< Window * > ChildList
typedef std::map< String,
Event * > 
EventMap

Protected Member Functions

virtual Rect getListRenderArea (void) const =0
 Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
virtual ListHeadercreateListHeader (void) const =0
 create and return a pointer to a ListHeaer widget for use as the column headers.
virtual ScrollbarcreateVertScrollbar (void) const =0
 create and return a pointer to a Scrollbar widget for use as vertical scroll bar
virtual ScrollbarcreateHorzScrollbar (void) const =0
 create and return a pointer to a Scrollbar widget for use as horizontal scroll bar
virtual void layoutComponentWidgets ()=0
 Setup size and position for the component widgets attached to this Listbox.
virtual void renderListboxBaseImagery (float z)=0
 Perform rendering of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items.
void addMultiColumnListboxEvents (void)
 Add multi column list box specific events.
virtual void drawSelf (float z)
 Perform the actual rendering for this Window.
void configureScrollbars (void)
 display required integrated scroll bars according to current state of the list box and update their values.
bool selectRange (const MCLGridRef &start, const MCLGridRef &end)
 select all strings between positions start and end. (inclusive). Returns true if something was modified.
float getTotalRowsHeight (void) const
 Return the sum of all row heights.
float getWidestColumnItemWidth (uint col_idx) const
 Return the width of the widest item in the given column.
float getHighestRowItemHeight (uint row_idx) const
 Return the height of the highest item in the given row.
bool clearAllSelections_impl (void)
 Clear the selected state for all items (implementation).
ListboxItemgetItemAtPoint (const Point &pt) const
 Return the ListboxItem under the given window local pixel co-ordinate.
bool setItemSelectState_impl (const MCLGridRef grid_ref, bool state)
 Set select state for the given item. This appropriately selects other items depending upon the select mode. Returns true if something is changed, else false.
void setSelectForItemsInRow (uint row_idx, bool state)
 Set select state for all items in the given row.
void setSelectForItemsInColumn (uint col_idx, bool state)
 Set select state for all items in the given column.
void moveColumn_impl (uint col_idx, uint position)
 Move the column at index col_idx so it is at index position. Implementation version which does not move the header segment (since that may have already happened).
bool resetList_impl (void)
 Remove all items from the list.
virtual void onSelectionModeChanged (WindowEventArgs &e)
 Handler called when the selection mode of the list box changes.
virtual void onNominatedSelectColumnChanged (WindowEventArgs &e)
 Handler called when the nominated selection column changes.
virtual void onNominatedSelectRowChanged (WindowEventArgs &e)
 Handler called when the nominated selection row changes.
virtual void onVertScrollbarModeChanged (WindowEventArgs &e)
 Handler called when the vertical scroll bar 'force' mode is changed.
virtual void onHorzScrollbarModeChanged (WindowEventArgs &e)
 Handler called when the horizontal scroll bar 'force' mode is changed.
virtual void onSelectionChanged (WindowEventArgs &e)
 Handler called when the current selection changes.
virtual void onListContentsChanged (WindowEventArgs &e)
 Handler called when the list contents is changed.
virtual void onSortColumnChanged (WindowEventArgs &e)
 Handler called when the sort column changes.
virtual void onSortDirectionChanged (WindowEventArgs &e)
 Handler called when the sort direction changes.
virtual void onListColumnSized (WindowEventArgs &e)
 Handler called when a column is sized.
virtual void onListColumnMoved (WindowEventArgs &e)
 Handler called when the column order is changed.
virtual void onSized (WindowEventArgs &e)
 Handler called when the window's size changes.
virtual void onMouseButtonDown (MouseEventArgs &e)
 Handler called when a mouse button has been depressed within this window's area.
virtual void onMouseWheel (MouseEventArgs &e)
 Handler called when the mouse wheel (z-axis) position changes within this window's area.
bool handleHeaderScroll (const EventArgs &e)
bool handleHeaderSegMove (const EventArgs &e)
bool handleColumnSizeChange (const EventArgs &e)
bool handleHorzScrollbar (const EventArgs &e)
bool handleSortColumnChange (const EventArgs &e)
bool handleSortDirectionChange (const EventArgs &e)
bool handleHeaderSegDblClick (const EventArgs &e)
virtual void onMoved (WindowEventArgs &e)
 Handler called when the window's position changes.
virtual void onTextChanged (WindowEventArgs &e)
 Handler called when the window's text is changed.
virtual void onFontChanged (WindowEventArgs &e)
 Handler called when the window's font is changed.
virtual void onAlphaChanged (WindowEventArgs &e)
 Handler called when the window's alpha blend value is changed.
virtual void onIDChanged (WindowEventArgs &e)
 Handler called when the window's client assigned ID is changed.
virtual void onShown (WindowEventArgs &e)
 Handler called when the window is shown (made visible).
virtual void onHidden (WindowEventArgs &e)
 Handler called when the window is hidden.
virtual void onEnabled (WindowEventArgs &e)
 Handler called when the window is enabled.
virtual void onDisabled (WindowEventArgs &e)
 Handler called when the window is disabled.
virtual void onMetricsChanged (WindowEventArgs &e)
 Handler called when the window's active metrics system is changed.
virtual void onClippingChanged (WindowEventArgs &e)
 Handler called when the window's setting for being clipped by it's parent is changed.
virtual void onParentDestroyChanged (WindowEventArgs &e)
 Handler called when the window's setting for being destroyed automatically be it's parent is changed.
virtual void onInheritsAlphaChanged (WindowEventArgs &e)
 Handler called when the window's setting for inheriting alpha-blending is changed.
virtual void onAlwaysOnTopChanged (WindowEventArgs &e)
 Handler called when the window's always-on-top setting is changed.
virtual void onCaptureGained (WindowEventArgs &e)
 Handler called when this window gains capture of mouse inputs.
virtual void onCaptureLost (WindowEventArgs &e)
 Handler called when this window loses capture of mouse inputs.
virtual void onRenderingStarted (WindowEventArgs &e)
 Handler called when rendering for this window has started.
virtual void onRenderingEnded (WindowEventArgs &e)
 Handler called when rendering for this window has ended.
virtual void onZChanged (WindowEventArgs &e)
 Handler called when the z-order position of this window has changed.
virtual void onDestructionStarted (WindowEventArgs &e)
 Handler called when this window's destruction sequence has begun.
virtual void onActivated (ActivationEventArgs &e)
 Handler called when this window has become the active window.
virtual void onDeactivated (ActivationEventArgs &e)
 Handler called when this window has lost input focus and has been deactivated.
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 screen size changes.
virtual void onChildAdded (WindowEventArgs &e)
 Handler called when a child window is added to this window.
virtual void onChildRemoved (WindowEventArgs &e)
 Handler called when a child window is removed from this window.
virtual void onMouseEnters (MouseEventArgs &e)
 Handler called when the mouse cursor has entered this window's area.
virtual void onMouseLeaves (MouseEventArgs &e)
 Handler called when the mouse cursor has left this window's area.
virtual void onMouseMove (MouseEventArgs &e)
 Handler called when the mouse cursor has been moved within this window's area.
virtual void onMouseButtonUp (MouseEventArgs &e)
 Handler called when a mouse button has been released within this window's area.
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.
virtual void onMouseDoubleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been double-clicked within this window's area.
virtual void onMouseTripleClicked (MouseEventArgs &e)
 Handler called when a mouse button has been triple-clicked within this window's area.
virtual void onKeyDown (KeyEventArgs &e)
 Handler called when a key as been depressed while this window has input focus.
virtual void onKeyUp (KeyEventArgs &e)
 Handler called when a key as been released while this window has input focus.
virtual void onCharacter (KeyEventArgs &e)
 Handler called when a character-key has been pressed while this window has input focus.
virtual void updateSelf (float elapsed)
 Perform actual update processing for this Window.
void setParent (Window *parent)
 Set the parent window for this window object.
float getParentWidth (void) const
 Return the pixel Width of the parent element. This always returns a valid number.
float getParentHeight (void) const
 Return the pixel Height of the parent element. This always returns a valid number.
Size getParentSize (void) const
 Return the pixel size of the parent element. This always returns a valid object.
Rect absoluteToRelative_impl (const Window *window, const Rect &rect) const
 Return a Rect object that describes, in values relative to window, the absolute area described by rect.
Size absoluteToRelative_impl (const Window *window, const Size &sz) const
Point absoluteToRelative_impl (const Window *window, const Point &pt) const
float absoluteToRelativeX_impl (const Window *window, float x) const
float absoluteToRelativeY_impl (const Window *window, float y) const
Rect relativeToAbsolute_impl (const Window *window, const Rect &rect) const
 Return a Rect object that describes, in absolute values offset from window, the relative area described by rect.
Size relativeToAbsolute_impl (const Window *window, const Size &sz) const
Point relativeToAbsolute_impl (const Window *window, const Point &pt) const
float relativeToAbsoluteX_impl (const Window *window, float x) const
float relativeToAbsoluteY_impl (const Window *window, float y) const
Size getWindowSize_impl (const Window *window) const
MetricsMode getInheritedMetricsMode (void) const
 Return the inherited metrics mode. This is either the metrics mode of our parent, or Relative if we have no parent.
void generateAutoRepeatEvent (MouseButton button)
 Fires off a repeated mouse button down event for this window.
void addStandardEvents (void)
 Add standard CEGUI::Window events.
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.

Static Protected Member Functions

bool pred_descend (const ListRow &a, const ListRow &b)
 std algorithm predicate used for sorting in descending order

Protected Attributes

Scrollbard_vertScrollbar
 vertical scroll-bar widget
Scrollbard_horzScrollbar
 horizontal scroll-bar widget
ListHeaderd_header
 The ListHeader attached to this multi-column list.
bool d_forceVertScroll
 true if vertical scrollbar should always be displayed
bool d_forceHorzScroll
 true if horizontal scrollbar should always be displayed
SelectionMode d_selectMode
 Holds selection mode (represented by settings below).
uint d_nominatedSelectCol
 Nominated column for single column selection.
uint d_nominatedSelectRow
 Nominated row for single row selection.
bool d_multiSelect
 Allow multiple selections.
bool d_fullRowSelect
 All items in a row are selected.
bool d_fullColSelect
 All items in a column are selected.
bool d_useNominatedRow
 true if we use a nominated row to select.
bool d_useNominatedCol
 true if we use a nominated col to select.
ListboxItemd_lastSelected
 holds pointer to the last selected item (used in range selections)
ListItemGrid d_grid
 Holds the list box data.
ChildList d_children
 The list of child Window objects attached to this.
MetricsMode d_metricsMode
 Holds the active metrics mode for this window.
Windowd_oldCapture
 The Window that previously had capture (used for restoreOldCapture mode).
Windowd_parent
 Holds pointer to the parent window.
const 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.
Rect d_abs_area
 This Window objects area (pixels relative to parent).
Rect d_rel_area
 This Window objects area (decimal fractions relative to parent).
const Imaged_mouseCursor
 Holds pointer to the Window objects current mouse cursor image.
void * d_userData
 Holds pointer to some user assigned data.
Size d_minSize
 current minimum size for the window (this is always stored in pixels).
Size d_maxSize
 current maximum size for the window (this is always stored in pixels).
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_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).
const String d_type
 String holding the type name for the Window (is also the name of the WindowFactory that created us).
const String d_name
 The name of the window (GUI system unique).
EventMap d_events
bool d_muted
 true if events for this EventSet have been muted.

Static Protected Attributes

Windowd_captureWindow = NULL
 Window that has captured inputs.
WindowProperties::AbsoluteHeight d_absHeightProperty
WindowProperties::AbsoluteMaxSize d_absMaxSizeProperty
WindowProperties::AbsoluteMinSize d_absMinSizeProperty
WindowProperties::AbsolutePosition d_absPositionProperty
WindowProperties::AbsoluteRect d_absRectProperty
WindowProperties::AbsoluteSize d_absSizeProperty
WindowProperties::AbsoluteWidth d_absWidthProperty
WindowProperties::AbsoluteXPosition d_absXPosProperty
WindowProperties::AbsoluteYPosition d_absYPosProperty
WindowProperties::Alpha d_alphaProperty
WindowProperties::AlwaysOnTop d_alwaysOnTopProperty
WindowProperties::ClippedByParent d_clippedByParentProperty
WindowProperties::DestroyedByParent d_destroyedByParentProperty
WindowProperties::Disabled d_disabledProperty
WindowProperties::Font d_fontProperty
WindowProperties::Height d_heightProperty
WindowProperties::ID d_IDProperty
WindowProperties::InheritsAlpha d_inheritsAlphaProperty
WindowProperties::MetricsMode d_metricsModeProperty
WindowProperties::MouseCursorImage d_mouseCursorProperty
WindowProperties::Position d_positionProperty
WindowProperties::Rect d_rectProperty
WindowProperties::RelativeHeight d_relHeightProperty
WindowProperties::RelativeMaxSize d_relMaxSizeProperty
WindowProperties::RelativeMinSize d_relMinSizeProperty
WindowProperties::RelativePosition d_relPositionProperty
WindowProperties::RelativeRect d_relRectProperty
WindowProperties::RelativeSize d_relSizeProperty
WindowProperties::RelativeWidth d_relWidthProperty
WindowProperties::RelativeXPosition d_relXPosProperty
WindowProperties::RelativeYPosition d_relYPosProperty
WindowProperties::RestoreOldCapture d_restoreOldCaptureProperty
WindowProperties::Size d_sizeProperty
WindowProperties::Text d_textProperty
WindowProperties::Visible d_visibleProperty
WindowProperties::Width d_widthProperty
WindowProperties::XPosition d_xPosProperty
WindowProperties::YPosition d_yPosProperty
WindowProperties::ZOrderChangeEnabled d_zOrderChangeProperty
WindowProperties::WantsMultiClickEvents d_wantsMultiClicksProperty
WindowProperties::MouseButtonDownAutoRepeat d_autoRepeatProperty
WindowProperties::AutoRepeatDelay d_autoRepeatDelayProperty
WindowProperties::AutoRepeatRate d_autoRepeatRateProperty

Friends

class System

Detailed Description

Base class for the multi column list widget.

Definition at line 71 of file CEGUIMultiColumnList.h.


Member Typedef Documentation

typedef std::vector<Window*> CEGUI::Window::ChildList [protected, inherited]
 

Definition at line 2615 of file CEGUIWindow.h.

typedef ConstBaseIterator<EventMap> CEGUI::EventSet::EventIterator [inherited]
 

Definition at line 216 of file CEGUIEventSet.h.

Referenced by CEGUI::EventSet::getIterator().

typedef std::map<String, Event*> CEGUI::EventSet::EventMap [protected, inherited]
 

Definition at line 207 of file CEGUIEventSet.h.

typedef std::vector<ListRow> CEGUI::MultiColumnList::ListItemGrid [protected]
 

Definition at line 1477 of file CEGUIMultiColumnList.h.

typedef ConstBaseIterator<PropertyRegistry> CEGUI::PropertySet::PropertyIterator [inherited]
 

Definition at line 201 of file CEGUIPropertySet.h.

Referenced by CEGUI::PropertySet::getIterator().


Member Enumeration Documentation

enum CEGUI::MultiColumnList::SelectionMode
 

Enumerated values for the selection modes possible with a Multi-column list.

Enumeration values:
RowSingle 
RowMultiple 
CellSingle 
CellMultiple 
NominatedColumnSingle 
NominatedColumnMultiple 
ColumnSingle 
ColumnMultiple 
NominatedRowSingle 
NominatedRowMultiple 

Definition at line 101 of file CEGUIMultiColumnList.h.


Constructor & Destructor Documentation

CEGUI::MultiColumnList::MultiColumnList const String type,
const String name
 

Constructor for the Multi-column list base class.

Definition at line 76 of file CEGUIMultiColumnList.cpp.

References addMultiColumnListboxEvents(), d_selectMode, RowSingle, and setSelectionMode().

CEGUI::MultiColumnList::~MultiColumnList void   )  [virtual]
 

Destructor for the multi-column list base class.

Definition at line 99 of file CEGUIMultiColumnList.cpp.

References resetList_impl().


Member Function Documentation

Rect CEGUI::Window::absoluteToRelative const Rect rect  )  const [inherited]
 

Convert the given area from absolute to relative metrics.

Parameters:
rect Rect object describing the area specified in pixels relative to this Window.
Returns:
A Rect object describing a relative metric area that is equivalent to rect, given the Window objects current size.

Definition at line 1322 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl().

Size CEGUI::Window::absoluteToRelative const Size sze  )  const [inherited]
 

Convert the given size from absolute to relative metrics.

Parameters:
sze Size object that describes a size specified in pixels.
Returns:
A Size object describing a relative metric size that is equivalent to sze, given the Window objects current size.

Definition at line 1313 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl().

Point CEGUI::Window::absoluteToRelative const Point pt  )  const [inherited]
 

Convert the given position from absolute to relative metrics.

Parameters:
pt Point object that describes a position specified in pixels relative to this Window (so 0,0 is this windows top-left corner).
Returns:
A Point object describing a relative metric position that is equivalent to pt, given the Window objects current size.

Definition at line 1304 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), and CEGUI::Point.

Referenced by CEGUI::StaticText::layoutComponentWidgets().

Point CEGUI::Window::absoluteToRelative_impl const Window window,
const Point pt
const [protected, inherited]
 

Definition at line 1877 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Window::getWindowSize_impl(), PixelAligned, and CEGUI::Point.

Size CEGUI::Window::absoluteToRelative_impl const Window window,
const Size sz
const [protected, inherited]
 

Definition at line 1845 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Rect CEGUI::Window::absoluteToRelative_impl const Window window,
const Rect rect
const [protected, inherited]
 

Return a Rect object that describes, in values relative to window, the absolute area described by rect.

Parameters:
window Pointer to a window object that is to be used as the base for the conversion. If this is NULL then the size of the display, as returned by the renderer object, is used.
rect Rect object describing the area, in absolute values, that is to be returned as relative values.
Returns:
Rect object that describes in values relative to window, the same area described as absolute values in rect.

Definition at line 1811 of file CEGUIWindow.cpp.

References CEGUI::Rect::d_bottom, CEGUI::Size::d_height, CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Window::absoluteToRelative(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::Window::getMaximumSize(), CEGUI::Window::getMinimumSize(), CEGUI::FrameWindow::moveBottomEdge(), CEGUI::FrameWindow::moveLeftEdge(), CEGUI::FrameWindow::moveRightEdge(), CEGUI::FrameWindow::moveTopEdge(), CEGUI::FrameWindow::offsetPixelPosition(), CEGUI::Thumb::onMouseMove(), CEGUI::Window::onParentSized(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), and CEGUI::Window::setSize().

float CEGUI::Window::absoluteToRelativeX float  val  )  const [inherited]
 

Convert the given X co-ordinate from absolute to relative metrics.

Parameters:
val X co-ordinate specified in pixels relative to this Window (so 0 is this windows left edge).
Returns:
A relative metric value that is equivalent to val, given the Window objects current width.

Definition at line 1286 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelativeX_impl().

Referenced by autoSizeColumnHeader(), getColumnHeaderWidth(), getTotalColumnHeadersWidth(), handleHorzScrollbar(), insertColumn(), and CEGUI::ListHeader::segmentDragHandler().

float CEGUI::Window::absoluteToRelativeX_impl const Window window,
float  x
const [protected, inherited]
 

Definition at line 1909 of file CEGUIWindow.cpp.

References CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Window::absoluteToRelativeX(), and CEGUI::ListHeaderSegment::doDragSizing().

float CEGUI::Window::absoluteToRelativeY float  val  )  const [inherited]
 

Convert the given Y co-ordinate from absolute to relative metrics.

Parameters:
val Y co-ordinate specified in pixels relative to this Window (so 0 is this windows top edge).
Returns:
A relative metric value that is equivalent to val, given the Window objects current height.

Definition at line 1295 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelativeY_impl().

Referenced by CEGUI::TabControlProperties::RelativeTabTextPadding::getDefault(), CEGUI::TabControl::setAbsoluteTabHeight(), and CEGUI::TabControl::setAbsoluteTabTextPadding().

float CEGUI::Window::absoluteToRelativeY_impl const Window window,
float  y
const [protected, inherited]
 

Definition at line 1928 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Window::absoluteToRelativeY().

void CEGUI::Window::activate void   )  [inherited]
 

Activate the Window giving it input focus and bringing it to the top of all non always-on-top Windows.

Returns:
Nothing

Definition at line 802 of file CEGUIWindow.cpp.

References CEGUI::Window::d_captureWindow, CEGUI::Window::moveToFront(), and CEGUI::Window::onCaptureLost().

Referenced by CEGUI::Combobox::activateEditbox(), CEGUI::Combobox::droplist_SelectionAcceptedHandler(), and CEGUI::Combobox::showDropList().

void CEGUI::Window::addChild_impl Window wnd  )  [protected, virtual, inherited]
 

Add given window to child list at an appropriate position.

Reimplemented in CEGUI::TabControl.

Definition at line 1730 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getParent(), CEGUI::Window::isAlwaysOnTop(), CEGUI::Window::onParentSized(), CEGUI::Window::removeChildWindow(), and CEGUI::Window::setParent().

Referenced by CEGUI::Window::addChildWindow(), CEGUI::Window::moveToFront(), and CEGUI::Window::setAlwaysOnTop().

void CEGUI::Window::addChildWindow Window window  )  [inherited]
 

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.

Parameters:
window Pointer to the Window object to be added.
Returns:
Nothing
Exceptions:
InvalidRequestException thrown if Window window is an ancestor of this Window, to prevent cyclic Window structures.

Definition at line 977 of file CEGUIWindow.cpp.

References CEGUI::Window::addChild_impl(), CEGUI::Window::onChildAdded(), and CEGUI::Window::onZChange_impl().

void CEGUI::Window::addChildWindow const String name  )  [inherited]
 

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.

Parameters:
name String object holding the name of the Window to be added.
Returns:
Nothing.
Exceptions:
UnknownObjectException thrown if no Window named name exists.
InvalidRequestException thrown if Window name is an ancestor of this Window, to prevent cyclic Window structures.

Definition at line 966 of file CEGUIWindow.cpp.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::addTab(), CEGUI::TabControl::initialise(), CEGUI::StaticText::initialise(), CEGUI::Slider::initialise(), CEGUI::Scrollbar::initialise(), CEGUI::MultiLineEditbox::initialise(), initialise(), CEGUI::Listbox::initialise(), CEGUI::FrameWindow::initialise(), CEGUI::Combobox::initialise(), and CEGUI::ListHeader::insertColumn().

void CEGUI::MultiColumnList::addColumn const String text,
uint  col_id,
float  width
 

Add a column to the list box.

Parameters:
text String object containing the text label for the column header.
col_id ID code to be assigned to the column header.
width Initial width to be set for the column using the active metrics mode for this window.
Returns:
Nothing.

Definition at line 658 of file CEGUIMultiColumnList.cpp.

References getColumnCount(), and insertColumn().

void CEGUI::EventSet::addEvent const String name  )  [inherited]
 

Add a new Event to the EventSet with the given name.

Parameters:
name String object containing the name to give the new Event. The name must be unique for the EventSet.
Returns:
Nothing
Exceptions:
AlreadyExistsException Thrown if an Event already exists named name.

Definition at line 54 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, and CEGUI::EventSet::isEventPresent().

Referenced by CEGUI::Checkbox::addCheckboxEvents(), CEGUI::Combobox::addComboboxEvents(), CEGUI::ComboDropList::addComboDropListEvents(), CEGUI::Editbox::addEditboxEvents(), CEGUI::FrameWindow::addFrameWindowEvents(), CEGUI::ListHeaderSegment::addHeaderSegmentEvents(), CEGUI::Listbox::addListboxEvents(), CEGUI::ListHeader::addListHeaderEvents(), CEGUI::MouseCursor::addMouseCursorEvents(), addMultiColumnListboxEvents(), CEGUI::MultiLineEditbox::addMultiLineEditboxEvents(), CEGUI::ProgressBar::addProgressBarEvents(), CEGUI::PushButton::addPushButtonEvents(), CEGUI::RadioButton::addRadioButtonEvents(), CEGUI::Scrollbar::addScrollbarEvents(), CEGUI::Slider::addSliderEvents(), CEGUI::Window::addStandardEvents(), CEGUI::TabButton::addTabButtonEvents(), CEGUI::TabControl::addTabControlEvents(), CEGUI::Thumb::addThumbEvents(), CEGUI::Renderer::Renderer(), and CEGUI::GlobalEventSet::subscribeEvent().

void CEGUI::MultiColumnList::addMultiColumnListboxEvents void   )  [protected]
 

Add multi column list box specific events.

Definition at line 1269 of file CEGUIMultiColumnList.cpp.

References CEGUI::EventSet::addEvent(), EventHorzScrollbarModeChanged, EventListColumnMoved, EventListColumnSized, EventListContentsChanged, EventNominatedSelectColumnChanged, EventNominatedSelectRowChanged, EventSelectionChanged, EventSelectionModeChanged, EventSortColumnChanged, EventSortDirectionChanged, and EventVertScrollbarModeChanged.

Referenced by MultiColumnList().

void CEGUI::PropertySet::addProperty Property property  )  [inherited]
 

Adds a new Property to the PropertySet.

Parameters:
property Pointer to the Property object to be added to the PropertySet.
Returns:
Nothing.
Exceptions:
NullObjectException Thrown if property is NULL.
AlreadyExistsException Thrown if a Property with the same name as property already exists in the PropertySet

Definition at line 37 of file CEGUIPropertySet.cpp.

References CEGUI::Property::getName(), and CEGUI::utf8.

Referenced by CEGUI::Window::addStandardProperties(), and CEGUI::TabControl::addTabControlProperties().

uint CEGUI::MultiColumnList::addRow ListboxItem item,
uint  col_id
 

Add a row to the list box, and set the item in the column with ID col_id to item.

Note:
If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the bottom of the list.
Parameters:
item Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.
col_id ID code of the column whos initial item is to be set to item.
Returns:
Initial zero based index of the new row.
Exceptions:
InvalidRequestException thrown if no column with the specified ID is attached to the list box.

Definition at line 788 of file CEGUIMultiColumnList.cpp.

References d_grid, CEGUI::MultiColumnList::ListRow::d_items, CEGUI::MultiColumnList::ListRow::d_sortColumn, getColumnCount(), getColumnWithID(), getRowCount(), getSortColumn(), getSortDirection(), onListContentsChanged(), CEGUI::ListboxItem::setOwnerWindow(), and CEGUI::uint.

uint CEGUI::MultiColumnList::addRow void   ) 
 

Add an empty row to the list box.

Note:
If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the bottom of the list.
Returns:
Initial zero based index of the new row.

Definition at line 779 of file CEGUIMultiColumnList.cpp.

References CEGUI::uint.

Referenced by insertRow().

void CEGUI::Window::addStandardEvents void   )  [protected, inherited]
 

Add standard CEGUI::Window events.

Definition at line 1683 of file CEGUIWindow.cpp.

References CEGUI::EventSet::addEvent(), CEGUI::Window::EventActivated, CEGUI::Window::EventAlphaChanged, CEGUI::Window::EventAlwaysOnTopChanged, CEGUI::Window::EventCharacterKey, CEGUI::Window::EventChildAdded, CEGUI::Window::EventChildRemoved, CEGUI::Window::EventClippedByParentChanged, CEGUI::Window::EventDeactivated, CEGUI::Window::EventDestroyedByParentChanged, CEGUI::Window::EventDestructionStarted, CEGUI::Window::EventDisabled, CEGUI::Window::EventEnabled, CEGUI::Window::EventFontChanged, CEGUI::Window::EventHidden, CEGUI::Window::EventIDChanged, CEGUI::Window::EventInheritsAlphaChanged, CEGUI::Window::EventInputCaptureGained, CEGUI::Window::EventInputCaptureLost, CEGUI::Window::EventKeyDown, CEGUI::Window::EventKeyUp, CEGUI::Window::EventMetricsModeChanged, CEGUI::Window::EventMouseButtonDown, CEGUI::Window::EventMouseButtonUp, CEGUI::Window::EventMouseClick, CEGUI::Window::EventMouseDoubleClick, CEGUI::Window::EventMouseEnters, CEGUI::Window::EventMouseLeaves, CEGUI::Window::EventMouseMove, CEGUI::Window::EventMouseTripleClick, CEGUI::Window::EventMouseWheel, CEGUI::Window::EventMoved, CEGUI::Window::EventParentSized, CEGUI::Window::EventRenderingEnded, CEGUI::Window::EventRenderingStarted, CEGUI::Window::EventShown, CEGUI::Window::EventSized, CEGUI::Window::EventTextChanged, and CEGUI::Window::EventZOrderChanged.

Referenced by CEGUI::Window::Window().

void CEGUI::Window::addStandardProperties void   )  [protected, inherited]
 

Add standard CEGUI::Window properties.

Definition at line 2539 of file CEGUIWindow.cpp.

References CEGUI::PropertySet::addProperty(), CEGUI::Window::d_absHeightProperty, CEGUI::Window::d_absMaxSizeProperty, CEGUI::Window::d_absMinSizeProperty, CEGUI::Window::d_absPositionProperty, CEGUI::Window::d_absRectProperty, CEGUI::Window::d_absSizeProperty, CEGUI::Window::d_absWidthProperty, CEGUI::Window::d_absXPosProperty, CEGUI::Window::d_absYPosProperty, CEGUI::Window::d_alphaProperty, CEGUI::Window::d_alwaysOnTopProperty, CEGUI::Window::d_autoRepeatDelayProperty, CEGUI::Window::d_autoRepeatProperty, CEGUI::Window::d_autoRepeatRateProperty, CEGUI::Window::d_clippedByParentProperty, CEGUI::Window::d_destroyedByParentProperty, CEGUI::Window::d_disabledProperty, CEGUI::Window::d_fontProperty, CEGUI::Window::d_heightProperty, CEGUI::Window::d_IDProperty, CEGUI::Window::d_inheritsAlphaProperty, CEGUI::Window::d_metricsModeProperty, CEGUI::Window::d_mouseCursorProperty, CEGUI::Window::d_positionProperty, CEGUI::Window::d_rectProperty, CEGUI::Window::d_relHeightProperty, CEGUI::Window::d_relMaxSizeProperty, CEGUI::Window::d_relMinSizeProperty, CEGUI::Window::d_relPositionProperty, CEGUI::Window::d_relRectProperty, CEGUI::Window::d_relSizeProperty, CEGUI::Window::d_relWidthProperty, CEGUI::Window::d_relXPosProperty, CEGUI::Window::d_relYPosProperty, CEGUI::Window::d_restoreOldCaptureProperty, CEGUI::Window::d_sizeProperty, CEGUI::Window::d_textProperty, CEGUI::Window::d_visibleProperty, CEGUI::Window::d_wantsMultiClicksProperty, CEGUI::Window::d_widthProperty, CEGUI::Window::d_xPosProperty, CEGUI::Window::d_yPosProperty, and CEGUI::Window::d_zOrderChangeProperty.

Referenced by CEGUI::Window::Window().

void CEGUI::MultiColumnList::autoSizeColumnHeader uint  col_idx  ) 
 

Automatically determines the "best fit" size for the specified column and sets the column width to the same.

Parameters:
col_idx Zero based index of the column to be sized.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_idx is out of range.

Definition at line 2247 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::absoluteToRelativeX(), ceguimax, getColumnCount(), CEGUI::Window::getMetricsMode(), getWidestColumnItemWidth(), setColumnHeaderWidth(), and CEGUI::utf8.

Referenced by handleHeaderSegDblClick().

bool CEGUI::Window::captureInput void   )  [inherited]
 

Captures input to this window.

Returns:
  • true if input was successfully captured to this window.
  • false if input could not be captured to this window (maybe because the window is not active).

Definition at line 1159 of file CEGUIWindow.cpp.

References CEGUI::Window::d_captureWindow, CEGUI::Window::d_oldCapture, CEGUI::Window::isActive(), CEGUI::Window::onCaptureGained(), and CEGUI::Window::onCaptureLost().

Referenced by CEGUI::Titlebar::onMouseButtonDown(), CEGUI::MultiLineEditbox::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Editbox::onMouseButtonDown(), CEGUI::ButtonBase::onMouseButtonDown(), and CEGUI::Combobox::showDropList().

void CEGUI::Window::cleanupChildren void   )  [protected, virtual, inherited]
 

Cleanup child windows.

Definition at line 1707 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), CEGUI::Window::isDestroyedByParent(), and CEGUI::Window::removeChildWindow().

Referenced by CEGUI::Window::~Window().

void CEGUI::MultiColumnList::clearAllSelections void   ) 
 

Removed the selected state from any currently selected ListboxItem attached to the list.

Returns:
Nothing.

Definition at line 1202 of file CEGUIMultiColumnList.cpp.

References clearAllSelections_impl(), and onSelectionChanged().

Referenced by setNominatedSelectionColumn(), setNominatedSelectionRow(), and setSelectionMode().

bool CEGUI::MultiColumnList::clearAllSelections_impl void   )  [protected]
 

Clear the selected state for all items (implementation).

Returns:
true if some selections were cleared, false nothing was changed.

Definition at line 1495 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isSelected(), CEGUI::ListboxItem::setSelected(), and CEGUI::uint.

Referenced by clearAllSelections(), onMouseButtonDown(), and setItemSelectState_impl().

void CEGUI::PropertySet::clearProperties void   )  [inherited]
 

Removes all Property objects from the PropertySet.

Returns:
Nothing.

Definition at line 68 of file CEGUIPropertySet.cpp.

void CEGUI::MultiColumnList::configureScrollbars void   )  [protected]
 

display required integrated scroll bars according to current state of the list box and update their values.

Definition at line 1284 of file CEGUIMultiColumnList.cpp.

References ceguimax, d_header, d_horzScrollbar, d_vertScrollbar, CEGUI::Rect::getHeight(), getListRenderArea(), CEGUI::Scrollbar::getScrollPosition(), getTotalRowsHeight(), CEGUI::ListHeader::getTotalSegmentsPixelExtent(), CEGUI::Rect::getWidth(), CEGUI::Window::hide(), CEGUI::Scrollbar::setDocumentSize(), CEGUI::Scrollbar::setPageSize(), CEGUI::Scrollbar::setScrollPosition(), CEGUI::Scrollbar::setStepSize(), and CEGUI::Window::show().

Referenced by handleColumnSizeChange(), handleUpdatedItemData(), initialise(), onListColumnSized(), onListContentsChanged(), onSized(), setShowHorzScrollbar(), and setShowVertScrollbar().

virtual Scrollbar* CEGUI::MultiColumnList::createHorzScrollbar void   )  const [protected, pure virtual]
 

create and return a pointer to a Scrollbar widget for use as horizontal scroll bar

Returns:
Pointer to a Scrollbar to be used for scrolling the list horizontally.

Referenced by initialise().

virtual ListHeader* CEGUI::MultiColumnList::createListHeader void   )  const [protected, pure virtual]
 

create and return a pointer to a ListHeaer widget for use as the column headers.

Returns:
Pointer to a ListHeader based object.

Referenced by initialise().

virtual Scrollbar* CEGUI::MultiColumnList::createVertScrollbar void   )  const [protected, pure virtual]
 

create and return a pointer to a Scrollbar widget for use as vertical scroll bar

Returns:
Pointer to a Scrollbar to be used for scrolling the list vertically.

Referenced by initialise().

void CEGUI::Window::deactivate void   )  [inherited]
 

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.

Returns:
Nothing.

Definition at line 825 of file CEGUIWindow.cpp.

References CEGUI::Window::onDeactivated(), and CEGUI::ActivationEventArgs::otherWindow.

void CEGUI::Window::disable void   )  [inline, inherited]
 

disable the Window to prevent interaction.

Returns:
Nothing

Definition at line 1094 of file CEGUIWindow.h.

void CEGUI::MultiColumnList::drawSelf float  z  )  [protected, virtual]
 

Perform the actual rendering for this Window.

Parameters:
z float value specifying the base Z co-ordinate that should be used when rendering
Returns:
Nothing

Implements CEGUI::Window.

Definition at line 1714 of file CEGUIMultiColumnList.cpp.

References d_grid, d_header, CEGUI::Size::d_height, d_horzScrollbar, CEGUI::Rect::d_left, CEGUI::Rect::d_top, d_vertScrollbar, CEGUI::Size::d_width, CEGUI::Vector3::d_x, CEGUI::Vector3::d_y, CEGUI::Vector3::d_z, CEGUI::ListboxItem::draw(), getColumnCount(), CEGUI::ListHeader::getColumnPixelWidth(), CEGUI::Window::getEffectiveAlpha(), getHighestRowItemHeight(), CEGUI::Rect::getIntersection(), getListRenderArea(), CEGUI::Window::getPosition(), getRowCount(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Window::getUnclippedPixelRect(), CEGUI::Rect::getWidth(), CEGUI::Rect::offset(), PixelAligned, renderListboxBaseImagery(), CEGUI::Rect::setSize(), and CEGUI::uint.

void CEGUI::Window::enable void   )  [inline, inherited]
 

enable the Window to allow interaction.

Returns:
Nothing

Definition at line 1084 of file CEGUIWindow.h.

ListboxItem * CEGUI::MultiColumnList::findColumnItemWithText const String text,
uint  col_idx,
const ListboxItem start_item
const
 

Return the ListboxItem in column col_idx that has the text string text.

Parameters:
text String object containing the text to be searched for.
col_idx Zero based index of the column to be searched.
start_item Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the top of the column.
Returns:
Pointer to the first ListboxItem in column col_idx, after start_item, that has the string text.
Exceptions:
InvalidRequestException thrown if start_item is not attached to the list box, or if col_idx is out of range.

Definition at line 384 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getItemRowIndex(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

ListboxItem * CEGUI::MultiColumnList::findListItemWithText const String text,
const ListboxItem start_item
const
 

Return the ListboxItem that has the text string text.

Note:
List box searching progresses across the columns in each row.
Parameters:
text String object containing the text to be searched for.
start_item Pointer to the ListboxItem where the exclusive search is to start, or NULL to search the whole list box.
Returns:
Pointer to the first ListboxItem, after start_item, that has the string text.
Exceptions:
InvalidRequestException thrown if start_item is not attached to the list box.

Definition at line 448 of file CEGUIMultiColumnList.cpp.

References CEGUI::MCLGridRef::column, d_grid, getColumnCount(), getItemGridReference(), getRowCount(), CEGUI::MCLGridRef::row, and CEGUI::uint.

ListboxItem * CEGUI::MultiColumnList::findRowItemWithText const String text,
uint  row_idx,
const ListboxItem start_item
const
 

Return the ListboxItem in row row_idx that has the text string text.

Parameters:
text String object containing the text to be searched for.
row_idx Zero based index of the row to be searched.
start_item Pointer to the ListboxItem where the exclusive search is to start, or NULL to search from the start of the row.
Returns:
Pointer to the first ListboxItem in row row_idx, after start_item, that has the string text.
Exceptions:
InvalidRequestException thrown if start_item is not attached to the list box, or if row_idx is out of range.

Definition at line 415 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getItemColumnIndex(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

void CEGUI::EventSet::fireEvent const String name,
EventArgs args,
const String eventNamespace = ""
[virtual, inherited]
 

Fires the named event passing the given EventArgs object.

Parameters:
name String object holding the name of the Event that is to be fired (triggered)
args The EventArgs (or derived) object that is to be bassed to each subscriber of the Event. Once all subscribers have been called the 'handled' field of the event is updated appropriately.
eventNamespace String object describing the global event namespace prefix for this event.
Returns:
Nothing.
Exceptions:
UnknownObjectException Thrown if no Event named name was found in the EventSet.

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 141 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::Window::onActivated(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onAlwaysOnTopChanged(), CEGUI::Window::onCaptureGained(), CEGUI::Window::onCaptureLost(), CEGUI::MultiLineEditbox::onCaratMoved(), CEGUI::Editbox::onCaratMoved(), CEGUI::Combobox::onCaratMoved(), CEGUI::Window::onCharacter(), CEGUI::Window::onChildAdded(), CEGUI::Window::onChildRemoved(), CEGUI::ListHeaderSegment::onClickableSettingChanged(), CEGUI::TabButton::onClicked(), CEGUI::PushButton::onClicked(), CEGUI::Window::onClippingChanged(), CEGUI::FrameWindow::onCloseClicked(), CEGUI::Window::onDeactivated(), CEGUI::Window::onDestructionStarted(), CEGUI::Window::onDisabled(), CEGUI::ListHeader::onDragMoveSettingChanged(), CEGUI::ListHeader::onDragSizeSettingChanged(), CEGUI::Combobox::onDropListDisplayed(), CEGUI::Combobox::onDroplistRemoved(), CEGUI::MultiLineEditbox::onEditboxFullEvent(), CEGUI::Editbox::onEditboxFullEvent(), CEGUI::Combobox::onEditboxFullEvent(), CEGUI::Window::onEnabled(), CEGUI::Window::onFontChanged(), CEGUI::Window::onHidden(), CEGUI::MultiLineEditbox::onHorzScrollbarModeChanged(), onHorzScrollbarModeChanged(), CEGUI::Listbox::onHorzScrollbarModeChanged(), CEGUI::Combobox::onHorzScrollbarModeChanged(), CEGUI::Window::onIDChanged(), CEGUI::MouseCursor::onImageChanged(), CEGUI::Window::onInheritsAlphaChanged(), CEGUI::Editbox::onInvalidEntryAttempted(), CEGUI::Combobox::onInvalidEntryAttempted(), CEGUI::Window::onKeyDown(), CEGUI::Window::onKeyUp(), onListColumnMoved(), onListColumnSized(), onListContentsChanged(), CEGUI::Listbox::onListContentsChanged(), CEGUI::Combobox::onListContentsChanged(), CEGUI::ComboDropList::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionChanged(), CEGUI::Editbox::onMaskCodePointChanged(), CEGUI::Editbox::onMaskedRenderingModeChanged(), CEGUI::MultiLineEditbox::onMaximumTextLengthChanged(), CEGUI::Editbox::onMaximumTextLengthChanged(), CEGUI::Combobox::onMaximumTextLengthChanged(), CEGUI::Window::onMetricsChanged(), CEGUI::Window::onMouseButtonDown(), CEGUI::Window::onMouseButtonUp(), CEGUI::Window::onMouseClicked(), CEGUI::Window::onMouseDoubleClicked(), CEGUI::Window::onMouseEnters(), CEGUI::Window::onMouseLeaves(), CEGUI::Window::onMouseMove(), CEGUI::Window::onMouseTripleClicked(), CEGUI::Window::onMouseWheel(), CEGUI::ListHeaderSegment::onMovableSettingChanged(), CEGUI::Window::onMoved(), CEGUI::Listbox::onMultiselectModeChanged(), onNominatedSelectColumnChanged(), onNominatedSelectRowChanged(), CEGUI::Window::onParentDestroyChanged(), CEGUI::Window::onParentSized(), CEGUI::ProgressBar::onProgressChanged(), CEGUI::ProgressBar::onProgressDone(), CEGUI::MultiLineEditbox::onReadOnlyChanged(), CEGUI::Editbox::onReadOnlyChanged(), CEGUI::Combobox::onReadOnlyChanged(), CEGUI::Window::onRenderingEnded(), CEGUI::Window::onRenderingStarted(), CEGUI::FrameWindow::onRollupToggled(), CEGUI::Scrollbar::onScrollConfigChanged(), CEGUI::Scrollbar::onScrollPositionChanged(), CEGUI::ListHeader::onSegmentAdded(), CEGUI::ListHeaderSegment::onSegmentClicked(), CEGUI::ListHeader::onSegmentClicked(), CEGUI::ListHeaderSegment::onSegmentDragPositionChanged(), CEGUI::ListHeaderSegment::onSegmentDragStart(), CEGUI::ListHeaderSegment::onSegmentDragStop(), CEGUI::ListHeader::onSegmentOffsetChanged(), CEGUI::ListHeader::onSegmentRemoved(), CEGUI::ListHeader::onSegmentSequenceChanged(), CEGUI::ListHeaderSegment::onSegmentSized(), CEGUI::ListHeader::onSegmentSized(), CEGUI::TabControl::onSelectionChanged(), onSelectionChanged(), CEGUI::Listbox::onSelectionChanged(), onSelectionModeChanged(), CEGUI::Checkbox::onSelectStateChange(), CEGUI::RadioButton::onSelectStateChanged(), CEGUI::Window::onShown(), CEGUI::Window::onSized(), CEGUI::ListHeaderSegment::onSizingSettingChanged(), onSortColumnChanged(), CEGUI::ListHeader::onSortColumnChanged(), onSortDirectionChanged(), CEGUI::ListHeaderSegment::onSortDirectionChanged(), CEGUI::ListHeader::onSortDirectionChanged(), CEGUI::Listbox::onSortModeChanged(), CEGUI::Combobox::onSortModeChanged(), CEGUI::ListHeader::onSortSettingChanged(), CEGUI::ListHeaderSegment::onSplitterDoubleClicked(), CEGUI::ListHeader::onSplitterDoubleClicked(), CEGUI::Editbox::onTextAcceptedEvent(), CEGUI::Combobox::onTextAcceptedEvent(), CEGUI::Window::onTextChanged(), CEGUI::Editbox::onTextInvalidatedEvent(), CEGUI::Combobox::onTextInvalidatedEvent(), CEGUI::MultiLineEditbox::onTextSelectionChanged(), CEGUI::Editbox::onTextSelectionChanged(), CEGUI::Combobox::onTextSelectionChanged(), CEGUI::Thumb::onThumbPositionChanged(), CEGUI::Thumb::onThumbTrackEnded(), CEGUI::Slider::onThumbTrackEnded(), CEGUI::Scrollbar::onThumbTrackEnded(), CEGUI::Thumb::onThumbTrackStarted(), CEGUI::Slider::onThumbTrackStarted(), CEGUI::Scrollbar::onThumbTrackStarted(), CEGUI::Editbox::onValidationStringChanged(), CEGUI::Combobox::onValidationStringChanged(), CEGUI::Slider::onValueChanged(), CEGUI::MultiLineEditbox::onVertScrollbarModeChanged(), onVertScrollbarModeChanged(), CEGUI::Listbox::onVertScrollbarModeChanged(), CEGUI::Combobox::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onWordWrapModeChanged(), CEGUI::Window::onZChanged(), CEGUI::DirectX81Renderer::setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().

void CEGUI::Window::generateAutoRepeatEvent MouseButton  button  )  [protected, inherited]
 

Fires off a repeated mouse button down event for this window.

Definition at line 2524 of file CEGUIWindow.cpp.

References CEGUI::MouseEventArgs::button, CEGUI::MouseEventArgs::moveDelta, CEGUI::Window::onMouseButtonDown(), CEGUI::MouseEventArgs::position, CEGUI::MouseEventArgs::sysKeys, and CEGUI::MouseEventArgs::wheelChange.

Referenced by CEGUI::Window::updateSelf().

float CEGUI::Window::getAbsoluteHeight void   )  const [inline, inherited]
 

Return the window height in absolute metrics.

Returns:
float value describing this windows height in absolute metrics.

Definition at line 848 of file CEGUIWindow.h.

Referenced by CEGUI::StaticText::getTextRenderArea().

Point CEGUI::Window::getAbsolutePosition void   )  const [inline, inherited]
 

Return the window position in absolute metrics.

Returns:
Point object describing this windows position, relative to the parent window, in absolute metrics.

Definition at line 798 of file CEGUIWindow.h.

References CEGUI::Point.

Rect CEGUI::Window::getAbsoluteRect void   )  const [inline, inherited]
 

Return the window area rect in absolute metrics.

Returns:
Rect object describing this windows area, relative to the parent window, in absolute metrics

Definition at line 788 of file CEGUIWindow.h.

Size CEGUI::Window::getAbsoluteSize void   )  const [inline, inherited]
 

Return the window size in absolute metrics.

Returns:
Size object describing this windows size in absolute metrics.

Definition at line 828 of file CEGUIWindow.h.

Referenced by CEGUI::StaticText::layoutComponentWidgets(), and CEGUI::Static::onSized().

float CEGUI::Window::getAbsoluteWidth void   )  const [inline, inherited]
 

Return the window width in absolute metrics.

Returns:
float value describing this windows width in absolute metrics.

Definition at line 838 of file CEGUIWindow.h.

Referenced by CEGUI::StaticText::getTextRenderArea(), CEGUI::ListHeaderSegment::onMouseMove(), and CEGUI::ListHeader::segmentDragHandler().

float CEGUI::Window::getAbsoluteXPosition void   )  const [inline, inherited]
 

Return the window X position in absolute metrics.

Returns:
float value describing this windows X position, relative to the parent window, in absolute metrics.

Definition at line 808 of file CEGUIWindow.h.

float CEGUI::Window::getAbsoluteYPosition void   )  const [inline, inherited]
 

Return the window Y position in absolute metrics.

Returns:
float value describing this windows Y position, relative to the parent window, in absolute metrics.

Definition at line 818 of file CEGUIWindow.h.

const Window * CEGUI::Window::getActiveChild void   )  const [inherited]
 

Definition at line 364 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getActiveChild(), CEGUI::Window::getChildCount(), CEGUI::Window::isActive(), and CEGUI::uint.

Window * CEGUI::Window::getActiveChild void   )  [inherited]
 

return a pointer to the Window that currently has input focus starting with this Window.

Returns:
Pointer to the window that is active (has input focus) starting at 'this. Will return 'this' if this Window is active and either no children are attached or if none of the attached children are active. Returns NULL if this Window (and therefore all children) are not active.

Definition at line 354 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::getActiveChild(), CEGUI::System::injectChar(), CEGUI::System::injectKeyDown(), and CEGUI::System::injectKeyUp().

float CEGUI::Window::getAlpha void   )  const [inline, inherited]
 

return the current alpha value set for this Window

Note:
The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.
Returns:
the currently set alpha value for this Window. Will be between 0.0f and 1.0f.

Definition at line 456 of file CEGUIWindow.h.

float CEGUI::Window::getAutoRepeatDelay void   )  const [inherited]
 

Return the current auto-repeat delay setting for this window.

Returns:
float value indicating the delay, in seconds, defore the first repeat mouse button down event will be triggered when autorepeat is enabled.

Definition at line 2648 of file CEGUIWindow.cpp.

float CEGUI::Window::getAutoRepeatRate void   )  const [inherited]
 

Return the current auto-repeat rate setting for this window.

Returns:
float value indicating the rate, in seconds, at which repeat mouse button down events will be generated after the initial delay has expired.

Definition at line 2657 of file CEGUIWindow.cpp.

Window* CEGUI::Window::getCaptureWindow void   )  [inline, static, inherited]
 

return the Window that currently has inputs captured.

Returns:
Pointer to the Window object that currently has inputs captured, or NULL if no Window has captured input.

Definition at line 534 of file CEGUIWindow.h.

Referenced by CEGUI::ButtonBase::updateInternalState().

Window * CEGUI::Window::getChild uint  ID  )  const [inherited]
 

return a pointer to the first attached child window with the specified ID.

This function will throw an exception if no child object with the given ID is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

Parameters:
ID uint value specifying the ID code of the window to return a pointer to.
Returns:
Pointer to the (first) Window object attached to this window that has the ID code ID.
Exceptions:
UnknownObjectException thrown if no window with the ID code ID is attached to this Window.

Definition at line 330 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::d_name, CEGUI::Window::getChildCount(), and CEGUI::uint.

Window * CEGUI::Window::getChild const String name  )  const [inherited]
 

return a pointer to the child window with the specified name.

This function will throw an exception if no child object with the given name is attached. This decision was made (over returning NULL if no window was found) so that client code can assume that if the call returns it has a valid window pointer. We provide the isChild() functions for checking if a given window is attached.

Parameters:
name String object holding the name of the child window to return a pointer to.
Returns:
Pointer to the Window object attached to this window that has the name name.
Exceptions:
UnknownObjectException thrown if no window named name is attached to this Window.

Definition at line 309 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::d_name, CEGUI::Window::getChildCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by CEGUI::TabControl::getTabContents(), CEGUI::TabControl::handleContentWindowTextChanged(), CEGUI::TabControl::removeButtonForTabContent(), CEGUI::TabControl::removeTab(), and CEGUI::TabControl::setSelectedTab().

Window* CEGUI::Window::getChildAtIdx uint  idx  )  const [inline, inherited]
 

return a pointer to the child window that is attached to 'this' at the given index.

Note:
Window indeces are of limited value to client code, since any time a window is added, removed, or it's z-order is changed the indeces all change.
Parameters:
idx Index of the child window whos pointer should be returned. This value is not bounds checked, client code should ensure that this is less than the value returned by getChildCount().
Returns:
Pointer to the child window currently attached at index position idx

Definition at line 358 of file CEGUIWindow.h.

Referenced by CEGUI::RadioButton::deselectOtherButtonsInGroup(), CEGUI::RadioButton::getSelectedButtonInGroup(), CEGUI::TabControl::getTabContentsAtIndex(), and CEGUI::TabControl::removeTab().

Window * CEGUI::Window::getChildAtPosition const Point position  )  const [inherited]
 

return the child Window that is 'hit' by the given position

Parameters:
position Point object that describes the position to check in screen pixels
Returns:
Pointer to the child Window that was hit according to the Point position, or NULL if no child window was hit.

Definition at line 594 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, and CEGUI::Point.

Referenced by CEGUI::TabButton::onMouseButtonUp(), CEGUI::RadioButton::onMouseButtonUp(), CEGUI::PushButton::onMouseButtonUp(), CEGUI::ComboDropList::onMouseButtonUp(), CEGUI::Checkbox::onMouseButtonUp(), CEGUI::ComboDropList::onMouseMove(), and CEGUI::ButtonBase::updateInternalState().

uint CEGUI::Window::getChildCount void   )  const [inline, inherited]
 

return the number of child Window objects currently attached to this Window.

Returns:
uint value equal to the number of Window objects directly attached to this Window as children.

Definition at line 257 of file CEGUIWindow.h.

References CEGUI::uint.

Referenced by CEGUI::Window::cleanupChildren(), CEGUI::RadioButton::deselectOtherButtonsInGroup(), CEGUI::Window::getActiveChild(), CEGUI::Window::getChild(), CEGUI::RadioButton::getSelectedButtonInGroup(), CEGUI::TabControl::getTabCount(), CEGUI::Window::isChild(), CEGUI::Window::moveToFront(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onDeactivated(), CEGUI::Window::onSized(), CEGUI::Window::onZChange_impl(), CEGUI::Window::removeChildWindow(), CEGUI::Window::render(), CEGUI::Window::setRestoreCapture(), and CEGUI::Window::update().

uint CEGUI::MultiColumnList::getColumnCount void   )  const
 

Return the number of columns in the multi-column list.

Returns:
uint value equal to the number of columns in the list.

Definition at line 137 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::ListHeader::getColumnCount(), and CEGUI::uint.

Referenced by addColumn(), addRow(), autoSizeColumnHeader(), clearAllSelections_impl(), drawSelf(), findColumnItemWithText(), findListItemWithText(), findRowItemWithText(), getHighestRowItemHeight(), getItemAtGridReference(), getItemAtPoint(), getItemColumnIndex(), getNextSelected(), getSelectedCount(), getWidestColumnItemWidth(), insertColumn(), insertRow(), isListboxItemInColumn(), isListboxItemInList(), isListboxItemInRow(), moveColumn_impl(), removeColumn(), removeRow(), resetList_impl(), setItem(), setItemSelectState_impl(), and setSelectForItemsInRow().

float CEGUI::MultiColumnList::getColumnHeaderWidth uint  col_idx  )  const
 

Return the width of the specified column header (and therefore the column itself).

Parameters:
col_idx Zero based column index of the column whos width is to be returned.
Returns:
Width of the column header at the zero based column index specified by col_idx, in whichever is the active metrics system.
Exceptions:
InvalidRequestException thrown if column is out of range.

Definition at line 200 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::absoluteToRelativeX(), d_header, CEGUI::ListHeader::getColumnPixelWidth(), and CEGUI::Window::getMetricsMode().

uint CEGUI::MultiColumnList::getColumnID uint  col_idx  )  const
 

Return the ID code assigned to the requested column.

Parameters:
col_idx Zero based index of the column whos ID code is to be returned.
Returns:
Current ID code assigned to the column at the requested index.
Exceptions:
InvalidRequestException thrown if col_idx is out of range

Definition at line 2150 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::Window::getID(), CEGUI::ListHeader::getSegmentFromColumn(), and CEGUI::uint.

Referenced by CEGUI::MultiColumnListProperties::SortColumnID::get().

uint CEGUI::MultiColumnList::getColumnWithHeaderText const String text  )  const
 

Return the zero based index of the column whos header text matches the specified text.

Parameters:
text String object containing the text to be searched for.
Returns:
Zero based column index of the column whos header has the specified text.
Exceptions:
InvalidRequestException thrown if no columns header has the requested text.

Definition at line 175 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::ListHeader::getColumnWithText(), and CEGUI::uint.

uint CEGUI::MultiColumnList::getColumnWithID uint  col_id  )  const
 

Return the zero based column index of the column with the specified ID.

Parameters:
col_id ID code of the column whos index is to be returned.
Returns:
Zero based column index of the first column whos ID matches col_id.
Exceptions:
InvalidRequestException thrown if no attached column has the requested ID.

Definition at line 165 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::ListHeader::getColumnFromID(), and CEGUI::uint.

Referenced by addRow(), moveColumnWithID(), removeColumnWithID(), setItem(), and setNominatedSelectionColumnID().

float CEGUI::Window::getEffectiveAlpha void   )  const [inherited]
 

return the effective alpha value that will be used when rendering this window, taking into account inheritance of parent window(s) alpha.

Returns:
the effective alpha that will be applied to this Window when rendering. Will be between 0.0f and 1.0f.

Definition at line 475 of file CEGUIWindow.cpp.

References CEGUI::Window::d_alpha, CEGUI::Window::d_parent, and CEGUI::Window::inheritsAlpha().

Referenced by CEGUI::StaticText::drawSelf(), CEGUI::Static::drawSelf(), drawSelf(), CEGUI::Listbox::drawSelf(), CEGUI::MultiLineEditbox::renderTextLines(), CEGUI::Window::setInheritsAlpha(), CEGUI::Static::updateRenderableFrameColours(), and CEGUI::StaticImage::updateRenderableImageColours().

ListboxItem * CEGUI::MultiColumnList::getFirstSelectedItem void   )  const
 

Return a pointer to the first selected ListboxItem attached to this list box.

Note:
List box searching progresses across the columns in each row.
Returns:
Pointer to the first ListboxItem attached to this list box that is selected, or NULL if no item is selected.

Definition at line 483 of file CEGUIMultiColumnList.cpp.

References getNextSelected().

const Font * CEGUI::Window::getFont void   )  const [inherited]
 

return the Font object active for the Window.

Returns:
Pointer to the Font being used by this Window. If the window has no assigned font, the default font is returned.

Definition at line 459 of file CEGUIWindow.cpp.

References CEGUI::Window::d_font.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::calculateTabButtonSizePosition(), CEGUI::StaticText::configureScrollbars(), CEGUI::MultiLineEditbox::configureScrollbars(), CEGUI::StaticText::drawSelf(), CEGUI::MultiLineEditbox::ensureCaratIsVisible(), CEGUI::MultiLineEditbox::formatText(), CEGUI::ListboxTextItem::getFont(), CEGUI::MultiLineEditbox::getTextIndexFromPosition(), CEGUI::FrameWindow::getTitlebarFont(), CEGUI::MultiLineEditbox::handleLineDown(), CEGUI::MultiLineEditbox::handleLineUp(), CEGUI::Combobox::initialise(), CEGUI::MultiLineEditbox::onCharacter(), CEGUI::Editbox::onCharacter(), CEGUI::TabControl::onFontChanged(), CEGUI::Combobox::onFontChanged(), CEGUI::MultiLineEditbox::renderTextLines(), and CEGUI::Window::setFont().

ListHeaderSegment & CEGUI::MultiColumnList::getHeaderSegmentForColumn uint  col_idx  )  const
 

Return the ListHeaderSegment object for the specified column.

Parameters:
col_idx zero based index of the column whos ListHeaderSegment is to be returned.
Returns:
ListHeaderSegment object for the column at the requested index.
Exceptions:
InvalidRequestException thrown if col_idx is out of range.

Definition at line 225 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::getSegmentFromColumn().

float CEGUI::Window::getHeight MetricsMode  mode  )  const [inherited]
 

return the height of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
float value that specifies the height of the Window using the specified MetricsMode.

Definition at line 2316 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Rect::getHeight(), and CEGUI::Window::getInheritedMetricsMode().

float CEGUI::Window::getHeight void   )  const [inherited]
 

return the height of the Window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
float value that specifies the height of the Window. Depending upon the metrics system in use for this window, the return value will either be in pixels, or as a decimal fraction of the height of the parent Window.

Definition at line 710 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Rect::getHeight(), and CEGUI::Window::getMetricsMode().

Referenced by CEGUI::Window::setWidth().

float CEGUI::MultiColumnList::getHighestRowItemHeight uint  row_idx  )  const [protected]
 

Return the height of the highest item in the given row.

Definition at line 1454 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), CEGUI::ListboxItem::getPixelSize(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by drawSelf(), getItemAtPoint(), and getTotalRowsHeight().

uint CEGUI::Window::getID void   )  const [inline, inherited]
 

return the ID code currently assigned to this Window by client code.

Returns:
uint value equal to the currently assigned ID code for this Window.

Definition at line 247 of file CEGUIWindow.h.

References CEGUI::uint.

Referenced by getColumnID(), getNominatedSelectionColumnID(), CEGUI::Window::isAncestor(), and setSortColumnByID().

MetricsMode CEGUI::Window::getInheritedMetricsMode void   )  const [protected, inherited]
 

Return the inherited metrics mode. This is either the metrics mode of our parent, or Relative if we have no parent.

Definition at line 2215 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, CEGUI::Window::getMetricsMode(), CEGUI::MetricsMode, and CEGUI::Relative.

Referenced by CEGUI::Window::getHeight(), CEGUI::Window::getMetricsMode(), CEGUI::Window::getPosition(), CEGUI::Window::getRect(), CEGUI::Window::getSize(), CEGUI::Window::getWidth(), CEGUI::Window::getXPosition(), CEGUI::Window::getYPosition(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), and CEGUI::Window::setSize().

Rect CEGUI::Window::getInnerRect void   )  const [inherited]
 

return a Rect object describing the clipped inner area for this window.

Returns:
Rect object that describes, in appropriately clipped screen pixel co-ordinates, the window object's inner rect area.

Definition at line 525 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, CEGUI::Rect::getIntersection(), CEGUI::Window::getRect(), CEGUI::Window::getUnclippedInnerRect(), and CEGUI::Window::isClippedByParent().

Referenced by CEGUI::Window::getPixelRect(), and CEGUI::Titlebar::onMouseButtonDown().

ListboxItem * CEGUI::MultiColumnList::getItemAtGridReference const MCLGridRef grid_ref  )  const
 

Return a pointer to the ListboxItem at the specified grid reference.

Parameters:
grid_ref MCLGridRef object that describes the position of the ListboxItem to be returned.
Returns:
Pointer to the ListboxItem at grid reference grid_ref.
Exceptions:
InvalidRequestException thrown if grid_ref is invalid for this list box.

Definition at line 282 of file CEGUIMultiColumnList.cpp.

References CEGUI::MCLGridRef::column, d_grid, getColumnCount(), getRowCount(), CEGUI::MCLGridRef::row, and CEGUI::utf8.

Referenced by isItemSelected().

ListboxItem * CEGUI::MultiColumnList::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.

Definition at line 1526 of file CEGUIMultiColumnList.cpp.

References d_grid, d_header, d_horzScrollbar, CEGUI::Rect::d_left, CEGUI::Rect::d_top, d_vertScrollbar, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, getColumnCount(), CEGUI::ListHeader::getColumnPixelWidth(), getHighestRowItemHeight(), getListRenderArea(), getRowCount(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Point, and CEGUI::uint.

Referenced by onMouseButtonDown().

uint CEGUI::MultiColumnList::getItemColumnIndex const ListboxItem item  )  const
 

Return the current zero based index of the column that contains item.

Parameters:
item Pointer to the ListboxItem that the column index is to returned for.
Returns:
Zero based index of the column that contains ListboxItem item.
Exceptions:
InvalidRequestException thrown if item is not attached to the list box.

Definition at line 253 of file CEGUIMultiColumnList.cpp.

References getColumnCount(), isListboxItemInColumn(), CEGUI::uint, and CEGUI::utf8.

Referenced by findRowItemWithText(), and getItemGridReference().

MCLGridRef CEGUI::MultiColumnList::getItemGridReference const ListboxItem item  )  const
 

Return the grid reference for item.

Parameters:
item Pointer to the ListboxItem whos current grid reference is to be returned.
Returns:
MCLGridRef object describing the current grid reference of ListboxItem item.
Exceptions:
InvalidRequestException thrown if item is not attached to the list box.

Definition at line 272 of file CEGUIMultiColumnList.cpp.

References getItemColumnIndex(), and getItemRowIndex().

Referenced by findListItemWithText(), getNextSelected(), onMouseButtonDown(), selectRange(), and setItemSelectState().

uint CEGUI::MultiColumnList::getItemRowIndex const ListboxItem item  )  const
 

Return the zero based index of the Row that contains item.

Parameters:
item Pointer to the ListboxItem that the row index is to returned for.
Returns:
Zero based index of the row that contains ListboxItem item.
Exceptions:
InvalidRequestException thrown if item is not attached to the list box.

Definition at line 234 of file CEGUIMultiColumnList.cpp.

References getRowCount(), isListboxItemInRow(), CEGUI::uint, and CEGUI::utf8.

Referenced by findColumnItemWithText(), and getItemGridReference().

EventSet::EventIterator CEGUI::EventSet::getIterator void   )  const [inherited]
 

Return a EventSet::EventIterator object to iterate over the available events.

Definition at line 183 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, and CEGUI::EventSet::EventIterator.

PropertySet::PropertyIterator CEGUI::PropertySet::getIterator void   )  const [inherited]
 

Return a PropertySet::PropertyIterator object to iterate over the available Properties.

Definition at line 131 of file CEGUIPropertySet.cpp.

References CEGUI::PropertySet::PropertyIterator.

virtual Rect CEGUI::MultiColumnList::getListRenderArea void   )  const [protected, pure 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.

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

Size CEGUI::Window::getMaximumSize void   )  const [inherited]
 

Return the current maximum size for this window.

Returns:
Size object describing the maximum size for this window. If using absolute co-ordinates the returned object has it's values expressed as screen pixels. If using relative co-ordinates the returned object has it's values expressed as fractions of the current display size.

Definition at line 2035 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Window::d_maxSize, and CEGUI::Window::getMetricsMode().

MetricsMode CEGUI::Window::getMetricsMode void   )  const [inherited]
 

return the current metrics mode employed by the Window

Returns:
One of the values of the MectricsMode enumerated type, that describes the current metrics in use by the Window.

Definition at line 635 of file CEGUIWindow.cpp.

References CEGUI::Window::d_metricsMode, CEGUI::Window::getInheritedMetricsMode(), and CEGUI::MetricsMode.

Referenced by autoSizeColumnHeader(), getColumnHeaderWidth(), CEGUI::Window::getHeight(), CEGUI::Window::getInheritedMetricsMode(), CEGUI::Window::getMaximumSize(), CEGUI::Window::getMinimumSize(), CEGUI::Window::getPosition(), CEGUI::Window::getRect(), CEGUI::Window::getSize(), CEGUI::TabControl::getTabHeight(), CEGUI::TabControl::getTabTextPadding(), CEGUI::MultiLineEditbox::getTextIndexFromPosition(), getTotalColumnHeadersWidth(), CEGUI::Window::getUnclippedPixelRect(), CEGUI::Window::getWidth(), CEGUI::Window::getXPosition(), CEGUI::Window::getYPosition(), insertColumn(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::Thumb::onMouseButtonDown(), onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), CEGUI::Window::onParentSized(), CEGUI::FrameWindow::onParentSized(), CEGUI::Window::screenToWindow(), CEGUI::Window::screenToWindowX(), CEGUI::Window::screenToWindowY(), CEGUI::ListHeader::segmentDragHandler(), CEGUI::ListHeader::segmentMovedHandler(), CEGUI::Window::setAreaRect(), setColumnHeaderWidth(), CEGUI::Window::setMaximumSize(), CEGUI::Window::setMetricsMode(), CEGUI::Window::setMinimumSize(), CEGUI::Window::setPosition(), CEGUI::Window::setSize(), CEGUI::TabControl::setTabHeight(), CEGUI::TabControl::setTabTextPadding(), CEGUI::FrameWindow::toggleRollup(), CEGUI::Window::windowToScreen(), CEGUI::Window::windowToScreenX(), and CEGUI::Window::windowToScreenY().

Size CEGUI::Window::getMinimumSize void   )  const [inherited]
 

Return the current minimum size for this window.

Returns:
Size object describing the minimum size for this window. If using absolute co-ordinates the returned object has it's values expressed as screen pixels. If using relative co-ordinates the returned object has it's values expressed as fractions of the current display size.

Definition at line 2052 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Window::d_minSize, and CEGUI::Window::getMetricsMode().

const Image * CEGUI::Window::getMouseCursor void   )  const [inherited]
 

Return a pointer to the mouse cursor image to use when the mouse is within this window.

Returns:
Pointer to the mouse cursor image that will be used when the mouse enters this window. May return NULL indicating no cursor.

Definition at line 2132 of file CEGUIWindow.cpp.

References CEGUI::Window::d_mouseCursor.

Referenced by CEGUI::Window::onMouseEnters(), and CEGUI::FrameWindow::setCursorForPoint().

const String& CEGUI::Window::getName void   )  const [inline, inherited]
 

return a String object holding the name of this Window.

Returns:
String object holding the unique Window name.

Definition at line 171 of file CEGUIWindow.h.

Referenced by CEGUI::TabControl::addChild_impl(), CEGUI::TabControl::addTab(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::TabControl::createTabButtonPane(), CEGUI::WindowManager::destroyWindow(), CEGUI::TabControl::handleTabButtonClicked(), CEGUI::Window::isAncestor(), CEGUI::TabControl::makeButtonName(), CEGUI::TabControl::removeTab(), and CEGUI::Editbox::setValidationString().

ListboxItem * CEGUI::MultiColumnList::getNextSelected const ListboxItem start_item  )  const
 

Return a pointer to the next selected ListboxItem after start_item.

Note:
List box searching progresses across the columns in each row.
Parameters:
start_item Pointer to the ListboxItem where the exclusive search is to start, or NULL to search the whole list box.
Returns:
Pointer to the first selected ListboxItem attached to this list box, after start_item, or NULL if no item is selected.
Exceptions:
InvalidRequestException thrown if start_item is not attached to the list box.

Definition at line 496 of file CEGUIMultiColumnList.cpp.

References CEGUI::MCLGridRef::column, d_grid, getColumnCount(), getItemGridReference(), getRowCount(), CEGUI::ListboxItem::isSelected(), CEGUI::MCLGridRef::row, and CEGUI::uint.

Referenced by getFirstSelectedItem().

uint CEGUI::MultiColumnList::getNominatedSelectionColumn void   )  const
 

Return the index of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.

Returns:
Zero based index of the nominated selection column.

Definition at line 584 of file CEGUIMultiColumnList.cpp.

References CEGUI::uint.

uint CEGUI::MultiColumnList::getNominatedSelectionColumnID void   )  const
 

Return the ID of the currently set nominated selection column to be used when in one of the NominatedColumn* selection modes.

Note:
You should only ever call this when getColumnCount() returns > 0.
Returns:
ID code of the nominated selection column.

Definition at line 575 of file CEGUIMultiColumnList.cpp.

References d_header, d_nominatedSelectCol, CEGUI::Window::getID(), CEGUI::ListHeader::getSegmentFromColumn(), and CEGUI::uint.

uint CEGUI::MultiColumnList::getNominatedSelectionRow void   )  const
 

Return the index of the currently set nominated selection row to be used when in one of the NominatedRow* selection modes.

Returns:
Zero based index of the nominated selection column.

Definition at line 593 of file CEGUIMultiColumnList.cpp.

References CEGUI::uint.

Window* CEGUI::Window::getParent void   )  const [inline, inherited]
 

return the parent of this Window.

Returns:
Pointer to the Window object that is the parent of this Window. This value can be NULL, in which case the Window is a GUI Sheet / Root.

Definition at line 676 of file CEGUIWindow.h.

Referenced by CEGUI::Window::addChild_impl(), CEGUI::GUILayout_xmlHandler::cleanupLoadedWindows(), CEGUI::ListHeaderSegment::doDragSizing(), CEGUI::System::injectChar(), CEGUI::System::injectKeyDown(), CEGUI::System::injectKeyUp(), CEGUI::System::injectMouseButtonDown(), CEGUI::System::injectMouseButtonUp(), CEGUI::System::injectMouseMove(), CEGUI::System::injectMouseWheelChange(), CEGUI::FrameWindow::moveBottomEdge(), CEGUI::FrameWindow::moveLeftEdge(), CEGUI::FrameWindow::moveRightEdge(), CEGUI::FrameWindow::moveTopEdge(), CEGUI::FrameWindow::offsetPixelPosition(), and CEGUI::Titlebar::onMouseButtonDown().

float CEGUI::Window::getParentHeight void   )  const [protected, inherited]
 

Return the pixel Height of the parent element. This always returns a valid number.

Returns:
float value that is equal to the pixel height of this Window objects parent

Definition at line 1659 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_parent, and CEGUI::Rect::getHeight().

Size CEGUI::Window::getParentSize void   )  const [protected, inherited]
 

Return the pixel size of the parent element. This always returns a valid object.

Returns:
Size object that describes the pixel dimensions of this Window objects parent

Definition at line 1674 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, and CEGUI::Window::getWindowSize_impl().

float CEGUI::Window::getParentWidth void   )  const [protected, inherited]
 

Return the pixel Width of the parent element. This always returns a valid number.

Returns:
float value that is equal to the pixel width of this Window objects parent

Definition at line 1644 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_parent, CEGUI::Rect::getWidth(), and CEGUI::Window::getWidth().

Rect CEGUI::Window::getPixelRect void   )  const [virtual, inherited]
 

return a Rect object describing the Window area in screen space.

Returns:
Rect object that describes the area covered by the Window. The values in the returned Rect are in screen pixels. The returned Rect is clipped as appropriate and depending upon the 'ClippedByParent' setting.
Note:
This has now been made virtual to ease some customisations that require more specialised clipping requirements.

Definition at line 506 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, CEGUI::Window::getInnerRect(), CEGUI::Rect::getIntersection(), CEGUI::Window::getRect(), CEGUI::Window::getUnclippedPixelRect(), and CEGUI::Window::isClippedByParent().

Referenced by CEGUI::Static::drawSelf(), and CEGUI::Window::isHit().

Point CEGUI::Window::getPosition MetricsMode  mode  )  const [inherited]
 

return the position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
Point object that describes the position of the Window relative to it's parent, using the specified MetricsMode.

Definition at line 2270 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getInheritedMetricsMode(), CEGUI::Rect::getPosition(), and CEGUI::Point.

Point CEGUI::Window::getPosition void   )  const [inherited]
 

return the position of the window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
Point object that describes the position of the Window relative to it's parent, depending on the metrics system in use for this Window, the values in the Point will specify either pixels or decimal fractions of the total width and height of the parent.

Definition at line 680 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getMetricsMode(), CEGUI::Rect::getPosition(), and CEGUI::Point.

Referenced by CEGUI::MultiLineEditbox::drawSelf(), drawSelf(), CEGUI::Listbox::drawSelf(), CEGUI::ButtonBase::onCaptureLost(), CEGUI::ListHeader::segmentDragHandler(), and CEGUI::ListHeader::segmentMovedHandler().

String CEGUI::PropertySet::getProperty const String name  )  const [inherited]
 

Gets the current value of the specified Property.

Parameters:
name String containing the name of the Property who's value is to be returned.
Returns:
String object containing a textual representation of the requested Property.
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.

Definition at line 99 of file CEGUIPropertySet.cpp.

References CEGUI::String::find(), and CEGUI::utf8.

String CEGUI::PropertySet::getPropertyDefault const String name  )  const [inherited]
 

Returns the default value of a Property as a String.

Parameters:
name String containing the name of the Property who's default string is to be returned.
Returns:
String object containing a textual representation of the default value for this property.

Definition at line 156 of file CEGUIPropertySet.cpp.

References CEGUI::String::find(), and CEGUI::utf8.

Referenced by CEGUI::TabControlProperties::TabTextPadding::getDefault(), and CEGUI::TabControlProperties::TabHeight::getDefault().

const String & CEGUI::PropertySet::getPropertyHelp const String name  )  const [inherited]
 

Return the help text for the specified Property.

Parameters:
name String holding the name of the Property who's help text is to be returned.
Returns:
String object containing the help text for the Property name.
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.

Definition at line 84 of file CEGUIPropertySet.cpp.

References CEGUI::Property::getHelp(), and CEGUI::utf8.

Rect CEGUI::Window::getRect MetricsMode  mode  )  const [inherited]
 

return a Rect object that describes the Window area using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
Rect object that describes the area covered by the Window using the specified MetricsMode.

Definition at line 2363 of file CEGUIWindow.cpp.

References CEGUI::Window::getInheritedMetricsMode().

Rect CEGUI::Window::getRect void   )  const [inherited]
 

return a Rect object that describes the Window area.

Returns:
Rect object that describes the area covered by the Window. The values in the returned Rect are in whatever form is set as the current metric type. The returned Rect is unclipped and relative to the Window objects parent.

Definition at line 489 of file CEGUIWindow.cpp.

References CEGUI::Window::getMetricsMode().

Referenced by CEGUI::Window::getInnerRect(), and CEGUI::Window::getPixelRect().

float CEGUI::Window::getRelativeHeight void   )  const [inline, inherited]
 

Return the window height in relative metrics.

Returns:
float value describing this windows height in parent relative metrics.

Definition at line 778 of file CEGUIWindow.h.

Point CEGUI::Window::getRelativePosition void   )  const [inline, inherited]
 

Return the window position in relative metrics.

Returns:
Point object describing this windows position, relative to the parent window, in parent relative metrics.

Definition at line 728 of file CEGUIWindow.h.

References CEGUI::Point.

Rect CEGUI::Window::getRelativeRect void   )  const [inline, inherited]
 

Return the window area rect in relative metrics.

Returns:
Rect object describing this windows area, relative to the parent window, in parent relative metrics.

Definition at line 718 of file CEGUIWindow.h.

Size CEGUI::Window::getRelativeSize void   )  const [inline, inherited]
 

Return the window size in relative metrics.

Returns:
Size object describing this windows size in parent relative metrics.

Definition at line 758 of file CEGUIWindow.h.

float CEGUI::Window::getRelativeWidth void   )  const [inline, inherited]
 

Return the window width in relative metrics.

Returns:
float value describing this windows width in parent relative metrics.

Definition at line 768 of file CEGUIWindow.h.

float CEGUI::Window::getRelativeXPosition void   )  const [inline, inherited]
 

Return the window X position in relative metrics.

Returns:
float value describing this windows X position, relative to the parent window, in parent relative metrics.

Definition at line 738 of file CEGUIWindow.h.

float CEGUI::Window::getRelativeYPosition void   )  const [inline, inherited]
 

Return the window Y position in relative metrics.

Returns:
float value describing this windows Y position, relative to the parent window, in parent relative metrics.

Definition at line 748 of file CEGUIWindow.h.

uint CEGUI::MultiColumnList::getRowCount void   )  const
 

Return the number of rows in the multi-column list.

Returns:
uint value equal to the number of rows currently in the list.

Definition at line 146 of file CEGUIMultiColumnList.cpp.

References d_grid, and CEGUI::uint.

Referenced by addRow(), clearAllSelections_impl(), drawSelf(), findColumnItemWithText(), findListItemWithText(), findRowItemWithText(), getHighestRowItemHeight(), getItemAtGridReference(), getItemAtPoint(), getItemRowIndex(), getNextSelected(), getSelectedCount(), getTotalRowsHeight(), getWidestColumnItemWidth(), handleSortColumnChange(), insertColumn(), insertRow(), isListboxItemInColumn(), isListboxItemInList(), isListboxItemInRow(), moveColumn_impl(), removeColumn(), removeRow(), resetList_impl(), setItem(), setItemSelectState_impl(), and setSelectForItemsInColumn().

uint CEGUI::MultiColumnList::getSelectedCount void   )  const
 

Return the number of selected ListboxItems attached to this list box.

return uint value equal to the number of ListboxItems attached to this list box that are currently selected.

Definition at line 532 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isSelected(), and CEGUI::uint.

MultiColumnList::SelectionMode CEGUI::MultiColumnList::getSelectionMode void   )  const
 

Return the currently set selection mode.

Returns:
One of the MultiColumnList::SelectionMode enumerated values specifying the current selection mode.

Definition at line 602 of file CEGUIMultiColumnList.cpp.

Size CEGUI::Window::getSize MetricsMode  mode  )  const [inherited]
 

return the size of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
Size object that describes the dimensions of the Window using the specified MetricsMode.

Definition at line 2339 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getInheritedMetricsMode(), and CEGUI::Rect::getSize().

Size CEGUI::Window::getSize void   )  const [inherited]
 

return the size of the Window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
Size object that describes the dimensions of the Window. Depending upon the metrics system in use for this window, the values will either be in pixels, or as decimal fractions of the width and height of the parent Window.

Definition at line 725 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getMetricsMode(), and CEGUI::Rect::getSize().

Referenced by CEGUI::StaticImage::onSized(), CEGUI::StaticImage::onStaticFrameChanged(), and CEGUI::FrameWindow::toggleRollup().

uint CEGUI::MultiColumnList::getSortColumn void   )  const
 

Return the zero based index of the current sort column. There must be at least one column to successfully call this method.

Returns:
Zero based column index that is the current sort column.
Exceptions:
InvalidRequestException thrown if there are no columns in this multi column list.

Definition at line 156 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::ListHeader::getSortColumn(), and CEGUI::uint.

Referenced by addRow(), CEGUI::MultiColumnListProperties::SortColumnID::get(), handleSortColumnChange(), insertRow(), setSortColumn(), and setSortColumnByID().

ListHeaderSegment::SortDirection CEGUI::MultiColumnList::getSortDirection void   )  const
 

Return the currently set sort direction.

Returns:
One of the ListHeaderSegment::SortDirection enumerated values specifying the current sort direction.

Definition at line 216 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::getSortDirection().

Referenced by addRow(), handleSortColumnChange(), handleSortDirectionChange(), insertRow(), and setSortDirection().

const String& CEGUI::Window::getText void   )  const [inline, inherited]
 

return the current text for the Window

Returns:
A String object that holds the current text for this Window.

Definition at line 430 of file CEGUIWindow.h.

Referenced by CEGUI::Combobox::button_PressHandler(), CEGUI::TabControl::calculateTabButtonSizePosition(), CEGUI::StaticText::drawSelf(), CEGUI::Combobox::editbox_MouseDownHandler(), CEGUI::TabControl::handleContentWindowTextChanged(), CEGUI::Combobox::onTextChanged(), and CEGUI::TabButton::setTargetWindow().

float CEGUI::MultiColumnList::getTotalColumnHeadersWidth void   )  const
 

Return the total width of all column headers.

Returns:
Sum total of all the column header widths in whichever metrics system is active.

Definition at line 184 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::absoluteToRelativeX(), d_header, CEGUI::Window::getMetricsMode(), and CEGUI::ListHeader::getTotalSegmentsPixelExtent().

float CEGUI::MultiColumnList::getTotalRowsHeight void   )  const [protected]
 

Return the sum of all row heights.

Definition at line 1397 of file CEGUIMultiColumnList.cpp.

References getHighestRowItemHeight(), getRowCount(), and CEGUI::uint.

Referenced by configureScrollbars().

const String& CEGUI::Window::getType void   )  const [inline, inherited]
 

return a String object holding the type name for this Window.

Returns:
String object holding the Window type.

Definition at line 161 of file CEGUIWindow.h.

Referenced by CEGUI::RadioButton::deselectOtherButtonsInGroup(), CEGUI::GUISheetFactory::destroyWindow(), and CEGUI::RadioButton::getSelectedButtonInGroup().

Rect CEGUI::Window::getUnclippedInnerRect void   )  const [virtual, inherited]
 

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.

Returns:
Rect object that describes, in unclipped screen pixel co-ordinates, the window object's inner rect area.

Reimplemented in CEGUI::Static, and CEGUI::StaticText.

Definition at line 564 of file CEGUIWindow.cpp.

References CEGUI::Window::getUnclippedPixelRect().

Referenced by CEGUI::Window::getInnerRect().

Rect CEGUI::Window::getUnclippedPixelRect void   )  const [inherited]
 

return a Rect object describing the Window area unclipped, in screen space.

Returns:
Rect object that describes the area covered by the Window. The values in the returned Rect are in screen pixels. The returned rect is fully unclipped.

Definition at line 545 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), CEGUI::Rect::getWidth(), and CEGUI::Window::windowToScreen().

Referenced by CEGUI::Static::drawSelf(), CEGUI::MultiLineEditbox::drawSelf(), drawSelf(), CEGUI::Listbox::drawSelf(), CEGUI::Window::getPixelRect(), and CEGUI::Window::getUnclippedInnerRect().

void* CEGUI::Window::getUserData void   )  const [inline, inherited]
 

Return the user data set for this Window.

Each Window can have some client assigned data attached to it, this data is not used by the GUI system in any way. Interpretation of the data is entirely application specific.

Returns:
pointer to the user data that is currently set for this window.

Definition at line 861 of file CEGUIWindow.h.

float CEGUI::MultiColumnList::getWidestColumnItemWidth uint  col_idx  )  const [protected]
 

Return the width of the widest item in the given column.

Definition at line 1413 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), CEGUI::ListboxItem::getPixelSize(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by autoSizeColumnHeader().

float CEGUI::Window::getWidth MetricsMode  mode  )  const [inherited]
 

return the width of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
float value that specifies the width of the Window using the specified MetricsMode.

Definition at line 2293 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getInheritedMetricsMode(), and CEGUI::Rect::getWidth().

float CEGUI::Window::getWidth void   )  const [inherited]
 

return the width of the Window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
float value that specifies the width of the Window. Depending upon the metrics system in use for this window, the return value will either be in pixels, or as a decimal fraction of the width of the parent Window.

Definition at line 695 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Window::getMetricsMode(), and CEGUI::Rect::getWidth().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition(), CEGUI::Window::getParentWidth(), and CEGUI::Window::setHeight().

Size CEGUI::Window::getWindowSize_impl const Window window  )  const [protected, inherited]
 

Definition at line 2018 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, and CEGUI::Rect::getSize().

Referenced by CEGUI::Window::absoluteToRelative_impl(), CEGUI::Window::absoluteToRelativeX_impl(), CEGUI::Window::absoluteToRelativeY_impl(), CEGUI::Window::getParentSize(), CEGUI::Window::relativeToAbsolute_impl(), CEGUI::Window::relativeToAbsoluteX_impl(), and CEGUI::Window::relativeToAbsoluteY_impl().

float CEGUI::Window::getXPosition MetricsMode  mode  )  const [inherited]
 

return the x position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
float value that specifies the x position of the Window relative to it's parent, using the specified MetricsMode.

Definition at line 2224 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_left, CEGUI::Window::d_rel_area, and CEGUI::Window::getInheritedMetricsMode().

float CEGUI::Window::getXPosition void   )  const [inherited]
 

return the x position of the window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
float value that specifies the x position of the Window relative to it's parent, depending on the metrics system in use for this Window, this value will specify either pixels or a decimal fraction of the width of the parent Window.

Definition at line 650 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_left, CEGUI::Window::d_rel_area, and CEGUI::Window::getMetricsMode().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition(), CEGUI::Thumb::setHorzRange(), and CEGUI::Window::setYPosition().

float CEGUI::Window::getYPosition MetricsMode  mode  )  const [inherited]
 

return the y position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
Returns:
float value that specifies the y position of the Window relative to it's parent, using the specified MetricsMode.

Definition at line 2247 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Rect::d_top, and CEGUI::Window::getInheritedMetricsMode().

float CEGUI::Window::getYPosition void   )  const [inherited]
 

return the y position of the window. Interpretation of return value depends upon the metric type in use by this window.

Returns:
float value that specifies the y position of the Window relative to it's parent, depending on the metrics system in use for this Window, this value will specify either pixels or a decimal fraction of the height of the parent Window.

Definition at line 665 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_rel_area, CEGUI::Rect::d_top, and CEGUI::Window::getMetricsMode().

Referenced by CEGUI::Thumb::setVertRange(), and CEGUI::Window::setXPosition().

bool CEGUI::MultiColumnList::handleColumnSizeChange const EventArgs e  )  [protected]
 

Definition at line 2019 of file CEGUIMultiColumnList.cpp.

References configureScrollbars(), and onListColumnSized().

Referenced by initialise().

bool CEGUI::MultiColumnList::handleHeaderScroll const EventArgs e  )  [protected]
 

Definition at line 1991 of file CEGUIMultiColumnList.cpp.

References d_header, d_horzScrollbar, CEGUI::ListHeader::getSegmentOffset(), CEGUI::Window::relativeToAbsoluteX(), and CEGUI::Scrollbar::setScrollPosition().

Referenced by initialise().

bool CEGUI::MultiColumnList::handleHeaderSegDblClick const EventArgs e  )  [protected]
 

Definition at line 2108 of file CEGUIMultiColumnList.cpp.

References autoSizeColumnHeader(), d_header, CEGUI::ListHeader::getColumnFromSegment(), and CEGUI::uint.

Referenced by initialise().

bool CEGUI::MultiColumnList::handleHeaderSegMove const EventArgs e  )  [protected]
 

Definition at line 2003 of file CEGUIMultiColumnList.cpp.

References moveColumn_impl(), and onListColumnMoved().

Referenced by initialise().

bool CEGUI::MultiColumnList::handleHorzScrollbar const EventArgs e  )  [protected]
 

Definition at line 2034 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::absoluteToRelativeX(), d_header, d_horzScrollbar, CEGUI::Scrollbar::getScrollPosition(), and CEGUI::ListHeader::setSegmentOffset().

Referenced by initialise().

bool CEGUI::MultiColumnList::handleSortColumnChange const EventArgs e  )  [protected]
 

Definition at line 2046 of file CEGUIMultiColumnList.cpp.

References d_grid, getRowCount(), getSortColumn(), getSortDirection(), onSortColumnChanged(), and CEGUI::uint.

Referenced by initialise().

bool CEGUI::MultiColumnList::handleSortDirectionChange const EventArgs e  )  [protected]
 

Definition at line 2081 of file CEGUIMultiColumnList.cpp.

References d_grid, getSortDirection(), and onSortDirectionChanged().

Referenced by initialise().

void CEGUI::MultiColumnList::handleUpdatedItemData void   ) 
 

Inform the list box that one or more attached ListboxItems have been externally modified, and the list should re-sync its internal state and refresh the display as needed.

Returns:
Nothing.

Definition at line 1244 of file CEGUIMultiColumnList.cpp.

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

void CEGUI::Window::hide void   )  [inline, inherited]
 

hide the Window.

Returns:
Nothing

Definition at line 1127 of file CEGUIWindow.h.

Referenced by CEGUI::ComboDropList::ComboDropList(), CEGUI::StaticText::configureScrollbars(), CEGUI::MultiLineEditbox::configureScrollbars(), configureScrollbars(), CEGUI::Listbox::configureScrollbars(), CEGUI::StaticText::initialise(), and CEGUI::ComboDropList::onCaptureLost().

bool CEGUI::Window::inheritsAlpha void   )  const [inline, inherited]
 

return true if the Window inherits alpha from its parent(s).

Returns:
true if the Window inherits alpha from its parent(s), false if the alpha for this Window is independant.

Definition at line 440 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getEffectiveAlpha().

void CEGUI::MultiColumnList::initialise 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.

Definition at line 611 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::addChildWindow(), configureScrollbars(), createHorzScrollbar(), createListHeader(), createVertScrollbar(), d_header, d_horzScrollbar, d_vertScrollbar, handleColumnSizeChange(), handleHeaderScroll(), handleHeaderSegDblClick(), handleHeaderSegMove(), handleHorzScrollbar(), handleSortColumnChange(), handleSortDirectionChange(), layoutComponentWidgets(), setSortDirection(), CEGUI::EventSet::subscribeEvent(), and CEGUI::Event::Subscriber.

void CEGUI::MultiColumnList::insertColumn const String text,
uint  col_id,
float  width,
uint  position
 

Insert a new column in the list.

Parameters:
text String object containing the text label for the column header.
col_id ID code to be assigned to the column header.
width Initial width to be set for the column using the active metrics mode for this window.
position Zero based index where the column is to be inserted. If this is greater than the current number of columns, the new column is inserted at the end.
Returns:
Nothing.

Definition at line 667 of file CEGUIMultiColumnList.cpp.

References CEGUI::Window::absoluteToRelativeX(), d_grid, d_header, d_nominatedSelectCol, getColumnCount(), CEGUI::Window::getMetricsMode(), getRowCount(), CEGUI::ListHeader::insertColumn(), onListContentsChanged(), CEGUI::Window::relativeToAbsoluteX(), and CEGUI::uint.

Referenced by addColumn().

uint CEGUI::MultiColumnList::insertRow ListboxItem item,
uint  col_id,
uint  row_idx
 

Insert a row into the list box, and set the item in the column with ID col_id to item.

Note:
If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the specified index.
Parameters:
item Pointer to a ListboxItem to be used as the initial contents for the column with ID col_id.
col_id ID code of the column whos initial item is to be set to item.
row_idx Zero based index where the row should be inserted. If this is greater than the current number of rows, the row is appended to the list.
Returns:
Zero based index where the row was actually inserted.
Exceptions:
InvalidRequestException thrown if no column with the specified ID is attached to the list box.

Definition at line 842 of file CEGUIMultiColumnList.cpp.

References addRow(), d_grid, CEGUI::MultiColumnList::ListRow::d_items, CEGUI::MultiColumnList::ListRow::d_sortColumn, getColumnCount(), getRowCount(), getSortColumn(), getSortDirection(), onListContentsChanged(), setItem(), and CEGUI::uint.

uint CEGUI::MultiColumnList::insertRow uint  row_idx  ) 
 

Insert an empty row into the list box.

Note:
If the list is being sorted, the new row will appear at an appropriate position according to the sorting being applied. If no sorting is being done, the new row will appear at the specified index.
Parameters:
row_idx Zero based index where the row should be inserted. If this is greater than the current number of rows, the row is appended to the list.
Returns:
Zero based index where the row was actually inserted.

Definition at line 833 of file CEGUIMultiColumnList.cpp.

References CEGUI::uint.

bool CEGUI::Window::isActive void   )  const [inherited]
 

return true if this is the active Window (the window that receives inputs)

Mouse events are always sent to the window containing the mouse cursor regardless of what this reports (unless the window has captured inputs). This mainly refers to where other (keyboard) inputs are sent.

Returns:
true if this window has input focus, or false if it does not.

Definition at line 237 of file CEGUIWindow.cpp.

References CEGUI::Window::d_active, and CEGUI::Window::d_parent.

Referenced by CEGUI::Combobox::activateEditbox(), CEGUI::Window::captureInput(), CEGUI::Window::getActiveChild(), CEGUI::MultiLineEditbox::hasInputFocus(), CEGUI::Editbox::hasInputFocus(), CEGUI::Window::moveToBack(), CEGUI::Window::moveToFront(), and CEGUI::Combobox::onActivated().

bool CEGUI::Window::isAlwaysOnTop void   )  const [inline, inherited]
 

returns whether or not this Window is an always on top (a.k.a 'topmost') Window.

Returns:
true if this Window is always show on top of other normal windows. false if the Window has normal z-order behaviour.

Definition at line 191 of file CEGUIWindow.h.

Referenced by CEGUI::Window::addChild_impl(), CEGUI::Window::moveToBack(), and CEGUI::Window::setAlwaysOnTop().

bool CEGUI::Window::isAncestor const Window window  )  const [inherited]
 

return true if the specified Window is some ancestor of this Window.

Parameters:
window Pointer to the Window object to look for.
Returns:
true if window was found to be an ancestor (parent, or parent of parent, etc) of this Window, otherwise false.

Definition at line 437 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, and CEGUI::Window::isAncestor().

bool CEGUI::Window::isAncestor uint  ID  )  const [inherited]
 

return true if any Window with the given ID is some ancestor of this Window.

Parameters:
ID uint value specifying the ID to look for.
Returns:
true if an ancestor (parent, or parent of parent, etc) was found with the ID code ID, else false.

Definition at line 415 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, CEGUI::Window::getID(), and CEGUI::Window::isAncestor().

bool CEGUI::Window::isAncestor const String name  )  const [inherited]
 

return true if the specified Window is some ancestor of this Window

Parameters:
name String object holding the name of the Window to check for.
Returns:
true if a Window named name is an ancestor (parent, or parent of parent, etc) of this Window, or false if not.

Definition at line 392 of file CEGUIWindow.cpp.

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

Referenced by CEGUI::Window::isAncestor().

bool CEGUI::Window::isCapturedByAncestor void   )  const [inline, inherited]
 

return true if a child window has captured inputs.

Returns:
true if inputs are captured by a Window that is attached as a child of this Window, else false.

Definition at line 554 of file CEGUIWindow.h.

bool CEGUI::Window::isCapturedByChild void   )  const [inline, inherited]
 

return true if an ancestor window has captured inputs.

Returns:
true if inputs are captured by a Window that is some ancestor (parent, parent of parent, etc) of this Window, else false.

Definition at line 564 of file CEGUIWindow.h.

bool CEGUI::Window::isCapturedByThis void   )  const [inline, inherited]
 

return true if this Window has input captured.

Returns:
true if this Window has captured inputs, or false if some other Window, or no Window, has captured inputs.

Definition at line 544 of file CEGUIWindow.h.

Referenced by CEGUI::Window::releaseInput().

bool CEGUI::Window::isChild const Window window  )  const [inherited]
 

return true if the given Window is a child of this window.

Parameters:
window Pointer to the Window object to look for.
Returns:
true if Window object window is attached to this window as a child.

Definition at line 289 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), and CEGUI::uint.

bool CEGUI::Window::isChild uint  ID  )  const [inherited]
 

returns whether at least one window with the given ID code is attached as a child.

Note:
ID codes are client assigned and may or may not be unique, and as such, the return from this function will only have meaning to the client code.
Parameters:
ID uint ID code to look for.
Returns:
true if a child window was found with the ID code ID, or false if no child window was found with the ID ID.

Definition at line 269 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), and CEGUI::uint.

bool CEGUI::Window::isChild const String name  )  const [inherited]
 

returns whether a Window with the specified name is currently attached to this Window as a child.

Parameters:
name String object containing the name of the Window to look for.
Returns:
true if a Window named name is currently attached to this Window as a child, else false.

Definition at line 249 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), and CEGUI::uint.

bool CEGUI::Window::isClippedByParent void   )  const [inline, inherited]
 

return true if this Window is clipped so that its rendering does not pass outside its parent windows area.

Returns:
true if the window will be clipped by its parent window, or false if this windows rendering may pass outside its parents area

Definition at line 237 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getInnerRect(), and CEGUI::Window::getPixelRect().

bool CEGUI::Window::isDestroyedByParent void   )  const [inline, inherited]
 

returns whether or not this Window is set to be destroyed when its parent is destroyed.

Returns:
true if the Window will be destroyed when its parent is destroyed, false if it will remain.

Definition at line 181 of file CEGUIWindow.h.

Referenced by CEGUI::Window::cleanupChildren().

bool CEGUI::Window::isDisabled void   )  const [inherited]
 

return true if the Window is currently disabled

Returns:
true if the window is disabled, false if the window is enabled.

Definition at line 214 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent.

Referenced by CEGUI::ButtonBase::drawSelf(), and CEGUI::Window::isHit().

bool CEGUI::EventSet::isEventPresent const String name  )  [inherited]
 

Checks to see if an Event with the given name is present in the EventSet.

Returns:
true if an Event named name was found, or false if the Event was not found

Definition at line 101 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::addEvent().

bool CEGUI::Window::isHit const Point position  )  const [virtual, inherited]
 

check if the given position would hit this window.

Parameters:
position Point object describing the position to check in screen pixels
Returns:
true if position 'hits' this Window, else false.

Reimplemented in CEGUI::Combobox.

Definition at line 573 of file CEGUIWindow.cpp.

References CEGUI::Window::getPixelRect(), CEGUI::Rect::getWidth(), CEGUI::Window::isDisabled(), CEGUI::Rect::isPointInRect(), and CEGUI::Point.

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

bool CEGUI::MultiColumnList::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.

Definition at line 2177 of file CEGUIMultiColumnList.cpp.

bool CEGUI::MultiColumnList::isItemSelected const MCLGridRef grid_ref  )  const
 

Return whether the ListboxItem at grid_ref is selected.

Parameters:
grid_ref MCLGridRef object describing the grid reference that is to be examined.
Returns:
  • true if there is a ListboxItem at grid_ref and it is selected.
  • false if there is no ListboxItem at grid_ref, or if the item is not selected.
Exceptions:
InvalidRequestException thrown if grid_ref contains an invalid grid position.

Definition at line 558 of file CEGUIMultiColumnList.cpp.

References getItemAtGridReference(), and CEGUI::ListboxItem::isSelected().

bool CEGUI::MultiColumnList::isListboxItemInColumn const ListboxItem item,
uint  col_idx
const
 

return whether ListboxItem item is attached to the column at index col_idx.

Parameters:
item Pointer to the ListboxItem to look for.
col_idx Zero based index of the column that is to be searched.
Returns:
  • true if item is attached to list box column col_idx.
  • false if item is not attached to list box column col_idx.
Exceptions:
InvalidRequestException thrown if col_idx is out of range.

Definition at line 304 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by getItemColumnIndex().

bool CEGUI::MultiColumnList::isListboxItemInList const ListboxItem item  )  const
 

return whether ListboxItem item is attached to the list box.

Parameters:
item Pointer to the ListboxItem to look for.
Returns:
  • true if item is attached to list box.
  • false if item is not attached to list box.

Definition at line 360 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getRowCount(), and CEGUI::uint.

bool CEGUI::MultiColumnList::isListboxItemInRow const ListboxItem item,
uint  row_idx
const
 

return whether ListboxItem item is attached to the row at index row_idx.

Parameters:
item Pointer to the ListboxItem to look for.
row_idx Zero based index of the row that is to be searched.
Returns:
  • true if item is attached to list box row row_idx.
  • false if item is not attached to list box row row_idx.
Exceptions:
InvalidRequestException thrown if row_idx is out of range.

Definition at line 332 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by getItemRowIndex().

bool CEGUI::Window::isMouseAutoRepeatEnabled void   )  const [inherited]
 

Return whether mouse button down event autorepeat is enabled for this window.

Returns:
  • true if autorepeat of mouse button down events is enabled for this window.
  • false if autorepeat of mouse button down events is not enabled for this window.

Definition at line 2639 of file CEGUIWindow.cpp.

bool CEGUI::EventSet::isMuted void   )  const [inherited]
 

Return whether the EventSet is muted or not.

Returns:
  • true if the EventSet is muted. All requests to fire events will be ignored.
  • false if the EventSet is not muted. All requests to fire events are processed as normal.

Definition at line 164 of file CEGUIEventSet.cpp.

bool CEGUI::PropertySet::isPropertyDefault const String name  )  const [inherited]
 

Returns whether a Property is at it's default value.

Parameters:
name String containing the name of the Property who's default state is to be tested.
Returns:
  • true if the property has it's default value.
  • false if the property has been modified from it's default value.

Definition at line 140 of file CEGUIPropertySet.cpp.

References CEGUI::String::find(), and CEGUI::utf8.

Referenced by CEGUI::TabControlProperties::TabTextPadding::isDefault(), and CEGUI::TabControlProperties::TabHeight::isDefault().

bool CEGUI::PropertySet::isPropertyPresent const String name  )  const [inherited]
 

Checks to see if a Property with the given name is in the PropertySet.

Parameters:
name String containing the name of the Property to check for.
Returns:
true if a Property named name is in the PropertySet. false if no Property named name is in the PropertySet.

Definition at line 76 of file CEGUIPropertySet.cpp.

bool CEGUI::MultiColumnList::isUserColumnDraggingEnabled void   )  const
 

Return whether the user may modify the order of the columns.

Returns:
true if the user may interactively modify the order of the columns, false if they may not.

Definition at line 128 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::isColumnDraggingEnabled().

bool CEGUI::MultiColumnList::isUserColumnSizingEnabled void   )  const
 

Return whether the user may size column segments.

Returns:
true if the user may interactively modify the width of columns, false if they may not.

Definition at line 119 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::isColumnSizingEnabled().

bool CEGUI::MultiColumnList::isUserSortControlEnabled void   )  const
 

Return whether user manipulation of the sort column and direction are enabled.

Returns:
true if the user may interactively modify the sort column and direction. false if the user may not modify the sort column and direction (these can still be set programmatically).

Definition at line 110 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::isSortingEnabled().

bool CEGUI::MultiColumnList::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.

Definition at line 2168 of file CEGUIMultiColumnList.cpp.

bool CEGUI::Window::isVisible void   )  const [inherited]
 

return true if the Window is currently visible.

A true return from this function does not mean that the window is not completely obscured by other windows, just that the window is processed when rendering and is not hidden.

Returns:
true if the window is drawn, false if the window is hidden and therefore ignored when rendering.

Definition at line 225 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent, and CEGUI::Window::d_visible.

Referenced by CEGUI::StaticText::drawSelf(), CEGUI::StaticText::getTextRenderArea(), CEGUI::Combobox::isDropDownListVisible(), CEGUI::StaticText::layoutComponentWidgets(), CEGUI::StaticText::onMouseWheel(), CEGUI::MultiLineEditbox::onMouseWheel(), onMouseWheel(), CEGUI::Listbox::onMouseWheel(), CEGUI::TabControl::removeTab(), and CEGUI::Window::render().

bool CEGUI::Window::isZOrderingEnabled void   )  const [inherited]
 

Return whether z-order changes are enabled or disabled for this Window.

Returns:
  • true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
  • false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.

Definition at line 2590 of file CEGUIWindow.cpp.

virtual void CEGUI::MultiColumnList::layoutComponentWidgets  )  [protected, pure virtual]
 

Setup size and position for the component widgets attached to this Listbox.

Returns:
Nothing.

Referenced by initialise(), and onSized().

void CEGUI::MultiColumnList::moveColumn uint  col_idx,
uint  position
 

Move the column at index col_idx so it is at index position.

Parameters:
col_idx Zero based index of the column to be moved.
position Zero based index of the new position for the column.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_idx is invalid.

Definition at line 760 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::moveColumn().

Referenced by moveColumnWithID().

void CEGUI::MultiColumnList::moveColumn_impl uint  col_idx,
uint  position
[protected]
 

Move the column at index col_idx so it is at index position. Implementation version which does not move the header segment (since that may have already happened).

Exceptions:
InvalidRequestException thrown if col_idx is invalid.

Definition at line 1663 of file CEGUIMultiColumnList.cpp.

References d_grid, d_nominatedSelectCol, getColumnCount(), getRowCount(), CEGUI::uint, and CEGUI::utf8.

Referenced by handleHeaderSegMove().

void CEGUI::MultiColumnList::moveColumnWithID uint  col_id,
uint  position
 

Move the column with ID col_id so it is at index position.

Parameters:
col_id ID code of the column to be moved.
position Zero based index of the new position for the column.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if no column with col_id is available on this list box.

Definition at line 770 of file CEGUIMultiColumnList.cpp.

References getColumnWithID(), and moveColumn().

void CEGUI::Window::moveToBack  )  [inherited]
 

Move the Window to the bottom of the Z order.

  • If the window is non always-on-top the Window is sent to the very bottom of its sibling windows and the process repeated for all ancestors.
  • If the window is always-on-top, the Window is sent to the bottom of all sibling always-on-top windows and the process repeated for all ancestors.

Returns:
Nothing

Definition at line 1113 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::d_parent, CEGUI::Window::isActive(), CEGUI::Window::isAlwaysOnTop(), CEGUI::Window::onDeactivated(), CEGUI::Window::onZChange_impl(), CEGUI::ActivationEventArgs::otherWindow, CEGUI::Window::removeChild_impl(), and CEGUI::Window::setParent().

void CEGUI::Window::moveToFront  )  [inherited]
 

Move the Window to the top of the z order.

  • If the Window is a non always-on-top window it is moved the the top of all other non always-on-top sibling windows, and the process repeated for all ancestors.
  • If the Window is an always-on-top window it is moved to the of of all sibling Windows, and the process repeated for all ancestors.

Returns:
Nothing

Definition at line 1043 of file CEGUIWindow.cpp.

References CEGUI::Window::addChild_impl(), CEGUI::Window::d_children, CEGUI::Window::d_parent, CEGUI::Window::getChildCount(), CEGUI::Window::isActive(), CEGUI::Window::onActivated(), CEGUI::Window::onDeactivated(), CEGUI::Window::onZChange_impl(), CEGUI::ActivationEventArgs::otherWindow, CEGUI::Window::removeChild_impl(), and CEGUI::uint.

Referenced by CEGUI::Window::activate(), CEGUI::Window::onMouseButtonDown(), and CEGUI::Window::releaseInput().

void CEGUI::Window::onActivated ActivationEventArgs e  )  [protected, virtual, inherited]
 

Handler called when this window has become the active window.

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

Reimplemented in CEGUI::Combobox, and CEGUI::ComboDropList.

Definition at line 2944 of file CEGUIWindow.cpp.

References CEGUI::Window::d_active, CEGUI::Window::EventActivated, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::moveToFront().

void CEGUI::Window::onAlphaChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's alpha blend value is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Reimplemented in CEGUI::Static, and CEGUI::StaticImage.

Definition at line 2807 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::EventAlphaChanged, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), CEGUI::Window::getChildCount(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setAlpha(), and CEGUI::Window::setInheritsAlpha().

void CEGUI::Window::onAlwaysOnTopChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's always-on-top setting is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2887 of file CEGUIWindow.cpp.

References CEGUI::Window::EventAlwaysOnTopChanged, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setAlwaysOnTop().

void CEGUI::Window::onCaptureGained WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when this window gains capture of mouse inputs.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2894 of file CEGUIWindow.cpp.

References CEGUI::Window::EventInputCaptureGained, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::captureInput().

void CEGUI::Window::onCaptureLost WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when this window loses capture of mouse inputs.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Reimplemented in CEGUI::ButtonBase, CEGUI::ComboDropList, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::ListHeaderSegment, CEGUI::MultiLineEditbox, CEGUI::Thumb, and CEGUI::Titlebar.

Definition at line 2900 of file CEGUIWindow.cpp.

References CEGUI::Window::d_oldCapture, CEGUI::Window::d_repeatButton, CEGUI::Window::d_restoreOldCapture, CEGUI::Window::EventInputCaptureLost, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::activate(), CEGUI::Window::captureInput(), and CEGUI::Window::releaseInput().

void CEGUI::Window::onCharacter KeyEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a character-key has been pressed while this window has input focus.

Parameters:
e KeyEventArgs object whose 'codepoint' field is set to the Unicode code point (encoded as utf32) for the character typed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. All other fields should be considered as 'junk'.

Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox.

Definition at line 3100 of file CEGUIWindow.cpp.

References CEGUI::Window::EventCharacterKey, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectChar().

void CEGUI::Window::onChildAdded WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a child window is added to this window.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that has been added.

Definition at line 2999 of file CEGUIWindow.cpp.

References CEGUI::Window::EventChildAdded, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::addChildWindow().

void CEGUI::Window::onChildRemoved WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a child window is removed from this window.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set the window that has been removed.

Definition at line 3006 of file CEGUIWindow.cpp.

References CEGUI::Window::EventChildRemoved, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::removeChildWindow().

void CEGUI::Window::onClippingChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's setting for being clipped by it's parent is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2867 of file CEGUIWindow.cpp.

References CEGUI::Window::EventClippedByParentChanged, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setClippedByParent().

void CEGUI::Window::onDeactivated ActivationEventArgs e  )  [protected, virtual, inherited]
 

Handler called when this window has lost input focus and has been deactivated.

Parameters:
e ActivationEventArgs object whose 'otherWindow' field is set to the window that has now become active, or NULL for none.

Definition at line 2952 of file CEGUIWindow.cpp.

References CEGUI::Window::d_active, CEGUI::Window::d_children, CEGUI::Window::EventDeactivated, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), CEGUI::Window::getChildCount(), CEGUI::Window::requestRedraw(), and CEGUI::uint.

Referenced by CEGUI::Window::deactivate(), CEGUI::Window::moveToBack(), and CEGUI::Window::moveToFront().

void CEGUI::Window::onDestructionStarted WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when this window's destruction sequence has begun.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2938 of file CEGUIWindow.cpp.

References CEGUI::Window::EventDestructionStarted, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::~Window().

void CEGUI::Window::onDisabled WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window is disabled.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2854 of file CEGUIWindow.cpp.

References CEGUI::Window::EventDisabled, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setEnabled().

void CEGUI::Window::onEnabled WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window is enabled.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2847 of file CEGUIWindow.cpp.

References CEGUI::Window::EventEnabled, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setEnabled().

void CEGUI::Window::onFontChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's font is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Reimplemented in CEGUI::Combobox, CEGUI::StaticText, and CEGUI::TabControl.

Definition at line 2800 of file CEGUIWindow.cpp.

References CEGUI::Window::EventFontChanged, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setFont().

void CEGUI::Window::onHidden WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window is hidden.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2840 of file CEGUIWindow.cpp.

References CEGUI::Window::EventHidden, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setVisible().

void CEGUI::MultiColumnList::onHorzScrollbarModeChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the horizontal scroll bar 'force' mode is changed.

Definition at line 1826 of file CEGUIMultiColumnList.cpp.

References EventHorzScrollbarModeChanged, EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by setShowHorzScrollbar().

void CEGUI::Window::onIDChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's client assigned ID is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2827 of file CEGUIWindow.cpp.

References CEGUI::Window::EventIDChanged, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::setID().

void CEGUI::Window::onInheritsAlphaChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's setting for inheriting alpha-blending is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2880 of file CEGUIWindow.cpp.

References CEGUI::Window::EventInheritsAlphaChanged, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setInheritsAlpha().

void CEGUI::Window::onKeyDown KeyEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a key as been depressed while this window has input focus.

Parameters:
e KeyEventArgs object whose 'scancode' field is set to the Key::Scan value representing the key that was pressed, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated.

Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox.

Definition at line 3088 of file CEGUIWindow.cpp.

References CEGUI::Window::EventKeyDown, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectKeyDown().

void CEGUI::Window::onKeyUp KeyEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a key as been released while this window has input focus.

Parameters:
e KeyEventArgs object whose 'scancode' field is set to the Key::Scan value representing the key that was released, and whose 'sysKeys' field represents the combination of SystemKey that were active when the event was generated. All other fields should be considered as 'junk'.

Definition at line 3094 of file CEGUIWindow.cpp.

References CEGUI::Window::EventKeyUp, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectKeyUp().

void CEGUI::MultiColumnList::onListColumnMoved WindowEventArgs e  )  [protected, virtual]
 

Handler called when the column order is changed.

Definition at line 1887 of file CEGUIMultiColumnList.cpp.

References EventListColumnMoved, EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by handleHeaderSegMove().

void CEGUI::MultiColumnList::onListColumnSized WindowEventArgs e  )  [protected, virtual]
 

Handler called when a column is sized.

Definition at line 1876 of file CEGUIMultiColumnList.cpp.

References configureScrollbars(), EventListColumnSized, EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by handleColumnSizeChange().

void CEGUI::MultiColumnList::onListContentsChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the list contents is changed.

Definition at line 1845 of file CEGUIMultiColumnList.cpp.

References configureScrollbars(), EventListContentsChanged, EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by addRow(), insertColumn(), insertRow(), removeColumn(), removeRow(), resetList(), and setItem().

void CEGUI::Window::onMetricsChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's active metrics system is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2861 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMetricsModeChanged, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::setMetricsMode().

void CEGUI::MultiColumnList::onMouseButtonDown MouseEventArgs e  )  [protected, virtual]
 

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

Definition at line 1912 of file CEGUIMultiColumnList.cpp.

References CEGUI::MouseEventArgs::button, clearAllSelections_impl(), d_lastSelected, getItemAtPoint(), getItemGridReference(), CEGUI::Window::getMetricsMode(), CEGUI::EventArgs::handled, CEGUI::ListboxItem::isSelected(), onSelectionChanged(), CEGUI::Point, CEGUI::MouseEventArgs::position, CEGUI::Window::relativeToAbsolute(), CEGUI::Window::screenToWindow(), selectRange(), setItemSelectState_impl(), and CEGUI::MouseEventArgs::sysKeys.

void CEGUI::Window::onMouseButtonUp MouseEventArgs e  )  [protected, virtual, inherited]
 

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::ButtonBase, CEGUI::Checkbox, CEGUI::ComboDropList, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::ListHeaderSegment, CEGUI::MultiLineEditbox, CEGUI::PushButton, CEGUI::RadioButton, CEGUI::TabButton, and CEGUI::Titlebar.

Definition at line 3061 of file CEGUIWindow.cpp.

References CEGUI::Window::d_repeatButton, CEGUI::Window::EventMouseButtonUp, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseButtonUp().

void CEGUI::Window::onMouseClicked MouseEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a mouse button has been clicked (that is depressed and then released, within a specified time) within this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Definition at line 3070 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseClick, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseButtonUp().

void CEGUI::Window::onMouseDoubleClicked MouseEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a mouse button has been double-clicked within this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::Editbox, CEGUI::ListHeaderSegment, CEGUI::MultiLineEditbox, and CEGUI::Titlebar.

Definition at line 3076 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseDoubleClick, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseButtonDown().

void CEGUI::Window::onMouseEnters MouseEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the mouse cursor has entered this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Definition at line 3013 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseEnters, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::getMouseCursor().

Referenced by CEGUI::System::injectMouseMove().

void CEGUI::Window::onMouseLeaves MouseEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the mouse cursor has left this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::ButtonBase, and CEGUI::ListHeaderSegment.

Definition at line 3022 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseLeaves, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseMove().

void CEGUI::Window::onMouseMove MouseEventArgs e  )  [protected, virtual, inherited]
 

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::ButtonBase, CEGUI::ComboDropList, CEGUI::Editbox, CEGUI::FrameWindow, CEGUI::ListHeaderSegment, CEGUI::MultiLineEditbox, CEGUI::Thumb, and CEGUI::Titlebar.

Definition at line 3028 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseMove, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseMove().

void CEGUI::Window::onMouseTripleClicked MouseEventArgs e  )  [protected, virtual, inherited]
 

Handler called when a mouse button has been triple-clicked within this window's area.

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented in CEGUI::Editbox, and CEGUI::MultiLineEditbox.

Definition at line 3082 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMouseTripleClick, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::System::injectMouseButtonDown().

void CEGUI::MultiColumnList::onMouseWheel MouseEventArgs e  )  [protected, virtual]
 

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

Parameters:
e MouseEventArgs object. All fields are valid.

Reimplemented from CEGUI::Window.

Definition at line 1970 of file CEGUIMultiColumnList.cpp.

References d_horzScrollbar, d_vertScrollbar, CEGUI::Scrollbar::getDocumentSize(), CEGUI::Scrollbar::getPageSize(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Scrollbar::getStepSize(), CEGUI::EventArgs::handled, CEGUI::Window::isVisible(), CEGUI::Scrollbar::setScrollPosition(), and CEGUI::MouseEventArgs::wheelChange.

void CEGUI::Window::onMoved WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's position changes.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2786 of file CEGUIWindow.cpp.

References CEGUI::Window::EventMoved, CEGUI::Window::EventNamespace, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::FrameWindow::moveLeftEdge(), CEGUI::FrameWindow::moveTopEdge(), CEGUI::FrameWindow::offsetPixelPosition(), CEGUI::Window::onParentSized(), CEGUI::Window::setPosition(), and CEGUI::Window::setRect().

void CEGUI::MultiColumnList::onNominatedSelectColumnChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the nominated selection column changes.

Definition at line 1799 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventNominatedSelectColumnChanged, and CEGUI::EventSet::fireEvent().

Referenced by setNominatedSelectionColumn().

void CEGUI::MultiColumnList::onNominatedSelectRowChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the nominated selection row changes.

Definition at line 1808 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventNominatedSelectRowChanged, and CEGUI::EventSet::fireEvent().

Referenced by setNominatedSelectionRow().

void CEGUI::Window::onParentDestroyChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's setting for being destroyed automatically be it's parent is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2874 of file CEGUIWindow.cpp.

References CEGUI::Window::EventDestroyedByParentChanged, CEGUI::Window::EventNamespace, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::setDestroyedByParent().

void CEGUI::Window::onParentSized WindowEventArgs e  )  [protected, virtual, inherited]
 

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 screen size changes.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set the the window that caused the event; this is typically either this window's parent window, or NULL to indicate the screen size has changed.

Reimplemented in CEGUI::FrameWindow.

Definition at line 2971 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Rect::constrainSize(), CEGUI::Window::d_abs_area, CEGUI::Window::d_maxSize, CEGUI::Window::d_minSize, CEGUI::Window::d_parent, CEGUI::Window::d_rel_area, CEGUI::Window::EventNamespace, CEGUI::Window::EventParentSized, CEGUI::EventSet::fireEvent(), CEGUI::Window::getMetricsMode(), CEGUI::Window::onMoved(), CEGUI::Window::onSized(), CEGUI::Window::relativeToAbsolute_impl(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::addChild_impl(), and CEGUI::System::setGUISheet().

void CEGUI::Window::onRenderingEnded WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when rendering for this window has ended.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2925 of file CEGUIWindow.cpp.

References CEGUI::Window::EventNamespace, CEGUI::Window::EventRenderingEnded, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::render().

void CEGUI::Window::onRenderingStarted WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when rendering for this window has started.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2919 of file CEGUIWindow.cpp.

References CEGUI::Window::EventNamespace, CEGUI::Window::EventRenderingStarted, and CEGUI::EventSet::fireEvent().

Referenced by CEGUI::Window::render().

void CEGUI::MultiColumnList::onSelectionChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the current selection changes.

Definition at line 1835 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventSelectionChanged, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by clearAllSelections(), onMouseButtonDown(), and setItemSelectState().

void CEGUI::MultiColumnList::onSelectionModeChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the selection mode of the list box changes.

Definition at line 1790 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventSelectionModeChanged, and CEGUI::EventSet::fireEvent().

Referenced by setSelectionMode().

void CEGUI::Window::onShown WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window is shown (made visible).

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2833 of file CEGUIWindow.cpp.

References CEGUI::Window::EventNamespace, CEGUI::Window::EventShown, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setVisible().

void CEGUI::MultiColumnList::onSized WindowEventArgs e  )  [protected, virtual]
 

Handler called when the window's size changes.

Parameters:
e WindowEventArgs 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.

Definition at line 1897 of file CEGUIMultiColumnList.cpp.

References configureScrollbars(), CEGUI::EventArgs::handled, and layoutComponentWidgets().

void CEGUI::MultiColumnList::onSortColumnChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the sort column changes.

Definition at line 1856 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventSortColumnChanged, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by handleSortColumnChange().

void CEGUI::MultiColumnList::onSortDirectionChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the sort direction changes.

Definition at line 1866 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventSortDirectionChanged, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by handleSortDirectionChange().

void CEGUI::Window::onTextChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the window's text is changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Reimplemented in CEGUI::Combobox, CEGUI::Editbox, CEGUI::MultiLineEditbox, and CEGUI::StaticText.

Definition at line 2793 of file CEGUIWindow.cpp.

References CEGUI::Window::EventNamespace, CEGUI::Window::EventTextChanged, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::setText().

void CEGUI::MultiColumnList::onVertScrollbarModeChanged WindowEventArgs e  )  [protected, virtual]
 

Handler called when the vertical scroll bar 'force' mode is changed.

Definition at line 1817 of file CEGUIMultiColumnList.cpp.

References EventNamespace, EventVertScrollbarModeChanged, and CEGUI::EventSet::fireEvent().

Referenced by setShowVertScrollbar().

void CEGUI::Window::onZChange_impl void   )  [protected, virtual, inherited]
 

Notify 'this' and all siblings of a ZOrder change event.

Definition at line 1786 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::d_parent, CEGUI::Window::getChildCount(), CEGUI::Window::onZChanged(), and CEGUI::uint.

Referenced by CEGUI::Window::addChildWindow(), CEGUI::Window::moveToBack(), CEGUI::Window::moveToFront(), CEGUI::Window::removeChildWindow(), and CEGUI::Window::setAlwaysOnTop().

void CEGUI::Window::onZChanged WindowEventArgs e  )  [protected, virtual, inherited]
 

Handler called when the z-order position of this window has changed.

Parameters:
e WindowEventArgs object whose 'window' pointer field is set to the window that triggered the event. For this event the trigger window is always 'this'.

Definition at line 2931 of file CEGUIWindow.cpp.

References CEGUI::Window::EventNamespace, CEGUI::Window::EventZOrderChanged, CEGUI::EventSet::fireEvent(), and CEGUI::Window::requestRedraw().

Referenced by CEGUI::Window::onZChange_impl().

bool CEGUI::MultiColumnList::pred_descend const ListRow a,
const ListRow b
[static, protected]
 

std algorithm predicate used for sorting in descending order

Definition at line 2159 of file CEGUIMultiColumnList.cpp.

Rect CEGUI::Window::relativeToAbsolute const Rect rect  )  const [inherited]
 

Convert the given area from relative to absolute metrics.

Parameters:
rect Rect object describing the area specified in relative metrics for this Window.
Returns:
A Rect object that describes an area in absolute metric values that is equivalent to rect, given the Window objects current size.

Definition at line 1367 of file CEGUIWindow.cpp.

References CEGUI::Window::relativeToAbsolute_impl().

Size CEGUI::Window::relativeToAbsolute const Size sze  )  const [inherited]
 

Convert the given size from relative to absolute metrics.

Parameters:
sze Size object describing a size specified in relative metrics for this Window.
Returns:
A Size object that describes a size in absolute metric values that is equivalent to sze, given the Window objects current size.

Definition at line 1358 of file CEGUIWindow.cpp.

References CEGUI::Window::relativeToAbsolute_impl().

Point CEGUI::Window::relativeToAbsolute const Point pt  )  const [inherited]
 

Convert the given position from relative to absolute metrics.

Parameters:
pt Point object describing a position specified in relative metrics for this Window (so 0,0 is this windows top-left corner).
Returns:
A Point object describing a position in absolute metric values that is equivalent to pt, given the Window objects current size.

Definition at line 1349 of file CEGUIWindow.cpp.

References CEGUI::Point, and CEGUI::Window::relativeToAbsolute_impl().

Referenced by CEGUI::MultiLineEditbox::getTextIndexFromPosition(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::Thumb::onMouseButtonDown(), onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), CEGUI::ListHeader::segmentDragHandler(), CEGUI::ListHeader::segmentMovedHandler(), and CEGUI::Window::windowToScreen().

Point CEGUI::Window::relativeToAbsolute_impl const Window window,
const Point pt
const [protected, inherited]
 

Definition at line 1979 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Window::getWindowSize_impl(), PixelAligned, and CEGUI::Point.

Size CEGUI::Window::relativeToAbsolute_impl const Window window,
const Size sz
const [protected, inherited]
 

Definition at line 1964 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Rect CEGUI::Window::relativeToAbsolute_impl const Window window,
const Rect rect
const [protected, inherited]
 

Return a Rect object that describes, in absolute values offset from window, the relative area described by rect.

Parameters:
window Pointer to a window object that is to be used as the base for the conversion. If this is NULL then the size of the display, as returned by the renderer object, is used.
rect Rect object describing the area, in relative values, that is to be returned as absolute values.
Returns:
Rect object that describes in absolute values offset from window, the same area described as relative values in rect.

Definition at line 1947 of file CEGUIWindow.cpp.

References CEGUI::Rect::d_bottom, CEGUI::Size::d_height, CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Window::onParentSized(), CEGUI::Window::relativeToAbsolute(), CEGUI::Window::setMaximumSize(), CEGUI::Window::setMinimumSize(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), and CEGUI::Window::setSize().

float CEGUI::Window::relativeToAbsoluteX float  val  )  const [inherited]
 

Convert the given X co-ordinate from relative to absolute metrics.

Parameters:
val X co-ordinate specified in relative metrics for this Window (so 0 is this windows left edge).
Returns:
An absolute metric value that is equivalent to val, given the Window objects current width.

Definition at line 1331 of file CEGUIWindow.cpp.

References CEGUI::Window::relativeToAbsoluteX_impl().

Referenced by handleHeaderScroll(), insertColumn(), CEGUI::ListHeader::segmentDragHandler(), CEGUI::ListHeader::segmentMovedHandler(), setColumnHeaderWidth(), and CEGUI::Window::windowToScreenX().

float CEGUI::Window::relativeToAbsoluteX_impl const Window window,
float  x
const [protected, inherited]
 

Definition at line 1994 of file CEGUIWindow.cpp.

References CEGUI::Size::d_width, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Thumb::onMouseMove(), and CEGUI::Window::relativeToAbsoluteX().

float CEGUI::Window::relativeToAbsoluteY float  val  )  const [inherited]
 

Convert the given Y co-ordinate from relative to absolute metrics.

Parameters:
val Y co-ordinate specified in relative metrics for this Window (so 0 is this windows top edge).
Returns:
An absolute metric value that is equivalent to val, given the Window objects current height.

Definition at line 1340 of file CEGUIWindow.cpp.

References CEGUI::Window::relativeToAbsoluteY_impl().

Referenced by CEGUI::TabControlProperties::AbsoluteTabHeight::getDefault(), CEGUI::TabControl::setRelativeTabHeight(), CEGUI::TabControl::setRelativeTabTextPadding(), and CEGUI::Window::windowToScreenY().

float CEGUI::Window::relativeToAbsoluteY_impl const Window window,
float  y
const [protected, inherited]
 

Definition at line 2006 of file CEGUIWindow.cpp.

References CEGUI::Size::d_height, CEGUI::Window::getWindowSize_impl(), and PixelAligned.

Referenced by CEGUI::Thumb::onMouseMove(), and CEGUI::Window::relativeToAbsoluteY().

void CEGUI::Window::releaseInput void   )  [inherited]
 

Releases input capture from this Window. If this Window does not have inputs captured, nothing happens.

Returns:
Nothing

Definition at line 1189 of file CEGUIWindow.cpp.

References CEGUI::Window::d_captureWindow, CEGUI::Window::d_oldCapture, CEGUI::Window::isCapturedByThis(), CEGUI::Window::moveToFront(), and CEGUI::Window::onCaptureLost().

Referenced by CEGUI::Combobox::hideDropList(), CEGUI::ComboDropList::onMouseButtonDown(), CEGUI::Titlebar::onMouseButtonUp(), CEGUI::MultiLineEditbox::onMouseButtonUp(), CEGUI::ListHeaderSegment::onMouseButtonUp(), CEGUI::FrameWindow::onMouseButtonUp(), CEGUI::Editbox::onMouseButtonUp(), CEGUI::ComboDropList::onMouseButtonUp(), CEGUI::ButtonBase::onMouseButtonUp(), CEGUI::Titlebar::setDraggingEnabled(), CEGUI::ListHeaderSegment::setSizingEnabled(), and CEGUI::Window::~Window().

void CEGUI::EventSet::removeAllEvents void   )  [inherited]
 

Remove all Event objects from the EventSet.

Returns:
Nothing

Definition at line 84 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::~EventSet().

void CEGUI::Window::removeChild_impl Window wnd  )  [protected, virtual, inherited]
 

Remove given window from child list.

Definition at line 1765 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, and CEGUI::Window::setParent().

Referenced by CEGUI::Window::moveToBack(), CEGUI::Window::moveToFront(), CEGUI::Window::removeChildWindow(), and CEGUI::Window::setAlwaysOnTop().

void CEGUI::Window::removeChildWindow uint  ID  )  [inherited]
 

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.

Parameters:
ID ID number assigned to the Window to be removed. If no Window with ID code ID is attached, nothing happens.
Returns:
Nothing.

Definition at line 1023 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), CEGUI::Window::removeChildWindow(), and CEGUI::uint.

void CEGUI::Window::removeChildWindow Window window  )  [inherited]
 

Remove the specified Window form this windows child list.

Parameters:
window Pointer to the Window object to be removed. If the window is not attached to this Window, then nothing happens.
Returns:
Nothing.

Definition at line 1009 of file CEGUIWindow.cpp.

References CEGUI::Window::onChildRemoved(), CEGUI::Window::onZChange_impl(), and CEGUI::Window::removeChild_impl().

void CEGUI::Window::removeChildWindow const String name  )  [inherited]
 

Remove the named Window from this windows child list.

Parameters:
name String object holding the name of the Window to be removed. If the Window specified is not attached to this Window, nothing happens.
Returns:
Nothing.

Definition at line 989 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), and CEGUI::uint.

Referenced by CEGUI::Window::addChild_impl(), CEGUI::Window::cleanupChildren(), CEGUI::GUILayout_xmlHandler::cleanupLoadedWindows(), CEGUI::TabControl::removeButtonForTabContent(), CEGUI::Window::removeChildWindow(), CEGUI::ListHeader::removeColumn(), CEGUI::TabControl::removeTab(), and CEGUI::Window::~Window().

void CEGUI::MultiColumnList::removeColumn uint  col_idx  ) 
 

Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.

Parameters:
col_idx Zero based index of the column to be removed.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_idx is invalid.

Definition at line 705 of file CEGUIMultiColumnList.cpp.

References d_grid, d_header, d_nominatedSelectCol, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isAutoDeleted(), onListContentsChanged(), CEGUI::ListHeader::removeColumn(), CEGUI::uint, and CEGUI::utf8.

Referenced by removeColumnWithID().

void CEGUI::MultiColumnList::removeColumnWithID uint  col_id  ) 
 

Removes a column from the list box. This will cause any ListboxItem using the autoDelete option in the column to be deleted.

Parameters:
col_id ID code of the column to be deleted.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if no column with col_id is available on this list box.

Definition at line 751 of file CEGUIMultiColumnList.cpp.

References getColumnWithID(), and removeColumn().

void CEGUI::EventSet::removeEvent const String name  )  [inherited]
 

Removes the Event with the given name. All connections to the event are disconnected.

Parameters:
name String object containing the name of the Event to remove. If no such Event exists, nothing happens.
Returns:
Nothing.

Definition at line 68 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

void CEGUI::PropertySet::removeProperty const String name  )  [inherited]
 

Removes a Property from the PropertySet.

Parameters:
name String containing the name of the Property to be removed. If Property name is not in the set, nothing happens.
Returns:
Nothing.

Definition at line 55 of file CEGUIPropertySet.cpp.

void CEGUI::MultiColumnList::removeRow uint  row_idx  ) 
 

Remove the list box row with index row_idx. Any ListboxItem in row row_idx using autoDelete mode will be deleted.

Parameters:
row_idx Zero based index of the row to be removed.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if row_idx is invalid.

Definition at line 882 of file CEGUIMultiColumnList.cpp.

References d_grid, d_nominatedSelectRow, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isAutoDeleted(), onListContentsChanged(), CEGUI::uint, and CEGUI::utf8.

void CEGUI::Window::render void   )  [inherited]
 

Causes the Window object to render itself and all of it's attached children.

Returns:
Nothing

Definition at line 1602 of file CEGUIWindow.cpp.

References CEGUI::Renderer::advanceZValue(), CEGUI::Window::d_children, CEGUI::Window::drawSelf(), CEGUI::Window::getChildCount(), CEGUI::Renderer::getCurrentZ(), CEGUI::Window::isVisible(), CEGUI::Window::onRenderingEnded(), CEGUI::Window::onRenderingStarted(), and CEGUI::uint.

Referenced by CEGUI::System::renderGUI().

virtual void CEGUI::MultiColumnList::renderListboxBaseImagery float  z  )  [protected, pure virtual]
 

Perform rendering of the widget control frame and other 'static' areas. This method should not render the actual items. Note that the items are typically rendered to layer 3, other layers can be used for rendering imagery behind and infront of the items.

Parameters:
z Z co-ordinate for layer 0.
Returns:
Nothing.

Referenced by drawSelf().

void CEGUI::Window::requestRedraw void   )  const [inherited]
 

Signal the System object to redraw (at least) this Window on the next render cycle.

Returns:
Nothing

Definition at line 1277 of file CEGUIWindow.cpp.

Referenced by CEGUI::TabControl::addTab(), CEGUI::TabControl::calculateTabButtonSizePosition(), CEGUI::MultiLineEditbox::formatText(), CEGUI::TabControl::handleContentWindowTextChanged(), CEGUI::StaticText::handleScrollbarChange(), handleUpdatedItemData(), CEGUI::Listbox::handleUpdatedItemData(), CEGUI::ListHeaderSegment::initSegmentHoverState(), CEGUI::ListHeaderSegment::initSizingHoverState(), CEGUI::Window::onActivated(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onAlwaysOnTopChanged(), CEGUI::ButtonBase::onCaptureLost(), CEGUI::MultiLineEditbox::onCaratMoved(), CEGUI::Editbox::onCaratMoved(), CEGUI::Window::onChildAdded(), CEGUI::Window::onChildRemoved(), CEGUI::Window::onClippingChanged(), CEGUI::Window::onDeactivated(), CEGUI::Window::onDisabled(), CEGUI::Window::onEnabled(), CEGUI::Window::onFontChanged(), CEGUI::StaticText::onFontChanged(), CEGUI::Window::onHidden(), CEGUI::MultiLineEditbox::onHorzScrollbarModeChanged(), CEGUI::Listbox::onHorzScrollbarModeChanged(), CEGUI::Window::onInheritsAlphaChanged(), onListColumnMoved(), onListColumnSized(), onListContentsChanged(), CEGUI::Listbox::onListContentsChanged(), CEGUI::Editbox::onMaskCodePointChanged(), CEGUI::Editbox::onMaskedRenderingModeChanged(), CEGUI::ButtonBase::onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseLeaves(), CEGUI::ButtonBase::onMouseLeaves(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::Window::onMoved(), CEGUI::Window::onParentSized(), CEGUI::ProgressBar::onProgressChanged(), CEGUI::Editbox::onReadOnlyChanged(), CEGUI::ListHeaderSegment::onSegmentDragPositionChanged(), CEGUI::ListHeaderSegment::onSegmentSized(), CEGUI::TabControl::onSelectionChanged(), onSelectionChanged(), CEGUI::Listbox::onSelectionChanged(), CEGUI::Window::onShown(), CEGUI::Window::onSized(), CEGUI::StaticText::onSized(), onSortColumnChanged(), onSortDirectionChanged(), CEGUI::ListHeaderSegment::onSortDirectionChanged(), CEGUI::Listbox::onSortModeChanged(), CEGUI::Window::onTextChanged(), CEGUI::StaticText::onTextChanged(), CEGUI::MultiLineEditbox::onTextSelectionChanged(), CEGUI::Editbox::onTextSelectionChanged(), CEGUI::MultiLineEditbox::onVertScrollbarModeChanged(), CEGUI::Listbox::onVertScrollbarModeChanged(), CEGUI::Window::onZChanged(), CEGUI::TabControl::removeTab(), CEGUI::Static::setBackgroundColours(), CEGUI::Static::setBackgroundEnabled(), CEGUI::Static::setBackgroundImage(), CEGUI::Titlebar::setCaptionColour(), CEGUI::ButtonBase::setDisabledTextColour(), CEGUI::StaticText::setFormatting(), CEGUI::StaticImage::setFormatting(), CEGUI::Static::setFrameColours(), CEGUI::Static::setFrameEnabled(), CEGUI::FrameWindow::setFrameEnabled(), CEGUI::Static::setFrameImages(), CEGUI::StaticText::setHorizontalFormatting(), CEGUI::StaticImage::setHorizontalFormatting(), CEGUI::ButtonBase::setHoverTextColour(), CEGUI::StaticImage::setImage(), CEGUI::StaticImage::setImageColours(), CEGUI::MultiLineEditbox::setInactiveSelectBrushColour(), CEGUI::Editbox::setInactiveSelectBrushColour(), CEGUI::MultiLineEditbox::setNormalSelectBrushColour(), CEGUI::Editbox::setNormalSelectBrushColour(), CEGUI::MultiLineEditbox::setNormalTextColour(), CEGUI::Editbox::setNormalTextColour(), CEGUI::ButtonBase::setNormalTextColour(), CEGUI::ButtonBase::setPushedTextColour(), CEGUI::TabButton::setRightOfSelected(), CEGUI::ListHeader::setSegmentOffset(), CEGUI::TabButton::setSelected(), CEGUI::RadioButton::setSelected(), CEGUI::Checkbox::setSelected(), CEGUI::MultiLineEditbox::setSelectedTextColour(), CEGUI::Editbox::setSelectedTextColour(), CEGUI::ListHeaderSegment::setSortDirection(), CEGUI::StaticText::setTextColours(), CEGUI::StaticText::setVerticalFormatting(), CEGUI::StaticImage::setVerticalFormatting(), and CEGUI::ButtonBase::updateInternalState().

void CEGUI::MultiColumnList::resetList void   ) 
 

Remove all items from the list.

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

Definition at line 644 of file CEGUIMultiColumnList.cpp.

References onListContentsChanged(), and resetList_impl().

bool CEGUI::MultiColumnList::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).

Definition at line 2204 of file CEGUIMultiColumnList.cpp.

References d_grid, d_lastSelected, d_nominatedSelectRow, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isAutoDeleted(), and CEGUI::uint.

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

bool CEGUI::Window::restoresOldCapture void   )  const [inline, inherited]
 

Return whether this window is set to restore old input capture when it loses input capture.

This is only really useful for certain sub-components for widget writers.

Returns:
  • true if the window will restore the previous capture window when it loses input capture.
  • false if the window will set the capture window to NULL when it loses input capture (this is the default behaviour).

Definition at line 965 of file CEGUIWindow.h.

Rect CEGUI::Window::screenToWindow const Rect rect  )  const [inherited]
 

Convert a screen area to a window area, specified in whichever metrics mode is active.

Parameters:
rect Rect object describing the area to be converted
Returns:
Rect object describing a window area that is equivalent to screen area rect.

Definition at line 1578 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), CEGUI::Rect::getWidth(), CEGUI::Window::windowToScreenX(), and CEGUI::Window::windowToScreenY().

Size CEGUI::Window::screenToWindow const Size sze  )  const [inherited]
 

Convert a pixel screen size to a window based size, specified in whichever metrics mode is active.

Parameters:
sze Size object describing the size to be converted
Returns:
Size object describing a window based size that is equivalent to screen based size sze.

Definition at line 1560 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), and CEGUI::Rect::getWidth().

Point CEGUI::Window::screenToWindow const Point pt  )  const [inherited]
 

Convert a screen relative pixel position to a window co-ordinate position, specified in whichever metrics mode is active.

Parameters:
pt Point object describing the position to be converted
Returns:
Point object describing a window co-ordinate position that is equivalent to screen co-ordinate x.

Definition at line 1540 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), CEGUI::Rect::getWidth(), CEGUI::Point, CEGUI::Window::windowToScreenX(), and CEGUI::Window::windowToScreenY().

Referenced by CEGUI::MultiLineEditbox::getTextIndexFromPosition(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::Thumb::onMouseButtonDown(), onMouseButtonDown(), CEGUI::ListHeaderSegment::onMouseButtonDown(), CEGUI::Listbox::onMouseButtonDown(), CEGUI::FrameWindow::onMouseButtonDown(), CEGUI::Titlebar::onMouseMove(), CEGUI::Thumb::onMouseMove(), CEGUI::ListHeaderSegment::onMouseMove(), CEGUI::FrameWindow::onMouseMove(), CEGUI::ComboDropList::onMouseMove(), CEGUI::ListHeader::segmentDragHandler(), and CEGUI::ListHeader::segmentMovedHandler().

float CEGUI::Window::screenToWindowX float  x  )  const [inherited]
 

Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.

Parameters:
x x co-ordinate value to be converted
Returns:
float value describing a window co-ordinate value that is equivalent to screen co-ordinate x.

Definition at line 1506 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::getMetricsMode(), CEGUI::Rect::getWidth(), and CEGUI::Window::windowToScreenX().

float CEGUI::Window::screenToWindowY float  y  )  const [inherited]
 

Convert a screen relative pixel co-ordinate value to a window co-ordinate value, specified in whichever metrics mode is active.

Parameters:
y y co-ordinate value to be converted
Returns:
float value describing a window co-ordinate value that is equivalent to screen co-ordinate y.

Definition at line 1523 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), and CEGUI::Window::windowToScreenY().

bool CEGUI::MultiColumnList::selectRange const MCLGridRef start,
const MCLGridRef end
[protected]
 

select all strings between positions start and end. (inclusive). Returns true if something was modified.

Definition at line 1354 of file CEGUIMultiColumnList.cpp.

References CEGUI::MCLGridRef::column, d_grid, getItemGridReference(), CEGUI::MCLGridRef::row, setItemSelectState_impl(), and CEGUI::uint.

Referenced by onMouseButtonDown().

void CEGUI::Window::setAlpha float  alpha  )  [inherited]
 

Set the current alpha value for this window.

Note:
The alpha value set for any given window may or may not be the final alpha value that is used when rendering. All window objects, by default, inherit alpha from thier parent window(s) - this will blend child windows, relatively, down the line of inheritance. This behaviour can be overridden via the setInheritsAlpha() method. To return the true alpha value that will be applied when rendering, use the getEffectiveAlpha() method.
Parameters:
alpha The new alpha value for the window. Value should be between 0.0f and 1.0f.
Returns:
Nothing

Definition at line 1237 of file CEGUIWindow.cpp.

References CEGUI::Window::d_alpha, and CEGUI::Window::onAlphaChanged().

void CEGUI::Window::setAlwaysOnTop bool  setting  )  [inherited]
 

Set whether this window is always on top, or not.

Parameters:
setting true to have the Window appear on top of all other non always on top windows, or false to allow the window to be covered by other windows.
Returns:
Nothing

Definition at line 740 of file CEGUIWindow.cpp.

References CEGUI::Window::addChild_impl(), CEGUI::Window::d_alwaysOnTop, CEGUI::Window::d_parent, CEGUI::Window::isAlwaysOnTop(), CEGUI::Window::onAlwaysOnTopChanged(), CEGUI::Window::onZChange_impl(), and CEGUI::Window::removeChild_impl().

Referenced by CEGUI::Titlebar::Titlebar().

void CEGUI::Window::setAreaRect const Rect area  )  [inherited]
 

Set the current area for the Window, this allows for setting of position and size at the same time. Interpretation of the input value area is dependant upon the current metrics system set for the Window.

Parameters:
area Rect object that describes the new area for Window, in units consistent with the current metrics mode.
Returns:
Nothing

Definition at line 927 of file CEGUIWindow.cpp.

References CEGUI::Window::getMetricsMode(), and CEGUI::Window::setRect().

void CEGUI::Window::setAutoRepeatDelay float  delay  )  [inherited]
 

Set the current auto-repeat delay setting for this window.

Parameters:
delay float value indicating the delay, in seconds, defore the first repeat mouse button down event should be triggered when autorepeat is enabled.
Returns:
Nothing.

Definition at line 2683 of file CEGUIWindow.cpp.

References CEGUI::Window::d_repeatDelay.

void CEGUI::Window::setAutoRepeatRate float  rate  )  [inherited]
 

Set the current auto-repeat rate setting for this window.

Parameters:
rate float value indicating the rate, in seconds, at which repeat mouse button down events should be generated after the initial delay has expired.
Returns:
Nothing.

Definition at line 2698 of file CEGUIWindow.cpp.

References CEGUI::Window::d_repeatRate.

void CEGUI::Window::setClippedByParent bool  setting  )  [inherited]
 

Set whether this Window will be clipped by its parent window(s).

Parameters:
setting true to have the Window clipped so that rendering is constrained to within the area of its parent(s), or false to have rendering constrained to the screen only.
Returns:
Nothing

Definition at line 836 of file CEGUIWindow.cpp.

References CEGUI::Window::d_clippedByParent, and CEGUI::Window::onClippingChanged().

void CEGUI::MultiColumnList::setColumnHeaderWidth uint  col_idx,
float  width
 

Set the width of the specified column header (and therefore the column itself).

Parameters:
col_idx Zero based column index of the column whos width is to be set.
width float value specifying the new width for the column using the active metrics system.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if column is out of range.

Definition at line 1255 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::Window::getMetricsMode(), CEGUI::Window::relativeToAbsoluteX(), and CEGUI::ListHeader::setColumnPixelWidth().

Referenced by autoSizeColumnHeader().

void CEGUI::Window::setDestroyedByParent bool  setting  )  [inherited]
 

Set whether or not this Window will automatically be destroyed when its parent Window is destroyed.

Parameters:
setting set to true to have the Window auto-destroyed when its parent is destroyed (default), or false to have the Window remain after its parent is destroyed.
Returns:
Nothing

Definition at line 2198 of file CEGUIWindow.cpp.

References CEGUI::Window::d_destroyedByParent, and CEGUI::Window::onParentDestroyChanged().

void CEGUI::Window::setEnabled bool  setting  )  [inherited]
 

Set whether this window is enabled or disabled. A disabled window normally can not be interacted with, and may have different rendering.

Parameters:
setting true to enable the Window, and false to disable the Window.
Returns:
Nothing

Definition at line 769 of file CEGUIWindow.cpp.

References CEGUI::Window::d_enabled, CEGUI::Window::onDisabled(), and CEGUI::Window::onEnabled().

Referenced by CEGUI::FrameWindow::setCloseButtonEnabled(), and CEGUI::FrameWindow::setTitleBarEnabled().

void CEGUI::Window::setFont const String name  )  [inherited]
 

Set the font used by this Window.

Parameters:
name String object holding the name of the Font object to be used by this Window. If name == "", the default font will be used.
Returns:
Nothing
Exceptions:
UnknownObjectException thrown if the specified Font is unknown within the system.

Definition at line 947 of file CEGUIWindow.cpp.

References CEGUI::String::empty(), CEGUI::Window::getFont(), and CEGUI::Window::setFont().

void CEGUI::Window::setFont const Font font  )  [inherited]
 

Set the font used by this Window.

Parameters:
font Pointer to the Font object to be used by this Window. If font is NULL, the default font will be used.
Returns:
Nothing

Definition at line 936 of file CEGUIWindow.cpp.

References CEGUI::Window::d_font, and CEGUI::Window::onFontChanged().

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::Combobox::initialise(), CEGUI::TabControl::onFontChanged(), CEGUI::Combobox::onFontChanged(), CEGUI::Window::setFont(), and CEGUI::FrameWindow::setTitlebarFont().

void CEGUI::Window::setHeight MetricsMode  mode,
float  height
[inherited]
 

set the height of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
height float value that specifies the height of the Window using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2442 of file CEGUIWindow.cpp.

References CEGUI::Window::getWidth(), and CEGUI::Window::setSize().

void CEGUI::Window::setHeight float  height  )  [inherited]
 

Set the current height of the Window. Interpretation of the input value height is dependant upon the current metrics system set for the Window.

Parameters:
height float value that specifies the new height for the window, in units consistent with whatever metrics mode is in operation.
Returns:
Nothing

Definition at line 874 of file CEGUIWindow.cpp.

References CEGUI::Window::getWidth(), and CEGUI::Window::setSize().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition().

void CEGUI::Window::setID uint  ID  )  [inherited]
 

Set the current ID for the Window.

Parameters:
ID Client assigned ID code for this Window. The GUI system assigns no meaning to any IDs, they are a device purely for client code usage.
Returns:
Nothing

Definition at line 2159 of file CEGUIWindow.cpp.

References CEGUI::Window::d_ID, and CEGUI::Window::onIDChanged().

Referenced by CEGUI::ListHeader::createInitialisedSegment().

void CEGUI::Window::setInheritsAlpha bool  setting  )  [inherited]
 

Sets whether this Window will inherit alpha from its parent windows.

Parameters:
setting true if the Window should use inherited alpha, or false if the Window should have an independant alpha value.
Returns:
Nothing

Definition at line 1248 of file CEGUIWindow.cpp.

References CEGUI::Window::d_inheritsAlpha, CEGUI::Window::getEffectiveAlpha(), CEGUI::EventArgs::handled, CEGUI::Window::onAlphaChanged(), and CEGUI::Window::onInheritsAlphaChanged().

void CEGUI::MultiColumnList::setItem ListboxItem item,
uint  col_id,
uint  row_idx
 

Set the ListboxItem for the column with ID col_id in row row_idx.

Parameters:
item Pointer to the ListboxItem to be set into the list.
col_id ID code of the column to receive item.
row_idx Zero based index of the row to receive item.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if no column with ID col_id exists, or of row_idx is out of range.

Definition at line 959 of file CEGUIMultiColumnList.cpp.

References getColumnWithID(), and setItem().

void CEGUI::MultiColumnList::setItem ListboxItem item,
const MCLGridRef position
 

Set the ListboxItem for grid reference position.

Parameters:
item Pointer to the ListboxItem to be set at position.
position MCLGridRef describing the grid reference of the item to be set.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if position contains an invalid grid reference.

Definition at line 924 of file CEGUIMultiColumnList.cpp.

References CEGUI::MCLGridRef::column, d_grid, getColumnCount(), getRowCount(), CEGUI::ListboxItem::isAutoDeleted(), onListContentsChanged(), CEGUI::MCLGridRef::row, CEGUI::ListboxItem::setOwnerWindow(), and CEGUI::utf8.

Referenced by insertRow(), and setItem().

void CEGUI::MultiColumnList::setItemSelectState const MCLGridRef grid_ref,
bool  state
 

Sets or clears the selected state of the ListboxItem at the given grid reference.

Note:
Depending upon the current selection mode, this may cause other items to be selected, other items to be deselected, or for nothing to actually happen at all.
Parameters:
grid_ref MCLGridRef object describing the position of the item to be affected.
state 
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if grid_ref is invalid for this list box.

Definition at line 1228 of file CEGUIMultiColumnList.cpp.

References onSelectionChanged(), and setItemSelectState_impl().

void CEGUI::MultiColumnList::setItemSelectState ListboxItem item,
bool  state
 

Sets or clears the selected state of the given ListboxItem which must be attached to the list.

Note:
Depending upon the current selection mode, this may cause other items to be selected, other items to be deselected, or for nothing to actually happen at all.
Parameters:
item Pointer to the attached ListboxItem to be affected.
state 
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if item is not attached to the list box.

Definition at line 1219 of file CEGUIMultiColumnList.cpp.

References getItemGridReference().

bool CEGUI::MultiColumnList::setItemSelectState_impl const MCLGridRef  grid_ref,
bool  state
[protected]
 

Set select state for the given item. This appropriately selects other items depending upon the select mode. Returns true if something is changed, else false.

Definition at line 1567 of file CEGUIMultiColumnList.cpp.

References clearAllSelections_impl(), CEGUI::MCLGridRef::column, d_grid, d_nominatedSelectCol, d_nominatedSelectRow, d_useNominatedCol, d_useNominatedRow, getColumnCount(), getRowCount(), CEGUI::MCLGridRef::row, setSelectForItemsInColumn(), setSelectForItemsInRow(), and CEGUI::utf8.

Referenced by onMouseButtonDown(), selectRange(), and setItemSelectState().

void CEGUI::Window::setMaximumSize const Size sz  )  [inherited]
 

Set the maximum size for this window.

Parameters:
sz Size object describing the maximum size for the window. For absolute metrics, the Size values are in screen pixels, for relative metrics the Size values are relative to the display size.

Definition at line 2100 of file CEGUIWindow.cpp.

References CEGUI::Rect::constrainSizeMax(), CEGUI::Window::d_abs_area, CEGUI::Size::d_height, CEGUI::Window::d_maxSize, CEGUI::Size::d_width, CEGUI::Window::getMetricsMode(), CEGUI::Window::onSized(), PixelAligned, and CEGUI::Window::relativeToAbsolute_impl().

Referenced by CEGUI::GUISheetFactory::createWindow(), and CEGUI::Window::Window().

void CEGUI::Window::setMetricsMode MetricsMode  mode  )  [inherited]
 

set the current metrics mode employed by the Window

Parameters:
mode One of the values of the MectricsMode enumerated type, that describes the metrics mode to be used by the Window.
Returns:
Nothing

Definition at line 2175 of file CEGUIWindow.cpp.

References CEGUI::Window::d_metricsMode, CEGUI::Window::getMetricsMode(), CEGUI::MetricsMode, and CEGUI::Window::onMetricsChanged().

Referenced by CEGUI::ListHeader::createInitialisedSegment().

void CEGUI::Window::setMinimumSize const Size sz  )  [inherited]
 

Set the minimum size for this window.

Parameters:
sz Size object describing the minimum size for the window. For absolute metrics, the Size values are in screen pixels, for relative metrics the Size values are relative to the display size.

Definition at line 2069 of file CEGUIWindow.cpp.

References CEGUI::Rect::constrainSizeMin(), CEGUI::Window::d_abs_area, CEGUI::Size::d_height, CEGUI::Window::d_minSize, CEGUI::Size::d_width, CEGUI::Window::getMetricsMode(), CEGUI::Window::onSized(), PixelAligned, and CEGUI::Window::relativeToAbsolute_impl().

Referenced by CEGUI::ListHeader::createInitialisedSegment(), and CEGUI::Window::Window().

void CEGUI::Window::setMouseAutoRepeatEnabled bool  setting  )  [inherited]
 

Set whether mouse button down event autorepeat is enabled for this window.

Parameters:
setting 
  • true to enable autorepeat of mouse button down events.
  • false to disable autorepeat of mouse button down events.
Returns:
Nothing.

Definition at line 2667 of file CEGUIWindow.cpp.

References CEGUI::Window::d_autoRepeat, and CEGUI::Window::d_repeatButton.

void CEGUI::Window::setMouseCursor const String imageset,
const String image_name
[inherited]
 

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:
imageset String object that contains the name of the Imageset that contains the image to be used.
image_name String object that contains the name of the Image on imageset that is to be used.
Returns:
Nothing.
Exceptions:
UnknownObjectException thrown if imageset is not known, or if imageset contains no Image named image_name.

Definition at line 2150 of file CEGUIWindow.cpp.

References CEGUI::Window::d_mouseCursor.

void CEGUI::Window::setMouseCursor MouseCursorImage  image  )  [inline, inherited]
 

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:
image One of the MouseCursorImage enumerated values.
Returns:
Nothing.

Definition at line 1550 of file CEGUIWindow.h.

void CEGUI::Window::setMouseCursor const Image image  )  [inline, inherited]
 

Set the mouse cursor image to be used when the mouse enters this window.

Parameters:
image Pointer to the Image object to use as the mouse cursor image when the mouse enters the area for this Window.
Returns:
Nothing.

Definition at line 1537 of file CEGUIWindow.h.

void CEGUI::EventSet::setMutedState bool  setting  )  [inherited]
 

Set the mute state for this EventSet.

Parameters:
setting 
  • true if the EventSet is to be muted (no further event firing requests will be honoured until EventSet is unmuted).
  • false if the EventSet is not to be muted and all events should fired as requested.
Returns:
Nothing.

Definition at line 173 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

void CEGUI::MultiColumnList::setNominatedSelectionColumn uint  col_idx  ) 
 

Set the column to be used for the NominatedColumn* selection modes.

Parameters:
col_idx zero based index of the column to be used in NominatedColumn* selection modes.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_idx is out of range.

Definition at line 1084 of file CEGUIMultiColumnList.cpp.

References clearAllSelections(), d_nominatedSelectCol, and onNominatedSelectColumnChanged().

Referenced by setNominatedSelectionColumnID().

void CEGUI::MultiColumnList::setNominatedSelectionColumnID uint  col_id  ) 
 

Set the column to be used for the NominatedColumn* selection modes.

Parameters:
col_id ID code of the column to be used in NominatedColumn* selection modes.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if no column has ID code col_id.

Definition at line 1075 of file CEGUIMultiColumnList.cpp.

References getColumnWithID(), and setNominatedSelectionColumn().

void CEGUI::MultiColumnList::setNominatedSelectionRow uint  row_idx  ) 
 

Set the row to be used for the NominatedRow* selection modes.

Parameters:
row_idx zero based index of the row to be used in NominatedRow* selection modes.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if row_idx is out of range.

Definition at line 1103 of file CEGUIMultiColumnList.cpp.

References clearAllSelections(), d_nominatedSelectRow, and onNominatedSelectRowChanged().

void CEGUI::Window::setParent Window parent  )  [protected, inherited]
 

Set the parent window for this window object.

Parameters:
parent Pointer to a Window object that is to be assigned as the parent to this Window.
Returns:
Nothing

Definition at line 1634 of file CEGUIWindow.cpp.

References CEGUI::Window::d_parent.

Referenced by CEGUI::Window::addChild_impl(), CEGUI::Window::moveToBack(), and CEGUI::Window::removeChild_impl().

void CEGUI::Window::setPosition MetricsMode  mode,
const Point position
[inherited]
 

set the position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
position Point object that describes the position of the Window relative to it's parent, using the specified MetricsMode.
Returns:
Nothing

Definition at line 2404 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Rect::constrainSize(), CEGUI::Window::d_abs_area, CEGUI::Window::d_maxSize, CEGUI::Window::d_minSize, CEGUI::Window::d_parent, CEGUI::Window::d_rel_area, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Window::getInheritedMetricsMode(), CEGUI::Window::onMoved(), PixelAligned, CEGUI::Point, CEGUI::Window::relativeToAbsolute_impl(), and CEGUI::Rect::setPosition().

void CEGUI::Window::setPosition const Point position  )  [inherited]
 

Set the current position of the Window. Interpretation of the input value position is dependant upon the current metrics system set for the Window.

Parameters:
position Point object that describes the new postion of the Window, in units consistent with the current metrics mode.
Returns:
Nothing

Definition at line 916 of file CEGUIWindow.cpp.

References CEGUI::Window::getMetricsMode(), and CEGUI::Point.

Referenced by CEGUI::TabControl::layoutComponentWidgets(), CEGUI::StaticText::layoutComponentWidgets(), CEGUI::ListHeader::layoutSegments(), CEGUI::Thumb::onMouseMove(), CEGUI::Window::setXPosition(), and CEGUI::Window::setYPosition().

void CEGUI::PropertySet::setProperty const String name,
const String value
[inherited]
 

Sets the current value of a Property.

Parameters:
name String containing the name of the Property who's value is to be set.
value String containing a textual representation of the new value for the Property
Returns:
Nothing
Exceptions:
UnknownObjectException Thrown if no Property named name is in the PropertySet.
InvalidRequestException Thrown when the Property was unable to interpret the content of value.

Definition at line 114 of file CEGUIPropertySet.cpp.

References CEGUI::String::find(), and CEGUI::utf8.

Referenced by CEGUI::GUILayout_xmlHandler::startElement().

void CEGUI::Window::setRect MetricsMode  mode,
const Rect area
[inherited]
 

set the Rect that describes the Window area using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
area Rect object that describes the area to be covered by the Window using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2486 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Rect::constrainSize(), CEGUI::Window::d_abs_area, CEGUI::Rect::d_bottom, CEGUI::Rect::d_left, CEGUI::Window::d_maxSize, CEGUI::Window::d_minSize, CEGUI::Window::d_parent, CEGUI::Window::d_rel_area, CEGUI::Rect::d_right, CEGUI::Rect::d_top, CEGUI::Window::getInheritedMetricsMode(), CEGUI::Window::onMoved(), CEGUI::Window::onSized(), PixelAligned, and CEGUI::Window::relativeToAbsolute_impl().

Referenced by CEGUI::Window::setAreaRect().

void CEGUI::Window::setRestoreCapture bool  setting  )  [inherited]
 

Set whether this window will remember and restore the previous window that had inputs captured.

Parameters:
setting 
  • true: The window will remember and restore the previous capture window. The CaptureLost event is not fired on the previous window when this window steals input capture. When this window releases capture, the old capture window is silently restored.
  • false: Input capture works as normal, each window losing capture is signalled via CaptureLost, and upon the final release of capture, no previous setting is restored (this is the default 'normal' behaviour).

Returns:
Nothing

Definition at line 1220 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::d_restoreOldCapture, CEGUI::Window::getChildCount(), and CEGUI::uint.

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

void CEGUI::MultiColumnList::setSelectForItemsInColumn uint  col_idx,
bool  state
[protected]
 

Set select state for all items in the given column.

Definition at line 1642 of file CEGUIMultiColumnList.cpp.

References d_grid, getRowCount(), CEGUI::ListboxItem::setSelected(), and CEGUI::uint.

Referenced by setItemSelectState_impl().

void CEGUI::MultiColumnList::setSelectForItemsInRow uint  row_idx,
bool  state
[protected]
 

Set select state for all items in the given row.

Definition at line 1623 of file CEGUIMultiColumnList.cpp.

References d_grid, getColumnCount(), CEGUI::ListboxItem::setSelected(), and CEGUI::uint.

Referenced by setItemSelectState_impl().

void CEGUI::MultiColumnList::setSelectionMode MultiColumnList::SelectionMode  sel_mode  ) 
 

Set the selection mode for the list box.

Parameters:
sel_mode One of the MultiColumnList::SelectionMode enumerated values specifying the selection mode to be used.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if the value specified for sel_mode is invalid.

Definition at line 968 of file CEGUIMultiColumnList.cpp.

References CellMultiple, CellSingle, clearAllSelections(), ColumnMultiple, ColumnSingle, d_fullColSelect, d_fullRowSelect, d_multiSelect, d_selectMode, d_useNominatedCol, d_useNominatedRow, NominatedColumnMultiple, NominatedColumnSingle, NominatedRowMultiple, NominatedRowSingle, onSelectionModeChanged(), RowMultiple, RowSingle, and CEGUI::utf8.

Referenced by MultiColumnList().

void CEGUI::MultiColumnList::setShowHorzScrollbar bool  setting  ) 
 

Set whether the horizontal scroll bar should always be shown, or just when needed.

Parameters:
setting 
  • true to have the horizontal scroll bar shown at all times.
  • false to have the horizontal scroll bar appear only when needed.
Returns:
Nothing.

Definition at line 1183 of file CEGUIMultiColumnList.cpp.

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

void CEGUI::MultiColumnList::setShowVertScrollbar bool  setting  ) 
 

Set whether the vertical scroll bar should always be shown, or just when needed.

Parameters:
setting 
  • true to have the vertical scroll bar shown at all times.
  • false to have the vertical scroll bar appear only when needed.
Returns:
Nothing.

Definition at line 1164 of file CEGUIMultiColumnList.cpp.

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

void CEGUI::Window::setSize MetricsMode  mode,
const Size size
[inherited]
 

set the size of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
size Size object that describes the dimensions of the Window using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2451 of file CEGUIWindow.cpp.

References CEGUI::Window::absoluteToRelative_impl(), CEGUI::Rect::constrainSize(), CEGUI::Window::d_abs_area, CEGUI::Size::d_height, CEGUI::Window::d_maxSize, CEGUI::Window::d_minSize, CEGUI::Window::d_parent, CEGUI::Window::d_rel_area, CEGUI::Size::d_width, CEGUI::Window::getInheritedMetricsMode(), CEGUI::Window::onSized(), PixelAligned, CEGUI::Window::relativeToAbsolute_impl(), and CEGUI::Rect::setSize().

void CEGUI::Window::setSize const Size size  )  [inherited]
 

Set the current size of the Window. Interpretation of the input value size is dependant upon the current metrics system set for the Window.

Parameters:
size Size object that describes the new dimensions for the window, in units consistent with whatever metrics mode is in operation.
Returns:
Nothing

Definition at line 884 of file CEGUIWindow.cpp.

References CEGUI::Window::getMetricsMode().

Referenced by CEGUI::ListHeader::createInitialisedSegment(), CEGUI::GUISheetFactory::createWindow(), CEGUI::TabControl::layoutComponentWidgets(), CEGUI::StaticText::layoutComponentWidgets(), CEGUI::Window::setHeight(), CEGUI::Window::setWidth(), and CEGUI::FrameWindow::toggleRollup().

void CEGUI::MultiColumnList::setSortColumn uint  col_idx  ) 
 

Set the column to be used as the sort key.

Parameters:
col_idx Zero based index of the column to use as the key when sorting the list items.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_idx is out of range.

Definition at line 1136 of file CEGUIMultiColumnList.cpp.

References d_header, getSortColumn(), and CEGUI::ListHeader::setSortColumn().

void CEGUI::MultiColumnList::setSortColumnByID uint  col_id  ) 
 

Set the column to be used as the sort key.

Parameters:
col_id ID code of the column to use as the key when sorting the list items.
Returns:
Nothing.
Exceptions:
InvalidRequestException thrown if col_id is invalid for this list box.

Definition at line 1150 of file CEGUIMultiColumnList.cpp.

References d_header, CEGUI::Window::getID(), CEGUI::ListHeader::getSegmentFromColumn(), getSortColumn(), and CEGUI::ListHeader::setSortColumnFromID().

void CEGUI::MultiColumnList::setSortDirection ListHeaderSegment::SortDirection  direction  ) 
 

Set the sort direction to be used.

Parameters:
direction One of the ListHeaderSegment::SortDirection enumerated values specifying the sort direction to be used.
Returns:
Nothing.

Definition at line 1122 of file CEGUIMultiColumnList.cpp.

References d_header, getSortDirection(), and CEGUI::ListHeader::setSortDirection().

Referenced by initialise().

void CEGUI::Window::setText const String text  )  [inherited]
 

Set the current text string for the Window.

Parameters:
text String object containing the text that is to be set as the Window text.
Returns:
Nothing

Definition at line 852 of file CEGUIWindow.cpp.

References CEGUI::Window::d_text, and CEGUI::Window::onTextChanged().

Referenced by CEGUI::ListHeader::createInitialisedSegment(), CEGUI::Combobox::droplist_SelectionAcceptedHandler(), CEGUI::Combobox::editbox_TextChangedEventHandler(), CEGUI::Editbox::handleBackspace(), CEGUI::TabControl::handleContentWindowTextChanged(), CEGUI::Editbox::handleDelete(), CEGUI::Editbox::onCharacter(), CEGUI::Combobox::onTextChanged(), and CEGUI::TabButton::setTargetWindow().

void CEGUI::MultiColumnList::setUserColumnDraggingEnabled bool  setting  ) 
 

Set whether the user may modify the order of the columns.

Parameters:
setting 
  • true if the user may interactively modify the order of the columns.
  • false if the user may not modify the order of the columns.

Definition at line 2141 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::setColumnDraggingEnabled().

void CEGUI::MultiColumnList::setUserColumnSizingEnabled bool  setting  ) 
 

Set whether the user may size column segments.

Parameters:
setting 
  • true if the user may interactively modify the width of columns.
  • false if the user may not change the width of the columns.
Returns:
Nothing.

Definition at line 2132 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::setColumnSizingEnabled().

void CEGUI::Window::setUserData void *  user_data  )  [inline, inherited]
 

Set the user data set for this Window.

Each Window can have some client assigned data attached to it, this data is not used by the GUI system in any way. Interpretation of the data is entirely application specific.

Parameters:
user_data pointer to the user data that is to be set for this window.
Returns:
Nothing.

Definition at line 1584 of file CEGUIWindow.h.

void CEGUI::MultiColumnList::setUserSortControlEnabled bool  setting  ) 
 

Set whether user manipulation of the sort column and direction are enabled.

Parameters:
setting 
  • true if the user may interactively modify the sort column and direction.
  • false if the user may not modify the sort column and direction (these can still be set programmatically).
Returns:
Nothing.

Definition at line 2123 of file CEGUIMultiColumnList.cpp.

References d_header, and CEGUI::ListHeader::setSortingEnabled().

void CEGUI::Window::setVisible bool  setting  )  [inherited]
 

Set whether the Window is visible or hidden.

Parameters:
setting true to make the Window visible, or false to make the Window hidden
Returns:
Nothing

Definition at line 785 of file CEGUIWindow.cpp.

References CEGUI::Window::d_visible, CEGUI::Window::onHidden(), and CEGUI::Window::onShown().

Referenced by CEGUI::TabControl::addTab(), and CEGUI::TabControl::selectTab_impl().

void CEGUI::Window::setWantsMultiClickEvents bool  setting  )  [inherited]
 

Set whether this window will receive multi-click events or multiple 'down' events instead.

Parameters:
setting 
  • true if the Window will receive double-click and triple-click events.
  • false if the Window will receive multiple mouse button down events instead of double/triple click events.
Returns:
Nothing.

Definition at line 2623 of file CEGUIWindow.cpp.

References CEGUI::Window::d_wantsMultiClicks.

void CEGUI::Window::setWidth MetricsMode  mode,
float  width
[inherited]
 

set the width of the Window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
width float value that specifies the width of the Window using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2433 of file CEGUIWindow.cpp.

References CEGUI::Window::getHeight(), and CEGUI::Window::setSize().

void CEGUI::Window::setWidth float  width  )  [inherited]
 

Set the current width of the Window. Interpretation of the input value width is dependant upon the current metrics system set for the Window.

Parameters:
width float value that specifies the new width for the window, in units consistent with whatever metrics mode is in operation.
Returns:
Nothing

Definition at line 864 of file CEGUIWindow.cpp.

References CEGUI::Window::getHeight(), and CEGUI::Window::setSize().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition(), and CEGUI::ListHeader::setColumnPixelWidth().

void CEGUI::Window::setXPosition MetricsMode  mode,
float  x
[inherited]
 

set the x position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
x float value that specifies the x position of the Window relative to it's parent, using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2386 of file CEGUIWindow.cpp.

References CEGUI::Window::getYPosition(), CEGUI::Point, and CEGUI::Window::setPosition().

void CEGUI::Window::setXPosition float  x  )  [inherited]
 

Set the current 'x' position of the Window. Interpretation of the input value x is dependant upon the current metrics system set for the Window.

Parameters:
x float value that specifies the new x postion of the Window, in units consistent with the current metrics mode.
Returns:
Nothing

Definition at line 895 of file CEGUIWindow.cpp.

References CEGUI::Window::getYPosition(), CEGUI::Point, and CEGUI::Window::setPosition().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition(), and CEGUI::Thumb::setHorzRange().

void CEGUI::Window::setYPosition MetricsMode  mode,
float  y
[inherited]
 

set the y position of the window using the specified metrics system.

Parameters:
mode One of the MetricsMode enumerated values specifying the metrics system to be used for the return value.
y float value that specifies the y position of the Window relative to it's parent, using the specified MetricsMode.
Returns:
Nothing.

Definition at line 2395 of file CEGUIWindow.cpp.

References CEGUI::Window::getXPosition(), CEGUI::Point, and CEGUI::Window::setPosition().

void CEGUI::Window::setYPosition float  y  )  [inherited]
 

Set the current 'y' position of the Window. Interpretation of the input value y is dependant upon the current metrics system set for the Window.

Parameters:
y float value that specifies the new y postion of the Window, in units consistent with the current metrics mode.
Returns:
Nothing

Definition at line 906 of file CEGUIWindow.cpp.

References CEGUI::Window::getXPosition(), CEGUI::Point, and CEGUI::Window::setPosition().

Referenced by CEGUI::TabControl::calculateTabButtonSizePosition(), and CEGUI::Thumb::setVertRange().

void CEGUI::Window::setZOrderingEnabled bool  setting  )  [inherited]
 

Set whether z-order changes are enabled or disabled for this Window.

Parameters:
setting 
  • true if z-order changes are enabled for this window. moveToFront/moveToBack work normally as expected.
  • false: z-order changes are disabled for this window. moveToFront/moveToBack are ignored for this window.
Returns:
Nothing.

Definition at line 2599 of file CEGUIWindow.cpp.

References CEGUI::Window::d_zOrderingEnabled.

void CEGUI::Window::show void   )  [inline, inherited]
 

show the Window

Returns:
Nothing

Definition at line 1117 of file CEGUIWindow.h.

Referenced by CEGUI::StaticText::configureScrollbars(), CEGUI::MultiLineEditbox::configureScrollbars(), configureScrollbars(), CEGUI::Listbox::configureScrollbars(), and CEGUI::Combobox::showDropList().

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Group  group,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the the specified group of the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
group Group which is to be subscribed to. Subscription groups are called in ascending order.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 126 of file CEGUIEventSet.cpp.

References CEGUI::Event::Connection, CEGUI::EventSet::d_events, and CEGUI::Event::Subscriber.

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 110 of file CEGUIEventSet.cpp.

References CEGUI::Event::Connection, CEGUI::EventSet::d_events, and CEGUI::Event::Subscriber.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::addTab(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::StaticText::initialise(), CEGUI::Slider::initialise(), CEGUI::Scrollbar::initialise(), initialise(), CEGUI::FrameWindow::initialise(), and CEGUI::Combobox::initialise().

void CEGUI::Window::update float  elapsed  )  [inherited]
 

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.

Note:
The update order is such that 'this' window is updated prior to any child windows, this is so that child windows that access the parent in their update code get the correct updated state.
Parameters:
elapsed float value indicating the number of seconds passed since the last update.
Returns:
Nothing.

Definition at line 2713 of file CEGUIWindow.cpp.

References CEGUI::Window::d_children, CEGUI::Window::getChildCount(), CEGUI::uint, and CEGUI::Window::updateSelf().

Referenced by CEGUI::System::injectTimePulse().

void CEGUI::Window::updateSelf float  elapsed  )  [protected, virtual, inherited]
 

Perform actual update processing for this Window.

Parameters:
elapsed float value indicating the number of seconds elapsed since the last update call.
Returns:
Nothing.

Definition at line 2732 of file CEGUIWindow.cpp.

References CEGUI::Window::d_autoRepeat, CEGUI::Window::d_repeatButton, CEGUI::Window::d_repeatElapsed, CEGUI::Window::d_repeating, and CEGUI::Window::generateAutoRepeatEvent().

Referenced by CEGUI::Window::update().

bool CEGUI::Window::wantsMultiClickEvents void   )  const [inherited]
 

Return whether this window will receive multi-click events or multiple 'down' events instead.

Returns:
  • true if the Window will receive double-click and triple-click events.
  • false if the Window will receive multiple mouse button down events instead of double/triple click events.

Definition at line 2613 of file CEGUIWindow.cpp.

Referenced by CEGUI::System::injectMouseButtonDown().

Rect CEGUI::Window::windowToScreen const Rect rect  )  const [inherited]
 

Convert a window area, specified in whichever metrics mode is active, to a screen area.

Parameters:
rect Rect object describing the area to be converted
Returns:
Rect object describing a screen area that is equivalent to window area rect.

Definition at line 1477 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_left, CEGUI::Window::d_parent, CEGUI::Rect::d_top, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Window::getMetricsMode(), CEGUI::Rect::offset(), CEGUI::Point, and CEGUI::Window::relativeToAbsolute().

Size CEGUI::Window::windowToScreen const Size sze  )  const [inherited]
 

Convert a window size value, specified in whichever metrics mode is active, to a size in pixels.

Parameters:
sze Size object describing the size to be converted
Returns:
Size object describing describing a size in pixels that is equivalent to the window based size sze.

Definition at line 1459 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Size::d_height, CEGUI::Size::d_width, CEGUI::Rect::getHeight(), CEGUI::Window::getMetricsMode(), and CEGUI::Rect::getWidth().

Point CEGUI::Window::windowToScreen const Point pt  )  const [inherited]
 

Convert a window co-ordinate position, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate position.

Parameters:
pt Point object describing the position to be converted
Returns:
Point object describing a screen co-ordinate position that is equivalent to window co-ordinate position pt.

Definition at line 1431 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_left, CEGUI::Window::d_parent, CEGUI::Rect::d_top, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Window::getMetricsMode(), CEGUI::Point, and CEGUI::Window::relativeToAbsolute().

Referenced by CEGUI::Window::getUnclippedPixelRect().

float CEGUI::Window::windowToScreenX float  x  )  const [inherited]
 

Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.

Parameters:
x x co-ordinate value to be converted
Returns:
float value describing a pixel screen co-ordinate that is equivalent to window co-ordinate x.

Definition at line 1377 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Rect::d_left, CEGUI::Window::d_parent, CEGUI::Window::getMetricsMode(), and CEGUI::Window::relativeToAbsoluteX().

Referenced by CEGUI::Window::screenToWindow(), and CEGUI::Window::screenToWindowX().

float CEGUI::Window::windowToScreenY float  y  )  const [inherited]
 

Convert a window co-ordinate value, specified in whichever metrics mode is active, to a screen relative pixel co-ordinate.

Parameters:
y y co-ordinate value to be converted
Returns:
float value describing a screen co-ordinate that is equivalent to window co-ordinate y.

Definition at line 1404 of file CEGUIWindow.cpp.

References CEGUI::Window::d_abs_area, CEGUI::Window::d_parent, CEGUI::Rect::d_top, CEGUI::Window::getMetricsMode(), and CEGUI::Window::relativeToAbsoluteY().

Referenced by CEGUI::Window::screenToWindow(), and CEGUI::Window::screenToWindowY().


Friends And Related Function Documentation

friend class System [friend, inherited]
 

Definition at line 2065 of file CEGUIWindow.h.


Member Data Documentation

Rect CEGUI::Window::d_abs_area [protected, inherited]
 

This Window objects area (pixels relative to parent).

Definition at line 2627 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getHeight(), CEGUI::Window::getParentHeight(), CEGUI::Window::getParentWidth(), CEGUI::Window::getPosition(), CEGUI::Window::getSize(), CEGUI::Window::getUnclippedPixelRect(), CEGUI::Window::getWidth(), CEGUI::Window::getWindowSize_impl(), CEGUI::Window::getXPosition(), CEGUI::Window::getYPosition(), CEGUI::Window::onParentSized(), CEGUI::Window::screenToWindow(), CEGUI::Window::screenToWindowX(), CEGUI::Window::screenToWindowY(), CEGUI::Window::setMaximumSize(), CEGUI::Window::setMinimumSize(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), CEGUI::Window::setSize(), CEGUI::Window::Window(), CEGUI::Window::windowToScreen(), CEGUI::Window::windowToScreenX(), and CEGUI::Window::windowToScreenY().

WindowProperties::AbsoluteHeight CEGUI::Window::d_absHeightProperty [static, protected, inherited]
 

Definition at line 46 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteMaxSize CEGUI::Window::d_absMaxSizeProperty [static, protected, inherited]
 

Definition at line 47 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteMinSize CEGUI::Window::d_absMinSizeProperty [static, protected, inherited]
 

Definition at line 48 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsolutePosition CEGUI::Window::d_absPositionProperty [static, protected, inherited]
 

Definition at line 49 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteRect CEGUI::Window::d_absRectProperty [static, protected, inherited]
 

Definition at line 50 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteSize CEGUI::Window::d_absSizeProperty [static, protected, inherited]
 

Definition at line 51 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteWidth CEGUI::Window::d_absWidthProperty [static, protected, inherited]
 

Definition at line 52 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteXPosition CEGUI::Window::d_absXPosProperty [static, protected, inherited]
 

Definition at line 53 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AbsoluteYPosition CEGUI::Window::d_absYPosProperty [static, protected, inherited]
 

Definition at line 54 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_active [protected, inherited]
 

true when Window is the active Window (receiving inputs).

Definition at line 2639 of file CEGUIWindow.h.

Referenced by CEGUI::Window::isActive(), CEGUI::Window::onActivated(), CEGUI::Window::onDeactivated(), and CEGUI::Window::Window().

float CEGUI::Window::d_alpha [protected, inherited]
 

Alpha transparency setting for the Window.

Definition at line 2626 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getEffectiveAlpha(), CEGUI::Window::setAlpha(), and CEGUI::Window::Window().

WindowProperties::Alpha CEGUI::Window::d_alphaProperty [static, protected, inherited]
 

Definition at line 55 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_alwaysOnTop [protected, inherited]
 

true if Window will be drawn on top of all other Windows

Definition at line 2642 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setAlwaysOnTop(), and CEGUI::Window::Window().

WindowProperties::AlwaysOnTop CEGUI::Window::d_alwaysOnTopProperty [static, protected, inherited]
 

Definition at line 56 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_autoRepeat [protected, inherited]
 

true if button will auto-repeat mouse button down events while mouse button is held down,

Definition at line 2649 of file CEGUIWindow.h.

Referenced by CEGUI::Window::onMouseButtonDown(), CEGUI::Window::setMouseAutoRepeatEnabled(), CEGUI::Window::updateSelf(), and CEGUI::Window::Window().

WindowProperties::AutoRepeatDelay CEGUI::Window::d_autoRepeatDelayProperty [static, protected, inherited]
 

Definition at line 87 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::MouseButtonDownAutoRepeat CEGUI::Window::d_autoRepeatProperty [static, protected, inherited]
 

Definition at line 86 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::AutoRepeatRate CEGUI::Window::d_autoRepeatRateProperty [static, protected, inherited]
 

Definition at line 88 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

Window * CEGUI::Window::d_captureWindow = NULL [static, protected, inherited]
 

Window that has captured inputs.

Definition at line 94 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::activate(), CEGUI::Window::captureInput(), and CEGUI::Window::releaseInput().

ChildList CEGUI::Window::d_children [protected, inherited]
 

The list of child Window objects attached to this.

Definition at line 2616 of file CEGUIWindow.h.

Referenced by CEGUI::Window::addChild_impl(), CEGUI::Window::cleanupChildren(), CEGUI::Window::getActiveChild(), CEGUI::Window::getChild(), CEGUI::Window::getChildAtPosition(), CEGUI::Window::isChild(), CEGUI::Window::moveToBack(), CEGUI::Window::moveToFront(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onDeactivated(), CEGUI::Window::onSized(), CEGUI::Window::onZChange_impl(), CEGUI::Window::removeChild_impl(), CEGUI::Window::removeChildWindow(), CEGUI::Window::render(), CEGUI::Window::setRestoreCapture(), and CEGUI::Window::update().

bool CEGUI::Window::d_clippedByParent [protected, inherited]
 

true when Window will be clipped by parent Window area Rect.

Definition at line 2640 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setClippedByParent(), and CEGUI::Window::Window().

WindowProperties::ClippedByParent CEGUI::Window::d_clippedByParentProperty [static, protected, inherited]
 

Definition at line 57 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_destroyedByParent [protected, inherited]
 

true when Window will be auto-destroyed by parent.

Definition at line 2641 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setDestroyedByParent(), and CEGUI::Window::Window().

WindowProperties::DestroyedByParent CEGUI::Window::d_destroyedByParentProperty [static, protected, inherited]
 

Definition at line 58 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::Disabled CEGUI::Window::d_disabledProperty [static, protected, inherited]
 

Definition at line 59 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_enabled [protected, inherited]
 

true when Window is enabled

Definition at line 2637 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setEnabled(), and CEGUI::Window::Window().

EventMap CEGUI::EventSet::d_events [protected, inherited]
 

Definition at line 208 of file CEGUIEventSet.h.

Referenced by CEGUI::EventSet::addEvent(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::getIterator(), CEGUI::EventSet::isEventPresent(), CEGUI::EventSet::removeAllEvents(), CEGUI::EventSet::removeEvent(), and CEGUI::EventSet::subscribeEvent().

const Font* CEGUI::Window::d_font [protected, inherited]
 

Holds pointer to the Window objects current Font.

Definition at line 2623 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getFont(), CEGUI::Window::setFont(), and CEGUI::Window::Window().

WindowProperties::Font CEGUI::Window::d_fontProperty [static, protected, inherited]
 

Definition at line 60 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::MultiColumnList::d_forceHorzScroll [protected]
 

true if horizontal scrollbar should always be displayed

Definition at line 1463 of file CEGUIMultiColumnList.h.

Referenced by setShowHorzScrollbar().

bool CEGUI::MultiColumnList::d_forceVertScroll [protected]
 

true if vertical scrollbar should always be displayed

Definition at line 1462 of file CEGUIMultiColumnList.h.

Referenced by setShowVertScrollbar().

bool CEGUI::MultiColumnList::d_fullColSelect [protected]
 

All items in a column are selected.

Definition at line 1471 of file CEGUIMultiColumnList.h.

Referenced by setSelectionMode().

bool CEGUI::MultiColumnList::d_fullRowSelect [protected]
 

All items in a row are selected.

Definition at line 1470 of file CEGUIMultiColumnList.h.

Referenced by setSelectionMode().

ListItemGrid CEGUI::MultiColumnList::d_grid [protected]
 

Holds the list box data.

Definition at line 1478 of file CEGUIMultiColumnList.h.

Referenced by addRow(), clearAllSelections_impl(), drawSelf(), findColumnItemWithText(), findListItemWithText(), findRowItemWithText(), getHighestRowItemHeight(), getItemAtGridReference(), getItemAtPoint(), getNextSelected(), getRowCount(), getSelectedCount(), getWidestColumnItemWidth(), handleSortColumnChange(), handleSortDirectionChange(), insertColumn(), insertRow(), isListboxItemInColumn(), isListboxItemInList(), isListboxItemInRow(), moveColumn_impl(), removeColumn(), removeRow(), resetList_impl(), selectRange(), setItem(), setItemSelectState_impl(), setSelectForItemsInColumn(), and setSelectForItemsInRow().

ListHeader* CEGUI::MultiColumnList::d_header [protected]
 

The ListHeader attached to this multi-column list.

Definition at line 1461 of file CEGUIMultiColumnList.h.

Referenced by configureScrollbars(), drawSelf(), getColumnCount(), getColumnHeaderWidth(), getColumnID(), getColumnWithHeaderText(), getColumnWithID(), getHeaderSegmentForColumn(), getItemAtPoint(), getNominatedSelectionColumnID(), getSortColumn(), getSortDirection(), getTotalColumnHeadersWidth(), handleHeaderScroll(), handleHeaderSegDblClick(), handleHorzScrollbar(), initialise(), insertColumn(), isUserColumnDraggingEnabled(), isUserColumnSizingEnabled(), isUserSortControlEnabled(), moveColumn(), removeColumn(), setColumnHeaderWidth(), setSortColumn(), setSortColumnByID(), setSortDirection(), setUserColumnDraggingEnabled(), setUserColumnSizingEnabled(), and setUserSortControlEnabled().

WindowProperties::Height CEGUI::Window::d_heightProperty [static, protected, inherited]
 

Definition at line 61 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

Scrollbar* CEGUI::MultiColumnList::d_horzScrollbar [protected]
 

horizontal scroll-bar widget

Definition at line 1460 of file CEGUIMultiColumnList.h.

Referenced by configureScrollbars(), drawSelf(), getItemAtPoint(), handleHeaderScroll(), handleHorzScrollbar(), initialise(), and onMouseWheel().

uint CEGUI::Window::d_ID [protected, inherited]
 

User ID assigned to this Window.

Definition at line 2625 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setID(), and CEGUI::Window::Window().

WindowProperties::ID CEGUI::Window::d_IDProperty [static, protected, inherited]
 

Definition at line 62 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_inheritsAlpha [protected, inherited]
 

true if the Window inherits alpha from the parent Window

Definition at line 2643 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setInheritsAlpha(), and CEGUI::Window::Window().

WindowProperties::InheritsAlpha CEGUI::Window::d_inheritsAlphaProperty [static, protected, inherited]
 

Definition at line 63 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

ListboxItem* CEGUI::MultiColumnList::d_lastSelected [protected]
 

holds pointer to the last selected item (used in range selections)

Definition at line 1474 of file CEGUIMultiColumnList.h.

Referenced by onMouseButtonDown(), and resetList_impl().

Size CEGUI::Window::d_maxSize [protected, inherited]
 

current maximum size for the window (this is always stored in pixels).

Definition at line 2634 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getMaximumSize(), CEGUI::Window::onParentSized(), CEGUI::Window::setMaximumSize(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), and CEGUI::Window::setSize().

MetricsMode CEGUI::Window::d_metricsMode [protected, inherited]
 

Holds the active metrics mode for this window.

Definition at line 2619 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getMetricsMode(), CEGUI::Window::setMetricsMode(), and CEGUI::Window::Window().

WindowProperties::MetricsMode CEGUI::Window::d_metricsModeProperty [static, protected, inherited]
 

Definition at line 64 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

Size CEGUI::Window::d_minSize [protected, inherited]
 

current minimum size for the window (this is always stored in pixels).

Definition at line 2633 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getMinimumSize(), CEGUI::Window::onParentSized(), CEGUI::Window::setMinimumSize(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), and CEGUI::Window::setSize().

const Image* CEGUI::Window::d_mouseCursor [protected, inherited]
 

Holds pointer to the Window objects current mouse cursor image.

Definition at line 2629 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getMouseCursor(), CEGUI::Window::setMouseCursor(), and CEGUI::Window::Window().

WindowProperties::MouseCursorImage CEGUI::Window::d_mouseCursorProperty [static, protected, inherited]
 

Definition at line 65 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::MultiColumnList::d_multiSelect [protected]
 

Allow multiple selections.

Definition at line 1469 of file CEGUIMultiColumnList.h.

Referenced by setSelectionMode().

bool CEGUI::EventSet::d_muted [protected, inherited]
 

true if events for this EventSet have been muted.

Definition at line 210 of file CEGUIEventSet.h.

Referenced by CEGUI::EventSet::setMutedState().

const String CEGUI::Window::d_name [protected, inherited]
 

The name of the window (GUI system unique).

Definition at line 2756 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getChild().

uint CEGUI::MultiColumnList::d_nominatedSelectCol [protected]
 

Nominated column for single column selection.

Definition at line 1467 of file CEGUIMultiColumnList.h.

Referenced by getNominatedSelectionColumnID(), insertColumn(), moveColumn_impl(), removeColumn(), setItemSelectState_impl(), and setNominatedSelectionColumn().

uint CEGUI::MultiColumnList::d_nominatedSelectRow [protected]
 

Nominated row for single row selection.

Definition at line 1468 of file CEGUIMultiColumnList.h.

Referenced by removeRow(), resetList_impl(), setItemSelectState_impl(), and setNominatedSelectionRow().

Window* CEGUI::Window::d_oldCapture [protected, inherited]
 

The Window that previously had capture (used for restoreOldCapture mode).

Definition at line 2621 of file CEGUIWindow.h.

Referenced by CEGUI::Window::captureInput(), CEGUI::Window::onCaptureLost(), and CEGUI::Window::releaseInput().

Window* CEGUI::Window::d_parent [protected, inherited]
 

Holds pointer to the parent window.

Definition at line 2622 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getEffectiveAlpha(), CEGUI::Window::getInheritedMetricsMode(), CEGUI::Window::getInnerRect(), CEGUI::Window::getParentHeight(), CEGUI::Window::getParentSize(), CEGUI::Window::getParentWidth(), CEGUI::Window::getPixelRect(), CEGUI::Window::isActive(), CEGUI::Window::isAncestor(), CEGUI::Window::isDisabled(), CEGUI::Window::isVisible(), CEGUI::Window::moveToBack(), CEGUI::Window::moveToFront(), CEGUI::Window::onParentSized(), CEGUI::Window::onZChange_impl(), CEGUI::Window::setAlwaysOnTop(), CEGUI::Window::setParent(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), CEGUI::Window::setSize(), CEGUI::Window::Window(), CEGUI::Window::windowToScreen(), CEGUI::Window::windowToScreenX(), CEGUI::Window::windowToScreenY(), and CEGUI::Window::~Window().

WindowProperties::Position CEGUI::Window::d_positionProperty [static, protected, inherited]
 

Definition at line 66 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::Rect CEGUI::Window::d_rectProperty [static, protected, inherited]
 

Definition at line 67 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

Rect CEGUI::Window::d_rel_area [protected, inherited]
 

This Window objects area (decimal fractions relative to parent).

Definition at line 2628 of file CEGUIWindow.h.

Referenced by CEGUI::Window::getHeight(), CEGUI::Window::getPosition(), CEGUI::Window::getSize(), CEGUI::Window::getWidth(), CEGUI::Window::getXPosition(), CEGUI::Window::getYPosition(), CEGUI::Window::onParentSized(), CEGUI::Window::setPosition(), CEGUI::Window::setRect(), CEGUI::Window::setSize(), and CEGUI::Window::Window().

WindowProperties::RelativeHeight CEGUI::Window::d_relHeightProperty [static, protected, inherited]
 

Definition at line 68 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeMaxSize CEGUI::Window::d_relMaxSizeProperty [static, protected, inherited]
 

Definition at line 69 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeMinSize CEGUI::Window::d_relMinSizeProperty [static, protected, inherited]
 

Definition at line 70 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativePosition CEGUI::Window::d_relPositionProperty [static, protected, inherited]
 

Definition at line 71 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeRect CEGUI::Window::d_relRectProperty [static, protected, inherited]
 

Definition at line 72 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeSize CEGUI::Window::d_relSizeProperty [static, protected, inherited]
 

Definition at line 73 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeWidth CEGUI::Window::d_relWidthProperty [static, protected, inherited]
 

Definition at line 74 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeXPosition CEGUI::Window::d_relXPosProperty [static, protected, inherited]
 

Definition at line 75 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::RelativeYPosition CEGUI::Window::d_relYPosProperty [static, protected, inherited]
 

Definition at line 76 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

MouseButton CEGUI::Window::d_repeatButton [protected, inherited]
 

Button we're tracking (implication of this is that we only support one button at a time).

Definition at line 2654 of file CEGUIWindow.h.

Referenced by CEGUI::Window::onCaptureLost(), CEGUI::Window::onMouseButtonDown(), CEGUI::Window::onMouseButtonUp(), CEGUI::Window::setMouseAutoRepeatEnabled(), CEGUI::Window::updateSelf(), and CEGUI::Window::Window().

float CEGUI::Window::d_repeatDelay [protected, inherited]
 

seconds before first repeat event is fired

Definition at line 2650 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setAutoRepeatDelay(), and CEGUI::Window::Window().

float CEGUI::Window::d_repeatElapsed [protected, inherited]
 

implements repeating - tracks time elapsed.

Definition at line 2653 of file CEGUIWindow.h.

Referenced by CEGUI::Window::onMouseButtonDown(), and CEGUI::Window::updateSelf().

bool CEGUI::Window::d_repeating [protected, inherited]
 

implements repeating - is true after delay has elapsed,

Definition at line 2652 of file CEGUIWindow.h.

Referenced by CEGUI::Window::onMouseButtonDown(), CEGUI::Window::updateSelf(), and CEGUI::Window::Window().

float CEGUI::Window::d_repeatRate [protected, inherited]
 

secons between further repeats after delay has expired.

Definition at line 2651 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setAutoRepeatRate(), and CEGUI::Window::Window().

bool CEGUI::Window::d_restoreOldCapture [protected, inherited]
 

true if the Window restores capture to the previous window when it releases capture.

Definition at line 2644 of file CEGUIWindow.h.

Referenced by CEGUI::Window::onCaptureLost(), CEGUI::Window::setRestoreCapture(), and CEGUI::Window::Window().

WindowProperties::RestoreOldCapture CEGUI::Window::d_restoreOldCaptureProperty [static, protected, inherited]
 

Definition at line 77 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

SelectionMode CEGUI::MultiColumnList::d_selectMode [protected]
 

Holds selection mode (represented by settings below).

Definition at line 1466 of file CEGUIMultiColumnList.h.

Referenced by MultiColumnList(), and setSelectionMode().

WindowProperties::Size CEGUI::Window::d_sizeProperty [static, protected, inherited]
 

Definition at line 78 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

String CEGUI::Window::d_text [protected, inherited]
 

Holds the text / label / caption for this Window.

Definition at line 2624 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setText().

WindowProperties::Text CEGUI::Window::d_textProperty [static, protected, inherited]
 

Definition at line 79 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

const String CEGUI::Window::d_type [protected, inherited]
 

String holding the type name for the Window (is also the name of the WindowFactory that created us).

Definition at line 2755 of file CEGUIWindow.h.

bool CEGUI::MultiColumnList::d_useNominatedCol [protected]
 

true if we use a nominated col to select.

Definition at line 1473 of file CEGUIMultiColumnList.h.

Referenced by setItemSelectState_impl(), and setSelectionMode().

bool CEGUI::MultiColumnList::d_useNominatedRow [protected]
 

true if we use a nominated row to select.

Definition at line 1472 of file CEGUIMultiColumnList.h.

Referenced by setItemSelectState_impl(), and setSelectionMode().

void* CEGUI::Window::d_userData [protected, inherited]
 

Holds pointer to some user assigned data.

Definition at line 2630 of file CEGUIWindow.h.

Referenced by CEGUI::Window::Window().

Scrollbar* CEGUI::MultiColumnList::d_vertScrollbar [protected]
 

vertical scroll-bar widget

Definition at line 1459 of file CEGUIMultiColumnList.h.

Referenced by configureScrollbars(), drawSelf(), getItemAtPoint(), initialise(), and onMouseWheel().

bool CEGUI::Window::d_visible [protected, inherited]
 

true when Window is visible (that is it will be rendered, but may be obscured so no necesarily really visible)

Definition at line 2638 of file CEGUIWindow.h.

Referenced by CEGUI::Window::isVisible(), CEGUI::Window::setVisible(), and CEGUI::Window::Window().

WindowProperties::Visible CEGUI::Window::d_visibleProperty [static, protected, inherited]
 

Definition at line 80 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_wantsMultiClicks [protected, inherited]
 

true if the Window wishes to hear about multi-click mouse events.

Definition at line 2646 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setWantsMultiClickEvents(), and CEGUI::Window::Window().

WindowProperties::WantsMultiClickEvents CEGUI::Window::d_wantsMultiClicksProperty [static, protected, inherited]
 

Definition at line 85 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::Width CEGUI::Window::d_widthProperty [static, protected, inherited]
 

Definition at line 81 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::XPosition CEGUI::Window::d_xPosProperty [static, protected, inherited]
 

Definition at line 82 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::YPosition CEGUI::Window::d_yPosProperty [static, protected, inherited]
 

Definition at line 83 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

WindowProperties::ZOrderChangeEnabled CEGUI::Window::d_zOrderChangeProperty [static, protected, inherited]
 

Definition at line 84 of file CEGUIWindow.cpp.

Referenced by CEGUI::Window::addStandardProperties().

bool CEGUI::Window::d_zOrderingEnabled [protected, inherited]
 

true if the Window responds to z-order change requests.

Definition at line 2645 of file CEGUIWindow.h.

Referenced by CEGUI::Window::setZOrderingEnabled(), and CEGUI::Window::Window().

const String CEGUI::Window::EventActivated [static, inherited]
 

Window has been activated (has input focus).

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onActivated().

const String CEGUI::Window::EventAlphaChanged [static, inherited]
 

Alpha blend value for the Window has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onAlphaChanged().

const String CEGUI::Window::EventAlwaysOnTopChanged [static, inherited]
 

Always on top mode has been modified.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onAlwaysOnTopChanged().

const String CEGUI::Window::EventCharacterKey [static, inherited]
 

A text character was typed on the keyboard.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onCharacter().

const String CEGUI::Window::EventChildAdded [static, inherited]
 

A child Window has been added.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onChildAdded().

const String CEGUI::Window::EventChildRemoved [static, inherited]
 

A child window has been removed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onChildRemoved().

const String CEGUI::Window::EventClippedByParentChanged [static, inherited]
 

Clipping by parent mode has been modified.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onClippingChanged().

const String CEGUI::Window::EventDeactivated [static, inherited]
 

Window has been deactivated (loses input focus).

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onDeactivated().

const String CEGUI::Window::EventDestroyedByParentChanged [static, inherited]
 

Destruction by parent mode has been modified.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onParentDestroyChanged().

const String CEGUI::Window::EventDestructionStarted [static, inherited]
 

Destruction of the Window is about to begin.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onDestructionStarted().

const String CEGUI::Window::EventDisabled [static, inherited]
 

Window has been disabled (interaction is no longer possible).

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onDisabled().

const String CEGUI::Window::EventEnabled [static, inherited]
 

Window has been enabled (interaction is possible).

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onEnabled().

const String CEGUI::Window::EventFontChanged [static, inherited]
 

Font object for the Window has been changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onFontChanged().

const String CEGUI::Window::EventHidden [static, inherited]
 

Window has been hidden from view.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onHidden().

const String CEGUI::MultiColumnList::EventHorzScrollbarModeChanged [static]
 

Event fired when the horizontal scroll bar 'force' setting changes.

Referenced by addMultiColumnListboxEvents(), and onHorzScrollbarModeChanged().

const String CEGUI::Window::EventIDChanged [static, inherited]
 

Client assigned ID code for the Window has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onIDChanged().

const String CEGUI::Window::EventInheritsAlphaChanged [static, inherited]
 

Alpha inherited from parent mode has been modified.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onInheritsAlphaChanged().

const String CEGUI::Window::EventInputCaptureGained [static, inherited]
 

Window has captured all inputs.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onCaptureGained().

const String CEGUI::Window::EventInputCaptureLost [static, inherited]
 

Window has lost it's capture on inputs.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onCaptureLost().

const String CEGUI::Window::EventKeyDown [static, inherited]
 

A key on the keyboard was pressed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onKeyDown().

const String CEGUI::Window::EventKeyUp [static, inherited]
 

A key on the keyboard was released.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onKeyUp().

const String CEGUI::MultiColumnList::EventListColumnMoved [static]
 

Event fired when the column order changes.

Referenced by addMultiColumnListboxEvents(), and onListColumnMoved().

const String CEGUI::MultiColumnList::EventListColumnSized [static]
 

Event fired when the width of a column in the list changes.

Referenced by addMultiColumnListboxEvents(), and onListColumnSized().

const String CEGUI::MultiColumnList::EventListContentsChanged [static]
 

Event fired when the contents of the list box changes.

Referenced by addMultiColumnListboxEvents(), and onListContentsChanged().

const String CEGUI::Window::EventMetricsModeChanged [static, inherited]
 

Active metrics mode has been modified.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMetricsChanged().

const String CEGUI::Window::EventMouseButtonDown [static, inherited]
 

A mouse button was pressed down within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseButtonDown().

const String CEGUI::Window::EventMouseButtonUp [static, inherited]
 

A mouse button was released within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseButtonUp().

const String CEGUI::Window::EventMouseClick [static, inherited]
 

A mouse button was clicked (down then up) within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseClicked().

const String CEGUI::Window::EventMouseDoubleClick [static, inherited]
 

A mouse button was double-clicked within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseDoubleClicked().

const String CEGUI::Window::EventMouseEnters [static, inherited]
 

Mouse cursor has entered the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseEnters().

const String CEGUI::Window::EventMouseLeaves [static, inherited]
 

Mouse cursor has left the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseLeaves().

const String CEGUI::Window::EventMouseMove [static, inherited]
 

Mouse cursor was moved within the area of the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseMove().

const String CEGUI::Window::EventMouseTripleClick [static, inherited]
 

A mouse button was triple-clicked within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseTripleClicked().

const String CEGUI::Window::EventMouseWheel [static, inherited]
 

Mouse wheel was scrolled within the Window.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMouseWheel().

const String CEGUI::Window::EventMoved [static, inherited]
 

Window position has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onMoved().

const String CEGUI::MultiColumnList::EventNamespace [static]
 

Namespace for global events.

Reimplemented from CEGUI::Window.

Referenced by onHorzScrollbarModeChanged(), onListColumnMoved(), onListColumnSized(), onListContentsChanged(), onNominatedSelectColumnChanged(), onNominatedSelectRowChanged(), onSelectionChanged(), onSelectionModeChanged(), onSortColumnChanged(), onSortDirectionChanged(), and onVertScrollbarModeChanged().

const String CEGUI::MultiColumnList::EventNominatedSelectColumnChanged [static]
 

Event fired when the nominated select column changes.

Referenced by addMultiColumnListboxEvents(), and onNominatedSelectColumnChanged().

const String CEGUI::MultiColumnList::EventNominatedSelectRowChanged [static]
 

Event fired when the nominated select row changes.

Referenced by addMultiColumnListboxEvents(), and onNominatedSelectRowChanged().

const String CEGUI::Window::EventParentSized [static, inherited]
 

Parent of this Window has been re-sized.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onParentSized().

const String CEGUI::Window::EventRenderingEnded [static, inherited]
 

Rendering for the Window has finished.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onRenderingEnded().

const String CEGUI::Window::EventRenderingStarted [static, inherited]
 

Rendering of the Window has started.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onRenderingStarted().

const String CEGUI::MultiColumnList::EventSelectionChanged [static]
 

Event fired when the current selection(s) within the list box changes.

Referenced by addMultiColumnListboxEvents(), and onSelectionChanged().

const String CEGUI::MultiColumnList::EventSelectionModeChanged [static]
 

Event fired when the selection mode for the list box changes.

Referenced by addMultiColumnListboxEvents(), and onSelectionModeChanged().

const String CEGUI::Window::EventShown [static, inherited]
 

Window has been made visible.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onShown().

const String CEGUI::Window::EventSized [static, inherited]
 

Window size has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onSized().

const String CEGUI::MultiColumnList::EventSortColumnChanged [static]
 

Event fired when the sort column changes.

Referenced by addMultiColumnListboxEvents(), and onSortColumnChanged().

const String CEGUI::MultiColumnList::EventSortDirectionChanged [static]
 

Event fired when the sort direction changes.

Referenced by addMultiColumnListboxEvents(), and onSortDirectionChanged().

const String CEGUI::Window::EventTextChanged [static, inherited]
 

Text string for the Window has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onTextChanged().

const String CEGUI::MultiColumnList::EventVertScrollbarModeChanged [static]
 

Event fired when the vertical scroll bar 'force' setting changes.

Referenced by addMultiColumnListboxEvents(), and onVertScrollbarModeChanged().

const String CEGUI::Window::EventZOrderChanged [static, inherited]
 

The z-order of the window has changed.

Referenced by CEGUI::Window::addStandardEvents(), and CEGUI::Window::onZChanged().


The documentation for this class was generated from the following files:
Generated on Wed Feb 16 12:41:16 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1