Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: tranp.h
Link against: irtranp.lib

Class TTranpPicture

class TTranpPicture;

Description

Represents a picture in Unified Picture Format (UPF), a standard for image data transmitted via infrared communication.

An object of this type is used when transmitting pictures using the IrTranP protocol.

A received picture can be saved as a JPEG type for viewing or it can be saved in native UPF format.

Members

Defined in TTranpPicture:
Filename(), GetLatticeSize(), GetThumbNail(), LoadFromJpeg(), LoadFromUPF(), LongFilename(), Picture(), SaveAsJpeg(), SaveAsUPF(), SetDesiredLatticeSize(), SetFilename(), SetLongFilename(), SetTime(), TTranpPicture(), Time(), ~TTranpPicture()


Construction and destruction


TTranpPicture()

IMPORT_C TTranpPicture();

Description

Constructor


~TTranpPicture()

IMPORT_C ~TTranpPicture();

Description

Destructor

[Top]


Member functions


SetFilename()

IMPORT_C void SetFilename(const TDesC8 &aName);

Description

Sets the file name of the picture in DOS 8.3 format.

Parameters

const TDesC8 &aName

The filename in 8.3 format.


SetLongFilename()

IMPORT_C void SetLongFilename(const TDesC8 &aName);

Description

Sets the file name of the picture in SJIS or as an ISO8859-1 character string.

Parameters

const TDesC8 &aName

The filename in long format.


SetTime()

IMPORT_C void SetTime(const TDesC8 &aTime);

Description

Sets the time stamp attribute iTime to aTime for the picture.

Parameters

const TDesC8 &aTime

The time stamp in YYYYMMDDHHMMSS character format.


Filename()

IMPORT_C const TDesC8 &Filename();

Description

Gets the DOS 8.3 format file name of the picture.

Return value

const TDesC8 &

The filename in 8.3 format.


LongFilename()

IMPORT_C const TDesC8 &LongFilename();

Description

Returns the file name of the picture in SJIS or as an ISO8859-1 character string.

Return value

const TDesC8 &

The filename in long format.


Time()

IMPORT_C const TDesC8 &Time();

Description

Returns the time stamp attribute for the picture

Return value

const TDesC8 &

iTime The time stamp in YYYYMMDDHHMMSS character format.


Picture()

IMPORT_C const TDesC8 *Picture();

Description

Gets a pointer to a non-modifiable descriptor containing the image data. The image is in JPEG format.

Return value

const TDesC8 *

A pointer to the image data.


SetDesiredLatticeSize()

IMPORT_C void SetDesiredLatticeSize(TLatticeSize aSize, TInt iWidth=0, TInt iHeight=0);

Description

Parameters

TLatticeSize aSize

TInt iWidth

TInt iHeight


GetLatticeSize()

IMPORT_C void GetLatticeSize(TLatticeSize &aSize, TInt &iWidth, TInt &iHeight);

Description

Parameters

TLatticeSize &aSize

TInt &iWidth

TInt &iHeight


GetThumbNail()

IMPORT_C const TDesC8 *GetThumbNail();

Description

Returns a pointer to a descriptor containing a thumbnail representation of the image. The thumbnail is in JPEG format.

Return value

const TDesC8 *

A pointer to the thumbnail data.


SaveAsJpeg()

IMPORT_C TInt SaveAsJpeg(const TFileName &aFileName);

Description

Saves the image data in JPEG format to the specified file on the host device.

Parameters

const TFileName &aFileName

The name of the file to contain the JPEG format image data.

Return value

TInt

KErrNone if successful, otherwise one of the other system wide error codes.


LoadFromJpeg()

IMPORT_C TInt LoadFromJpeg(const TFileName &aFileName);

Description

Loads JPEG format image data from the specified file on the host device.

Parameters

const TFileName &aFileName

The name of the file containing the JPEG format image data.

Return value

TInt

KErrNone if successful, otherwise one of the other system wide error codes.


SaveAsUPF()

IMPORT_C TInt SaveAsUPF(const TFileName &aFileName);

Description

Saves the image data in native UPF format to the specified file on the host device.

Parameters

const TFileName &aFileName

The name of the file to contain the native UPF format image data.

Return value

TInt

KErrNone if successful, otherwise one of the other system wide error codes.


LoadFromUPF()

IMPORT_C TInt LoadFromUPF(const TFileName &aFileName);

Description

Loads native UPF format image data from the specified file on the host device.

Parameters

const TFileName &aFileName

The name of the file containing the native UPF format image data.

Return value

TInt

KErrNone if successful, otherwise one of the other system wide error codes.