Symbian^3 Application Developer Library >

MCoeLayoutManager Class Reference

class MCoeLayoutManager

Base class for layout managers.

A layout manager can be attached to one, or many (depending on the concrete layout manager), compound controls. The layout manager handles the layout of the components of the attached compound controls, and calculates the attached compound controls' minimum size.

Public Member Functions
void AttachL ( CCoeControl &)
TSize CalcMinimumSize (const CCoeControl &)
TInt CalcTextBaselineOffset (const CCoeControl &, const TSize &)
TBool CanAttach ()
void Detach ( CCoeControl &)
void HandleAddedControlL (const CCoeControl &, const CCoeControl &)
TInt HandleControlReplaced (const CCoeControl &, const CCoeControl &)
void HandleRemovedControl (const CCoeControl &, const CCoeControl &)
void PerformLayout ()
void SetTextBaselineSpacing ( TInt )
TInt TextBaselineSpacing ()
Protected Member Functions
MCoeLayoutManager ()
Private Member Functions
IMPORT_C void Reserved_MCoeLayoutManager_1 ()
IMPORT_C void Reserved_MCoeLayoutManager_10 ()
IMPORT_C void Reserved_MCoeLayoutManager_11 ()
IMPORT_C void Reserved_MCoeLayoutManager_2 ()
IMPORT_C void Reserved_MCoeLayoutManager_3 ()
IMPORT_C void Reserved_MCoeLayoutManager_4 ()
IMPORT_C void Reserved_MCoeLayoutManager_5 ()
IMPORT_C void Reserved_MCoeLayoutManager_6 ()
IMPORT_C void Reserved_MCoeLayoutManager_7 ()
IMPORT_C void Reserved_MCoeLayoutManager_8 ()
IMPORT_C void Reserved_MCoeLayoutManager_9 ()
Private Attributes
TInt iMCoeLayoutManager_Reserved1

Constructor & Destructor Documentation

MCoeLayoutManager()

IMPORT_C MCoeLayoutManager ( ) [protected]

Member Functions Documentation

AttachL(CCoeControl &)

void AttachL ( CCoeControl & aCompoundControl ) [pure virtual]

Attaches aCompoundControl to the layout manager. Is normally not called manually since CCoeControl::SetLayoutManagerL() calls this function. Once a compound control is attached to a layout manager, the layout manager owns itself. Detach() CCoeControl::SetLayoutManagerL()

Parameters

CCoeControl & aCompoundControl The compound control.

CalcMinimumSize(const CCoeControl &)

TSize CalcMinimumSize ( const CCoeControl & aCompoundControl ) const [pure virtual]

Calculates the minimum size of aCompoundControl Is normally not called manually since CCoeControl::MinimumSize() calls this function in the default implementation on controls with layout managers.

To calculate the minimum size is almost as time consuming as performing an actual layout and should be used with caution. The minimum size depends on aCompoundControl 's maximum width. CCoeControl::MaximumWidth()

Parameters

const CCoeControl & aCompoundControl The compound control

CalcTextBaselineOffset(const CCoeControl &, const TSize &)

TInt CalcTextBaselineOffset ( const CCoeControl & aCompoundControl,
const TSize & aSize
) const [pure virtual]

Gets the offset to the first text baseline relative to the top of the control.

CCoeControl::TextBaselineOffset()

Parameters

const CCoeControl & aCompoundControl The control
const TSize & aSize The size of the control

CanAttach()

TBool CanAttach ( ) const [pure virtual]

Determines if it is possible to attach another control to the layout manager.

Detach(CCoeControl &)

void Detach ( CCoeControl & aCompoundControl ) [pure virtual]

Detaches aCompoundControl from the layout manager. Is normally not called manually since CCoeControl::SetLayoutManagerL() calls this function when you switch layout managers on a control. It is also called from CCoeControl::~CCoeControl When the last attached compound control detaches, the layout manager deletes itself. CCoeControl::SetLayoutManagerL()

Parameters

CCoeControl & aCompoundControl The compound control.

HandleAddedControlL(const CCoeControl &, const CCoeControl &)

