Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: W32STD.H
Link against: ws32.lib

Class TWsGraphicId

class TWsGraphicId;

Description

Identifies an abstract artwork

This is a piece of artwork that might be owned and authored by another process. A client can draw a piece of artwork, but that doesn't confer the ability to access the pixel representation of that artwork directly.

Members

Defined in TWsGraphicId:
Compare(), EUninitialized, Id(), IsId(), IsUid(), Set(), Set(), TUninitialized, TWsGraphicId(), TWsGraphicId(), TWsGraphicId(), TWsGraphicId(), Uid()


Construction and destruction


TWsGraphicId()

inline TWsGraphicId(TUninitialized);

Description

Parameters

TUninitialized


TWsGraphicId()

IMPORT_C TWsGraphicId(TUid aUid);

Description

Construct a UID

Parameters

TUid aUid

UID of the graphic artwork.


TWsGraphicId()

IMPORT_C TWsGraphicId(TInt aId);

Description

Construct a transient Id

Parameters

TInt aId


TWsGraphicId()

IMPORT_C TWsGraphicId(const TWsGraphicId &aCopy);

Description

Copy constructor.

Parameters

const TWsGraphicId &aCopy

Graphic artwork Id.

[Top]


Member functions


Uid()

IMPORT_C TUid Uid() const;

Description

Returns UID.

Return value

TUid

UID of graphic artwork. KNullUid if graphic artwork is transient.


IsUid()

IMPORT_C TBool IsUid() const;

Description

Identifies whether graphic artwork is non-transient.

Return value

TBool

ETrue if graphic artwork is non-transient.


Set()

IMPORT_C void Set(TUid aUid);

Description

Set to be a UID

Parameters

TUid aUid


Id()

IMPORT_C TInt Id() const;

Description

Returns the transient Id.

Return value

TInt

Id of transient graphic artwork. Zero if graphic artwork is non-transient.


IsId()

IMPORT_C TBool IsId() const;

Description

Identifies whether graphic artwork is transient.

Return value

TBool

ETrue if graphic artwork is transient.


Set()

IMPORT_C void Set(TInt aId);

Description

Set to be a transient Id

Parameters

TInt aId


Compare()

IMPORT_C TInt Compare(const TWsGraphicId &aOther) const;

Description

Compares another Id with this one.

Parameters

const TWsGraphicId &aOther

Return value

TInt

0 if the other Id is identical, else -1 if the other Id is to greater than or 1 if the other Id is less than

[Top]


Member enumerations


Enum TUninitialized

TUninitialized

Description

EUninitialized