TWsGraphicId Class Reference

#include <w32std.h>

class TWsGraphicId
Public Member Enumerations
enumTUninitialized { EUninitialized }
Public Member Functions
TWsGraphicId(TUninitialized)
TWsGraphicId(TUid)
TWsGraphicId(TInt)
TWsGraphicId(const TWsGraphicId &)
IMPORT_C TIntCompare(const TWsGraphicId &)
IMPORT_C TIntId()
IMPORT_C TBoolIsId()
IMPORT_C TBoolIsUid()
IMPORT_C voidSet(TUid)
IMPORT_C voidSet(TInt)
IMPORT_C TUidUid()

Detailed 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.

Member Enumeration Documentation

Enum TUninitialized

EnumeratorValueDescription
EUninitialized

Constructor & Destructor Documentation

TWsGraphicId ( TUninitialized )

TWsGraphicId(TUninitialized)[inline]

TWsGraphicId ( TUid )

IMPORT_CTWsGraphicId(TUidaUid)

Construct a UID

Parameters
aUidUID of the graphic artwork.

TWsGraphicId ( TInt )

IMPORT_CTWsGraphicId(TIntaId)

Construct a transient Id

TWsGraphicId ( const TWsGraphicId & )

IMPORT_CTWsGraphicId(const TWsGraphicId &aCopy)

Copy constructor.

Parameters
aCopyGraphic artwork Id.

Member Function Documentation

Compare ( const TWsGraphicId & )

IMPORT_C TIntCompare(const TWsGraphicId &aOther)const

Compares another Id with this one.

Return Value
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

Id ( )

IMPORT_C TIntId()const

Returns the transient Id.

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

IsId ( )

IMPORT_C TBoolIsId()const

Identifies whether graphic artwork is transient.

Return Value
ETrue if graphic artwork is transient.

IsUid ( )

IMPORT_C TBoolIsUid()const

Identifies whether graphic artwork is non-transient.

Return Value
ETrue if graphic artwork is non-transient.

Set ( TUid )

IMPORT_C voidSet(TUidaUid)

Set to be a UID

Set ( TInt )

IMPORT_C voidSet(TIntaId)

Set to be a transient Id

Uid ( )

IMPORT_C TUidUid()const

Returns UID.

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