Crazy Eddie's GUI System  0.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::WindowRenderer Class Referenceabstract

Base-class for the assignable WindowRenderer object. More...

Inherits CEGUI::AllocatedObject< WindowRenderer >.

Inherited by CEGUI::EditboxWindowRenderer, CEGUI::FalagardButton, CEGUI::FalagardDefault, CEGUI::FalagardFrameWindow, CEGUI::FalagardListHeaderSegment, CEGUI::FalagardProgressBar, CEGUI::FalagardStatic, CEGUI::FalagardTabButton, CEGUI::FalagardTitlebar, CEGUI::FalagardTree, CEGUI::ItemEntryWindowRenderer, CEGUI::ItemListBaseWindowRenderer, CEGUI::ListboxWindowRenderer, CEGUI::ListHeaderWindowRenderer, CEGUI::MultiColumnListWindowRenderer, CEGUI::MultiLineEditboxWindowRenderer, CEGUI::ScrollablePaneWindowRenderer, CEGUI::ScrollbarWindowRenderer, CEGUI::SliderWindowRenderer, CEGUI::TabControlWindowRenderer, and CEGUI::TooltipWindowRenderer.

+ Collaboration diagram for CEGUI::WindowRenderer:

Public Member Functions

 WindowRenderer (const String &name, const String &class_name="Window")
 Constructor. More...
 
virtual ~WindowRenderer ()
 Destructor.
 
virtual void render ()=0
 Populate render cache. More...
 
const StringgetName () const
 Returns the factory type name of this window renderer.
 
WindowgetWindow () const
 Get the window this windowrenderer is attached to.
 
const StringgetClass () const
 Get the "minimum" Window class this renderer requires.
 
const WidgetLookFeelgetLookNFeel () const
 Get the Look'N'Feel assigned to our window.
 
virtual Rectf getUnclippedInnerRect () const
 Get unclipped inner rectangle that our window should return from its member function with the same name.
 
virtual void performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.
 
virtual void getRenderingContext (RenderingContext &ctx) const
 update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name.
 
virtual void update (float)
 perform any time based updates for this WindowRenderer.
 
virtual bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed. More...
 

Protected Types

typedef std::pair< Property
*, bool > 
PropertyEntry
 type used for entries in the PropertyList.
 
typedef std::vector
< PropertyEntry
CEGUI_VECTOR_ALLOC(PropertyEntry)> 
PropertyList
 type to use for the property list.
 

Protected Member Functions

void registerProperty (Property *property, const bool ban_from_xml)
 Register a property class that will be properly managed by this window renderer. More...
 
void registerProperty (Property *property)
 Register a property class that will be properly managed by this window renderer. More...
 
virtual void onAttach ()
 Handler called when this windowrenderer is attached to a window.
 
virtual void onDetach ()
 Handler called when this windowrenderer is detached from its window.
 
virtual void onLookNFeelAssigned ()
 Handler called when a Look'N'Feel is assigned to our window.
 
virtual void onLookNFeelUnassigned ()
 Handler called when a Look'N'Feel is removed/unassigned from our window.
 

Protected Attributes

Windowd_window
 Pointer to the window this windowrenderer is assigned to.
 
const String d_name
 Name of the factory type used to create this window renderer.
 
const String d_class
 Name of the widget class that is the "minimum" requirement.
 
PropertyList d_properties
 The list of properties that this windowrenderer will be handling.
 

Friends

class Window
 

Detailed Description

Base-class for the assignable WindowRenderer object.

Constructor & Destructor Documentation

CEGUI::WindowRenderer::WindowRenderer ( const String name,
const String class_name = "Window" 
)

Constructor.

Parameters
nameFactory type name
class_nameThe name of a widget class that is to be the minimum requirement for this window renderer.

Member Function Documentation

virtual bool CEGUI::WindowRenderer::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 in CEGUI::FalagardStaticText, CEGUI::FalagardEditbox, CEGUI::FalagardMultiLineEditbox, CEGUI::FalagardListbox, and CEGUI::FalagardMenuItem.

void CEGUI::WindowRenderer::registerProperty ( Property property,
const bool  ban_from_xml 
)
protected

Register a property class that will be properly managed by this window renderer.

Parameters
propertyPointer to a static Property object that will be added to the target window.
ban_from_xml
  • true if this property should be added to the 'ban' list so that it is not written in XML output.
  • false if this property is not banned and should appear in XML output.
void CEGUI::WindowRenderer::registerProperty ( Property property)
protected

Register a property class that will be properly managed by this window renderer.

Parameters
propertyPointer to a static Property object that will be added to the target window.