#include <GUILayouterReposition.h>

Inheritance diagram for CGUILayouterReposition:

[legend]

Public Member Functions
	CGUILayouterReposition (CGUICompositeObject *const pkObject=NULL, const CGUILayoutHelper::RepositionAlignment_t &eBasePoint=CGUILayoutHelper::REPOSITION_ALIGN_INVALID, const eC_Value &vGap=eC_FromInt(0), eC_Bool bTakeOverParentLayout=false)

virtual	~CGUILayouterReposition ()
	Destructor a Reposition-Layouter.

virtual void	DoLayout (eMovedEdges_t eMovedEdges)

eC_Value	GetGap () const

virtual void	InitLayouter (eMovedEdges_t eMovedEdges)

virtual void	ReadFromStream ()

void	SetBasePoint (CGUILayoutHelper::RepositionAlignment_t eNewBasePoint)

void	SetBorder (const eC_Value vBorder)

void	SetGap (const eC_Value vGap)

void	SetResizeObject (const eC_Bool bResize)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIGroupLayouter
	CGUIGroupLayouter ()
	Default constuctor.

	CGUIGroupLayouter (CGUICompositeObject *pkObject, eC_Bool bTakeOverParentLayout)

virtual	~CGUIGroupLayouter ()
	Destructor a Reposition-Layouter.

virtual eC_Bool	IsDependentOnParentSize ()

virtual eC_Bool	IsGroupLayouter () const

virtual void	ReadFromStream ()

virtual void	SetAssociatedObject (CGUIObject *const pkObject)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUILayouter
virtual	~CGUILayouter ()
	Destructor. More...

virtual void	DoLayout (eMovedEdges_t eMovedEdges)=0

CGUIObject *	GetAssociatedObject () const

virtual void	InitLayouter (eMovedEdges_t eMovedEdges)

virtual eC_Bool	IsDependentOnParentSize ()=0

virtual eC_Bool	IsGroupLayouter () const

virtual void	SetAssociatedObject (CGUIObject *const pkObject)

Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const

virtual void	ReadFromStream ()

void	SetXMLTag (const eC_String &kXMLTag)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Static Public Attributes
static const eC_UInt	LAYOUTER_REPOSITION_CLASS_VERSION
	Class version of reposition layouter class.

Static Public Attributes inherited from CGUIGroupLayouter
static const eC_UInt	GROUP_LAYOUTER_CLASS_VERSION
	Class version of group layouter class.

Static Public Attributes inherited from CGUILayouter
static const eC_Char	XMLTAG_LAYOUTERCLASSID []
	XML tag to be used when writing a layouter class ID into a stream.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Additional Inherited Members
Public Types inherited from CGUILayouter
enum	eMovedEdges_t { CHANGED_WIDTH , CHANGED_HEIGHT , CHANGED_RELXPOS , CHANGED_RELYPOS , CHANGED_EDGE_ALL }
	Enumerate possible reasons for calling layout,. More...

Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t	GenerateUUID ()

Protected Member Functions inherited from CGUIGroupLayouter
eC_Bool	LayoutAction ()

Protected Member Functions inherited from CGUILayouter
	CGUILayouter (CGUIObject *const pkObject=NULL)

Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const

void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const

void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Detailed Description

This is a layouter, which implements repositioning of the children like CGUIRepositionCompositeObject does.

Constructor & Destructor Documentation

◆ CGUILayouterReposition()

CGUILayouterReposition::CGUILayouterReposition	(	CGUICompositeObject *const	pkObject = `NULL`,
		const CGUILayoutHelper::RepositionAlignment_t &	eBasePoint = `CGUILayoutHelper::REPOSITION_ALIGN_INVALID`,
		const eC_Value &	vGap = `eC_FromInt(0)`,
		eC_Bool	bTakeOverParentLayout = `false`
	)

Constructs a Reposition-Layouter.

Parameters

pkObject	Pointer to the object to which the layouter is attached.
eBasePoint	The base point on which the repositioning is based.
vGap	The gap between the children.
bTakeOverParentLayout	True if LayoutAction() shall take over the size of the associated object's parent to the associated object and set the x and y position of the associated to zero.

Member Function Documentation

◆ DoLayout()

virtual void CGUILayouterReposition::DoLayout ( eMovedEdges_t eMovedEdges )

virtual

Repositions child objects and resizes associated object.

Parameters

eMovedEdges Reason for layouter call

Implements CGUILayouter.

◆ GetGap()

eC_Value CGUILayouterReposition::GetGap ( ) const

inline

Get Gap between child objects

Returns: gap

◆ InitLayouter()

virtual void CGUILayouterReposition::InitLayouter ( eMovedEdges_t eMovedEdges )

inlinevirtual

This function is useful for child layouters. Called when the layout of the associated object itself has changed. It is called by the framework every time the width or height or x or y relative position of the associated object is changed. That is, for example when the new distance to parent's border(s) shall be set in a child layouter to base upcoming layouting on this data the framework calls this method.

InitLayouter() is only called on the layouter of the associated object for one change of the position or size of the associated object. DoLayout() in contrast is called on the layouter of the associated object and on the layouters of all decendants of the associated object for one change of the size of the associated object.

This function usually does not implement changes to any layout. It is typically used to remember layout data to be used in DoLayout() later on (useful for child layouters that depend on changes of their associated object's parent).

Parameters

eMovedEdges Reason for layouter call

Reimplemented from CGUILayouter.

◆ ReadFromStream()

virtual void CGUILayouterReposition::ReadFromStream ( )

virtual

Reads attributes from the streaming file. Only for use with GUIFactoryManager.

See also: CGUIObject::ReadFromStream()

Reimplemented from CGUIGroupLayouter.

◆ SetBasePoint()

void CGUILayouterReposition::SetBasePoint ( CGUILayoutHelper::RepositionAlignment_t eNewBasePoint )

inline

Sets BasePoint on which repositioning is based.

Parameters

eNewBasePoint

◆ SetBorder()

void CGUILayouterReposition::SetBorder ( const eC_Value vBorder )

inline

Set Border spacing

Parameters

vBorder

◆ SetGap()

void CGUILayouterReposition::SetGap ( const eC_Value vGap )

inline

Set Gap between child objects

Parameters

vGap

◆ SetResizeObject()

void CGUILayouterReposition::SetResizeObject ( const eC_Bool bResize )

inline

Specifies if the associated object shall automatically be resized to be exactly large enough to contain its children

Parameters

bResize

◆ WriteToStream()

virtual void CGUILayouterReposition::WriteToStream ( const eC_Bool bWriteClassID = false )

virtual

Writes attributes to the streaming file. A CGUIStreamWriter has to be initialized.

Parameters

bWriteClassID This flag is used to switch writing of the class ID, leading and trailing tags. When implementing a new streamable object, check this flag. If it is true, first write the class ID, then continue with this object's attributes, and finally call the base class implementation with this flag set to false (this is the default).

Reimplemented from CGUIGroupLayouter.

The documentation for this class was generated from the following file:

GUILayouterReposition.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUILayouterReposition()

Member Function Documentation

◆ DoLayout()

◆ GetGap()

◆ InitLayouter()

◆ ReadFromStream()

◆ SetBasePoint()

◆ SetBorder()

◆ SetGap()

◆ SetResizeObject()

◆ WriteToStream()