Helper container window that has configurable clipping. Used by the ItemListbox widget. More...

Inheritance diagram for CEGUI::ClippedContainer:

Collaboration diagram for CEGUI::ClippedContainer:

Public Member Functions
	ClippedContainer (const String &type, const String &name)
	Constructor for ClippedContainer objects.
	~ClippedContainer (void)
	Destructor for ClippedContainer objects.
const Rectf &	getClipArea (void) const
	Return the current clipping rectangle.
Window *	getClipperWindow (void) const
	Returns the reference window used for converting the clipper rect to screen space.
void	setClipArea (const Rectf &r)
	Set the custom clipper area in pixels.
void	setClipperWindow (Window *w)
	Set the clipper reference window.
Static Public Attributes
static const String	WidgetTypeName
	Type name for ClippedContainer.
static const String	EventNamespace
	Namespace for global events.
Protected Member Functions
virtual Rectf	getUnclippedInnerRect_impl (bool skipAllPixelAlignment) const
	Default implementation of function to return Element's inner rect area.
virtual void	drawSelf (const RenderingContext &)
	Perform the actual rendering for this Window.
Protected Attributes
Rectf	d_clipArea
	the pixel rect to be used for clipping relative to either a window or the screen.
Window *	d_clipperWindow
	the base window which the clipping rect is relative to.

Detailed Description

Helper container window that has configurable clipping. Used by the ItemListbox widget.

Deprecated:: This class is deprecated and is scheduled for removal. The function this class used to provide was broken when the inner-rect (aka client area) support got fixed. The good news is that fixing inner-rect support effectively negated the need for this class anyway - clipping areas can now be established in the looknfeel and extracted via the WindowRenderer.

Member Function Documentation

virtual void CEGUI::ClippedContainer::drawSelf ( const RenderingContext & ctx ) [inline, protected, virtual]

Perform the actual rendering for this Window.

Parameters:

ctx	RenderingContext holding the details of the RenderingSurface to be used for the Window rendering operations.

Reimplemented from CEGUI::Window.

const Rectf& CEGUI::ClippedContainer::getClipArea ( void ) const

Return the current clipping rectangle.

Returns:: Rect object describing the clipping area in pixel that will be applied during rendering.

void CEGUI::ClippedContainer::setClipperWindow ( Window * w )

Set the clipper reference window.

Parameters:

w	The window to be used a base for converting the custom clipper rect to screen space. NULL if the clipper rect is relative to the screen.