FrameComponent_wrapper Struct Reference

Inheritance diagram for FrameComponent_wrapper:

Collaboration diagram for FrameComponent_wrapper:

Public Member Functions
	FrameComponent_wrapper (CEGUI::FrameComponent const &arg)
void	renderImage (::CEGUI::GeometryBuffer &buffer,::CEGUI::Image const *image,::CEGUI::VerticalFormatting vertFmt,::CEGUI::HorizontalFormatting horzFmt,::CEGUI::Rectf &destRect,::CEGUI::ColourRect const &colours,::CEGUI::Rectf const *clipper, bool clipToDisplay) const
virtual void	render_impl (::CEGUI::Window &srcWindow,::CEGUI::Rectf &destRect,::CEGUI::ColourRect const *modColours,::CEGUI::Rectf const *clipper, bool clipToDisplay) const
virtual void	default_render_impl (::CEGUI::Window &srcWindow,::CEGUI::Rectf &destRect,::CEGUI::ColourRect const *modColours,::CEGUI::Rectf const *clipper, bool clipToDisplay) const
virtual bool	handleFontRenderSizeChange (::CEGUI::Window &window,::CEGUI::Font const *font) const
bool	default_handleFontRenderSizeChange (::CEGUI::Window &window,::CEGUI::Font const *font) const
void	initColoursRect (::CEGUI::Window const &wnd,::CEGUI::ColourRect const *modCols,::CEGUI::ColourRect &cr) const
bool	writeColoursXML (::CEGUI::XMLSerializer &xml_stream) const
Public Member Functions inherited from CEGUI::FrameComponent
void	setLeftEdgeFormatting (VerticalFormatting fmt)
	Set the formatting to be used for the left edge image. More...
void	setRightEdgeFormatting (VerticalFormatting fmt)
	Set the formatting to be used for the right edge image. More...
void	setTopEdgeFormatting (HorizontalFormatting fmt)
	Set the formatting to be used for the top edge image. More...
void	setBottomEdgeFormatting (HorizontalFormatting fmt)
	Set the formatting to be used for the bottom edge image. More...
void	setBackgroundVerticalFormatting (VerticalFormatting fmt)
	Set the vertical formatting to be used for the background image. More...
void	setBackgroundHorizontalFormatting (HorizontalFormatting fmt)
	Set the horizontal formatting to be used for the background image. More...
void	setLeftEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the left edge image.
void	setRightEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the right edge image.
void	setTopEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the top edge image.
void	setBottomEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the bottom edge image.
void	setBackgroundVerticalFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the vertical formatting to use for the backdround image.
void	setBackgroundHorizontalFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the horizontal formatting to use for the backdround image.
VerticalFormatting	getLeftEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the left edge image. More...
VerticalFormatting	getRightEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the right edge image. More...
HorizontalFormatting	getTopEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the top edge image. More...
HorizontalFormatting	getBottomEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the bottom edge image. More...
VerticalFormatting	getBackgroundVerticalFormatting (const Window &wnd) const
	Return the vertical formatting to be used for the background image. More...
HorizontalFormatting	getBackgroundHorizontalFormatting (const Window &wnd) const
	Return the horizontal formatting to be used for the background image. More...
const Image *	getImage (FrameImageComponent part, const Window &wnd) const
	Return the Image object that will be drawn by this FrameComponent for a specified frame part. More...
void	setImage (FrameImageComponent part, const Image *image)
	Set an Image that will be drawn by this FrameComponent. More...
void	setImage (FrameImageComponent part, const String &name)
	Set an Image that will be drawn by this FrameComponent. More...
void	setImagePropertySource (FrameImageComponent part, const String &name)
	Set the name of the Property that will be accesssed on the target Window to determine the Image that will be drawn by the FrameComponent. More...
bool	isImageSpecified (FrameImageComponent part) const
	Return whether the given component image has been specified. More...
bool	isImageFetchedFromProperty (FrameImageComponent part) const
	Return whether the given component image is specified via a property. More...
const String &	getImagePropertySource (FrameImageComponent part) const
	Return the name of the property that will be used to determine the image to use for the given component image. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this FrameComponent to out_stream. More...
bool	operator== (const FrameComponent &rhs) const
void	setLeftEdgeFormatting (VerticalFormatting fmt)
	Set the formatting to be used for the left edge image. More...
void	setRightEdgeFormatting (VerticalFormatting fmt)
	Set the formatting to be used for the right edge image. More...
void	setTopEdgeFormatting (HorizontalFormatting fmt)
	Set the formatting to be used for the top edge image. More...
void	setBottomEdgeFormatting (HorizontalFormatting fmt)
	Set the formatting to be used for the bottom edge image. More...
void	setBackgroundVerticalFormatting (VerticalFormatting fmt)
	Set the vertical formatting to be used for the background image. More...
void	setBackgroundHorizontalFormatting (HorizontalFormatting fmt)
	Set the horizontal formatting to be used for the background image. More...
void	setLeftEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the left edge image.
void	setRightEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the right edge image.
void	setTopEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the top edge image.
void	setBottomEdgeFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the formatting to use for the bottom edge image.
void	setBackgroundVerticalFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the vertical formatting to use for the backdround image.
void	setBackgroundHorizontalFormattingPropertySource (const String &property_name)
	Set the name of a property that will be used to obtain the horizontal formatting to use for the backdround image.
VerticalFormatting	getLeftEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the left edge image. More...
VerticalFormatting	getRightEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the right edge image. More...
HorizontalFormatting	getTopEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the top edge image. More...
HorizontalFormatting	getBottomEdgeFormatting (const Window &wnd) const
	Return the formatting to be used for the bottom edge image. More...
