Class CEikCheckBox

class CEikCheckBox : public CEikButtonBase;

Description

Check box.

This class creates an on screen control that may be ticked or unticked by the user, and can be used to toggle some state in an application.

The editor has an associated control factory identifier EEikCtCheckBox . It has no associated resource struct.

This class is not intended for user derivation.

Derivation

• MQikCommandHandler - Interface for classes responsible of executing commands
• MQikCommandListOwner - Interface for classes adding commands
• MEikBorderedControl - Interface for bordered controls

• CCoeControl - Control base class from which all other controls are derived
• CEikBorderedControl - A control which is drawn surrounded by a rectangular border
• CEikButtonBase - This is the base class from which concrete button controls (command buttons, option buttons and checkboxes) are derived
• CEikCheckBox - Check box

Members

Defined in CEikCheckBox:
CEikCheckBox(), Draw(), GetColorUseListL(), HandleCommandL(), HandleResourceChange(), MapCommandHandler(), MinimumSize(), PrepareForFocusGainL(), PrepareForFocusLossL(), StateChanged(), ~CEikCheckBox()

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(), 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:
iBorder

Inherited from CEikButtonBase:
ActivateL(), Animate(), Border(), CEikButtonBase_Reserved_1(), CEikButtonBase_Reserved_2(), CEikButtonBase_Reserved_3(), ComponentControl(), ConstructFromResourceL(), CopyDrawStateTo(), CountComponentControls(), DrawState(), EClear, EDrawClear, EDrawClearPressed, EDrawIndeterminate, EDrawIndeterminatePressed, EDrawSet, EDrawSetPressed, EIndeterminate, ESet, FocusChanged(), GetHelpContext(), GetTextDrawer(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HasBorder(), InputCapabilities(), IsPressed(), MakeVisible(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), RequestRelayout(), SetAdjacent(), SetAllowTristate(), SetBehavior(), SetBorder(), SetBubbleHelpTextL(), SetContainerWindowL(), SetCoordinator(), SetDimmed(), SetIgnoreNextPointerUp(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetReportOnPointerDown(), SetState(), SetTextBaselineSpacing(), SizeChanged(), State(), TDrawState, TState, TextBaselineOffset(), WriteInternalStateL(), iButFlags

Inherited from MEikBorderedControl:
ETypeId, anonymous

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

Inherited from MQikCommandHandler:
HandleAttemptDimmedSelectionL()

IMPORT_C ~CEikCheckBox();

Description

Destructor. This destroys a CEikCheckBox .

IMPORT_C CEikCheckBox();

Description

Constructor. This fully constructs the checkbox. No second phase construction is required.

virtual IMPORT_C TSize MinimumSize();

Description

Gets the control's minimum size.

Return value

See also:

• CCoeControl::MinimumSize()

virtual IMPORT_C void Draw(const TRect &aRect) const;

Description

Draws the control.

Parameters

See also:

• CCoeControl::Draw()

virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;

Description

Gets the list of logical colours used to draw the check box. The list includes an explanation of how each colour is used, and is appended to aColorUseList .

Parameters

See also:

• CCoeControl::GetColorUseListL()

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources. The types of resources handled are those shared across the environment, e.g. colours or fonts.

Parameters

See also:

• CCoeControl::HandleResourceChange()

virtual IMPORT_C void PrepareForFocusGainL();

Description

See also:

• CCoeControl::PrepareForFocusGainL()

virtual IMPORT_C void PrepareForFocusLossL();

Description

See also:

• CCoeControl::PrepareForFocusLossL()

protected: virtual IMPORT_C MQikCommandHandler *MapCommandHandler(CQikCommand &aCommand);

Description

From MQikCommandListOwner

Parameters

Return value

protected: virtual IMPORT_C void HandleCommandL(CQikCommand &aCommand);

Description

Called when a softkey or menupane item has been selected.

Parameters

private: virtual IMPORT_C void StateChanged();

Description

Notifies the button that its draw state has changed.

This function is called by CEikButtonBase when the button's draw state changes.