Collapse all Symbian^3 Application Developer Library

CAlfLCTAnchorLayout Class Reference

class CAlfLCTAnchorLayout : public CAlfAnchorLayout

LCT Anchor layout

This is a specialised anchor layout, which is aware of the avkon LCT layout system. It provides additional APIs that allow anchors to be set by referring to LCT layout components from the Layout Specifcations.

alfclient.lib

Since: S60 v3.2

Inherits from

CAlfLCTAnchorLayout
- CAlfAnchorLayout
  - CAlfLayout
    - CAlfVisual
      - CAlfPropertyOwner
        
        CBase

Public Member Functions
	CAlfLCTAnchorLayout ()
	~CAlfLCTAnchorLayout ()
IMPORT_C CAlfLCTAnchorLayout *	AddNewL ( CAlfControl &, CAlfLayout *)
IMPORT_C TAlfXYMetric	BaseUnit ()
IMPORT_C void	ConstructL ( CAlfControl &)
IMPORT_C CAlfVisual *	FindTag (const TDesC8 &)
IMPORT_C void	RemoveAndDestroyAllD ()
IMPORT_C void	SetAnchors ( TInt , TAknLayoutHierarchyComponentHandle &, const TAlfTimedPoint &)
IMPORT_C void	UpdateChildrenLayout ( TInt )

Protected Member Functions
IMPORT_C void	DoRemoveAndDestroyAllD ()
IMPORT_C void	PropertyOwnerExtension (const TUid &, TAny **)