void HandleAddedControlL ( const CCoeControl & aCompoundControl,
const CCoeControl & aAddedControl
) [pure virtual]

Handles when a component control is added to an attached compound control Is normally not called manually since CCoeControlArray::InsertLC() calls this function for controls with layout managers. Is used by layout managers to prepare to layout one more component control. CCoeControlArray::InsertLC()

Parameters

const CCoeControl & aCompoundControl The compound control.
const CCoeControl & aAddedControl The added control

HandleControlReplaced(const CCoeControl &, const CCoeControl &)

TInt HandleControlReplaced ( const CCoeControl & aOldControl,
const CCoeControl & aNewControl
) [pure virtual]

Handles when a component control is replaced by another component control in an attached compound control

Is not called by CCoeControl . Is used by layout managers to move settings and similar that are specified for aOldControl to aNewControl If this function is called, neither HandleAddedControlL nor HandleRemovedControl is allowed to be called.

Parameters

const CCoeControl & aOldControl The old component control
const CCoeControl & aNewControl The new component control

HandleRemovedControl(const CCoeControl &, const CCoeControl &)

void HandleRemovedControl ( const CCoeControl & aCompoundControl,
const CCoeControl & aRemovedControl
) [pure virtual]

Handles when a component control is removed from an attached compound control Is normally not called manually since CCoeControlArray::Remove() calls this function for controls with layout managers. Is used by layout managers to remove all settings and similar that are specific for aRemovedControl . CCoeControlArray::Remove()

Parameters

const CCoeControl & aCompoundControl The compound control.
const CCoeControl & aRemovedControl The removed control

PerformLayout()

void PerformLayout ( ) [pure virtual]

Performs the layout of the attached controls Is normally not called manually since CCoeControl::SizeChanged() calls this function in the default implementation on controls with layout managers.

The layout is generally performed by calling the component controls' SetMaximumWidth() , followed by MinimumSize() , and then the layout manager tries to place the component controls according to their minimum sizes and the settings.

CCoeControl::SetMaximumWidth() CCoeControl::MinimumSize()

Reserved_MCoeLayoutManager_1()

IMPORT_C void Reserved_MCoeLayoutManager_1 ( ) [private, virtual]

Reserved_MCoeLayoutManager_10()

IMPORT_C void Reserved_MCoeLayoutManager_10 ( ) [private, virtual]

Reserved_MCoeLayoutManager_11()

IMPORT_C void Reserved_MCoeLayoutManager_11 ( ) [private, virtual]

Reserved_MCoeLayoutManager_2()

IMPORT_C void Reserved_MCoeLayoutManager_2 ( ) [private, virtual]

Reserved_MCoeLayoutManager_3()

IMPORT_C void Reserved_MCoeLayoutManager_3 ( ) [private, virtual]

Reserved_MCoeLayoutManager_4()

IMPORT_C void Reserved_MCoeLayoutManager_4 ( ) [private, virtual]

Reserved_MCoeLayoutManager_5()

IMPORT_C void Reserved_MCoeLayoutManager_5 ( ) [private, virtual]

Reserved_MCoeLayoutManager_6()

IMPORT_C void Reserved_MCoeLayoutManager_6 ( ) [private, virtual]

Reserved_MCoeLayoutManager_7()

IMPORT_C void Reserved_MCoeLayoutManager_7 ( ) [private, virtual]

Reserved_MCoeLayoutManager_8()

IMPORT_C void Reserved_MCoeLayoutManager_8 ( ) [private, virtual]

Reserved_MCoeLayoutManager_9()

IMPORT_C void Reserved_MCoeLayoutManager_9 ( ) [private, virtual]

SetTextBaselineSpacing(TInt)

void SetTextBaselineSpacing ( TInt aBaselineSpacing ) [pure virtual]

Sets the spacing between text baselines.

CCoeControl::SetTextBaseLineSpacing()

Parameters

TInt aBaselineSpacing The new value for the baseline

TextBaselineSpacing()

TInt TextBaselineSpacing ( ) const [pure virtual]

Returns the baseline spacing.

Member Data Documentation

TInt iMCoeLayoutManager_Reserved1

TInt iMCoeLayoutManager_Reserved1 [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.