Home · API Reference · Modules

Maliit Namespace Reference
[Common]


Classes

class  AttributeExtension
 Register extensions such as key overrides. More...
class  InputMethod
 Listen to device orientation, language and raw key events. More...
class  PreeditInjectionEvent
 Extension for preedit text inside text edits. More...
struct  PreeditTextFormat
 The text format for part of the preedit string, specified by start and length. More...

Namespaces

namespace  InputMethodQuery

Enumerations

enum  OrientationAngle {
  Angle0 = 0,
  Angle90 = 90,
  Angle180 = 180,
  Angle270 = 270
}
enum  Orientation {
  Portrait,
  Landscape
}
enum  TextContentType {
  FreeTextContentType,
  NumberContentType,
  PhoneNumberContentType,
  EmailContentType,
  UrlContentType,
  CustomContentType
}
enum  ItemType {
  ItemUndefined,
  ItemButton,
  ItemLabel
}
enum  VisibleType {
  VisibleUndefined,
  VisibleWhenSelectingText,
  VisibleAlways
}
enum  ActionType {
  ActionUndefined,
  ActionSendKeySequence,
  ActionSendString,
  ActionSendCommand,
  ActionCopy,
  ActionPaste,
  ActionShowGroup,
  ActionHideGroup,
  ActionClose,
  ActionCopyPaste
}
enum  CopyPasteState {
  InputMethodNoCopyPaste,
  InputMethodCopy,
  InputMethodPaste
}
enum  SwitchDirection {
  SwitchUndefined,
  SwitchForward,
  SwitchBackward
}
enum  PreeditFace {
  PreeditDefault,
  PreeditNoCandidates,
  PreeditKeyPress
}
enum  HandlerState {
  OnScreen,
  Hardware,
  Accessory
}
enum  EventRequestType {
  EventRequestBoth,
  EventRequestSignalOnly,
  EventRequestEventOnly
}
enum  InputModeIndicator {
  NoIndicator,
  LatinLowerIndicator,
  LatinUpperIndicator,
  LatinLockedIndicator,
  CyrillicLowerIndicator,
  CyrillicUpperIndicator,
  CyrillicLockedIndicator,
  ArabicIndicator,
  PinyinIndicator,
  ZhuyinIndicator,
  CangjieIndicator,
  NumAndSymLatchedIndicator,
  NumAndSymLockedIndicator,
  DeadKeyAcuteIndicator,
  DeadKeyCaronIndicator,
  DeadKeyCircumflexIndicator,
  DeadKeyDiaeresisIndicator,
  DeadKeyGraveIndicator,
  DeadKeyTildeIndicator
}
enum  InputMethodMode {
  InputMethodModeNormal,
  InputMethodModeDirect,
  InputMethodModeProxy
}
enum  InputMethodQueryExtensions {
  VisualizationPriorityQuery = 10001,
  PreeditRectangleQuery,
  ImCorrectionEnabledQuery,
  ImModeQuery,
  InputMethodAttributeExtensionIdQuery,
  InputMethodAttributeExtensionQuery,
  WesternNumericInputEnforcedQuery
}

Functions

void requestInputMethodPanel ()
void closeInputMethodPanel ()


Enumeration Type Documentation

Type of action.

Enumerator:
ActionUndefined  Do nothing.
ActionSendKeySequence  Send key sequence like Ctrl+D.
ActionSendString  Send string.
ActionSendCommand  Send command (not implemented yet).
ActionCopy  Copy selected text.
ActionPaste  Paste text from clipboard.
ActionShowGroup  Show some group of items.
ActionHideGroup  Hide some group of items.
ActionClose  Close virtual keyboard.
ActionCopyPaste  Standard copy/paste button.

State of Copy/Paste button.

Enumerator:
InputMethodNoCopyPaste  Copy/Paste button is hidden.
InputMethodCopy  Copy button is accessible.
InputMethodPaste  Paste button is accessible.

Key event request type for MInputContext::keyEvent().

Enumerator:
EventRequestBoth  Both a Qt::KeyEvent and a signal.
EventRequestSignalOnly  Only a signal.
EventRequestEventOnly  Only a Qt::KeyEvent.

Enumerator:
OnScreen 
Hardware 
Accessory 

Enumerator:
InputMethodModeNormal  Normal mode allows to use preedit and error correction.
InputMethodModeDirect  Virtual keyboard sends QKeyEvent for every key press or release.
InputMethodModeProxy  Used with proxy widget.

Extensions for Qt::inputMethodQuery.

Note:
the inputMethodQuery interface may change or be removed in Qt 5!
Enumerator:
VisualizationPriorityQuery  Tells if input method widget wants to have high.

priority for visualization. Input method should honor this and stay out of widgets space.

PreeditRectangleQuery  Retrieve bounding rectangle for current preedit text.
ImCorrectionEnabledQuery  Explicit correction enabling for text entries.
ImModeQuery  Retrieve mode: normal, direct or proxy.
InputMethodAttributeExtensionIdQuery  Attribute extension identifier for text entry.
InputMethodAttributeExtensionQuery  Attribute extension file name for text entry.
WesternNumericInputEnforcedQuery  Overrides localized numeric input with western numeric input.

Possible values for all the modes that are shown in the Input mode indicator.

Enumerator:
NoIndicator  No indicator should be shown.
LatinLowerIndicator  Latin lower case mode.
LatinUpperIndicator  Latin upper case mode.
LatinLockedIndicator  Latin caps locked mode.
CyrillicLowerIndicator  Cyrillic lower case mode.
CyrillicUpperIndicator  Cyrillic upper case mode.
CyrillicLockedIndicator  Cyrillic caps locked mode.
ArabicIndicator  Arabic mode.
PinyinIndicator  Pinyin mode.
ZhuyinIndicator  Zhuyin mode.
CangjieIndicator  Cangjie mode.
NumAndSymLatchedIndicator  Number and Symbol latched mode.
NumAndSymLockedIndicator  Number and Symbol locked mode.
DeadKeyAcuteIndicator  Dead key acute mode.
DeadKeyCaronIndicator  Dead key caron mode.
DeadKeyCircumflexIndicator  Dead key circumflex mode.
DeadKeyDiaeresisIndicator  Dead key diaeresis mode.
DeadKeyGraveIndicator  Dead key grave mode.
DeadKeyTildeIndicator  Dead key tilde mode.

Type of toolbar widget.

Enumerator:
ItemUndefined  Undefined item type.
ItemButton  Item should be visualized as button.
ItemLabel  Item should be visualized as label.

Possible orientations of windows in the application.

Deprecated:
See also:
OrientationAngle
Enumerator:
Portrait  equal to either Maliit::Angle90 or Maliit::Angle270 orientation angles
Landscape  equal to either Maliit::Angle0 or Maliit::Angle180 orientation angles

Orientation angle of windows in the application. Relative to natural drawing direction.

See also:
Orientation
Enumerator:
Angle0 
Angle90 
Angle180 
Angle270 

Enumerator:
PreeditDefault 
PreeditNoCandidates 
PreeditKeyPress  Used for displaying the hwkbd key just pressed.

Direction of plugin switching.

Enumerator:
SwitchUndefined  Special value for uninitialized variables.
SwitchForward  Activate next plugin.
SwitchBackward  Activate previous plugin.

Content type for text entries.

Content type of the text in the text edit widget, which can be used by input method plugins to offer more specific input methods, such as a numeric keypad for a number content type. Plugins may also adjust their word prediction and error correction accordingly.

Enumerator:
FreeTextContentType  all characters allowed
NumberContentType  only integer numbers allowed
PhoneNumberContentType  allows numbers and certain other characters used in phone numbers
EmailContentType  allows only characters permitted in email address
UrlContentType  allows only character permitted in URL address
CustomContentType  allows content with user defined format

Type of visible premiss for toolbar button.

Enumerator:
VisibleUndefined  Item's visibility will not be changed automatically.
VisibleWhenSelectingText  Item's visibility depends on text selection.
VisibleAlways  Item is always visible.


Function Documentation

void Maliit::closeInputMethodPanel (  ) 

Sends a request to the application's input context to close a software input panel.

See also:
requestInputMethodPanel

void Maliit::requestInputMethodPanel (  ) 

Sends a request to the application's input context to open a software input panel (e.g. the virtual keyboard).

Warning:
In order to gain more screen space, window decorations may be temporarily hidden while the input panel is up.
See also:
closeInputMethodPanel


Copyright © 2011 Nokia Corporation
Maliit