Inherited Functions
	CAlfAnchorLayout::Attach(TInt,TAlfAnchorType,const TAlfMetric &,TAlfAnchorAttachmentOrigin,TInt)
	CAlfAnchorLayout::Attach(TInt,TAlfAnchorType,const TAlfXYMetric &,TAlfAnchorAttachmentOrigin,TInt)
	CAlfAnchorLayout::Attach(TInt,const TAlfBoxMetric &,TAlfAnchorAttachmentOrigin,TInt)
	CAlfAnchorLayout::CAlfAnchorLayout()
	CAlfAnchorLayout::Detach(TInt)
	CAlfAnchorLayout::Detach(TInt,TAlfAnchorType)
	CAlfAnchorLayout::RemoveAnchor(TAlfAnchor,TInt)
	CAlfAnchorLayout::Reset()
	CAlfAnchorLayout::SetAnchor(TAlfAnchor,TInt,TAlfAnchorOrigin,TAlfAnchorOrigin,TAlfAnchorMetric,TAlfAnchorMetric,const TAlfTimedPoint &)
	CAlfAnchorLayout::SetRelativeAnchorRect(TInt,TAlfAnchorOrigin,TAlfAnchorOrigin,const TAlfRealPoint &,TAlfAnchorOrigin,TAlfAnchorOrigin,const TAlfRealPoint &)
	CAlfAnchorLayout::~CAlfAnchorLayout()
	CAlfLayout::Append(CAlfVisual *,TBool,TInt)
	CAlfLayout::CAlfLayout()
	CAlfLayout::ChildOrdinal(TInt)
	CAlfLayout::ChildPos(TInt,TPoint &)
	CAlfLayout::ChildSize(TInt,TSize &)
	CAlfLayout::Count()const
	CAlfLayout::EffectiveLayoutOrdinal(const CAlfVisual &)const
	CAlfLayout::EnableScrollingL(TBool)
	CAlfLayout::FindVisual(CAlfVisual *)const
	CAlfLayout::HorizontalInnerPadding()const
	CAlfLayout::InnerPadding()const
	CAlfLayout::InnerPaddingAsMetric()const
	CAlfLayout::InnerPaddingInBaseUnits()const
	CAlfLayout::Insert(CAlfVisual *,TInt)
	CAlfLayout::MoveVisualToBack(CAlfVisual &,TInt)
	CAlfLayout::MoveVisualToFront(CAlfVisual &,TInt)
	CAlfLayout::Remove(CAlfVisual *,TInt)
	CAlfLayout::Reorder(CAlfVisual &,TInt,TInt)
	CAlfLayout::ScrollOffset()const
	CAlfLayout::Scrolling()const
	CAlfLayout::SetBaseUnit(const TAlfMetric &)
	CAlfLayout::SetBaseUnit(const TAlfXYMetric &)
	CAlfLayout::SetInnerPadding(const TAlfXYMetric &)
	CAlfLayout::SetInnerPadding(const TPoint &)
	CAlfLayout::SetScrollOffset(const TAlfTimedPoint &)
	CAlfLayout::SetTransitionTime(TInt)
	CAlfLayout::TransitionTime()const
	CAlfLayout::VerticalInnerPadding()const
	CAlfLayout::VirtualSize()const
	CAlfLayout::Visual(TInt)const
	CAlfLayout::~CAlfLayout()
	CAlfPropertyOwner::CAlfPropertyOwner()
	CAlfPropertyOwner::CopyProperty(const CAlfPropertyOwner &,const TDesC8 &)
	CAlfPropertyOwner::PropertyClear()
	CAlfPropertyOwner::PropertyFindInteger(const TDesC8 &,TInt *)const
	CAlfPropertyOwner::PropertyFindString(const TDesC8 &,TDesC **)const
	CAlfPropertyOwner::PropertyRemove(const TDesC8 &)
	CAlfPropertyOwner::PropertySetIntegerL(const TDesC8 &,TInt,TInt,TInt)
	CAlfPropertyOwner::PropertySetStringL(const TDesC8 &,const TDesC &)
	CAlfPropertyOwner::~CAlfPropertyOwner()
	CAlfVisual::AlignByOrigin(TAlfRealRect &)const
	CAlfVisual::Brushes()
	CAlfVisual::CAlfVisual()
	CAlfVisual::ClearFlag(TAlfVisualFlags)
	CAlfVisual::ClearFlags(TUint)
	CAlfVisual::Clipping()const
	CAlfVisual::Comms()const
	CAlfVisual::ConstructL(CAlfControl &,TInt,TInt,const TDesC8 &)
	CAlfVisual::CopyValues(const CAlfVisual &,TInt,TInt)
	CAlfVisual::DepthOffset()const
	CAlfVisual::Display()const
	CAlfVisual::DisplayRect()const
	CAlfVisual::DisplayRectTarget()const
	CAlfVisual::DisplayToLocal(const TAlfRealPoint &)const
	CAlfVisual::DisplayToLocal(const TPoint &)const
	CAlfVisual::DropShadowHandler()const
	CAlfVisual::EffectiveOpacity()const
	CAlfVisual::EnableBrushesL(TBool)
	CAlfVisual::EnableDropShadowL(TBool)
	CAlfVisual::EnableTransformationL(TBool)
	CAlfVisual::Env()const
	CAlfVisual::Flags()const
	CAlfVisual::HasTactileFeedback(TInt)const
	CAlfVisual::HorizontalOrigin()const
	CAlfVisual::HorizontalPadding()const
	CAlfVisual::Identifier()const
	CAlfVisual::IsTagged()const
	CAlfVisual::Layout()const
	CAlfVisual::LocalToDisplay(const TAlfRealPoint &)const
	CAlfVisual::LocalToDisplay(const TPoint &)const
	CAlfVisual::MaxSize()const
	CAlfVisual::MaxSizeInBaseUnits()const
	CAlfVisual::Mimic(CAlfVisual &,TInt)
	CAlfVisual::MinSize()const
	CAlfVisual::MinSizeInBaseUnits()const
	CAlfVisual::Move(const TAlfRealPoint &,TInt)
	CAlfVisual::Move(const TPoint &,TInt)
	CAlfVisual::MoveToFront(TInt)
	CAlfVisual::Opacity()const
	CAlfVisual::Owner()const
	CAlfVisual::Padding()const
	CAlfVisual::PaddingAsMetric()const
	CAlfVisual::PaddingInPixels()const
	CAlfVisual::Pause(TInt)
	CAlfVisual::Pos()const
	CAlfVisual::RemoveTactileFeedback(TInt)
	CAlfVisual::Resume(TInt)
	CAlfVisual::SetCenteredPosAndSize(const TAlfRealPoint &,const TAlfRealSize &,TInt)
	CAlfVisual::SetCenteredPosAndSize(const TPoint &,const TSize &,TInt)
	CAlfVisual::SetClipping(TBool)
	CAlfVisual::SetDepthOffset(const TAlfTimedValue &)
	CAlfVisual::SetDisplay(CAlfDisplay *)
	CAlfVisual::SetEffectL(const TDesC &)
	CAlfVisual::SetFlag(TAlfVisualFlags)
	CAlfVisual::SetFlags(TUint)
	CAlfVisual::SetGroupEffectL(const TDesC &,TInt)
	CAlfVisual::SetLayout(CAlfLayout *)
	CAlfVisual::SetMaxSize(const TAlfRealSize &)
	CAlfVisual::SetMaxSize(const TSize &)
	CAlfVisual::SetMinSize(const TAlfRealSize &)
	CAlfVisual::SetMinSize(const TSize &)
	CAlfVisual::SetOpacity(const TAlfTimedValue &)
	CAlfVisual::SetOrigin(TAlfVisualHOrigin,TAlfVisualVOrigin)
	CAlfVisual::SetOwner(CAlfControl &)
	CAlfVisual::SetPadding(TInt)
	CAlfVisual::SetPadding(const TAlfBoxMetric &)
	CAlfVisual::SetPadding(const TPoint &)
	CAlfVisual::SetPos(const TAlfRealPoint &,TInt)
	CAlfVisual::SetPos(const TAlfTimedPoint &)
	CAlfVisual::SetRect(const TAlfRealRect &,TInt)
	CAlfVisual::SetSize(const TAlfRealSize &,TInt)
	CAlfVisual::SetSize(const TAlfTimedPoint &)
	CAlfVisual::SetTactileFeedbackL(TInt,TInt)
	CAlfVisual::SetTagL(const TDesC8 &)
	CAlfVisual::Size()const
	CAlfVisual::Tag()const
	CAlfVisual::TagMatches(const TDesC8 &)const
	CAlfVisual::Transformation()
	CAlfVisual::VerticalOrigin()const
	CAlfVisual::VerticalPadding()const
	CAlfVisual::~CAlfVisual()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Inherited Enumerations
	CAlfLayout:TExpansionFlags

