1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/* * This file is part of Maliit framework *
*
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
*
* Contact: maliit-discuss@lists.maliit.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation
* and appearing in the file LICENSE.LGPL included in the packaging
* of this file.
*/
#ifndef MIMSERVERCONNECTION_H
#define MIMSERVERCONNECTION_H
#include <maliit/namespace.h>
#include <QtCore>
class MImServerConnectionPrivate;
class MImPluginSettingsInfo;
class MImServerConnection : public QObject
{
Q_OBJECT
public:
//! \brief Constructor
explicit MImServerConnection(QObject *parent = 0);
virtual bool pendingResets();
/* Outgoing communication */
virtual void activateContext();
virtual void showInputMethod();
virtual void hideInputMethod();
virtual void mouseClickedOnPreedit(const QPoint &pos, const QRect &preeditRect);
virtual void setPreedit(const QString &text, int cursorPos);
virtual void updateWidgetInformation(const QMap<QString, QVariant> &stateInformation, bool focusChanged);
virtual void reset(bool requireSynchronization);
virtual void appOrientationAboutToChange(int angle);
virtual void appOrientationChanged(int angle);
virtual void setCopyPasteState(bool copyAvailable, bool pasteAvailable);
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);
virtual void registerAttributeExtension(int id, const QString &fileName);
virtual void unregisterAttributeExtension(int id);
virtual void setExtendedAttribute(int id, const QString &target, const QString &targetItem,
const QString &attribute, const QVariant &value);
virtual void loadPluginSettings(const QString &descriptionLanguage);
public:
/*! \brief Notifies about connection to server being established.
*
* Note: Creating connection to server and thus emission of this signal
* have to be deferred to the mainloop.
*/
Q_SIGNAL void connected();
Q_SIGNAL void disconnected();
/* Incoming communication */
Q_SIGNAL void activationLostEvent();
//! \brief Notifies about hiding initiated by the input method server side
Q_SIGNAL void imInitiatedHide();
/*!
* \brief Commits a string to current focus widget, and set cursor position.
* \param string The new string committed
* \param replacementStart The position at which characters are to be replaced relative
* from the start of the preedit string.
* \param replacementLength The number of characters to be replaced in the preedit string.
* \param cursorPos The cursor position to be set. the cursorPos is the position relative
* to commit string start. Negative values are used as commit string end position
*
* Note: If \a replacementLength is 0, \a replacementStart gives the insertion position
* for the inserted \a string.
* For example, if the replacement starting at -1 with a length of 2, then application will
* remove the last character before the preedit string and the first character afterwards,
* and insert the commit string directly before the preedit string.
*/
Q_SIGNAL void commitString(const QString &string, int replacementStart = 0,
int replacementLength = 0, int cursorPos = -1);
/*!
* \brief Updates preedit string of the current focus widget
* \param string The new string
* \param preeditFormats The formats for each part of preedit.
* \param replacementStart The position at which characters are to be replaced relative
* from the start of the preedit string.
* \param replacementLength The number of characters to be replaced in the preedit string.
* \param cursorPos Cursor position. If it is less than 0, then the cursor will be hidden.
*
*/
Q_SIGNAL void updatePreedit(const QString &string, const QList<Maliit::PreeditTextFormat> &preeditFormats,
int replacementStart = 0, int replacementLength = 0, int cursorPos = -1);
//! \brief Sends a non-printable key event. Parameters as in QKeyEvent constructor
Q_SIGNAL void keyEvent(int type, int key, int modifiers, const QString &text, bool autoRepeat,
int count, Maliit::EventRequestType requestType
= Maliit::EventRequestBoth);
//!
// \brief Updates the input method window area
// \param rect Bounding rectangle of the input method area
Q_SIGNAL void updateInputMethodArea(const QRect &rect);
/*!
* \brief set global correction option enable/disable
*/
Q_SIGNAL void setGlobalCorrectionEnabled(bool);
/*! \brief Get rectangle covering preedit
* \param valid validity for the return value
* \param rectangle the preedit rectangle.
*
* Warning: If multiple slots are connected to this signal, the last slot to be
* called will be able to overwrite value set by previously called slots.
*/
Q_SIGNAL void getPreeditRectangle(QRect &rectangle, bool &valid) const;
/*!
* \brief Sends command action to text editor.
* This method tries to call action slot in the focused widget
* and sends QKeyEvent corresponding to sequence if slot can not be called.
*/
Q_SIGNAL void invokeAction(const QString &action,
const QKeySequence &sequence);
/*!
* \brief Set if the input method wants to process all raw key events
* from hardware keyboard (via \a processKeyEvent calls).
*/
Q_SIGNAL void setRedirectKeys(bool enabled);
/*!
* \brief Set detectable autorepeat for X on/off
*
* Detectable autorepeat means that instead of press, release, press, release, press,
* release... sequence of key events you get press, press, press, release key events
* when a key is repeated. The setting is X client specific. This is intended to be
* used when key event redirection is enabled with \a setRedirectKeys.
*/
Q_SIGNAL void setDetectableAutoRepeat(bool enabled);
/*!
* \brief Sets selection which start from \start with \a length in the focus widget.
*
* \param start the start index
* \param length the length of selection
* Note: The cursor will be moved after the commit string has been committed, and the
* preedit string will be located at the new edit position.
*/
Q_SIGNAL void setSelection(int start, int length);
/*!
* \brief get selecting text
* \param valid validity for the return value
* \param selection the current selection
*
* Warning: If multiple slots are connected to this signal, the last slot to be
* called will be able to overwrite value set by previously called slots.
*/
Q_SIGNAL void getSelection(QString &selection, bool &valid) const;
/*!
* \brief Updates current language of active input method in input context.
* \param language ICU format locale ID string
* \sa QInputContext::language()
*/
Q_SIGNAL void setLanguage(const QString &language);
/*!
*\brief Informs application that input method server has changed the \a attribute of the \a targetItem
* in the attribute extension \a target which has unique \a id to \a value.
*/
Q_SIGNAL void extendedAttributeChanged(int id,
const QString &target,
const QString &targetItem,
const QString &attribute,
const QVariant &value);
/*!
* \brief Updates the list of server settings known to the application.
* \param info list of server and plugin settings
*
* Sent in response to \a loadPluginSettings(). Might be sent spontaneously by
* the server in response to external events (plugin loaded/unloaded, ...).
*/
Q_SIGNAL void pluginSettingsReceived(const QList<MImPluginSettingsInfo> &info);
private:
Q_DISABLE_COPY(MImServerConnection)
MImServerConnectionPrivate *d;
};
#endif
|