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_C CAlfBrush ( ) [protected]

Constructor

~CAlfBrush()

IMPORT_C ~CAlfBrush ( ) [virtual]

Destructor.

Member Functions Documentation

AppendContainingArray(CAlfBrushArray &)

TInt AppendContainingArray ( CAlfBrushArray & aContainingArray )

Parameters

CAlfBrushArray & aContainingArray

ClipToVisual()

IMPORT_C TBool ClipToVisual ( ) 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 void ConstructL ( CAlfEnv & aEnv,
TInt aImplementationId,
TInt aImplementationUid,
const TDesC8 & aConstructionParams
) [protected]

Second phase constructor

Parameters

CAlfEnv & aEnv
TInt aImplementationId
TInt aImplementationUid
const TDesC8 & aConstructionParams

ConstructL()

IMPORT_C void ConstructL ( ) [protected]

Identifier()

IMPORT_C TInt Identifier ( ) const

Return the server side handle

Opacity()

IMPORT_C const TAlfTimedValue & Opacity ( ) const

Get opacity

PropertyOwnerExtension(const TUid &, TAny **)

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

! future proofing

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

RemoveContainingArray(CAlfBrushArray &)

void RemoveContainingArray ( CAlfBrushArray & aContainingArray )

Parameters

CAlfBrushArray & aContainingArray

SetClipToVisual(TBool)

IMPORT_C void SetClipToVisual ( TBool aClipToVisual )

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

Parameters

TBool aClipToVisual If ETrue, drawing is clipped to visuals area.

SetLayer(TAlfBrushLayer)

IMPORT_C void SetLayer ( TAlfBrushLayer aLayer )

Set the layer

Parameters

TAlfBrushLayer aLayer Layer (foreground/backgroud).

SetOpacity(const TAlfTimedValue &)

IMPORT_C void SetOpacity ( const TAlfTimedValue & aOpacity )

Set opacity

Parameters

const TAlfTimedValue & aOpacity New opacity value.

Member Data Documentation

TPrivateData * iData

TPrivateData * iData [private]