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
|
// 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.
//
// TODO(satorux): Move this from 'cros' directory to 'input_method'
// directory.
#ifndef CHROME_BROWSER_CHROMEOS_CROS_INPUT_METHOD_LIBRARY_H_
#define CHROME_BROWSER_CHROMEOS_CROS_INPUT_METHOD_LIBRARY_H_
#pragma once
#include <string>
#include <utility>
#include "base/observer_list.h"
#include "base/time.h"
#include "base/timer.h"
#include "chrome/browser/chromeos/input_method/ibus_controller.h"
namespace chromeos {
// This class handles the interaction with the ChromeOS language library APIs.
// Classes can add themselves as observers. Users can get an instance of this
// library class like this:
// chromeos::CrosLibrary::Get()->GetInputMethodLibrary()
class InputMethodLibrary {
public:
class Observer {
public:
virtual ~Observer() {}
// Called when the current input method is changed.
virtual void InputMethodChanged(
InputMethodLibrary* obj,
const input_method::InputMethodDescriptor& current_input_method,
size_t num_active_input_methods) = 0;
// Called when the active input methods are changed.
virtual void ActiveInputMethodsChanged(
InputMethodLibrary* obj,
const input_method::InputMethodDescriptor& current_input_method,
size_t num_active_input_methods) = 0;
// Called when the preferences have to be updated.
virtual void PreferenceUpdateNeeded(
InputMethodLibrary* obj,
const input_method::InputMethodDescriptor& previous_input_method,
const input_method::InputMethodDescriptor& current_input_method) = 0;
// Called when the list of properties is changed.
virtual void PropertyListChanged(
InputMethodLibrary* obj,
const input_method::ImePropertyList& current_ime_properties) = 0;
// Called by AddObserver() when the first observer is added.
virtual void FirstObserverIsAdded(InputMethodLibrary* obj) = 0;
};
virtual ~InputMethodLibrary() {}
// Adds an observer to receive notifications of input method related
// changes as desribed in the Observer class above.
virtual void AddObserver(Observer* observer) = 0;
virtual void RemoveObserver(Observer* observer) = 0;
// Returns the list of input methods we can select (i.e. active). If the cros
// library is not found or IBus/DBus daemon is not alive, this function
// returns a fallback input method list (and never returns NULL).
virtual input_method::InputMethodDescriptors* GetActiveInputMethods() = 0;
// Returns the number of active input methods.
virtual size_t GetNumActiveInputMethods() = 0;
// Returns the list of input methods we support, including ones not active.
// If the cros library is not found or IBus/DBus daemon is not alive, this
// function returns a fallback input method list (and never returns NULL).
virtual input_method::InputMethodDescriptors* GetSupportedInputMethods() = 0;
// Changes the current input method to |input_method_id|.
virtual void ChangeInputMethod(const std::string& input_method_id) = 0;
// Sets whether the input method property specified by |key| is activated. If
// |activated| is true, activates the property. If |activate| is false,
// deactivates the property. Examples of keys:
// - "InputMode.Katakana"
// - "InputMode.HalfWidthKatakana"
// - "TypingMode.Romaji"
// - "TypingMode.Kana"
virtual void SetImePropertyActivated(const std::string& key,
bool activated) = 0;
// Returns true if the input method specified by |input_method_id| is active.
virtual bool InputMethodIsActivated(const std::string& input_method_id) = 0;
// Updates a configuration of ibus-daemon or IBus engines with |value|.
// Returns true if the configuration (and all pending configurations, if any)
// are processed. If ibus-daemon is not running, this function just queues
// the request and returns false.
// When you would like to set 'panel/custom_font', |section| should
// be "panel", and |config_name| should be "custom_font".
// Notice: This function might call the Observer::ActiveInputMethodsChanged()
// callback function immediately, before returning from the SetImeConfig
// function. See also http://crosbug.com/5217.
virtual bool SetImeConfig(const std::string& section,
const std::string& config_name,
const input_method::ImeConfigValue& value) = 0;
// Returns the keyboard overlay ID corresponding to |input_method_id|.
// Returns an empty string if there is no corresponding keyboard overlay ID.
virtual std::string GetKeyboardOverlayId(
const std::string& input_method_id) = 0;
// Sets the IME state to enabled, and launches input method daemon if needed.
// Returns true if the daemon is started. Otherwise, e.g. the daemon is
// already started, returns false.
virtual bool StartInputMethodDaemon() = 0;
// Disables the IME, and kills the daemon process if they are running.
virtual void StopInputMethodDaemon() = 0;
// Controls whether the IME process is started when preload engines are
// specificed, or defered until a non-default method is activated.
virtual void SetDeferImeStartup(bool defer) = 0;
// Controls whether the IME process is stopped when all non-default preload
// engines are removed.
virtual void SetEnableAutoImeShutdown(bool enable) = 0;
// Sends a handwriting stroke to libcros. See chromeos::SendHandwritingStroke
// for details.
virtual void SendHandwritingStroke(
const input_method::HandwritingStroke& stroke) = 0;
// Clears last N handwriting strokes in libcros. See
// chromeos::CancelHandwriting for details.
virtual void CancelHandwritingStrokes(int stroke_count) = 0;
virtual input_method::InputMethodDescriptor previous_input_method() const = 0;
virtual input_method::InputMethodDescriptor current_input_method() const = 0;
virtual const input_method::ImePropertyList& current_ime_properties()
const = 0;
// Factory function, creates a new instance and returns ownership.
// For normal usage, access the singleton via CrosLibrary::Get().
static InputMethodLibrary* GetImpl(bool stub);
};
} // namespace chromeos
#endif // CHROME_BROWSER_CHROMEOS_CROS_INPUT_METHOD_LIBRARY_H_
|
