summaryrefslogtreecommitdiff
path: root/docs
Unidiff
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/inputmethodinterface.doc49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/inputmethodinterface.doc b/docs/inputmethodinterface.doc
new file mode 100644
index 0000000..465182b
--- a/dev/null
+++ b/docs/inputmethodinterface.doc
@@ -0,0 +1,49 @@
1/*! \class InputMethodInterface inputmethodinterface.h
2 \brief The InputMethodInterface class provides an interface for Qtopia
3 input methods.
4
5 Input methods must supply a QWidget that will be shown above the task bar
6 and emit a signal when a key is pressed:
7
8 Input methods may be added to Qtopia via plugins. In order to write an
9 input method plugin you must create an interface to your input method by
10 deriving from the InputMethodInterface class and implementing the pure
11 virtual functions.
12
13 See also: <a href=inputmethods.html>Input Method Tutorial</a>
14*/
15
16
17/*! \fn QWidget *InputMethodInterface::inputMethod( QWidget *parent, Qt::WFlags f )
18
19 The inputMethod() function returns the input method widget. This
20 widget will be display just above the task bar when the user needs to input
21 text. You should always return the same widget if this function is called
22 multiple times.
23*/
24
25/*! \fn void InputMethodInterface::resetState()
26
27 The resetState() function should return the input method to its default
28 state.
29*/
30
31/*! \fn QString InputMethodInterface::name()
32
33 The name() function returns the name of the input method. This will
34 be displayed in the popup list of available input methods.
35*/
36
37/*! \fn QPixmap *InputMethodInterface::icon()
38
39 The icon() function returns the icon for the input method. This will
40 be displayed in the taskbar when the input method is selected.
41*/
42
43
44/*! \fn void InputMethodInterface::onKeyPress( QObject *receiver, const char *slot )
45
46 The onKeyPress() function must connect the supplied slot to the signal
47 that is emitted when a key press is generated.
48*/
49