Crazy Eddie's GUI System  0.8.4
CEGUI::FalagardListbox Class Reference

Listbox class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardListbox:
+ Collaboration diagram for CEGUI::FalagardListbox:

List of all members.

Public Member Functions

 FalagardListbox (const String &type)
 Constructor.
void cacheListboxBaseImagery ()
 Perform caching 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 render ()
 Populate render cache.
Rectf getListRenderArea (void) const
 Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.
void resizeListToContent (bool fit_width, bool fit_height) const
bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed.

Static Public Attributes

static const String TypeName
 type name for this widget.

Protected Member Functions

Rectf getItemRenderingArea (bool hscroll, bool vscroll) const

Detailed Description

Listbox class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

  • Enabled
  • Disabled

Named Areas:

  • ItemRenderingArea
  • ItemRenderingAreaHScroll
  • ItemRenderingAreaVScroll
  • ItemRenderingAreaHVScroll
  • - OR -
  • ItemRenderArea
  • ItemRenderAreaHScroll
  • ItemRenderAreaVScroll
  • ItemRenderAreaHVScroll

Child Widgets: Scrollbar based widget with name suffix "__auto_vscrollbar__" Scrollbar based widget with name suffix "__auto_hscrollbar__"


Member Function Documentation

Perform caching 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.

Returns:
Nothing.
bool CEGUI::FalagardListbox::handleFontRenderSizeChange ( const Font *const  font) [virtual]

Perform any updates needed because the given font's render size has changed.

/note This base implementation deals with updates needed for various definitions in the assigned widget look. If you override, you should generally always call this base class implementation.

Parameters:
fontPointer to the Font whose render size has changed.
Returns:
  • true if some action was taken.
  • false if no action was taken (i.e font is not used here).

Reimplemented from CEGUI::WindowRenderer.

void CEGUI::FalagardListbox::render ( ) [virtual]

Populate render cache.

This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...

Implements CEGUI::WindowRenderer.

void CEGUI::FalagardListbox::resizeListToContent ( bool  fit_width,
bool  fit_height 
) const [virtual]

Resize the Listbox the renderer is attached to such that it's content can be displayed without needing scrollbars if there is enough space, otherwise make the Listbox as large as possible (without moving it).

Implements CEGUI::ListboxWindowRenderer.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends