| class CImageTransform : public CBase |
The public API for clients to call the Image Transform (scaling) library. This class provides functions to scale images held in files or descriptors.
| Public Member Functions | |
|---|---|
| ~CImageTransform() | |
| IMPORT_C void | CancelTransform() |
| IMPORT_C void | ClearSourceRect() |
| IMPORT_C CImageTransformPluginExtension * | Extension() |
| IMPORT_C CImageTransformPluginExtension * | Extension(TUid, TInt &) |
| IMPORT_C CImageTransform * | NewL(RFs &) |
| IMPORT_C void | Reset() |
| IMPORT_C void | SetDestDataL(HBufC8 *&) |
| IMPORT_C void | SetDestFilenameL(const TDesC &) |
| IMPORT_C void | SetDestSizeInPixelsL(const TSize &, TBool) |
| IMPORT_C void | SetOptionsL(TUint) |
| IMPORT_C void | SetPluginUidL(TUid) |
| IMPORT_C void | SetPreserveImageData(TBool) |
| IMPORT_C void | SetSourceDataL(const TDesC8 &) |
| IMPORT_C void | SetSourceFilenameL(const TDesC &) |
| IMPORT_C void | SetSourceImageTypeL(TUid, TUid) |
| IMPORT_C void | SetSourceMimeTypeL(const TDesC8 &) |
| IMPORT_C void | SetSourceRect(const TRect &) |
| IMPORT_C void | SetTransformationsL(TUint) |
| IMPORT_C void | SetupL() |
| IMPORT_C void | Transform(TRequestStatus &) |
| Private Member Functions | |
|---|---|
| CImageTransform() | |
| void | ConstructL(RFs &) |
| Public Member Enumerations | |
|---|---|
| enum | TOptions { EOptionNone = 0x00, EThumbnail = 0x01, EIgnoreExifMetadataProcessing = 0x02, EEnumBoundary = 0x04 } |
| enum | TTransformations { ETransformationNone = 0x00, EScale = 0x01, ECrop = 0x02, ESqueeze = 0x04, EOrientation = 0x08, EOverlay = 0x10, EExif = 0x20, ETransformEnumBoundary = 0x40 } |
| Private Attributes | |
|---|---|
| CImageTransformFramework * | iBody |
| IMPORT_C CImageTransformPluginExtension * | Extension | ( | TUid | aExtensionUid, |
| TInt & | aError | |||
| ) | const | |||
| IMPORT_C void | SetDestFilenameL | ( | const TDesC & | aFilename | ) |
| const TDesC & aFilename |
| IMPORT_C void | SetDestSizeInPixelsL | ( | const TSize & | aDestinationSize, |
| TBool | aMaintainAspectRatio = ETrue | |||
| ) | ||||
| IMPORT_C void | SetPreserveImageData | ( | TBool | aPreserveImageData | ) |
| TBool aPreserveImageData |
| IMPORT_C void | SetSourceDataL | ( | const TDesC8 & | aData | ) |
| const TDesC8 & aData |
| IMPORT_C void | SetSourceFilenameL | ( | const TDesC & | aFilename | ) |
| const TDesC & aFilename |
| IMPORT_C void | SetSourceImageTypeL | ( | TUid | aImageType, |
| TUid | aImageSubType = KNullUid | |||
| ) | ||||
| IMPORT_C void | SetSourceMimeTypeL | ( | const TDesC8 & | aMIMEType | ) |
| const TDesC8 & aMIMEType |
| IMPORT_C void | SetSourceRect | ( | const TRect & | aRect | ) |
| const TRect & aRect |
| IMPORT_C void | SetTransformationsL | ( | TUint | aTransformations | ) |
| TUint aTransformations |
| IMPORT_C void | Transform | ( | TRequestStatus & | aStatus | ) |
| TRequestStatus & aStatus |
Flags to control how the image is transformed. The EThumbnail and EIgnoreExifMetadataProcessing are mutually exclusive, and SHOULD NOT be used together. If they are, then EThumbnail is used.
| EOptionNone = 0x00 |
No flag set. This is the default option |
| EThumbnail = 0x01 |
If set, the destination image will always have a thumbnail. If the source already has a thumbnail, then this is the one that will appear in the destination, otherwise one will be generated. |
| EIgnoreExifMetadataProcessing = 0x02 |
If set, then the Exif data is not parsed and ExifMetaData() will always return NULL. If the source image is EXIF, then the EXIF information is copied without modification (i.e. without parsing) to the destination. In cases where the source is JFIF, the destination image is also JFIF. |
| EEnumBoundary = 0x04 |
TOptions should not be set greater than or equal to this value. |
Flags to specify the desired transformations. If no flag or "EScale" flag is set then the framework will look for the plugins supporting scaling which includes all the plugins supporting version-1 opaque data and the plugins supporting version-2 opaque data with the scaling flag set. A plug-in supporting Squeeze, Orientation and Overlay in a single transform must perform these transformation in the order: Overlaying, Orientation and then Squeezing
| ETransformationNone = 0x00 |
No transformation set |
| EScale = 0x01 |
If set, the image is scaled based on the parameter passed in SetDestSizeInPixelsL(). |
| ECrop = 0x02 |
If set, the image is clipped based on the parameter passed in SetSourceRect(). |
| ESqueeze = 0x04 |
If set, the image is squeezed |
| EOrientation = 0x08 |
If set, the image is oriented |
| EOverlay = 0x10 |
If set, the image is blend with the overlay image |
| EExif = 0x20 |
If set, the plugin having exif extension is looked for |
| ETransformEnumBoundary = 0x40 |
TTransformations should not be set greater than or equal to this value |