Private Attributes
TLCTAnchorLayoutPrivateData *	iLCTAnchorLayoutData

Constructor & Destructor Documentation

CAlfLCTAnchorLayout()

IMPORT_C

CAlfLCTAnchorLayout

(

)

Constructor.

~CAlfLCTAnchorLayout()

IMPORT_C

~CAlfLCTAnchorLayout

(

)

Destructor.

Member Functions Documentation

AddNewL(CAlfControl &, CAlfLayout *)

IMPORT_C CAlfLCTAnchorLayout *	AddNewL	(	CAlfControl &	aOwnerControl,
			CAlfLayout *	aParentLayout = 0
		)	[static]

Two-phased constructor, which attach new object into the control.

Parameters

CAlfControl & aOwnerControl	Control that owns this new obejct.
CAlfLayout * aParentLayout = 0	If given, the new object is set as child.

BaseUnit()

IMPORT_C TAlfXYMetric

BaseUnit

(

)

const [virtual]

From CAlfLayout CAlfLayout

ConstructL(CAlfControl &)

IMPORT_C void

ConstructL

(

CAlfControl &

aOwner

)

[virtual]

Second-phase constructor.

Parameters

CAlfControl & aOwner

DoRemoveAndDestroyAllD()

IMPORT_C void

DoRemoveAndDestroyAllD

(

)

[protected, virtual]

From CAlfVisual CAlfVisual

FindTag(const TDesC8 &)

IMPORT_C CAlfVisual *

FindTag

(

const TDesC8 &

aTag

)

[virtual]

CAlfVisual Finds a visual whose tag descriptor contains a specific tag.

CAlfLayout::FindTag() extends the search into child visuals, covering recursively entire visual hierarchies.

Todo: how should several visuals with matching tag to be handled ??

CAlfVisual::Tag() CAlfVisual::SetTagL() CAlfVisual::IsTagged() CAlfVisual::FindTag()

Parameters

const TDesC8 & aTag

Tag to look for. If this tag is found as a part of a visual's colon-separated tag descriptor, it is treated as a match and the visual is returned. The tag to look for cannot contain separator characters (:).

PropertyOwnerExtension(const TUid &, TAny **)

IMPORT_C void	PropertyOwnerExtension	(	const TUid &	aExtensionUid,
			TAny **	aExtensionParams
		)	[protected, virtual]

! future proofing

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

RemoveAndDestroyAllD()

IMPORT_C void

RemoveAndDestroyAllD

(

)

[virtual]

From CAlfVisual CAlfVisual

SetAnchors(TInt, TAknLayoutHierarchyComponentHandle &, const TAlfTimedPoint &)

IMPORT_C void	SetAnchors	(	TInt	aOrdinal,
			TAknLayoutHierarchyComponentHandle &	aComponentHandle,
			const TAlfTimedPoint &	aOffset
		)

Defines both anchors for a child.. An anchor is a point within the layout control that a child control's corner may be attached to. The use of anchors allows for the neat layout of visuals within the layout control.

Parameters

TInt aOrdinal	Ordinal of the child that this anchor applies to.
TAknLayoutHierarchyComponentHandle & aComponentHandle	reference to the layout data that corresponds to the visual that is anchored at this ordinal position. @ param aOffset timed point, note that the position of the timed point will be ignored.
const TAlfTimedPoint & aOffset

UpdateChildrenLayout(TInt)

IMPORT_C void

UpdateChildrenLayout

(

TInt

aTransitionTime = 0

)

[virtual]

CAlfVisual Update the layout of all children. Subclasses can call this to recalculate the layout of all children.

Parameters

TInt aTransitionTime = 0

Time for layout transition in milliseconds. Any negative value uses value given in CAlfEnv::StaticSetLayoutTransitionTime()

Member Data Documentation

TLCTAnchorLayoutPrivateData * iLCTAnchorLayoutData

TLCTAnchorLayoutPrivateData *

iLCTAnchorLayoutData

[private]