blob: dbf9df4ecbdc88c07a18242c82fc30356350d5ac [file] [log] [blame]
// Copyright (c) 2012 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.
#include <vector>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "ui/base/ime/ime_input_context_handler_interface.h"
#include "ui/base/ime/input_method.h"
#include "ui/base/ime/ui_base_ime_export.h"
#include "ui/events/event_dispatcher.h"
namespace gfx {
class Rect;
} // namespace gfx
namespace ui {
class InputMethodObserver;
class KeyEvent;
class TextInputClient;
// A helper class providing functionalities shared among ui::InputMethod
// implementations.
class UI_BASE_IME_EXPORT InputMethodBase
: NON_EXPORTED_BASE(public InputMethod),
public base::SupportsWeakPtr<InputMethodBase>,
public IMEInputContextHandlerInterface {
~InputMethodBase() override;
// Overriden from InputMethod.
void SetDelegate(internal::InputMethodDelegate* delegate) override;
void OnFocus() override;
void OnBlur() override;
void SetFocusedTextInputClient(TextInputClient* client) override;
void DetachTextInputClient(TextInputClient* client) override;
TextInputClient* GetTextInputClient() const override;
void SetOnScreenKeyboardBounds(const gfx::Rect& new_bounds) override;
// If a derived class overrides this method, it should call parent's
// implementation.
void OnTextInputTypeChanged(const TextInputClient* client) override;
void OnInputLocaleChanged() override;
bool IsInputLocaleCJK() const override;
TextInputType GetTextInputType() const override;
TextInputMode GetTextInputMode() const override;
int GetTextInputFlags() const override;
bool CanComposeInline() const override;
void ShowImeIfNeeded() override;
void AddObserver(InputMethodObserver* observer) override;
void RemoveObserver(InputMethodObserver* observer) override;
virtual void OnWillChangeFocusedClient(TextInputClient* focused_before,
TextInputClient* focused) {}
virtual void OnDidChangeFocusedClient(TextInputClient* focused_before,
TextInputClient* focused) {}
// IMEInputContextHandlerInterface:
void CommitText(const std::string& text) override;
void UpdateCompositionText(const CompositionText& text,
uint32_t cursor_pos,
bool visible) override;
void DeleteSurroundingText(int32_t offset, uint32_t length) override;
void SendKeyEvent(KeyEvent* event) override;
InputMethod* GetInputMethod() override;
// Sends a fake key event for IME composing without physical key events.
// Returns true if the faked key event is stopped propagation.
bool SendFakeProcessKeyEvent(bool pressed) const;
// Returns true if |client| is currently focused.
bool IsTextInputClientFocused(const TextInputClient* client);
// Checks if the focused text input client's text input type is
// TEXT_INPUT_TYPE_NONE. Also returns true if there is no focused text
// input client.
bool IsTextInputTypeNone() const;
// Convenience method to call the focused text input client's
// OnInputMethodChanged() method. It'll only take effect if the current text
// input type is not TEXT_INPUT_TYPE_NONE.
void OnInputMethodChanged() const;
// Convenience method to call delegate_->DispatchKeyEventPostIME().
// Returns true if the event was processed
ui::EventDispatchDetails DispatchKeyEventPostIME(ui::KeyEvent* event) const
// Convenience method to notify all observers of TextInputClient changes.
void NotifyTextInputStateChanged(const TextInputClient* client);
// Convenience method to notify all observers of CaretBounds changes on
// |client| which is the text input client with focus.
void NotifyTextInputCaretBoundsChanged(const TextInputClient* client);
// Gets the bounds of the composition text or cursor in |client|.
std::vector<gfx::Rect> GetCompositionBounds(const TextInputClient* client);
// Indicates whether the IME extension is currently sending a fake key event.
// This is used in SendKeyEvent.
bool sending_key_event_;
// InputMethod:
const std::vector<std::unique_ptr<ui::KeyEvent>>& GetKeyEventsForTesting()
void SetFocusedTextInputClientInternal(TextInputClient* client);
internal::InputMethodDelegate* delegate_;
TextInputClient* text_input_client_;
base::ObserverList<InputMethodObserver> observer_list_;
std::vector<std::unique_ptr<ui::KeyEvent>> key_events_for_testing_;
// Screen bounds of a on-screen keyboard.
gfx::Rect keyboard_bounds_;
} // namespace ui