Class CQikKeyboardControl

class CQikKeyboardControl : public CCoeControl, public MQikChangeKeytopObserver;

Description

Keyboard control.

The keyboard control displays an on-screen keyboard, from which users can select characters/symbols for entry into an application. The control can display different keyboard configurations, known as keytops. Users can toggle between the keytops using the selection keys provided. Note that most applications do not need to use this class directly. Controls should normally implement InputCapabilities() to return their text input capabilities, then the system takes care of displaying the virtual keyboard.

Note that the events generated when the user presses an on-screen key are not handled by this control, but rather by the keyboard observer. This is set using the SetObserver() method, which should be called immediately after the keyboard control is created.

Derivation

• MQikChangeKeytopObserver - No description.
• 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
• CQikKeyboardControl - Keyboard control

Members

Defined in CQikKeyboardControl:
CurrentKeytopType(), EAlphabetic, EDefault, ENumerical, NewL(), ResetCapsAndShift(), SetCurrentKeytopTypeL(), SetLayoutL(), SetObserver(), SupportedLayoutsLC(), TKeytopType

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

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), ActivateL(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentControl(), Components(), ConstructFromResourceL(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CountComponentControls(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), FocusChanged(), GetColor(), GetColorUseListL(), GetGc(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleRedrawEvent(), HandleResourceChange(), HasBorder(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), InputCapabilities(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MakeVisible(), MaximumWidth(), MinimumSize(), MopSupplyObject(), Observer(), OfferKeyEventL(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), RequestRelayout(), Reserved_CCoeControl_10(), Reserved_CCoeControl_11(), Reserved_CCoeControl_12(), Reserved_CCoeControl_13(), ResetGc(), ScreenFont(), SetAdjacent(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetDimmed(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetLayoutManagerL(), SetMaximumWidth(), SetMopParent(), SetNeighbor(), SetNonFocusing(), SetParent(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetTextBaselineSpacing(), SetUniqueHandle(), SetZoomFactorL(), Size(), SizeChanged(), SystemGc(), TZoomType, TextBaselineOffset(), TextDrawer(), UniqueHandle(), Window(), WriteInternalStateL(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from MObjectProvider:
MopGetObject(), MopGetObjectNoChaining()

See also:

• CQikKeytopControl

static IMPORT_C CQikKeyboardControl *NewL(const CCoeControl &aContainer, TKeytopType aVisibleAtStart=EDefault, TBool aPreAllocMemory=EFalse);

Description

Allocates and constructs a new keyboard control.

Parameters

const CCoeControl &aContainer The parent container window for this keyboard TKeytopType aVisibleAtStart TBool aPreAllocMemory

Return value

CQikKeyboardControl * An Instance of the KeyboardControl .

IMPORT_C void SetObserver(MQikKeyboardObserver *aObserver);

Description

Sets the keyboard observer.

The keyboard observer handles key events and size changes. This function should be called immediately after creating the control. It is necessary to return the Keyevent, for handling the change of size etc. If no observer is set, other functions will panic, since there will be no mechanism to consume the key events.

Parameters

MQikKeyboardObserver *aObserver A pointer to the class that implements the functions.

See also:

• MQikKeyboardObserver

IMPORT_C void ResetCapsAndShift();

Description

Resets the CapsLock, Shift, Alt, and Ctrl key for all keytops.

IMPORT_C TKeytopType CurrentKeytopType() const;

Description

Gets which type of keytop is active at the moment.

Return value

TKeytopType Returns the EQikAlpha , EQikNumeric , or EQikSpecial depending on the active keyboard. If this function returns KErrNotFound , something during construction must have gone wrong.

IMPORT_C TBool SetCurrentKeytopTypeL(TKeytopType aType);

Description

Sets the type of keytop to use on the keyboard.

Parameters

TKeytopType aType Type of keytop to use on the keyboard.

Return value

TBool ETrue if successful, otherwise EFalse .

IMPORT_C CDesCArray *SupportedLayoutsLC() const;

Description

Return value

CDesCArray *

IMPORT_C void SetLayoutL(TInt aIndex);

Description

Parameters

TInt aIndex

TKeytopType

Description

EDefault EAlphabetic ENumerical