Collapse all Symbian^3 Product Developer Library

Alf::AlfLayoutManagerImpl Class Reference

class Alf::AlfLayoutManagerImpl : public Alf::IAlfLayoutPreferences

layoutmanager implementation class

alfwidgetmodel.lib

Since: S60 ?S60_version

Inherits from

Alf::AlfLayoutManagerImpl
- Alf::IAlfLayoutPreferences
  - Alf::IAlfInterfaceBase

Public Member Functions
	AlfLayoutManagerImpl(TAlfLayoutType)
	~AlfLayoutManagerImpl()
void	childRemoved(CAlfWidgetControl *)
bool	controlRect(CAlfWidgetControl &, TAlfRealRect &)
int	count()
void	createLayout(CAlfWidgetControl &, CAlfLayout *, int)
void	doUpdateChildLayout(CAlfWidgetControl *)
CAlfWidgetControl *	getControl(int)
CAlfLayout &	getLayout()
const IAlfLayoutPreferences *	getLayoutPreferences(CAlfWidgetControl *)
bool	getMaximumSize(TAlfXYMetric &)
bool	getMinimumSize(TAlfXYMetric &)
bool	getPreferredSize(TAlfXYMetric &)
IAlfInterfaceBase *	makeInterface(const IfId &)
CAlfWidgetControl &	owner()
void	setPreferredSize(const TAlfXYMetric &)
void	setWidgetPosition(IAlfWidget &, const TAlfRealPoint &)
void	setWidgetRect(IAlfWidget &, const TAlfRealRect &)
void	setWidgetSize(IAlfWidget &, const TAlfRealPoint &)
void	updateAllWidgetRects()
void	updateMainLayout()

Private Member Functions
void	checkLayout()
CAlfVisual *	findRootVisual(CAlfWidgetControl *)
CAlfWidgetControl *	getControl(CAlfVisual &)

Inherited Functions
	Alf::IAlfInterfaceBase::makeInterface(IAlfInterfaceBase *)
	Alf::IAlfInterfaceBase::~IAlfInterfaceBase()
	Alf::IAlfLayoutPreferences::type()

Private Attributes
auto_ptr< CAlfLayout >	mLayout
TAlfLayoutType	mLayoutType

Constructor & Destructor Documentation

AlfLayoutManagerImpl(TAlfLayoutType)

AlfLayoutManagerImpl

(

TAlfLayoutType

aLayoutType

)

layout manager constructor

Parameters

TAlfLayoutType aLayoutType

type of layout used by the manager.

~AlfLayoutManagerImpl()

~AlfLayoutManagerImpl

(

)

destructor

Member Functions Documentation

checkLayout()

void

checkLayout

(

)

const [private]

checks, that layout is created. If not, throws an exception.

childRemoved(CAlfWidgetControl *)

void

childRemoved

(

CAlfWidgetControl *

aControl

)

notifies the layout manager, that the control's has been removed from the layout.

Parameters

CAlfWidgetControl * aControl

control, which size has changed.

controlRect(CAlfWidgetControl &, TAlfRealRect &)

bool	controlRect	(	CAlfWidgetControl &	aControl,
			TAlfRealRect &	aRect
		)

returns the rect of the control.

Parameters

CAlfWidgetControl & aControl
TAlfRealRect & aRect

count()

int

count

(

)

const

createLayout(CAlfWidgetControl &, CAlfLayout *, int)

void	createLayout	(	CAlfWidgetControl &	aOwner,
			CAlfLayout *	aParentLayout,
			int	aLayoutIndex
		)

creates the layout used by the layoutmanager.

Parameters

CAlfWidgetControl & aOwner
CAlfLayout * aParentLayout	parent for the created layout
int aLayoutIndex	index, where created visual should be placed in the parent layout.

doUpdateChildLayout(CAlfWidgetControl *)

void

doUpdateChildLayout

(

CAlfWidgetControl *

aControl

)

notifies the layout manager, that the child control's layout must be updated.

Parameters

CAlfWidgetControl * aControl

control, which size or position has changed.

findRootVisual(CAlfWidgetControl *)

CAlfVisual *

findRootVisual

