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 | VertScrollbarNameSuffix |
Name suffix for vertical scrollbar component. | |
static const String | HorzScrollbarNameSuffix |
Name suffix for horizontal scrollbar component. | |
static const String | ContentPaneNameSuffix |
Name suffix for the content pane component. | |
static const String | EventVertScrollbarModeChanged |
Event fired when the vertical scroll bar mode changes. | |
static const String | EventHorzScrollbarModeChanged |
Event fired when the horizontal scroll bar mode change. | |
Protected Member Functions | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy. | |
void | configureScrollbars (const Size &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 |
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. |
References CEGUI::UDim::asAbsolute(), CEGUI::Rect::d_left, CEGUI::Rect::d_right, CEGUI::Size::d_width, getHorzScrollbar(), CEGUI::ItemEntry::getItemPixelSize(), CEGUI::ItemListBase::getItemRenderArea(), CEGUI::Window::getPixelSize(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Rect::getWidth(), CEGUI::Window::getXPosition(), and CEGUI::Scrollbar::setScrollPosition().
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. |
References CEGUI::UDim::asAbsolute(), CEGUI::Rect::d_bottom, CEGUI::Size::d_height, CEGUI::Rect::d_top, CEGUI::Rect::getHeight(), CEGUI::ItemEntry::getItemPixelSize(), CEGUI::ItemListBase::getItemRenderArea(), CEGUI::Window::getPixelSize(), CEGUI::Scrollbar::getScrollPosition(), getVertScrollbar(), CEGUI::Window::getYPosition(), and CEGUI::Scrollbar::setScrollPosition().
void CEGUI::ScrolledItemListBase::initialiseComponents | ( | void | ) | [virtual] |
Initialise the Window based object ready for use.
Reimplemented from CEGUI::ItemListBase.
Reimplemented in CEGUI::ItemListbox.
References CEGUI::Window::addChildWindow(), ContentPaneNameSuffix, CEGUI::Rect::d_left, CEGUI::Window::d_name, CEGUI::ItemListBase::d_pane, CEGUI::Rect::d_top, CEGUI::Scrollbar::EventScrollPositionChanged, getHorzScrollbar(), CEGUI::ItemListBase::getItemRenderArea(), getVertScrollbar(), CEGUI::Window::hide(), CEGUI::Window::setAlwaysOnTop(), CEGUI::Window::setPosition(), and CEGUI::EventSet::subscribeEvent().
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.
References CEGUI::ItemListBase::d_pane, CEGUI::Rect::getHeight(), CEGUI::ItemListBase::getItemCount(), CEGUI::Scrollbar::getScrollPosition(), CEGUI::Window::getUnclippedPixelRect(), getVertScrollbar(), CEGUI::EventArgs::handled, CEGUI::Window::isVisible(), CEGUI::Scrollbar::setScrollPosition(), and CEGUI::MouseEventArgs::wheelChange.
virtual bool CEGUI::ScrolledItemListBase::testClassName_impl | ( | const String & | class_name | ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::ItemListBase.
Reimplemented in CEGUI::ItemListbox.
References CEGUI::ItemListBase::testClassName_impl().
Referenced by CEGUI::ItemListbox::testClassName_impl().