TTranpPicture Class Reference

#include <tranp.h>

Link against: irtranp.lib

class TTranpPicture

Public Member Functions
	TTranpPicture()
	~TTranpPicture()
IMPORT_C const TDesC8 &	Filename()
IMPORT_C void	GetLatticeSize(TLatticeSize &, TInt &, TInt &)
IMPORT_C const TDesC8 *	GetThumbNail()
IMPORT_C TInt	LoadFromJpeg(const TFileName &)
IMPORT_C TInt	LoadFromUPF(const TFileName &)
IMPORT_C const TDesC8 &	LongFilename()
IMPORT_C const TDesC8 *	Picture()
IMPORT_C TInt	SaveAsJpeg(const TFileName &)
IMPORT_C TInt	SaveAsUPF(const TFileName &)
IMPORT_C void	SetDesiredLatticeSize(TLatticeSize, TInt, TInt)
IMPORT_C void	SetFilename(const TDesC8 &)
IMPORT_C void	SetLongFilename(const TDesC8 &)
IMPORT_C void	SetTime(const TDesC8 &)
IMPORT_C const TDesC8 &	Time()

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

Constructor & Destructor Documentation

TTranpPicture ( )

IMPORT_C

TTranpPicture

(

)

Constructor

~TTranpPicture ( )

IMPORT_C

~TTranpPicture

(

)

Destructor

Member Function Documentation

Filename ( )

IMPORT_C const TDesC8 &

Filename

(

)

Gets the DOS 8.3 format file name of the picture.

Return Value: The filename in 8.3 format.

GetLatticeSize ( TLatticeSize &, TInt &, TInt & )

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

GetThumbNail ( )

IMPORT_C const TDesC8 *

GetThumbNail

(

)

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

Return Value: A pointer to the thumbnail data.

LoadFromJpeg ( const TFileName & )

IMPORT_C TInt

LoadFromJpeg

(

const TFileName &

aFileName

)

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

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

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

LoadFromUPF ( const TFileName & )

IMPORT_C TInt

LoadFromUPF

(

const TFileName &

aFileName

)

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

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

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

LongFilename ( )

IMPORT_C const TDesC8 &

LongFilename

(

)

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

Return Value: The filename in long format.

Picture ( )

IMPORT_C const TDesC8 *

Picture

(

)

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

Return Value: A pointer to the image data.

SaveAsJpeg ( const TFileName & )

IMPORT_C TInt

SaveAsJpeg

(

const TFileName &

aFileName

)

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

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

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

SaveAsUPF ( const TFileName & )

IMPORT_C TInt

SaveAsUPF

(

const TFileName &

aFileName

)

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

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

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

SetDesiredLatticeSize ( TLatticeSize, TInt, TInt )

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

SetFilename ( const TDesC8 & )

IMPORT_C void

SetFilename

(

const TDesC8 &

aName

)

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

Parameters
aName	The filename in 8.3 format.

SetLongFilename ( const TDesC8 & )

IMPORT_C void

SetLongFilename

(

const TDesC8 &

aName

)

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

Parameters
aName	The filename in long format.

SetTime ( const TDesC8 & )

IMPORT_C void

SetTime

(

const TDesC8 &

aTime

)

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

Parameters
aTime	The time stamp in YYYYMMDDHHMMSS character format.

Time ( )

IMPORT_C const TDesC8 &

Time

(

)

Returns the time stamp attribute for the picture

Return Value: iTime The time stamp in YYYYMMDDHHMMSS character format.