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
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_CHROMEOS_INPUT_METHOD_IBUS_ENGINE_CONTROLLER_H_
#define CHROME_BROWSER_CHROMEOS_INPUT_METHOD_IBUS_ENGINE_CONTROLLER_H_
#pragma once
#include "base/basictypes.h"
#include <string>
#include <vector>
namespace chromeos {
namespace input_method {
struct KeyEventHandle;
// IBusEngineController is used to encapsulate an ibus engine.
class IBusEngineController {
public:
class Observer {
public:
// Called when a key is pressed or released.
virtual void OnKeyEvent(bool key_press, unsigned int keyval,
unsigned int keycode, bool alt_key,
bool ctrl_key, bool shift_key,
KeyEventHandle* key_data) = 0;
// Called when the engine should reset its internal state.
virtual void OnReset() = 0;
// Called when the engine become the current engine.
virtual void OnEnable() = 0;
// Called when the engine is being disabled.
virtual void OnDisable() = 0;
// Called when a text field is focused.
virtual void OnFocusIn() = 0;
// Called when focus leaves a text field.
virtual void OnFocusOut() = 0;
// Called when one of the engine's menus is interacted with.
virtual void OnPropertyActivate(const char *prop_name,
unsigned int prop_state) = 0;
// Called when a candidate in the candidate window is clicked on.
virtual void OnCandidateClicked(unsigned int index, unsigned int button,
unsigned int state) = 0;
};
struct Candidate {
std::string value;
std::string label;
std::string annotation;
};
enum {
PROPERTY_MODIFIED_LABEL = 0x0001,
PROPERTY_MODIFIED_TOOLTIP = 0x0002,
PROPERTY_MODIFIED_SENSITIVE = 0x0004,
PROPERTY_MODIFIED_VISIBLE = 0x0008,
PROPERTY_MODIFIED_TYPE = 0x0010,
PROPERTY_MODIFIED_CHECKED = 0x0020,
};
struct EngineProperty {
EngineProperty();
virtual ~EngineProperty();
std::string key;
std::string label;
std::string tooltip;
bool sensitive;
bool visible;
int type;
bool checked;
unsigned int modified;
std::vector<EngineProperty*> children;
};
// Constants for the button parameter of OnCandidateClicked
enum {
MOUSE_BUTTON_1_MASK = 0x01,
MOUSE_BUTTON_2_MASK = 0x02,
MOUSE_BUTTON_3_MASK = 0x04,
};
// Constants for the type argument of SetPreeditUnderline
enum {
UNDERLINE_NONE,
UNDERLINE_SINGLE,
UNDERLINE_DOUBLE,
UNDERLINE_LOW,
UNDERLINE_ERROR
};
// Constants for RegisterProperties and UpdateProperties
enum {
PROPERTY_TYPE_NORMAL,
PROPERTY_TYPE_TOGGLE,
PROPERTY_TYPE_RADIO,
PROPERTY_TYPE_SEPARATOR,
PROPERTY_TYPE_MENU
};
static IBusEngineController* Create(Observer* observer,
const char* engine_id,
const char* engine_name,
const char* description,
const char* language,
const char* layout);
virtual ~IBusEngineController();
// Set the preedit text.
virtual void SetPreeditText(const char* text, int cursor) = 0;
// Adds an underline to the preedit text. Can be called multiple times.
virtual void SetPreeditUnderline(int start, int end, int type) = 0;
// Commit the provided text to the current input box.
virtual void CommitText(const char* text) = 0;
// Show or hide the candidate window.
virtual void SetTableVisible(bool visible) = 0;
// Show or hide the cursor in the candidate window.
virtual void SetCursorVisible(bool visible) = 0;
// Change the orientation of the candidate window.
virtual void SetOrientationVertical(bool vertical) = 0;
// Set the number of candidates displayed in the candidate window.
virtual void SetPageSize(unsigned int size) = 0;
// Remove all candidates.
virtual void ClearCandidates() = 0;
// Set the list of candidates in the candidate window.
virtual void SetCandidates(std::vector<Candidate> candidates) = 0;
// Set the text displayed at the bottom of the candidate window.
virtual void SetCandidateAuxText(const char* text) = 0;
// Show or hide the text at the bottom of the candidate window.
virtual void SetCandidateAuxTextVisible(bool visible) = 0;
// Set the posistion of the cursor in the candidate window.
virtual void SetCursorPosition(unsigned int position) = 0;
// Set the properties that ibus will display in the language bar.
virtual bool RegisterProperties(
const std::vector<EngineProperty*>& properties) = 0;
// Update the attributes of the listed properties.
virtual bool UpdateProperties(
const std::vector<EngineProperty*>& properties) = 0;
// Inform the engine that a key event has been processed.
virtual void KeyEventDone(KeyEventHandle* key_data, bool handled) = 0;
};
} // namespace input_method
} // namespace chromeos
#endif // CHROME_BROWSER_CHROMEOS_INPUT_METHOD_IBUS_ENGINE_CONTROLLER_H_
|
