Home ยท API Reference

MAbstractInputMethod Class Reference

MAbstractInputMethod is a base class for input method servers. More...

List of all members.

Signals

void activeSubViewChanged (const QString &subViewId, MInputMethod::HandlerState state=MInputMethod::OnScreen)

Public Member Functions

 MAbstractInputMethod (MAbstractInputMethodHost *host, QWidget *mainWindow)
virtual ~MAbstractInputMethod ()
MAbstractInputMethodHostinputMethodHost () const
 Returns input method host.
virtual void show ()
 Shows the input method.
virtual void hide ()
 Hides the input method.
virtual void setPreedit (const QString &preeditString, int cursorPos)
 Sets preedit string of the input method server.
virtual void update ()
 Update input method server state.
virtual void reset ()
 Resets input method server state.
virtual void handleMouseClickOnPreedit (const QPoint &pos, const QRect &preeditRect)
 Notifies input method server about mouse click on the preedit string.
virtual void handleFocusChange (bool focusIn)
 Notifies input method server about changed focus.
virtual void handleVisualizationPriorityChange (bool priority)
 Notifies that the focus widget in application changed visualization priority.
virtual void handleAppOrientationAboutToChange (int angle)
 Target application is about to change orientation. Input method usually changes its own orientation according to this.
virtual void handleAppOrientationChanged (int angle)
 Target application already finish changing orientation. Input method usually changes its own orientation according to this.
virtual void setToolbar (QSharedPointer< const MToolbarData > toolbar)
 Uses a custom toolbar which is defined by given parameter.
virtual void processKeyEvent (QEvent::Type keyType, Qt::Key keyCode, Qt::KeyboardModifiers modifiers, const QString &text, bool autoRepeat, int count, quint32 nativeScanCode, quint32 nativeModifiers, unsigned long time)
 Process a key event redirected from hardware keyboard to input method.
virtual void setState (const QSet< MInputMethod::HandlerState > &state)
virtual void handleClientChange ()
 This method is called when target client is changed.
virtual void switchContext (MInputMethod::SwitchDirection direction, bool enableAnimation)
 Switch context to given direction.
virtual QList
< MInputMethodSubView > 
subViews (MInputMethod::HandlerState state=MInputMethod::OnScreen) const
 Returns all subviews (IDs and titles) which are supported for state.
virtual void showLanguageNotification ()
 Show notification informing about current language.
virtual void setKeyOverrides (const QMap< QString, QSharedPointer< MKeyOverride > > &overrides)
 Uses custom key overrides which are defined by given parameter.
virtual bool imExtensionEvent (MImExtensionEvent *event)
 handles extension event not covered by separate method.

Classes

struct  MInputMethodSubView


Detailed Description

MAbstractInputMethod is a base class for input method servers.

It defines the interface which input method framework can use for passing commands received from the applications


Constructor & Destructor Documentation

MAbstractInputMethod::MAbstractInputMethod ( MAbstractInputMethodHost host,
QWidget *  mainWindow 
)

Constructor

Parameters:
host serves as communication link to framework and application. Managed by framework.
mainWindow should be used to install plugin's UI into it. Managed by framework.

MAbstractInputMethod::~MAbstractInputMethod (  )  [virtual]


Member Function Documentation

MAbstractInputMethodHost * MAbstractInputMethod::inputMethodHost (  )  const

Returns input method host.

void MAbstractInputMethod::show (  )  [virtual]

Shows the input method.

void MAbstractInputMethod::hide (  )  [virtual]

Hides the input method.

void MAbstractInputMethod::setPreedit ( const QString &  preeditString,
int  cursorPos 
) [virtual]

Sets preedit string of the input method server.

Parameters:
preeditString preedit string
cursorPos the cursor position inside preedit.
Note: This method is used by application to initiate the predit and the cursor position for input method server. Input method server fully controls the preedit and the cursor inside it. (Input method server decides whether and where to show cursor inside preedit).

void MAbstractInputMethod::update (  )  [virtual]

Update input method server state.

void MAbstractInputMethod::reset (  )  [virtual]

Resets input method server state.

void MAbstractInputMethod::handleMouseClickOnPreedit ( const QPoint &  pos,
const QRect &  preeditRect 
) [virtual]

Notifies input method server about mouse click on the preedit string.

void MAbstractInputMethod::handleFocusChange ( bool  focusIn  )  [virtual]

Notifies input method server about changed focus.

Parameters:
focusIn true - focus has entered a widget, false - focus has left a widget

void MAbstractInputMethod::handleVisualizationPriorityChange ( bool  priority  )  [virtual]

Notifies that the focus widget in application changed visualization priority.

void MAbstractInputMethod::handleAppOrientationAboutToChange ( int  angle  )  [virtual]

Target application is about to change orientation. Input method usually changes its own orientation according to this.

void MAbstractInputMethod::handleAppOrientationChanged ( int  angle  )  [virtual]

Target application already finish changing orientation. Input method usually changes its own orientation according to this.

void MAbstractInputMethod::setToolbar ( QSharedPointer< const MToolbarData toolbar  )  [virtual]

Uses a custom toolbar which is defined by given parameter.

Parameters:
toolbar Pointer to toolbar definition.

void MAbstractInputMethod::processKeyEvent ( QEvent::Type  keyType,
Qt::Key  keyCode,
Qt::KeyboardModifiers  modifiers,
const QString &  text,
bool  autoRepeat,
int  count,
quint32  nativeScanCode,
quint32  nativeModifiers,
unsigned long  time 
) [virtual]

Process a key event redirected from hardware keyboard to input method.

This is called only if one has enabled redirection by calling MInputContextConnection::setRedirectKeys.

void MAbstractInputMethod::setState ( const QSet< MInputMethod::HandlerState > &  state  )  [virtual]

void MAbstractInputMethod::handleClientChange (  )  [virtual]

This method is called when target client is changed.

void MAbstractInputMethod::switchContext ( MInputMethod::SwitchDirection  direction,
bool  enableAnimation 
) [virtual]

Switch context to given direction.

Parameters:
direction Switching direction
enableAnimation Contains true if swipe should be animated

QList< MAbstractInputMethod::MInputMethodSubView > MAbstractInputMethod::subViews ( MInputMethod::HandlerState  state = MInputMethod::OnScreen  )  const [virtual]

Returns all subviews (IDs and titles) which are supported for state.

Implement this function to return the subviews which are supported by this input method for the specified state. The subview titles will be shown in the input method settings.

void MAbstractInputMethod::showLanguageNotification (  )  [virtual]

Show notification informing about current language.

void MAbstractInputMethod::setKeyOverrides ( const QMap< QString, QSharedPointer< MKeyOverride > > &  overrides  )  [virtual]

Uses custom key overrides which are defined by given parameter.

Parameters:
overrides Pointer to key override definitions.

bool MAbstractInputMethod::imExtensionEvent ( MImExtensionEvent event  )  [virtual]

handles extension event not covered by separate method.

Parameters:
event event to handle
Should return true if event is handled, otherwise false.

void MAbstractInputMethod::activeSubViewChanged ( const QString &  subViewId,
MInputMethod::HandlerState  state = MInputMethod::OnScreen 
) [signal]

Inform that active subview is changed to subViewId for state.

Parameters:
subViewId the identifier of the new subview.
state the state which subViewId belongs to. Emitted when plugin changes the active subview for specified state.


Copyright © 2010 Nokia Corporation
MeeGo Touch