ui/base/ime/text_input_client.h

   1 // Copyright (c) 2012 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.
   4
   5 #ifndef UI_BASE_IME_TEXT_INPUT_CLIENT_H_
   6 #define UI_BASE_IME_TEXT_INPUT_CLIENT_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/i18n/rtl.h"
  10 #include "base/strings/string16.h"
  11 #include "ui/base/ime/composition_text.h"
  12 #include "ui/base/ime/text_input_mode.h"
  13 #include "ui/base/ime/text_input_type.h"
  14 #include "ui/base/ime/ui_base_ime_export.h"
  15 #include "ui/gfx/native_widget_types.h"
  16 #include "ui/gfx/range/range.h"
  17
  18 namespace gfx {
  19 class Rect;
  20 }
  21
  22 namespace ui {
  23
  24 // An interface implemented by a View that needs text input support.
  25 class UI_BASE_IME_EXPORT TextInputClient {
  26  public:
  27   virtual ~TextInputClient();
  28
  29   // Input method result -------------------------------------------------------
  30
  31   // Sets composition text and attributes. If there is composition text already,
  32   // it'll be replaced by the new one. Otherwise, current selection will be
  33   // replaced. If there is no selection, the composition text will be inserted
  34   // at the insertion point.
  35   virtual void SetCompositionText(const ui::CompositionText& composition) = 0;
  36
  37   // Converts current composition text into final content.
  38   virtual void ConfirmCompositionText() = 0;
  39
  40   // Removes current composition text.
  41   virtual void ClearCompositionText() = 0;
  42
  43   // Inserts a given text at the insertion point. Current composition text or
  44   // selection will be removed. This method should never be called when the
  45   // current text input type is TEXT_INPUT_TYPE_NONE.
  46   virtual void InsertText(const base::string16& text) = 0;
  47
  48   // Inserts a single char at the insertion point. Unlike above InsertText()
  49   // method, this method has an extra |flags| parameter indicating the modifier
  50   // key states when the character is generated. This method should only be
  51   // called when a key press is not handled by the input method but still
  52   // generates a character (eg. by the keyboard driver). In another word, the
  53   // preceding key press event should not be a VKEY_PROCESSKEY.
  54   // This method will be called whenever a char is generated by the keyboard,
  55   // even if the current text input type is TEXT_INPUT_TYPE_NONE.
  56   virtual void InsertChar(base::char16 ch, int flags) = 0;
  57
  58   // Input context information -------------------------------------------------
  59
  60   // Returns current text input type. It could be changed and even becomes
  61   // TEXT_INPUT_TYPE_NONE at runtime.
  62   virtual ui::TextInputType GetTextInputType() const = 0;
  63
  64   // Returns current text input mode. It could be changed and even becomes
  65   // TEXT_INPUT_MODE_DEFAULT at runtime.
  66   virtual ui::TextInputMode GetTextInputMode() const = 0;
  67
  68   // Returns the current text input flags, which is a bit map of
  69   // WebTextInputType defined in blink. This is valid only for web input fileds;
  70   // it will return TEXT_INPUT_FLAG_NONE for native input fields.
  71   virtual int GetTextInputFlags() const = 0;
  72
  73   // Returns if the client supports inline composition currently.
  74   virtual bool CanComposeInline() const = 0;
  75
  76   // Returns current caret (insertion point) bounds in the universal screen
  77   // coordinates. If there is selection, then the selection bounds will be
  78   // returned.
  79   // Note: On Windows, the returned value is supposed to be DIP (Density
  80   // Independent Pixel).
  81   // TODO(ime): Have a clear spec whether the returned value is DIP or not.
  82   // http://crbug.com/360334
  83   virtual gfx::Rect GetCaretBounds() const = 0;
  84
  85   // Retrieves the composition character boundary rectangle in the universal
  86   // screen coordinates. The |index| is zero-based index of character position
  87   // in composition text.
  88   // Returns false if there is no composition text or |index| is out of range.
  89   // The |rect| is not touched in the case of failure.
  90   // Note: On Windows, the returned value is supposed to be DIP
  91   // (Density Independent Pixel).
  92   // TODO(ime): Have a clear spec whether the returned value is DIP or not.
  93   // http://crbug.com/360334
  94   virtual bool GetCompositionCharacterBounds(uint32 index,
  95                                              gfx::Rect* rect) const = 0;
  96
  97   // Returns true if there is composition text.
  98   virtual bool HasCompositionText() const = 0;
  99
 100   // Document content operations ----------------------------------------------
 101
 102   // Retrieves the UTF-16 based character range containing accessibled text in
 103   // the View. It must cover the composition and selection range.
 104   // Returns false if the information cannot be retrieved right now.
 105   virtual bool GetTextRange(gfx::Range* range) const = 0;
 106
 107   // Retrieves the UTF-16 based character range of current composition text.
 108   // Returns false if the information cannot be retrieved right now.
 109   virtual bool GetCompositionTextRange(gfx::Range* range) const = 0;
 110
 111   // Retrieves the UTF-16 based character range of current selection.
 112   // Returns false if the information cannot be retrieved right now.
 113   virtual bool GetSelectionRange(gfx::Range* range) const = 0;
 114
 115   // Selects the given UTF-16 based character range. Current composition text
 116   // will be confirmed before selecting the range.
 117   // Returns false if the operation is not supported.
 118   virtual bool SetSelectionRange(const gfx::Range& range) = 0;
 119
 120   // Deletes contents in the given UTF-16 based character range. Current
 121   // composition text will be confirmed before deleting the range.
 122   // The input caret will be moved to the place where the range gets deleted.
 123   // ExtendSelectionAndDelete should be used instead as far as you are deleting
 124   // characters around current caret. This function with the range based on
 125   // GetSelectionRange has a race condition due to asynchronous IPCs between
 126   // browser and renderer.
 127   // Returns false if the operation is not supported.
 128   virtual bool DeleteRange(const gfx::Range& range) = 0;
 129
 130   // Retrieves the text content in a given UTF-16 based character range.
 131   // The result will be stored into |*text|.
 132   // Returns false if the operation is not supported or the specified range
 133   // is out of the text range returned by GetTextRange().
 134   virtual bool GetTextFromRange(const gfx::Range& range,
 135                                 base::string16* text) const = 0;
 136
 137   // Miscellaneous ------------------------------------------------------------
 138
 139   // Called whenever current keyboard layout or input method is changed,
 140   // especially the change of input locale and text direction.
 141   virtual void OnInputMethodChanged() = 0;
 142
 143   // Called whenever the user requests to change the text direction and layout
 144   // alignment of the current text box. It's for supporting ctrl-shift on
 145   // Windows.
 146   // Returns false if the operation is not supported.
 147   virtual bool ChangeTextDirectionAndLayoutAlignment(
 148       base::i18n::TextDirection direction) = 0;
 149
 150   // Deletes the current selection plus the specified number of characters
 151   // before and after the selection or caret. This function should be used
 152   // instead of calling DeleteRange with GetSelectionRange, because
 153   // GetSelectionRange may not be the latest value due to asynchronous of IPC
 154   // between browser and renderer.
 155   virtual void ExtendSelectionAndDelete(size_t before, size_t after) = 0;
 156
 157   // Ensure the caret is within |rect|.  |rect| is in screen coordinates and
 158   // may extend beyond the bounds of this TextInputClient.
 159   // Note: On Windows, the returned value is supposed to be DIP (Density
 160   // Independent Pixel).
 161   // TODO(ime): Have a clear spec whether the returned value is DIP or not.
 162   // http://crbug.com/360334
 163   virtual void EnsureCaretInRect(const gfx::Rect& rect) = 0;
 164
 165   // Returns true if |command_id| is currently allowed to be executed.
 166   virtual bool IsEditCommandEnabled(int command_id) = 0;
 167
 168   // Execute the command specified by |command_id| on the next key event.
 169   // This allows a TextInputClient to be informed of a platform-independent edit
 170   // command that has been derived from the key event currently being dispatched
 171   // (but not yet sent to the TextInputClient). The edit command will take into
 172   // account any OS-specific, or user-specified, keybindings that may be set up.
 173   virtual void SetEditCommandForNextKeyEvent(int command_id) = 0;
 174 };
 175
 176 }  // namespace ui
 177
 178 #endif  // UI_BASE_IME_TEXT_INPUT_CLIENT_H_