ui/base/ime/chromeos/ime_input_context_handler_interface.h

// Copyright 2014 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.

#ifndef UI_BASE_IME_CHROMEOS_IME_INPUT_CONTEXT_HANDLER_INTERFACE_H_
#define UI_BASE_IME_CHROMEOS_IME_INPUT_CONTEXT_HANDLER_INTERFACE_H_

#include <stdint.h>

#include <string>
#include "base/component_export.h"
#include "ui/base/ime/composition_text.h"
#include "ui/base/ime/input_method.h"
#include "ui/base/ime/text_input_client.h"
#include "ui/events/event.h"

namespace ui {

struct SurroundingTextInfo {
  base::string16 surrounding_text;
  gfx::Range selection_range;
};

class COMPONENT_EXPORT(UI_BASE_IME_CHROMEOS) IMEInputContextHandlerInterface {
 public:
  // Called when the engine commit a text.
  virtual void CommitText(
      const std::string& text,
      TextInputClient::InsertTextCursorBehavior cursor_behavior) = 0;

  // Called when the engine changes the composition range.
  // Returns true if the operation was successful.
  // If |text_spans| is empty, then this function uses a default span that
  // spans across the new composition range.
  virtual bool SetCompositionRange(
      uint32_t before,
      uint32_t after,
      const std::vector<ui::ImeTextSpan>& text_spans) = 0;
  virtual bool SetComposingRange(
      uint32_t start,
      uint32_t end,
      const std::vector<ui::ImeTextSpan>& text_spans) = 0;
  virtual gfx::Range GetAutocorrectRange() = 0;
  virtual gfx::Rect GetAutocorrectCharacterBounds() = 0;
  // Sets the autocorrect range to be `range`.
  virtual bool SetAutocorrectRange(const gfx::Range& range) = 0;

  // Called when the engine changes the selection range.
  // Returns true if the operation was successful.
  virtual bool SetSelectionRange(uint32_t start, uint32_t end) = 0;

  // Called when the engine updates composition text.
  virtual void UpdateCompositionText(const CompositionText& text,
                                     uint32_t cursor_pos,
                                     bool visible) = 0;

  // Called when the engine request deleting surrounding string.
  virtual void DeleteSurroundingText(int32_t offset, uint32_t length) = 0;

  // Called from the extension API.
  virtual SurroundingTextInfo GetSurroundingTextInfo() = 0;

  // Called when the engine sends a key event.
  virtual void SendKeyEvent(KeyEvent* event) = 0;

  // Gets the input method pointer.
  virtual InputMethod* GetInputMethod() = 0;

  // Commits any composition text.
  // Set |reset_engine| to false if this was triggered from the extension.
  virtual void ConfirmCompositionText(bool reset_engine,
                                      bool keep_selection) = 0;

  // Returns true if there is any composition text.
  virtual bool HasCompositionText() = 0;
};

}  // namespace ui

#endif  // UI_BASE_IME_CHROMEOS_IME_INPUT_CONTEXT_HANDLER_INTERFACE_H_