Symbian^3 Application Developer Library >

MIHLImageViewer Class Reference

class MIHLImageViewer : public MIHLViewer

MIHLImageViewer

Pure virtual interface for Image Viewer class. Class can be used to view, process and play animation from source image.

If interface needs to be pushed into CleanupStack , remember to use CleanupStackDeletePushL() function! DO NOT USE CleanupStack::PushL() !!

IHL.lib
Since
3.0

Inherits from

Public Member Functions
~MIHLImageViewer ()
TInt AnimationFrame ()
TInt AnimationFrameCount ()
TBool HorizontalMirroring ()
TBool IsAnimation ()
TBool IsPlaying ()
TInt MoveSourceRect ( TInt , TInt )
void Play ()
TInt RotateClockwise ()
TInt RotateCounterClockwise ()
TInt RotationAngle ()
TInt SetAnimationFrame ( TInt )
void SetFilter (MIHLFilter *)
TInt SetHorizontalMirroring ( TBool )
TInt SetRotationAngle ( TInt )
TInt SetSourceRectPosition (const TPoint &)
TInt SetVerticalMirroring ( TBool )
TInt SetViewerSize (const TSize &, TInt )
TInt SetZoomRatio ( TReal )
TRect SourceRect ()
TSize SourceSize ()
void Stop ()
TBool VerticalMirroring ()
TSize ViewerSize ()
TReal ZoomRatio ()
TReal ZoomToFitRatio ()
Inherited Functions
MIHLViewer::Type()const
MIHLViewer::~MIHLViewer()
Public Member Enumerations
enum TOptions { EOptionIgnoreAspectRatio  = 0x01, EOptionUseBilinearInterpolation  = 0x02 }
enum TRotationAngle { ERotationAngle0  = 0, ERotationAngle90  = 90, ERotationAngle180  = 180, ERotationAngle270  = 270 }

Constructor & Destructor Documentation

~MIHLImageViewer()

~MIHLImageViewer ( ) [inline, virtual]

Virtual destructor.

Member Functions Documentation

AnimationFrame()

TInt AnimationFrame ( ) const [pure virtual]
Current animation frame in display.
Since
3.0

AnimationFrameCount()

TInt AnimationFrameCount ( ) const [pure virtual]
Count of frames in animated image. If not animated, return zero.
Since
3.0

HorizontalMirroring()

TBool HorizontalMirroring ( ) const [pure virtual]
Check if source is horizontally mirrored.
Since
3.0

IsAnimation()

TBool IsAnimation ( ) const [pure virtual]
Check if source image is animated.
Since
3.0

IsPlaying()

TBool IsPlaying ( ) const [pure virtual]
Check if animation playback is currently running.
Since
3.0

MoveSourceRect(TInt, TInt)

TInt MoveSourceRect ( TInt aDx,
TInt aDy
) [pure virtual]
Move source clip rectangle. This is the area that is used from source image and processed to destination bitmap. Check valid move area with SourceRect() and SourceSize() methods.
Since
3.0

Parameters

TInt aDx Movement in X-axis.
TInt aDy Movement in Y-axis.

Play()

void Play ( ) [pure virtual]
Start animation playback. If source image is not animated, method does nothing.
Since
3.0

RotateClockwise()

TInt RotateClockwise ( ) [pure virtual]
Rotate source image 90 degree clockwise. Source rect is also moved to remain in same position where it was according to source image data.
Since
3.0

RotateCounterClockwise()

TInt RotateCounterClockwise ( ) [pure virtual]
Rotate source image 90 degree counterclockwise. Source rect is also moved to remain in same position where it was according to source image data.
Since
3.0

RotationAngle()

TInt RotationAngle ( ) const [pure virtual]
Current rotation angle.
Since
3.0

SetAnimationFrame(TInt)

TInt SetAnimationFrame ( TInt aFrameIndex ) [pure virtual]
Change current animation frame.
Since
3.0

Parameters

TInt aFrameIndex New animation frame.

SetFilter(MIHLFilter *)

void SetFilter ( MIHLFilter * aFilter ) [pure virtual]
Set filter. For future use, not used currently!
Since
3.0

Parameters

MIHLFilter * aFilter

SetHorizontalMirroring(TBool)

TInt SetHorizontalMirroring ( TBool aValue ) [pure virtual]
Set horizontal mirroring for source image. Source rect is also moved to remain in same position where it was according to source image data.
Since
3.0

Parameters

TBool aValue Mirroring flag.

SetRotationAngle(TInt)

TInt SetRotationAngle ( TInt aRotationAngle ) [pure virtual]
Set rotation angle. Use values from TRotationAngle enumeration. Source rect is also moved to remain in same position where it was according to source image data.
Since
3.0

Parameters

TInt aRotationAngle New rotation angle.

SetSourceRectPosition(const TPoint &)

TInt SetSourceRectPosition ( const TPoint & aPosition ) [pure virtual]
Set source clip rectangle position. This is the area that is used from source image and processed to destination bitmap. Check valid move area with SourceRect() and SourceSize() methods.
Since
3.0

Parameters

const TPoint & aPosition Topleft posion of rectangle.

SetVerticalMirroring(TBool)

TInt SetVerticalMirroring ( TBool aValue ) [pure virtual]
Set vertical mirroring for source image. Source rect is also moved to remain in same position where it was according to source image data.
Since
3.0

Parameters

TBool aValue Mirroring flag.

SetViewerSize(const TSize &, TInt)

TInt SetViewerSize ( const TSize & aViewerSize,
TInt srcBitmapScaleFactor = 1
) [pure virtual]
Change viewer size. This is also the maximum size of destination bitmap.
Since
3.0

Parameters

const TSize & aViewerSize New viewer size.
TInt srcBitmapScaleFactor = 1

SetZoomRatio(TReal)

TInt SetZoomRatio ( TReal aZoomRatio ) [pure virtual]
Set new zoom ratio. Zoom ratio is multiplier for scaling, 0,5 is 50%, 1.0 is 100%, 2,0 is 200% and so on. Value cannot be zero or negative.
Since
3.0

Parameters

TReal aZoomRatio New zoom ratio.

SourceRect()

TRect SourceRect ( ) const [pure virtual]
This is the area that is used from source image and processed to destination bitmap.
Since
3.0

SourceSize()

TSize SourceSize ( ) const [pure virtual]
Source image size. Note that this will change if image is rotated.
Since
3.0

Stop()

void Stop ( ) [pure virtual]
Stop animation playback. If source image is not animated or animation is not played currently, method does nothing.
Since
3.0

VerticalMirroring()

TBool VerticalMirroring ( ) const [pure virtual]
Check if source is vertically mirrored.
Since
3.0

ViewerSize()

TSize ViewerSize ( ) const [pure virtual]
Viewer size. This is also the maximum size of destination bitmap.
Since
3.0

ZoomRatio()

TReal ZoomRatio ( ) const [pure virtual]
Current zoom ratio.
Since
3.0

ZoomToFitRatio()

TReal ZoomToFitRatio ( ) const [pure virtual]
Zoom to fit ratio. Using this zoom ratio, image will fit exactly to viewer.
Since
3.0

Member Enumerations Documentation

Enum TOptions

Flags to control viewer functionality. These can be combined using an OR operation.
Since
3.0

Enumerators

EOptionIgnoreAspectRatio = 0x01
EOptionUseBilinearInterpolation = 0x02

Enum TRotationAngle

Rotation angle of source image.
Since
3.0

Enumerators

ERotationAngle0 = 0
ERotationAngle90 = 90
ERotationAngle180 = 180
ERotationAngle270 = 270

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.