CCameraViewFinder Class Reference

class CCameraViewFinder : public CBase

CCamera view finder base class is used to provide features common to both client view finders and direct view finders.

Note:

This class is not intended for stand alone use. One of the derived class shall be used instead. Features of this class will automatically be used when either direct view finder or client based view finder are created by clients.

If the class methods leave, the output type parameter value is not guaranteed to be valid.

Inherits from

Public Member Functions
~CCameraViewFinder()
IMPORT_C voidGetViewFinderFadingCapabilitiesL(TViewFinderFadingCapabilities &)
IMPORT_C voidGetViewFinderFadingEffectL(TViewFinderFadingEffect &)
IMPORT_C voidGetViewFinderHandleL(TInt &)
IMPORT_C voidSetViewFinderFadingEffectL(const TViewFinderFadingEffect &)
Protected Member Functions
CCameraViewFinder(CCamera &)
voidGetImageEnhancementL(TImageEnhancement &)
voidGetSpotsPositionL(TUint, RArray< TRect > &)
voidGetSupportedImageEnhancementL(TUint &)
voidGetSupportedVFMagnificationL(RArray< TUint > &)
voidGetViewfinderMagnificationL(TUint &)
voidSetImageEnhancementL(TImageEnhancement)
voidSetViewfinderMagnificationL(TUint)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enumTImageEnhancement { EImageEnhancementNone = 0x00, EImageEnhancementSwitchOFF = 0x01, EImageEnhancementAuto = 0x02, EImageEnhancementSwitchOn = 0x04 }
enumTViewFinderFadingControl { EVFFadingControlNone = 0x00, EVFFadingControlSwitchedOn = 0x01, EVFFadingControlSwitchedOff = 0x02, EVFFadingControlSwitchAuto = 0x04 }
enumTViewFinderFadingDirection {
EVFFadingDirectionNone = 0x00, EVFFadingDirectionAuto = 0x01, EVFFadingDirectionUniform = 0x02, EVFFadingDirectionUpDown = 0x04, EVFFadingDirectionDownUp = 0x08, EVFFadingDirectionLeftRight = 0x10, EVFFadingDirectionRightLeft = 0x20
}
enumTViewFinderFadingType { EVFFadingTypeNone = 0x00, EVFFadingTypeStaticColorFading = 0x01, EVFFadingTypeStaticFrameFading = 0x02, EVFFadingTypeCross = 0x04 }
Protected Attributes
MCameraViewFinder *iImplBase
CCamera &iOwner

Constructor & Destructor Documentation

CCameraViewFinder(CCamera &)

CCameraViewFinder(CCamera &aOwner)[protected]

CCameraViewFinder Constructor.

Parameters

CCamera & aOwnera reference to a CCamera object providing the settings.

~CCameraViewFinder()

~CCameraViewFinder()

Destructor

Member Functions Documentation

GetImageEnhancementL(TImageEnhancement &)

voidGetImageEnhancementL(TImageEnhancement &aImageEnhancement)const [protected]

Get the current image enhancement for the particular viewfinder.

leave
May leave with any error code.

Parameters

TImageEnhancement & aImageEnhancementCurrently used TImageEnhancement for the viewfinder display.

GetSpotsPositionL(TUint, RArray< TRect > &)

voidGetSpotsPositionL(TUintaSpotCombination,
RArray< TRect > &aSpotsPosition
)const [protected]

Retrieves the position of spots for a given spot combination which is to be displayed on a particular viewfinder.

leave
May leave with any error code.
Note:

These TRect specify the position of the spots relative to the targeted viewfinder space. Note that spots could also be represented as points since point is a special case of rectangle.

CCamera::CCameraImageCaptureControl::GetMaximumSpotsL CCamera::CCameraImageCaptureControl::GetSupportedSpotsCombinationL CCamera::CCameraImageCaptureControl::GetSpotsCombinationL CCamera::CCameraImageCaptureControl::SetSpotsCombination

Parameters

TUint aSpotCombinationA given spot combination. It is a bitfield where every bit represents the presence or absence of a particular spot.
RArray< TRect > & aSpotsPositionAn array of TRect which represents the position of every spot present in the given spot combination. The first member of this array maps the first spot present in the given spot combination from the least significant bit side. The position of a spot is relative to the top-left corner of viewfinder.

GetSupportedImageEnhancementL(TUint &)

voidGetSupportedImageEnhancementL(TUint &aSupportedImageEnhancement)const [protected]

Retrieves the supported image enhancements.

leave
May leave with any error code.

Parameters

TUint & aSupportedImageEnhancementA bitfield of all supported TImageEnhancement to be provided to the client.

GetSupportedVFMagnificationL(RArray< TUint > &)

voidGetSupportedVFMagnificationL(RArray< TUint > &aSupportedVFMagnification)const [protected]

Retrieves the supported viewfinder magnification factor in terms of percentage. Changing the magnification factor allows the user to view more or less area than what would normally appear on the captured image.

leave
May leave with any error code.

Parameters

RArray< TUint > & aSupportedVFMagnificationAn array of TUint which retrieves the supported magnification factor. Every member of this array is a magnification factor and represents a percentage unit. Note that every array member is multiplied by KECamFineResolutionFactor to support fractional percentages as well. For example, 90.5% will be represented by 9050.

GetViewFinderFadingCapabilitiesL(TViewFinderFadingCapabilities &)

IMPORT_C voidGetViewFinderFadingCapabilitiesL(TViewFinderFadingCapabilities &aVFFadingCapabilities)const

Retrieves the fading capabilites for a particular viewfinder.

leave
May leave with any error code.

Parameters

TViewFinderFadingCapabilities & aVFFadingCapabilitiesRetrieves the fading capabilities associated with the given viewfinder.

GetViewFinderFadingEffectL(TViewFinderFadingEffect &)

IMPORT_C voidGetViewFinderFadingEffectL(TViewFinderFadingEffect &aCurrentVFFadingEffect)const

Retrieves the current fading effect/control being used for a particular viewfinder.

leave
May leave with any error code.

Parameters

TViewFinderFadingEffect & aCurrentVFFadingEffectRetrieves the fading effects associated with the given viewfinder.

GetViewFinderHandleL(TInt &)

IMPORT_C voidGetViewFinderHandleL(TInt &aVFHandle)const

Retrieves the handle number which represents the given viewfinder object.

leave
May leave with any error code.
Note:

KECamDefaultViewFinderHandle is used to refer to the viewfinder started using CCamera methods.

Parameters

TInt & aVFHandleThe viewfinder handle

GetViewfinderMagnificationL(TUint &)

voidGetViewfinderMagnificationL(TUint &aVFMagnification)const [protected]

Retrieves the current magnification factor for a particular viewfinder.

leave
May leave with any error code.

Parameters

TUint & aVFMagnificationThe current magnification factor used for the given viewfinder. It represents a percentage unit. Note that the magnification factor is multiplied by KECamFineResolutionFactor to support fractional percentages as well. For example, 90.5% will be represented by 9050.

SetImageEnhancementL(TImageEnhancement)

voidSetImageEnhancementL(TImageEnhancementaImageEnhancement)[protected]

Set the image enhancement for a particular viewfinder.

leave
KErrNotSupported If the implementation of this method is not present.
Note:

Event KUidECamEvent2ViewFinderImageEnhancement is used to notify clients about the image enhancement setting operation.

Parameters

TImageEnhancement aImageEnhancementThe TImageEnhancement value to be set

SetViewFinderFadingEffectL(const TViewFinderFadingEffect &)

IMPORT_C voidSetViewFinderFadingEffectL(const TViewFinderFadingEffect &aVFFadingEffect)

Sets the fading effect/control for a particular viewfinder.

leave
KErrNotSupported if the implementation of this method is not present.
Note:

Event KUidECamEvent2ViewFinderFadingEffect is used to notify the requesting client about the setting of the fading effect.

Parameters

const TViewFinderFadingEffect & aVFFadingEffectThe desired fading effects associated with the given viewfinder.

SetViewfinderMagnificationL(TUint)

voidSetViewfinderMagnificationL(TUintaVFMagnification)[protected]

Set a particular magnification factor for the given viewfinder.

leave
KErrNotSupported If the implementation of this method is not present.
Note:

Event KUidECamEvent2ViewFinderMagnification is used to notify the requesting client about the setting of the magnification factor.

Parameters

TUint aVFMagnificationThe magnification factor to be set. It represents a percentage unit. Note that the magnification factor is multiplied by KECamFineResolutionFactor to support fractional percentages as well. For example, 90.5% will be represented by 9050.

Member Enumerations Documentation

Enum TImageEnhancement

Image enhancement options to be applied for a particular display. The enumeration list may be extended in future.

Enumerators

EImageEnhancementNone = 0x00

Not Supported.

EImageEnhancementSwitchOFF = 0x01

Image Enhancement switches off.

EImageEnhancementAuto = 0x02

Image Enhancement switches to auto mode.

EImageEnhancementSwitchOn = 0x04

Image Enhancement switches on.

Enum TViewFinderFadingControl

Different ways to control the viewfinder fading. The enumeration list may be extended in future.

Enumerators

EVFFadingControlNone = 0x00

Fading not supported.

EVFFadingControlSwitchedOn = 0x01

Switch on (enable) the fading.

EVFFadingControlSwitchedOff = 0x02

Switch off (disable) the fading.

EVFFadingControlSwitchAuto = 0x04

Automatic fading.

Enum TViewFinderFadingDirection

Different directions in which the fading may appear. The enumeration list may be extended in future.

Enumerators

EVFFadingDirectionNone = 0x00

Fading not supported.

EVFFadingDirectionAuto = 0x01

Automatic direction or may be even custom direction decided by implementation.

EVFFadingDirectionUniform = 0x02

Uniform fading.

EVFFadingDirectionUpDown = 0x04

Start to fade from up to down.

EVFFadingDirectionDownUp = 0x08

Start to fade from down to up.

EVFFadingDirectionLeftRight = 0x10

Start to fade from left to right.

EVFFadingDirectionRightLeft = 0x20

Start to fade from right to left.

Enum TViewFinderFadingType

Different types of available viewfinder fading. The enumeration list may be extended in future.

Enumerators

EVFFadingTypeNone = 0x00

Fading not supported.

EVFFadingTypeStaticColorFading = 0x01

Fading from a single frame of color given by the client.

EVFFadingTypeStaticFrameFading = 0x02

Fading from a single frame given by the client.

EVFFadingTypeCross = 0x04

Fading from a number of previous VF frames.

Member Data Documentation

MCameraViewFinder * iImplBase

MCameraViewFinder *iImplBase[protected]

CCamera & iOwner

CCamera &iOwner[protected]