Class CEikCalendar

class CEikCalendar : public CEikBorderedControl;

Description

Date selection pop-up.

This control brings up a pop-up calendar from which a user may select a single date. It is used in conjunction with a user-supplied MEikCalendarObserver .

This class is not intended for user derivation.

Derivation

• MEikBorderedControl - Interface for bordered controls
• MObjectProvider - An interface that allows an object to be part of a network of object providers
• CBase - Base class for all classes to be instantiated on the heap
• CCoeControl - Control base class from which all other controls are derived
• CEikBorderedControl - A control which is drawn surrounded by a rectangular border
• CEikCalendar - Date selection pop-up

Members

Defined in CEikCalendar:
CEikCalendar(), CreateCalendarByTypeL(), CreateCalendarByTypeL(), ExecuteLD(), GetCalendar(), GetCalendarTypeFromFileL(), SetCalendarObserver(), SetCalendarTypeInFileL(), WriteInternalStateL(), ~CEikCalendar()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentArrayExists(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GetTextDrawer(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), MopNext(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_2(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from CEikBorderedControl:
ActivateL(), Border(), ComponentControl(), ConstructFromResourceL(), CountComponentControls(), Draw(), FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), SetAdjacent(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TextBaselineOffset(), iBorder

Inherited from MEikBorderedControl:
ETypeId, anonymous

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining()

IMPORT_C CEikCalendar();

Description

Default constructor.

Inherits from CEikBorderedControl , and is initialised with an ESingleGray border.

This constructs and initialises a new calendar pop-up control. The new control has no observer.

See also:

• SetCalendarObserver()

IMPORT_C ~CEikCalendar();

Description

Destructor.

This function frees all resources allocated by this calendar during its construction and ExecuteLD() phases. CEikCalendar s delete themselves automatically when the user makes a choice of date, so developers usually do not need to use delete directly.

IMPORT_C void SetCalendarObserver(MEikCalendarObserver *aObserver);

Description

Registers a calendar observer.

An observer associated with a calendar by this function can observe the user's final choice of date, and provides basic initialisation information to the calendar object.

Parameters

IMPORT_C void ExecuteLD(TInt aDepricatedArgument=0x18b22002);

Description

Displays the pop-up calendar.

The function reads the resource passed as argument, which must be R_EIK_ONE_MONTH_CALENDAR , and displays the pop-up calendar control it represents. This function incorporates second-stage construction and execution of the dialog.

The date selected by the user is presented to the currently registered calendar observer, MEikCalendarObserver .

Parameters

IMPORT_C void CreateCalendarByTypeL();

Description

Creates a Gregorian calendar.

IMPORT_C TBool CreateCalendarByTypeL(TInt aCalendarControlId);

Description

Creates a calendar with a specified id.

Parameters

Return value

IMPORT_C CEikCalendarBase *GetCalendar() const;

Description

Returns the calendar.

Return value

static IMPORT_C void SetCalendarTypeInFileL(TInt aCalendarControlId);

Description

Used to write to the .ini file, the type of the calendar.

Parameters

static IMPORT_C TInt GetCalendarTypeFromFileL();

Description

Returns the current calendar id from the .ini file

Return value

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters