blob: 4d732cdd0e4821ed8b3e19ffad4ceb09ec570235 [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 "base/basictypes.h"
#include "base/compiler_specific.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "ui/base/ime/input_method.h"
#include "ui/base/ui_base_export.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_EXPORT InputMethodBase
: NON_EXPORTED_BASE(public InputMethod),
public base::SupportsWeakPtr<InputMethodBase> {
~InputMethodBase() override;
// Overriden from InputMethod.
void SetDelegate(internal::InputMethodDelegate* delegate) override;
void Init(bool focused) override;
// If a derived class overrides OnFocus()/OnBlur(), it should call parent's
// implementation first, to make sure |system_toplevel_window_focused_| flag
// can be updated correctly.
void OnFocus() override;
void OnBlur() override;
void SetFocusedTextInputClient(TextInputClient* client) override;
void DetachTextInputClient(TextInputClient* client) override;
TextInputClient* GetTextInputClient() const override;
// If a derived class overrides this method, it should call parent's
// implementation.
void OnTextInputTypeChanged(const TextInputClient* client) 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) {}
// 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
bool DispatchKeyEventPostIME(const 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);
// Interface for for signalling candidate window events.
// See also *Callback functions below. To avoid reentrancy issue that
// TextInputClient manipulates IME state during even handling, these methods
// defer sending actual signals to renderer.
void OnCandidateWindowShown();
void OnCandidateWindowUpdated();
void OnCandidateWindowHidden();
bool system_toplevel_window_focused() const {
return system_toplevel_window_focused_;
void SetFocusedTextInputClientInternal(TextInputClient* client);
// Deferred callbacks for signalling TextInputClient about candidate window
// appearance changes.
void CandidateWindowShownCallback();
void CandidateWindowUpdatedCallback();
void CandidateWindowHiddenCallback();
internal::InputMethodDelegate* delegate_;
TextInputClient* text_input_client_;
ObserverList<InputMethodObserver> observer_list_;
bool system_toplevel_window_focused_;
} // namespace ui