Crazy Eddie's GUI System
0.8.4
|
ScrolledItemListBase window class. More...
Public Member Functions | |
bool | isVertScrollbarAlwaysShown (void) const |
Returns whether the vertical scrollbar is being forced visible. Despite content size. | |
bool | isHorzScrollbarAlwaysShown (void) const |
Returns whether the horizontal scrollbar is being forced visible. Despite content size. | |
Scrollbar * | getVertScrollbar () const |
Get the vertical scrollbar component attached to this window. | |
Scrollbar * | getHorzScrollbar () const |
Get the horizontal scrollbar component attached to this window. | |
void | setShowVertScrollbar (bool mode) |
Sets whether the vertical scrollbar should be forced visible. Despite content size. | |
void | setShowHorzScrollbar (bool mode) |
Sets whether the horizontal scrollbar should be forced visible. Despite content size. | |
void | ensureItemIsVisibleVert (const ItemEntry &item) |
Scroll the vertical list position if needed to ensure that the ItemEntry item is, if possible, fully visible witin the ScrolledItemListBase viewable area. | |
void | ensureItemIsVisibleHorz (const ItemEntry &item) |
Scroll the horizontal list position if needed to ensure that the ItemEntry item is, if possible, fully visible witin the ScrolledItemListBase viewable area. | |
ScrolledItemListBase (const String &type, const String &name) | |
Constructor for the ScrolledItemListBase base class constructor. | |
virtual | ~ScrolledItemListBase (void) |
Destructor for the ScrolledItemListBase base class. | |
virtual void | initialiseComponents (void) |
Initialise the Window based object ready for use. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | VertScrollbarName |
Name for vertical scrollbar component. | |
static const String | HorzScrollbarName |
Name for horizontal scrollbar component. | |
static const String | ContentPaneName |
Name for the content pane component. | |
static const String | EventVertScrollbarModeChanged |
static const String | EventHorzScrollbarModeChanged |
Protected Member Functions | |
void | configureScrollbars (const Sizef &doc_size) |
Configure scrollbars. | |
virtual void | onVertScrollbarModeChanged (WindowEventArgs &e) |
virtual void | onHorzScrollbarModeChanged (WindowEventArgs &e) |
virtual void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
bool | handle_VScroll (const EventArgs &e) |
bool | handle_HScroll (const EventArgs &e) |
Protected Attributes | |
bool | d_forceVScroll |
bool | d_forceHScroll |
ScrolledItemListBase window class.
void CEGUI::ScrolledItemListBase::ensureItemIsVisibleHorz | ( | const ItemEntry & | item | ) |
Scroll the horizontal list position if needed to ensure that the ItemEntry item is, if possible, fully visible witin the ScrolledItemListBase viewable area.
item | const reference to an ItemEntry attached to this ScrolledItemListBase that should be made visible in the view area. |
void CEGUI::ScrolledItemListBase::ensureItemIsVisibleVert | ( | const ItemEntry & | item | ) |
Scroll the vertical list position if needed to ensure that the ItemEntry item is, if possible, fully visible witin the ScrolledItemListBase viewable area.
item | const reference to an ItemEntry attached to this ScrolledItemListBase that should be made visible in the view area. |
virtual void CEGUI::ScrolledItemListBase::initialiseComponents | ( | void | ) | [virtual] |
Initialise the Window based object ready for use.
Reimplemented from CEGUI::ItemListBase.
virtual void CEGUI::ScrolledItemListBase::onMouseWheel | ( | MouseEventArgs & | e | ) | [protected, virtual] |
Handler called when the mouse wheel (z-axis) position changes within this window's area.
e | MouseEventArgs object. All fields are valid. |
Reimplemented from CEGUI::Window.
const String CEGUI::ScrolledItemListBase::EventHorzScrollbarModeChanged [static] |
Event fired when the horizontal scroll bar mode change. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ScrolledItemListBase whose horizontal scroll bar mode has been changed.
const String CEGUI::ScrolledItemListBase::EventVertScrollbarModeChanged [static] |
Event fired when the vertical scroll bar mode changes. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ScrolledItemListBase whose vertical scroll bar mode has been changed.