Drive: Add BatchableRequest subclass.
[chromium-blink-merge.git] / ui / base / ime / linux / linux_input_method_context.h
blob09fc04bce03b3ec84981d742e19c4ee242e8b733
1 // Copyright 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef UI_BASE_IME_LINUX_LINUX_INPUT_METHOD_CONTEXT_H_
6 #define UI_BASE_IME_LINUX_LINUX_INPUT_METHOD_CONTEXT_H_
8 #include "base/strings/string16.h"
9 #include "ui/base/ime/text_input_type.h"
10 #include "ui/base/ime/ui_base_ime_export.h"
12 namespace gfx {
13 class Rect;
16 namespace ui {
18 struct CompositionText;
19 class KeyEvent;
21 // An interface of input method context for input method frameworks on
22 // GNU/Linux and likes.
23 class UI_BASE_IME_EXPORT LinuxInputMethodContext {
24 public:
25 virtual ~LinuxInputMethodContext() {}
27 // Dispatches the key event to an underlying IME. Returns true if the key
28 // event is handled, otherwise false. A client must set the text input type
29 // before dispatching a key event.
30 virtual bool DispatchKeyEvent(const ui::KeyEvent& key_event) = 0;
32 // Resets the context. A client needs to call OnTextInputTypeChanged() again
33 // before calling DispatchKeyEvent().
34 virtual void Reset() = 0;
36 // Notifies the context that the text input type has changed.
37 virtual void OnTextInputTypeChanged(TextInputType text_input_type) = 0;
39 // Notifies the context that the caret bounds have changed. |caret_bounds| is
40 // relative to screen coordinates.
41 virtual void OnCaretBoundsChanged(const gfx::Rect& caret_bounds) = 0;
44 // An interface of callback functions called from LinuxInputMethodContext.
45 class UI_BASE_IME_EXPORT LinuxInputMethodContextDelegate {
46 public:
47 virtual ~LinuxInputMethodContextDelegate() {}
49 // Commits the |text| to the text input client.
50 virtual void OnCommit(const base::string16& text) = 0;
52 // Sets the composition text to the text input client.
53 virtual void OnPreeditChanged(const CompositionText& composition_text) = 0;
55 // Cleans up a composition session and makes sure that the composition text is
56 // cleared.
57 virtual void OnPreeditEnd() = 0;
59 // Prepares things for a new composition session.
60 virtual void OnPreeditStart() = 0;
63 } // namespace ui
65 #endif // UI_BASE_IME_LINUX_LINUX_INPUT_METHOD_CONTEXT_H_