RWsGraphicMsgBuf Class Reference

Utility class for building data buffers to be attached to CWindowGc::DrawWsGraphic commands Useful when there is more than one piece of data to be attached to the draw command. More...

#include <w32std.h>

Inheritance diagram for RWsGraphicMsgBuf:

Public Member Functions
IMPORT_C	RWsGraphicMsgBuf ()
	Default Constructor.
IMPORT_C TInt	Append (TUid aTypeId, const TDesC8 &aData)
	Append a descriptor as data.
IMPORT_C TInt	Append (TUid aTypeId, const TDesC16 &aData)
	Append a descriptor as data.
IMPORT_C TInt	Append (TUid aTypeId, TInt aLen, TPtr8 &aPtr)
	Append a message of the specified length and type, and return a pointer to allow client code to modify the message.
IMPORT_C TInt	Append (const TWsGraphicMsgFixedBase &aMsg)
	Append a fixed-size message.
IMPORT_C void	Remove (TInt aIndex)
IMPORT_C TInt	Count () const
	Returns the number of messages in the buffer.
IMPORT_C TUid	TypeId (TInt aIndex) const
IMPORT_C TPtrC8	Data (TInt aIndex) const
IMPORT_C TPtr8	Data (TInt aIndex)
IMPORT_C void	GetFixedMsg (TWsGraphicMsgFixedBase &aMsg, TInt aIndex) const
IMPORT_C const TDesC8 &	Pckg () const

Detailed Description

Utility class for building data buffers to be attached to CWindowGc::DrawWsGraphic commands Useful when there is more than one piece of data to be attached to the draw command.

API status

Published to all clients. Released API.

Definition at line 2072 of file w32std.h.

Constructor & Destructor Documentation

RWsGraphicMsgBuf()

IMPORT_C RWsGraphicMsgBuf::RWsGraphicMsgBuf

(

)

Default Constructor.

(generated from Symbian Developer Library)

Member Function Documentation

Append() [1/4]

IMPORT_C TInt RWsGraphicMsgBuf::Append

(

const TWsGraphicMsgFixedBase &

aMsg

)

Append a fixed-size message.

Parameters

aMsg	the fixed-size message to append

(generated from Symbian Developer Library)

Append() [2/4]

IMPORT_C TInt RWsGraphicMsgBuf::Append	(	TUid	aTypeId,
		const TDesC16 &	aData
	)

Append a descriptor as data.

Parameters

aTypeId	the type of the message to append
aData	arbitrary length data consisting of the whole message

(generated from Symbian Developer Library)

Append() [3/4]

IMPORT_C TInt RWsGraphicMsgBuf::Append	(	TUid	aTypeId,
		const TDesC8 &	aData
	)

Append a descriptor as data.

Parameters

aTypeId	the type of the message to append
aData	arbitrary length data consisting of the whole message

(generated from Symbian Developer Library)

Append() [4/4]

IMPORT_C TInt RWsGraphicMsgBuf::Append	(	TUid	aTypeId,
		TInt	aLen,
		TPtr8 &	aPtr
	)

Append a message of the specified length and type, and return a pointer to allow client code to modify the message.

aPtr is only set if the append succeeds. aPtr is only valid until the next message is appended to the buffer.

Parameters

aTypeId	the type of the message to append
aLen	the length of the message to be reserved
aPtr	a modifiable descriptor to be used by the client code to write into the message body

(generated from Symbian Developer Library)

Count()

IMPORT_C TInt RWsGraphicMsgBuf::Count

(

)

const

Returns the number of messages in the buffer.

(generated from Symbian Developer Library)

Data() [1/2]

IMPORT_C TPtr8 RWsGraphicMsgBuf::Data

(

TInt

aIndex

)

Parameters

aIndex

the ordinal position of the message

Panic condition: if the index is out of bounds

(generated from Symbian Developer Library)

Data() [2/2]

IMPORT_C TPtrC8 RWsGraphicMsgBuf::Data

(

TInt

aIndex

)

const

Parameters

aIndex

the ordinal position of the message

Panic condition: if the index is out of bounds

(generated from Symbian Developer Library)

GetFixedMsg()

IMPORT_C void RWsGraphicMsgBuf::GetFixedMsg	(	TWsGraphicMsgFixedBase &	aMsg,
		TInt	aIndex
	)		const

Parameters

aIndex

the ordinal position of the message

Panic condition: if the index is out of bounds

Panic condition: the message specified is not of the correct type

(generated from Symbian Developer Library)

Pckg()

IMPORT_C const TDesC8 & RWsGraphicMsgBuf::Pckg

(

)

const

RWsGraphicMsgBuf msgBuf;
msgBuf.Append(...);
... TWsGraphicId id(...);
SystemGc().DrawWsGraphic(id, Rect(), msgBuf.Pckg());
msgBuf.Close();

(generated from Symbian Developer Library)

Remove()

IMPORT_C void RWsGraphicMsgBuf::Remove

(

TInt

aIndex

)

Parameters

aIndex

the ordinal position of message to be removed

Panic condition: if the index is out of bounds

(generated from Symbian Developer Library)

TypeId()

IMPORT_C TUid RWsGraphicMsgBuf::TypeId

(

TInt

aIndex

)

const

Parameters

aIndex

the ordinal position of the message

Panic condition: if the index is out of bounds

(generated from Symbian Developer Library)

---

The documentation for this class was generated from the following files:

• w32std.h
• w32std.h.dox