CEGUI::ScrolledItemListBase Class Reference

ScrolledItemListBase window class. More...

Inheritance diagram for CEGUI::ScrolledItemListBase:

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

Collaboration graph
[legend]

List of all members.

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.
ScrollbargetVertScrollbar () const
 Get the vertical scrollbar component attached to this window.
ScrollbargetHorzScrollbar () 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


Detailed Description

ScrolledItemListBase window class.

Member Function Documentation

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.

Parameters:
item const reference to an ItemEntry attached to this ScrolledItemListBase that should be made visible in the view area.
Returns:
Nothing.

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.

Parameters:
item const reference to an ItemEntry attached to this ScrolledItemListBase that should be made visible in the view area.
Returns:
Nothing.

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]

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

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.

Parameters:
class_name The class name that is to be checked.
Returns:
true if this window was inherited from class_name. false if not.

Reimplemented from CEGUI::ItemListBase.

Reimplemented in CEGUI::ItemListbox.

References CEGUI::ItemListBase::testClassName_impl().

Referenced by CEGUI::ItemListbox::testClassName_impl().


Generated on Thu Nov 27 20:34:38 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1