(

CAlfWidgetControl *

aControl

)

const [private]

finds the root visual for a control

Parameters

CAlfWidgetControl * aControl

control, which rootvisual is searched

getControl(int)

CAlfWidgetControl *

getControl

(

int

aIndex

)

const

returns the control at aIndex.

Parameters

int aIndex

index for the control.

getControl(CAlfVisual &)

CAlfWidgetControl *

getControl

(

CAlfVisual &

aVisual

)

const [private]

returns the control, which owns the visual

Parameters

CAlfVisual & aVisual

visual, which the control owns.

getLayout()

CAlfLayout &

getLayout

(

)

const

returns the layout used by layoutmanager.

getLayoutPreferences(CAlfWidgetControl *)

const IAlfLayoutPreferences *

getLayoutPreferences

(

CAlfWidgetControl *

aControl

)

const

returns the layout preferences for a control

Parameters

CAlfWidgetControl * aControl

control instance

getMaximumSize(TAlfXYMetric &)

bool

getMaximumSize

(

TAlfXYMetric &

aMaxSize

)

const [virtual]

Returns the maximum size of the layout by combining the maximum sizes of the layed out visuals.

Parameters

TAlfXYMetric & aMaxSize

The maximum size that the object would like to be laid out to

getMinimumSize(TAlfXYMetric &)

bool

getMinimumSize

(

TAlfXYMetric &

aMinSize

)

const [virtual]

Returns the minimum size of the layout by combining the minimum sizes of the layed out visuals.

Parameters

TAlfXYMetric & aMinSize

The minimum size that the object would like to be laid out to

getPreferredSize(TAlfXYMetric &)

bool

getPreferredSize

(

TAlfXYMetric &

aPreferredSize

)

const [virtual]

Returns the size combined by all preferred sizes of child UI elements in this layout when they are being layed out according to the layout manager rules.

Parameters

TAlfXYMetric & aPreferredSize

Filled with the referred area occupied by child elements when layed out by layouting rules in this layout manager.

makeInterface(const IfId &)

IAlfInterfaceBase *

makeInterface

(

const IfId &

aType

)

[virtual]

Interface getter. IAlfInterfaceBase::MakeInterface

Since: S60 ?S60_version

Parameters

const IfId & aType

The type id of the queried interface.

owner()

CAlfWidgetControl &

owner

(

)

const

setPreferredSize(const TAlfXYMetric &)

void

setPreferredSize

(

const TAlfXYMetric &

aPreferredSize

)

[virtual]

Set the preferred size into a presentation object.

This is not supported on the layout manager. Users should set preferred sizes of the contained UI elements.

Parameters

const TAlfXYMetric & aPreferredSize

setWidgetPosition(IAlfWidget &, const TAlfRealPoint &)

void	setWidgetPosition	(	IAlfWidget &	aWidget,
			const TAlfRealPoint &	aPos
		)

sets the position to the widget.

Parameters

IAlfWidget & aWidget
const TAlfRealPoint & aPos

setWidgetRect(IAlfWidget &, const TAlfRealRect &)

void	setWidgetRect	(	IAlfWidget &	aWidget,
			const TAlfRealRect &	aRect
		)

sets the size and position to the widget.

Parameters

IAlfWidget & aWidget
const TAlfRealRect & aRect

setWidgetSize(IAlfWidget &, const TAlfRealPoint &)

void	setWidgetSize	(	IAlfWidget &	aWidget,
			const TAlfRealPoint &	aSize
		)

sets the size to widget.

Parameters

IAlfWidget & aWidget
const TAlfRealPoint & aSize

updateAllWidgetRects()

void

updateAllWidgetRects

(

)

updates widget size and position properties for all the children to correct sizes and positions of the root visuals.

updateMainLayout()

void

updateMainLayout

(

)

updates the main layout

Member Data Documentation

auto_ptr< CAlfLayout > mLayout

auto_ptr< CAlfLayout >

mLayout

[private]

the layout created and used by the layout manager. Destroyed along with instance of this class.

TAlfLayoutType mLayoutType

TAlfLayoutType

mLayoutType

[private]

the layout type of mLayout