VerticalFormatting	getBackgroundVerticalFormatting (const Window &wnd) const
	Return the vertical formatting to be used for the background image. More...
HorizontalFormatting	getBackgroundHorizontalFormatting (const Window &wnd) const
	Return the horizontal formatting to be used for the background image. More...
const Image *	getImage (FrameImageComponent part, const Window &wnd) const
	Return the Image object that will be drawn by this FrameComponent for a specified frame part. More...
void	setImage (FrameImageComponent part, const Image *image)
	Set an Image that will be drawn by this FrameComponent. More...
void	setImage (FrameImageComponent part, const String &name)
	Set an Image that will be drawn by this FrameComponent. More...
void	setImagePropertySource (FrameImageComponent part, const String &name)
	Set the name of the Property that will be accesssed on the target Window to determine the Image that will be drawn by the FrameComponent. More...
bool	isImageSpecified (FrameImageComponent part) const
	Return whether the given component image has been specified. More...
bool	isImageFetchedFromProperty (FrameImageComponent part) const
	Return whether the given component image is specified via a property. More...
const String &	getImagePropertySource (FrameImageComponent part) const
	Return the name of the property that will be used to determine the image to use for the given component image. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this FrameComponent to out_stream. More...
bool	operator== (const FrameComponent &rhs) const
Public Member Functions inherited from CEGUI::FalagardComponentBase
void	render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
	Render this component. More correctly, the component is cached for rendering. More...
void	render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
	Render this component. More correctly, the component is cached for rendering. More...
const ComponentArea &	getComponentArea () const
	Return the ComponentArea of this component. More...
void	setComponentArea (const ComponentArea &area)
	Set the conponent's ComponentArea. More...
const ColourRect &	getColours () const
	Return the ColourRect used by this component. More...
void	setColours (const ColourRect &cols)
	Set the colours to be used by this component. More...
void	setColoursPropertySource (const String &property)
	Set the name of the property where colour values can be obtained. More...
virtual bool	handleFontRenderSizeChange (Window &window, const Font *font) const
	perform any processing required due to the given font having changed.
void	render (Window &srcWindow, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
	Render this component. More correctly, the component is cached for rendering. More...
void	render (Window &srcWindow, const Rectf &baseRect, const CEGUI::ColourRect *modColours=0, const Rectf *clipper=0, bool clipToDisplay=false) const
	Render this component. More correctly, the component is cached for rendering. More...
const ComponentArea &	getComponentArea () const
	Return the ComponentArea of this component. More...
void	setComponentArea (const ComponentArea &area)
	Set the conponent's ComponentArea. More...
const ColourRect &	getColours () const
	Return the ColourRect used by this component. More...
void	setColours (const ColourRect &cols)
	Set the colours to be used by this component. More...
void	setColoursPropertySource (const String &property)
	Set the name of the property where colour values can be obtained. More...
virtual bool	handleFontRenderSizeChange (Window &window, const Font *font) const
	perform any processing required due to the given font having changed.

Additional Inherited Members
Static Public Attributes inherited from CEGUI::FrameComponent
static const HorizontalFormatting	HorizontalFormattingDefault
	Default value for the HorzFormat elements of the FrameComponent. More...
static const VerticalFormatting	VerticalFormattingDefault
	Default value for the VertFormat elements of the FrameComponent.
Protected Member Functions inherited from CEGUI::FrameComponent
void	render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const
	Function to do main render caching work.
void	renderImage (GeometryBuffer &buffer, const Image *image, VerticalFormatting vertFmt, HorizontalFormatting horzFmt, Rectf &destRect, const ColourRect &colours, const Rectf *clipper, bool clipToDisplay) const
void	render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const
	Function to do main render caching work.
void	renderImage (GeometryBuffer &buffer, const Image *image, VerticalFormatting vertFmt, HorizontalFormatting horzFmt, Rectf &destRect, const ColourRect &colours, const Rectf *clipper, bool clipToDisplay) const
Protected Member Functions inherited from CEGUI::FalagardComponentBase
void	initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const
	Helper function to initialise a ColourRect with appropriate values according to the way the component is set up. More...
bool	writeColoursXML (XMLSerializer &xml_stream) const
	Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
void	initColoursRect (const Window &wnd, const ColourRect *modCols, ColourRect &cr) const
	Helper function to initialise a ColourRect with appropriate values according to the way the component is set up. More...
bool	writeColoursXML (XMLSerializer &xml_stream) const
	Writes xml for the colours to a OutStream. Will prefer property colours before explicit. More...
Protected Attributes inherited from CEGUI::FrameComponent
FormattingSetting< VerticalFormatting >	d_leftEdgeFormatting
FormattingSetting< VerticalFormatting >	d_rightEdgeFormatting
FormattingSetting< HorizontalFormatting >	d_topEdgeFormatting
FormattingSetting< HorizontalFormatting >	d_bottomEdgeFormatting
FormattingSetting< VerticalFormatting >	d_backgroundVertFormatting
FormattingSetting< HorizontalFormatting >	d_backgroundHorzFormatting
FrameImageSource	d_frameImages [FIC_FRAME_IMAGE_COUNT]
	FrameImageSource array describing images to be used.
Protected Attributes inherited from CEGUI::FalagardComponentBase
ComponentArea	d_area
	Destination area for this component.
ColourRect	d_colours
	base colours to be applied when rendering the image component.
String	d_colourPropertyName
	name of property to fetch colours from.