Guiliani  Version 2.4 revision 5970 (build 3)
CGUILayouterList Class Reference

Layouter for list arangement, resizes to asscoiated object. More...

#include <GUILayouterList.h>

Inheritance diagram for CGUILayouterList:

Public Member Functions

 CGUILayouterList (CGUICompositeObject *pObject, CGUILayoutHelper::ListAlignment_t eBasePoint, eC_Bool bTakeOverParentLayout)
 
 CGUILayouterList ()
 Default Constuctor.
 
virtual ~CGUILayouterList ()
 Destructor a List-Layouter.
 
virtual void DoLayout (eMovedEdges_t eMovedEdges)
 
eC_UInt GetBasePoint () const
 
virtual void InitLayouter (eMovedEdges_t eMovedEdges)
 
virtual void ReadFromStream ()
 
void SetBasePoint (const CGUILayoutHelper::ListAlignment_t eBasePoint)
 
virtual void WriteToStream (const eC_Bool bWriteClassID=false)
 
- Public Member Functions inherited from CGUIGroupLayouter
 CGUIGroupLayouter ()
 Default constuctor.
 
 CGUIGroupLayouter (CGUICompositeObject *pObject, eC_Bool bTakeOverParentLayout)
 
virtual ~CGUIGroupLayouter ()
 Destructor a Reposition-Layouter.
 
virtual eC_Bool IsDependentOnParentSize ()
 
virtual eC_Bool IsGroupLayouter () const
 
virtual void SetAssociatedObject (CGUIObject *const pObject)
 
- Public Member Functions inherited from CGUILayouter
virtual ~CGUILayouter ()
 Destructor. More...
 
CGUIObjectGetAssociatedObject () const
 
- Public Member Functions inherited from CGUIStreamableObject
const eC_String & GetXMLTag () const
 
void SetXMLTag (const eC_String &kXMLTag)
 

Static Public Attributes

static const eC_UInt LAYOUTER_LIST_CLASS_VERSION = 2
 Class version of list layouter class.
 
- Static Public Attributes inherited from CGUIGroupLayouter
static const eC_UInt GROUP_LAYOUTER_CLASS_VERSION = 1
 Class version of group layouter class.
 
- Static Public Attributes inherited from CGUILayouter
static const eC_Char XMLTAG_LAYOUTERCLASSID [] = "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 [] = "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...
 
- Protected Member Functions inherited from CGUIGroupLayouter
eC_Bool LayoutAction ()
 
- Protected Member Functions inherited from CGUILayouter
 CGUILayouter (CGUIObject *const pObject=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

Layouter for list arangement, resizes to asscoiated object.

This is a layouter, which implements repositioning of the children of the associated object in a list according to the size of the associated object. If a line or row is completely filled it wraps to another one.

Constructor & Destructor Documentation

◆ CGUILayouterList()

CGUILayouterList::CGUILayouterList ( CGUICompositeObject pObject,
CGUILayoutHelper::ListAlignment_t  eBasePoint,
eC_Bool  bTakeOverParentLayout 
)

Constructs a List-Layouter.

Parameters
pObjectPointer to the object to which the layouter is attached.
eBasePointThe base point on which the list positioning is based.
bTakeOverParentLayoutTrue 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()

void CGUILayouterList::DoLayout ( eMovedEdges_t  eMovedEdges)
virtual

Repositions child objects and resizes associated object.

Parameters
eMovedEdgesReason for layouter call

Implements CGUILayouter.

◆ GetBasePoint()

eC_UInt CGUILayouterList::GetBasePoint ( ) const
inline

Get 'BasePoint' repositioning parameter, see CGUILayoutHelper::AdjustListArrangement().

Returns
basepoint

◆ InitLayouter()

virtual void CGUILayouterList::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
eMovedEdgesReason for layouter call

Reimplemented from CGUILayouter.

◆ ReadFromStream()

void CGUILayouterList::ReadFromStream ( )
virtual

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

See also
CGUIObject::ReadFromStream()

Reimplemented from CGUIGroupLayouter.

◆ SetBasePoint()

void CGUILayouterList::SetBasePoint ( const CGUILayoutHelper::ListAlignment_t  eBasePoint)
inline

Set 'BasePoint' repositioning parameter, see CGUILayoutHelper::AdjustListArrangement().

Parameters
eBasePoint

◆ WriteToStream()

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

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

Parameters
bWriteClassIDThis 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 files: