PkIM Class Reference
[QtInputMethodsModule]

Detailed Description

The PkIM class provides an input method based on a standard telephone keypad. Also provides full screen handwriting input.

Member Function Documentation

bool PkIM::isActive () const

Returns true if key or mouse events are currently being filtered by the input method to generate text. Otherwise returns false.

bool PkIM::isFiltering () const

Returns true if key or mouse events are currently being filtered by the input method to generate text. Otherwise returns false.

bool PkIM::passwordHint () const

Returns the current password hint status. Input methods may react to this in different ways, and at their own discretion, but common actions include obscuring preedit text or not using dictionaries.

See also setPasswordHint().

void PkIM::processAuxiliaryHints ( QStringList inputHint )   [virtual protected]

This helper function takes the inputHint, processes any additional hint information and changes the internal state of the input method accordingly. Note: This function requires the primary input hint as well as the auixilliary hints in order to resolve ambiguity introduced by the "propernouns" hint.

See also setHint().

bool PkIM::restrictToHint () const

Returns true if the input method is restricted to s single mode based of the current input hint. Otherwise returns false.

See also setRestrictToHint().

void PkIM::sendMatchedCharacters ( const QList<QFSPenMatch::Guess> & cl )   [protected slot]

Adds the characters in the character list cl to its current state. This may result in sending key events or adding letters to the currently composed word.

void PkIM::setHint ( const QString & s )

Sets the mode of the input method to the hint s. If the hint starts with only will take the remaining string as the hint and restrict the mode to the one that best matches that hint.

Possible hints include "" "words" "phone" "int" "email" "propernouns" and "text" additionally, adding "password", with or without a preceding space will enable password mode. For PkIM, this just means that words will not be saved to the dictionary.

PkIM also recognizes a small set of auxiliary (or modifier) hints. These are appended to the hint, separated by spaces. PkIM does not recognize order in auxiliary hints, so "text autocapitalization propernouns" is equivalent to "text propernouns autocapitalization".

See also processAuxiliaryHints() and QtopiaApplication::ProperNouns.

void PkIM::setMicroFocus ( int x, int y )

Updates the internal representation of the location on the screen of the cursor. x and y are relative to the top level window.

void PkIM::setPasswordHint ( bool password )

Sets the current password hint to password.

See also passwordHint().

void PkIM::setRestrictToHint ( bool b )

If b is true will restrict the mode of the input method to the current mode.

See also restrictToHint().

void PkIM::setStatusWidget ( QLabel * l )

Sets the widget used to display the current status to l. The input method will update the icon for the widget to reflect the input method mode

void PkIM::stateChanged ( int state )   [signal]

This signal is emitted when the state of the input method changes. It is used by the server to update icon state and visability appropriately.

If the input method is filtering state will be QtopiaInputMethod::Ready. Otherwise state will be QtopiaInputMethod::Sleeping.

void PkIM::updateHandler ( int type )   [virtual protected]

This function handles update information from the server. type describes what has updated, as described in QWSInputMethod.

Reimplemented from QWSInputMethod.

See also QWSInputMethod::updateHandler().