CAlfBrush Class Reference

class CAlfBrush : public CAlfPropertyOwner

A brush implements a series of graphics drawing operations. Brushes are attached to visuals and drawn whenever the visual is drawn. Brushes can be used for augmenting the normal appearance of visuals with graphical features such as background pictures, gradients, overlay icons, and selection highlights. This is base class for all brushes and it cannot be instantiated.

Usage:
 //Sets the brush layer
   myBrush->setLayer( EAlfBrushLayerForeground );
alfclient.lib
Since
S60 v3.2

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CAlfBrush()

IMPORT_CCAlfBrush()[protected]

Constructor

~CAlfBrush()

IMPORT_C~CAlfBrush()[virtual]

Destructor.

Member Functions Documentation

AppendContainingArray(CAlfBrushArray &)

TInt AppendContainingArray(CAlfBrushArray &aContainingArray)

Parameters

CAlfBrushArray & aContainingArray

ClipToVisual()

IMPORT_C TBoolClipToVisual()const

Gets whether the brush can draw outside brush guide (i.e. visual's) rect

Comms()

IMPORT_C CAlfGenComponent *Comms()const

Return communications

ConstructL(CAlfEnv &, TInt, TInt, const TDesC8 &)

IMPORT_C voidConstructL(CAlfEnv &aEnv,
TIntaImplementationId,
TIntaImplementationUid,
const TDesC8 &aConstructionParams
)[protected]

Second phase constructor

Parameters

CAlfEnv & aEnv
TInt aImplementationId
TInt aImplementationUid
const TDesC8 & aConstructionParams

ConstructL()

IMPORT_C voidConstructL()[protected]

Identifier()

IMPORT_C TIntIdentifier()const

Return the server side handle

Opacity()

IMPORT_C const TAlfTimedValue &Opacity()const

Get opacity

PropertyOwnerExtension(const TUid &, TAny **)

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

! future proofing

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

RemoveContainingArray(CAlfBrushArray &)

voidRemoveContainingArray(CAlfBrushArray &aContainingArray)

Parameters

CAlfBrushArray & aContainingArray

SetClipToVisual(TBool)

IMPORT_C voidSetClipToVisual(TBoolaClipToVisual)

Sets whether the brush can draw outside brush guide (i.e. visual's) rect

Parameters

TBool aClipToVisualIf ETrue, drawing is clipped to visuals area.

SetLayer(TAlfBrushLayer)

IMPORT_C voidSetLayer(TAlfBrushLayeraLayer)

Set the layer

Parameters

TAlfBrushLayer aLayerLayer (foreground/backgroud).

SetOpacity(const TAlfTimedValue &)

IMPORT_C voidSetOpacity(const TAlfTimedValue &aOpacity)

Set opacity

Parameters

const TAlfTimedValue & aOpacityNew opacity value.

Member Data Documentation

TPrivateData * iData

TPrivateData *iData[private]