Class CBitmapRotator

class CBitmapRotator : public CBase;

Description

The public API for clients to call the BitmapTransforms Library bitmap rotation.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CBitmapRotator - The public API for clients to call the BitmapTransforms Library bitmap rotation.

Members

Defined in CBitmapRotator:

• Cancel()Cancels any outstanding action.
• CustomCommand(TUid,TAny *)Provides custom command capabilties on CBitmapRotator. The command is dispatched...
• EMirrorHorizontalAxisUsed to mirror a bitmap about the horizontal axis.
• EMirrorVerticalAxisUsed to mirror a bitmap about the vertical axis.
• ERotation180DegreesClockwiseUsed to rotate a bitmap 180 degrees clockwise.
• ERotation270DegreesClockwiseUsed to rotate a bitmap 270 degrees clockwise.
• ERotation90DegreesClockwiseUsed to rotate a bitmap 90 degrees clockwise.
• NewL()Constructs a CBitmapRotator object.
• Rotate(TRequestStatus *,CFbsBitmap &,CFbsBitmap &,TRotationAngle)Schedules a rotate/mirror operation on a bitmap supplied in the aSrcBitmap param...
• Rotate(TRequestStatus *,CFbsBitmap &,TRotationAngle)The function Rotate schedules a rotate/mirror operation on a bitmap supplied in ...
• TRotationAngleThe enumeration provides a set of supported rotation and mirror angles. TRotatio...
• ~CBitmapRotator()Default destructor for this class.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CBitmapRotator* NewL();

Description

Constructs a CBitmapRotator object.

If any errors are encountered this function leaves with an appropriate leave code.

Return value

CBitmapRotator * A pointer to a CBitmapRotator object.

IMPORT_C ~CBitmapRotator();

Description

Default destructor for this class.

Frees all resources owned by the object prior to its destruction.

IMPORT_C void Rotate(TRequestStatus *aRequestStatus, CFbsBitmap &aSrcBitmap, CFbsBitmap &aTgtBitmap, TRotationAngle aAngle);

Pre-Condition

• aRequestStatus is not a NULL pointer.

• aSrcBitmap is a fully constructed bitmap of unknown size including zero dimension

• aTgtBitmap is a fully constructed bitmap of unknown size including zero dimension

• aAngle is a member of the enumeration TRotationAngle.

Description

Schedules a rotate/mirror operation on a bitmap supplied in the aSrcBitmap paramter and produces the output pointed to by aTgtBitmap. The CBitmapRotator is an active object and as such provides asynchronous operations. The result of the operation is pointed to by aRequestStatus.

Post-Condition

If successful aTgtBitmap contains the rotated bitmap and aRequestStatus points to the value KErrNone. If unsuccessful the bitmap supplied in aSrcBitmap will remain unaltered.

Parameters

TRequestStatus *aRequestStatus A pointer to the completion status of the asynchronous operation. CFbsBitmap &aSrcBitmap This bitmap should have been created CFbsBitmap &aTgtBitmap This bitmap should have been created CBitmapRotator::TRotationAngle aAngle A member of the enumeration TRotationAngle that specifies the rotation mirror operation.

Panic codes

ENoSourceBitmap This function panics with TBitmapTransformsMain::ENoSourceBitmap when the aSrcBitmap has not been constructed ie. its handle is zero.

IMPORT_C void Rotate(TRequestStatus *aRequestStatus, CFbsBitmap &aBitmap, TRotationAngle aAngle);

Pre-Condition

• aRequestStatus is not a NULL pointer.

• aBitmap is a fully constructed bitmap of unknown size including zero dimension.

• aAngle is a member of the enumeration TRotationAngle.

Description

The function Rotate schedules a rotate/mirror operation on a bitmap supplied in the aBitmap whose output overwrites aBitmap. The result of the operation is pointed to by aRequestStatus.

Post-Condition

• aBitmap contains the rotated bitmap.

• aRequestStatus points to the value KErrorNone.

Parameters

TRequestStatus *aRequestStatus A pointer to the completion status of the asynchronous operation. CFbsBitmap &aBitmap A reference to a CFbsBitmap. This bitmap should have been created and is also an output. CBitmapRotator::TRotationAngle aAngle A member of the enumeration TRotationAngle that specifies the rotation mirror operation.

Panic codes

ENoSourceBitmap This function panics with TBitmapTransformsMain::ENoSourceBitmap when the aSrcBitmap has not been constructed ie. its handle is 0.

IMPORT_C TInt CustomCommand(TUid aUid, TAny *aParam);

Pre-Condition

When a command requires parameters aParam is not NULL.

Description

Provides custom command capabilties on CBitmapRotator. The command is dispatched on aUid and if the command is not known KErrNotSupported will be returned. This function is synchronous.

Parameters

TUid aUid The ID of the command. TAny *aParam The command specific information.

Return value

TInt

IMPORT_C void Cancel();

Description

Cancels any outstanding action.

TRotationAngle

Description

The enumeration provides a set of supported rotation and mirror angles. TRotationAngle is an enumeration within the namespace CBitmapRotator.

ERotation90DegreesClockwise Used to rotate a bitmap 90 degrees clockwise. ERotation180DegreesClockwise Used to rotate a bitmap 180 degrees clockwise. ERotation270DegreesClockwise Used to rotate a bitmap 270 degrees clockwise. EMirrorHorizontalAxis Used to mirror a bitmap about the horizontal axis. EMirrorVerticalAxis Used to mirror a bitmap about the vertical axis.