Collapse all Symbian^3 Product Developer Library

CAlfLCTTextVisual Class Reference

class CAlfLCTTextVisual : public CAlfTextVisual

Text visual for text drawing. Supports setting style from LCT layout data.

alfclient.lib

Since: S60 v3.2

Inherits from

CAlfLCTTextVisual
- CAlfTextVisual
  - CAlfVisual
    - CAlfPropertyOwner
      - CBase

Nested Classes and Structures

CAlfLCTTextVisual::TLCTTextVisualPrivateData

Public Member Functions
	CAlfLCTTextVisual()
	~CAlfLCTTextVisual()
IMPORT_C CAlfLCTTextVisual *	AddNewL(CAlfControl &, CAlfLayout *)
IMPORT_C void	ConstructL(CAlfControl &)
IMPORT_C CAlfVisual *	FindTag(const TDesC8 &)
IMPORT_C void	RemoveAndDestroyAllD()
IMPORT_C void	SetTextPane(TAknLayoutHierarchyComponentHandle &)
IMPORT_C void	UpdateChildrenLayout(TInt)

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

Inherited Functions
	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()
	CAlfTextVisual::BackgroundType()
	CAlfTextVisual::CAlfTextVisual()
	CAlfTextVisual::EnableShadow(TBool)
	CAlfTextVisual::MaxLineCount()const
	CAlfTextVisual::Offset()const
	CAlfTextVisual::PrepareForUpdateMesh()
	CAlfTextVisual::ReleaseMesh()
	CAlfTextVisual::SetAlign(TAlfAlignHorizontal,TAlfAlignVertical)
	CAlfTextVisual::SetColor(TRgb)
	CAlfTextVisual::SetColor(const TAknsItemID &,const TInt)
	CAlfTextVisual::SetColor(const TDesC &,const TDesC &)
	CAlfTextVisual::SetHighlightRange(TInt,TInt,TRgb &,TRgb &)
	CAlfTextVisual::SetLineSpacing(TInt,TLineSpacingUnits)
	CAlfTextVisual::SetMaxLineCount(TInt)
	CAlfTextVisual::SetOffset(const TAlfTimedPoint &)
	CAlfTextVisual::SetShadowOpacity(const TAlfTimedValue &)
	CAlfTextVisual::SetStyle(TAlfPreconfiguredTextStyle,TAlfBackgroundType)
	CAlfTextVisual::SetTextL(const TDesC &)
	CAlfTextVisual::SetTextStyle(TInt)
	CAlfTextVisual::SetWrapping(TLineWrap)
	CAlfTextVisual::ShadowOpacity()
	CAlfTextVisual::Style()
	CAlfTextVisual::SubstringExtents(TUint,TUint)const
	CAlfTextVisual::Text()const
	CAlfTextVisual::TextExtents()const
	CAlfTextVisual::TextStyle()const
	CAlfTextVisual::UpdateMesh(TBool)
	CAlfTextVisual::Wrapping()const
	CAlfTextVisual::~CAlfTextVisual()
	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
	CAlfTextVisual:TLineSpacingUnits
	CAlfTextVisual:TLineWrap

Private Attributes
TLCTTextVisualPrivateData *	iLCTTextVisualData

Constructor & Destructor Documentation

CAlfLCTTextVisual()

IMPORT_C

CAlfLCTTextVisual

(

)

Constructor.

~CAlfLCTTextVisual()

IMPORT_C

~CAlfLCTTextVisual

(

)

Destructor.

Member Functions Documentation

AddNewL(CAlfControl &, CAlfLayout *)

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

Constructor, which gives ownership to the control.

Parameters

CAlfControl & aOwnerControl	The control
CAlfLayout * aParentLayout = 0	If given, the parent layout.

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]

Finds a visual whose tag descriptor contains a specific tag.

CAlfVisual::FindTag() is the basic implementation that checks if this visual's tag matches the specified 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() CAlfLayout::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

SetTextPane(TAknLayoutHierarchyComponentHandle &)

IMPORT_C void

SetTextPane

(

TAknLayoutHierarchyComponentHandle &

aComponentHandle

)

Sets the text pane layout of the text visual. Note that the actual text pane position should be called by setting an anchor on the containing layout.

Parameters

TAknLayoutHierarchyComponentHandle & aComponentHandle

reference to the layout data that corresponds to the text visual.

UpdateChildrenLayout(TInt)

IMPORT_C void

UpdateChildrenLayout

(

TInt

aTransitionTime = 0

)

[virtual]

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

TLCTTextVisualPrivateData * iLCTTextVisualData

TLCTTextVisualPrivateData *

iLCTTextVisualData

[private]