Inheritance diagram for CEGUI::ListHeader:
Public Member Functions | |
uint | getColumnCount (void) const |
Return the number of columns or segments attached to the header. | |
ListHeaderSegment & | getSegmentFromColumn (uint column) const |
Return the ListHeaderSegment object for the specified column. | |
ListHeaderSegment & | getSegmentFromID (uint id) const |
Return the ListHeaderSegment object with the specified ID. | |
ListHeaderSegment & | getSortSegment (void) const |
Return the ListHeaderSegment that is marked as being the 'sort key' segment. There must be at least one segment to successfully call this method. | |
uint | getColumnFromSegment (const ListHeaderSegment &segment) const |
Return the zero based column index of the specified segment. | |
uint | getColumnFromID (uint id) const |
Return the zero based column index of the segment with the specified ID. | |
uint | getSortColumn (void) const |
Return the zero based index of the current sort column. There must be at least one segment/column to successfully call this method. | |
uint | getColumnWithText (const String &text) const |
Return the zero based column index of the segment with the specified text. | |
float | getPixelOffsetToSegment (const ListHeaderSegment &segment) const |
Return the pixel offset to the given ListHeaderSegment. | |
float | getPixelOffsetToColumn (uint column) const |
Return the pixel offset to the ListHeaderSegment at the given zero based column index. | |
float | getTotalSegmentsPixelExtent (void) const |
Return the total pixel width of all attached segments. | |
float | getColumnPixelWidth (uint column) const |
Return the pixel width of the specified column. | |
ListHeaderSegment::SortDirection | getSortDirection (void) const |
Return the currently set sort direction. | |
bool | isSortingEnabled (void) const |
Return whether user manipulation of the sort column & direction are enabled. | |
bool | isColumnSizingEnabled (void) const |
Return whether the user may size column segments. | |
bool | isColumnDraggingEnabled (void) const |
Return whether the user may modify the order of the segments. | |
float | getSegmentOffset (void) const |
Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader area. | |
void | setSortingEnabled (bool setting) |
Set whether user manipulation of the sort column and direction is enabled. | |
void | setSortDirection (ListHeaderSegment::SortDirection direction) |
Set the current sort direction. | |
void | setSortSegment (const ListHeaderSegment &segment) |
Set the column segment to be used as the sort column. | |
void | setSortColumn (uint column) |
Set the column to be used as the sort column. | |
void | setSortColumnFromID (uint id) |
Set the column to to be used for sorting via its ID code. | |
void | setColumnSizingEnabled (bool setting) |
Set whether columns may be sized by the user. | |
void | setColumnDraggingEnabled (bool setting) |
Set whether columns may be reordered by the user via drag and drop. | |
void | addColumn (const String &text, uint id, float width) |
Add a new column segment to the end of the header. | |
void | insertColumn (const String &text, uint id, float width, uint position) |
Insert a new column segment at the specified position. | |
void | insertColumn (const String &text, uint id, float width, const ListHeaderSegment &position) |
Insert a new column segment at the specified position. | |
void | removeColumn (uint column) |
Removes a column segment from the ListHeader. | |
void | removeSegment (const ListHeaderSegment &segment) |
Remove the specified segment from the ListHeader. | |
void | moveColumn (uint column, uint position) |
Moves a column segment into a new position. | |
void | moveColumn (uint column, const ListHeaderSegment &position) |
Move a column segment to a new position. | |
void | moveSegment (const ListHeaderSegment &segment, uint position) |
Moves a segment into a new position. | |
void | moveSegment (const ListHeaderSegment &segment, const ListHeaderSegment &position) |
Move a segment to a new position. | |
void | setSegmentOffset (float offset) |
Set the current base segment offset. (This implements scrolling of the header segments within the header area). | |
void | setColumnPixelWidth (uint column, float width) |
Set the pixel width of the specified column. | |
ListHeader (const String &type, const String &name) | |
Constructor for the list header base class. | |
virtual | ~ListHeader (void) |
Destructor for the list header base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventSortColumnChanged |
Event fired when the current sort column changes. | |
static const String | EventSortDirectionChanged |
Event fired when the sort direction changes. | |
static const String | EventSegmentSized |
Event fired when a segment has been sized by the user (e.window is the segment). | |
static const String | EventSegmentClicked |
Event fired when a segment has been clicked by the user (e.window is the segment). | |
static const String | EventSplitterDoubleClicked |
Event fired when a segment splitter has been double-clicked. (e.window is the segment). | |
static const String | EventSegmentSequenceChanged |
Event fired when the order of the segments has changed. ('e' is a HeaderSequenceEventArgs&). | |
static const String | EventSegmentAdded |
Event fired when a segment is added to the header. | |
static const String | EventSegmentRemoved |
Event fired when a segment is removed from the header. | |
static const String | EventSortSettingChanged |
Event fired when setting that controls user modification to sort configuration changes. | |
static const String | EventDragMoveSettingChanged |
Event fired when setting that controls user drag & drop of segments changes. | |
static const String | EventDragSizeSettingChanged |
Event fired when setting that controls user sizing of segments changes. | |
static const String | EventSegmentRenderOffsetChanged |
Event fired when the rendering offset for the segments changes. | |
static const float | ScrollSpeed = 8.0f |
Speed to scroll at when dragging outside header. | |
static const float | MinimumSegmentPixelWidth = 20.0f |
Miniumum width of a segment in pixels. | |
Protected Types | |
typedef std::vector< ListHeaderSegment * > | SegmentList |
Protected Member Functions | |
virtual ListHeaderSegment * | createNewSegment (const String &name) const =0 |
Create and return a pointer to a new ListHeaderSegment based object. | |
virtual void | destroyListSegment (ListHeaderSegment *segment) const =0 |
Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method. | |
ListHeaderSegment * | createInitialisedSegment (const String &text, uint id, float width) |
Create initialise and return a ListHeaderSegment object, with all events subscribed and ready to use. | |
void | layoutSegments (void) |
Layout the attached segments. | |
void | addListHeaderEvents (void) |
Add ListHeader specific events. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual void | onSortColumnChanged (WindowEventArgs &e) |
Handler called when the sort column is changed. | |
virtual void | onSortDirectionChanged (WindowEventArgs &e) |
Handler called when the sort direction is changed. | |
virtual void | onSegmentSized (WindowEventArgs &e) |
Handler called when a segment is sized by the user. e.window points to the segment. | |
virtual void | onSegmentClicked (WindowEventArgs &e) |
Handler called when a segment is clicked by the user. e.window points to the segment. | |
virtual void | onSplitterDoubleClicked (WindowEventArgs &e) |
Handler called when a segment splitter / sizer is double-clicked. e.window points to the segment. | |
virtual void | onSegmentSequenceChanged (WindowEventArgs &e) |
Handler called when the segment / column order changes. | |
virtual void | onSegmentAdded (WindowEventArgs &e) |
Handler called when a new segment is added to the header. | |
virtual void | onSegmentRemoved (WindowEventArgs &e) |
Handler called when a segment is removed from the header. | |
virtual void | onSortSettingChanged (WindowEventArgs &e) |
Handler called then setting that controls the users ability to modify the search column & direction changes. | |
virtual void | onDragMoveSettingChanged (WindowEventArgs &e) |
Handler called when the setting that controls the users ability to drag and drop segments changes. | |
virtual void | onDragSizeSettingChanged (WindowEventArgs &e) |
Handler called when the setting that controls the users ability to size segments changes. | |
virtual void | onSegmentOffsetChanged (WindowEventArgs &e) |
Handler called when the base rendering offset for the segments (scroll position) changes. | |
bool | segmentSizedHandler (const EventArgs &e) |
bool | segmentMovedHandler (const EventArgs &e) |
bool | segmentClickedHandler (const EventArgs &e) |
bool | segmentDoubleClickHandler (const EventArgs &e) |
bool | segmentDragHandler (const EventArgs &e) |
Protected Attributes | |
SegmentList | d_segments |
Attached segment windows in header order. | |
ListHeaderSegment * | d_sortSegment |
Pointer to the segment that is currently set as the sork-key,. | |
bool | d_sizingEnabled |
true if segments can be sized by the user. | |
bool | d_sortingEnabled |
true if the sort criteria modifications by user are enabled (no sorting is actuall done) | |
bool | d_movingEnabled |
true if drag & drop moving of columns / segments is enabled. | |
uint | d_uniqueIDNumber |
field used to create unique names. | |
float | d_segmentOffset |
Base offset used to layout the segments (allows scrolling within the window area). | |
ListHeaderSegment::SortDirection | d_sortDir |
Brief copy of the current sort direction. |
|
Add a new column segment to the end of the header.
|
|
Create and return a pointer to a new ListHeaderSegment based object.
|
|
Cleanup and destroy the given ListHeaderSegment that was created via the createNewSegment method.
|
|
Return the number of columns or segments attached to the header.
|
|
Return the zero based column index of the segment with the specified ID.
|
|
Return the zero based column index of the specified segment.
|
|
Return the pixel width of the specified column.
|
|
Return the zero based column index of the segment with the specified text.
|
|
Return the pixel offset to the ListHeaderSegment at the given zero based column index.
|
|
Return the pixel offset to the given ListHeaderSegment.
|
|
Return the ListHeaderSegment object for the specified column.
|
|
Return the ListHeaderSegment object with the specified ID.
|
|
Return the current segment offset value. This value is used to implement scrolling of the header segments within the ListHeader area.
|
|
Return the zero based index of the current sort column. There must be at least one segment/column to successfully call this method.
|
|
Return the currently set sort direction.
|
|
Return the ListHeaderSegment that is marked as being the 'sort key' segment. There must be at least one segment to successfully call this method.
|
|
Return the total pixel width of all attached segments.
|
|
Insert a new column segment at the specified position.
|
|
Insert a new column segment at the specified position.
|
|
Return whether the user may modify the order of the segments.
|
|
Return whether the user may size column segments.
|
|
Return whether user manipulation of the sort column & direction are enabled.
|
|
Move a column segment to a new position.
|
|
Moves a column segment into a new position.
|
|
Move a segment to a new position.
|
|
Moves a segment into a new position.
|
|
Removes a column segment from the ListHeader.
|
|
Remove the specified segment from the ListHeader.
|
|
Set whether columns may be reordered by the user via drag and drop.
|
|
Set the pixel width of the specified column.
|
|
Set whether columns may be sized by the user.
|
|
Set the current base segment offset. (This implements scrolling of the header segments within the header area).
|
|
Set the column to be used as the sort column.
|
|
Set the column to to be used for sorting via its ID code.
|
|
Set the current sort direction.
|
|
Set whether user manipulation of the sort column and direction is enabled.
|
|
Set the column segment to be used as the sort column.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |