CEikRangeEditor Class Reference

#include <mw/eikmfne.h>

Link against: eikctl.lib

class CEikRangeEditor : public CEikMfne

Inherits from

CEikRangeEditor
- CEikMfne
  - CEikBorderedControl
    - CAknControl

Public Member Functions
	CEikRangeEditor()
virtual IMPORT_C void	ConstructFromResourceL(TResourceReader &)
IMPORT_C void	ConstructL(TInt, TInt, const SEikRange &, HBufC *)
IMPORT_C void	GetMinimumAndMaximum(TInt &, TInt &)
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C SEikRange	Range()
IMPORT_C void	SetMinimumAndMaximum(TInt, TInt)
IMPORT_C void	SetRange(const SEikRange &)

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CEikBorderedControl::iBorder

Inherited Enumerations
	CCoeControl:TZoomType
	CEikMfne:TFeatureId
	CEikMfne:TFingerSupportParams

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::ComponentControl(TInt)const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CountComponentControls()const
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MaximumWidth()const
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()
	CEikBorderedControl::Border()const
	CEikBorderedControl::CEikBorderedControl()
	CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
	CEikBorderedControl::HasBorder()const
	CEikBorderedControl::SetAdjacent(TInt)
	CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
	CEikBorderedControl::SetBorder(TInt)
	CEikMfne::AddField(CEikMfneField *)
	CEikMfne::BorderMargins()const
	CEikMfne::CEikMfne()
	CEikMfne::Convert(const TTime &)
	CEikMfne::Convert(const TTimeIntervalSeconds &)
	CEikMfne::CreateFieldArrayL(TInt)
	CEikMfne::CurrentField()const
	CEikMfne::DrawNowAndLeaveWithTimeDateFormatInfoMsgL(TInt,const TTime &)const
	CEikMfne::Field(TInt)const
	CEikMfne::FocusChanged(TDrawNow)
	CEikMfne::Font()const
	CEikMfne::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CEikMfne::GetCursorInfo(TPoint &,TInt &,TInt &,TInt &)
	CEikMfne::GetFeature(TInt,TInt &)const
	CEikMfne::HandleInteraction(TBool,TInt,TInt,CEikMfneField::THighlightType,TBool &,TBool &)
	CEikMfne::HandleMfneCommandL(TInt)
	CEikMfne::HandleResourceChange(TInt)
	CEikMfne::HighlightField(TInt)
	CEikMfne::InputCapabilities()const
	CEikMfne::InvalidFieldAlert()
	CEikMfne::LeaveWithAlert(TInt)
	CEikMfne::MakeVisible(TBool)
	CEikMfne::MfneSize()const
	CEikMfne::MfneSize(TBool)
	CEikMfne::MinimumSize()
	CEikMfne::MopSupplyObject(TTypeUid)
	CEikMfne::NumFields()const
	CEikMfne::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CEikMfne::PrepareForFocusLossL()
	CEikMfne::ReadDate(TResourceReader &)
	CEikMfne::ReadDuration(TResourceReader &)
	CEikMfne::ReadTime(TResourceReader &)
	CEikMfne::ReadTimeAndDate(TResourceReader &)
	CEikMfne::ReadTimeOffset(TResourceReader &)
	CEikMfne::ReportStateChangeEventL()
	CEikMfne::ReportUpdate()
	CEikMfne::ResetFieldArray()
	CEikMfne::SetCurrentField(TInt)
	CEikMfne::SetFeature(TInt,TInt)
	CEikMfne::SetFirstEditableField()
	CEikMfne::SetFont(const CFont *)
	CEikMfne::SetMfneAlignment(TInt)
	CEikMfne::SetSkinBackgroundControlContextL(MAknsControlContext *)
	CEikMfne::SetSkinTextColorL(TInt,TInt)
	CEikMfne::SetSuppressBackgroundDrawing(TBool)
	CEikMfne::SetUpAndDownKeysConsumed(TBool)
	CEikMfne::SetUseOverrideColors(TBool)
	CEikMfne::SetValidateCallBack(TCallBack)
	CEikMfne::SizeChanged()
	CEikMfne::SupportsFeature(TInt)const
	CEikMfne::WriteInternalStateL(RWriteStream &)const
	CEikMfne::~CEikMfne()

Detailed Description

Numeric range editor.

This editor supports editing an integer range. It has two fields; the first represents the lower value and the second the upper value. The second value must be greater than, or equal to, the first.

Minimum and maximum values for the editor are specified during construction. If a number is entered which is not within the editor's minimum and maximum values, it is automatically reset to the nearest allowable value.

The editor has an associated resource struct RANGE_EDITOR and control factory identifier EEikCtRangeEditor.

Constructor & Destructor Documentation

CEikRangeEditor ( )

IMPORT_C

CEikRangeEditor

(

)

Default constructor.

This function should be used as the first stage in two stage construction, followed by a call to either ConstructFromResourceL() to initialise the editor's field values from a resource file, or ConstructL() if no resource file is used.

Member Function Documentation

ConstructFromResourceL ( TResourceReader & )

IMPORT_C void

ConstructFromResourceL

(

TResourceReader &

aResourceReader

)

[virtual]

Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)

Second phase constructor from resource.

This function completes construction of a newly-allocated range editor. It sets the minimum and maximum values, initial range and separator text as specified by the resource.

Parameter	Description
aResourceReader	A resource reader.

ConstructL ( TInt, TInt, const SEikRange &, HBufC * )

IMPORT_C void	ConstructL	(	TInt	aMinimumValue,
			TInt	aMaximumValue,
			const SEikRange &	aInitialRange,
			HBufC *	aSeparatorText
		)

Second phase constructor.

This function completes construction of a range editor. It sets the minimum and maximum values, initial range and separator text. It should be called by the container only if the control is not constructed from a resource file.

panic: 8 If the initial lower or upper limit is outside the minimum or maximum bounds.

Parameter	Description
aMinimumValue	The minimum value for the range editor.
aMaximumValue	The maximum value for the range editor.
aInitialRange	Struct containing upper and lower range limits. Must be within the minimum and maximum values.
aSeparatorText	The text to be used to separate the numeric values.

GetMinimumAndMaximum ( TInt &, TInt & )

IMPORT_C void	GetMinimumAndMaximum	(	TInt &	aMinimumValue,
			TInt &	aMaximumValue
		)	const

Gets the range editor's minimum and maximum values.

Parameter	Description
aMinimumValue	On return, the minimum value for the range editor.
aMaximumValue	On return, the maximum value for the range editor.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Reimplemented from CEikMfne::HandlePointerEventL(const TPointerEvent &)

From CCoeControl.

Handles pointer events.

Parameter	Description
aPointerEvent	The pointer event.

Range ( )

IMPORT_C SEikRange

Range

(

)

const

Gets the range editor's current values.

Can only be called if CEikMfne::PrepareForFocusLossL() succeeded

Returns: Struct containing current range values.

SetMinimumAndMaximum ( TInt, TInt )

IMPORT_C void	SetMinimumAndMaximum	(	TInt	aMinimumValue,
			TInt	aMaximumValue
		)

Sets the range editor's minimum and maximum values.

Any values are permitted. If the range values are outside the new minimum / maximum they are changed to be within the new minimum / maximum.

Parameter	Description
aMinimumValue	The minimum value for the range editor.
aMaximumValue	The maximum value for the range editor.

SetRange ( const SEikRange & )

IMPORT_C void

SetRange

(

const SEikRange &

aRange

)

Sets the range editor's current values.

Parameter	Description
aRange	Struct containing new range values.