TPictureHeader Class Reference

Picture header providing an interface to a stored picture. More...

#include <gdi.h>

Public Member Functions
IMPORT_C	TPictureHeader ()
	Constructs a default picture header.
IMPORT_C void	InternalizeL (RReadStream &aStream)
	Internalises a picture header object from a read stream.
IMPORT_C void	ExternalizeL (RWriteStream &aStream) const
	Externalises a picture header object to a write stream.
IMPORT_C void	DeletePicture ()
	Deletes the internalised picture.

Public Attributes
TSwizzle< CPicture >	iPicture
	A swizzle storing either the ID of the stream in which the picture is stored, or a pointer to the internalised picture.
TUid	iPictureType
	A UID specifying the type of the picture.
TSize	iSize
	The original size of the picture.

Detailed Description

Picture header providing an interface to a stored picture.

The header holds:

the picture's type, encoded as a UID, which ensures that it will be restored to the correct picture type

the picture's size, which facilitates deferred loading

the stream ID of the picture body, which is replaced by a pointer to the picture object when it has been restored.

API status

Published to all clients. Released API.

Definition at line 3669 of file gdi.h.

Constructor & Destructor Documentation

TPictureHeader()

IMPORT_C TPictureHeader::TPictureHeader

(

)

Constructs a default picture header.

(generated from Symbian Developer Library)

Member Function Documentation

DeletePicture()

IMPORT_C void TPictureHeader::DeletePicture

(

)

Deletes the internalised picture.

The picture can only be deleted if the picture has been internalized.

(generated from Symbian Developer Library)

ExternalizeL()

IMPORT_C void TPictureHeader::ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises a picture header object to a write stream.

The presence of this function means that the standard templated stream operator<<() is available to externalise objects of this class.

Parameters

aStream

The write stream.

(generated from Symbian Developer Library)

InternalizeL()

IMPORT_C void TPictureHeader::InternalizeL

(

RReadStream &

aStream

)

Internalises a picture header object from a read stream.

The presence of this function means that the standard templated stream operator>>() is available to internalise objects of this class.

Parameters

aStream

The read stream.

(generated from Symbian Developer Library)

Member Data Documentation

iPicture

TSwizzle<CPicture> TPictureHeader::iPicture

A swizzle storing either the ID of the stream in which the picture is stored, or a pointer to the internalised picture.

Definition at line 3679 of file gdi.h.

iPictureType

TUid TPictureHeader::iPictureType

A UID specifying the type of the picture.

Definition at line 3681 of file gdi.h.

iSize

TSize TPictureHeader::iSize

The original size of the picture.

Definition at line 3683 of file gdi.h.

---

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

• gdi.h
• gdi.h.dox