ui/base/touch/touch_editing_controller.h

   1 // Copyright (c) 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.
   4
   5 #ifndef UI_BASE_TOUCH_TOUCH_EDITING_CONTROLLER_H_
   6 #define UI_BASE_TOUCH_TOUCH_EDITING_CONTROLLER_H_
   7
   8 #include "ui/base/models/simple_menu_model.h"
   9
  10 namespace gfx {
  11 class Point;
  12 class Rect;
  13 }
  14
  15 namespace ui {
  16 class SelectionBound;
  17
  18 // An interface implemented by widget that has text that can be selected/edited
  19 // using touch.
  20 class UI_BASE_EXPORT TouchEditable : public ui::SimpleMenuModel::Delegate {
  21  public:
  22   // TODO(mohsen): Consider switching from local coordinates to screen
  23   // coordinates in this interface and see if it will simplify things.
  24
  25   // Select everything between start and end (points are in view's local
  26   // coordinate system). |start| is the logical start and |end| is the logical
  27   // end of selection. Visually, |start| may lie after |end|.
  28   virtual void SelectRect(const gfx::Point& start, const gfx::Point& end) = 0;
  29
  30   // Move the caret to |point|. |point| is in local coordinates.
  31   virtual void MoveCaretTo(const gfx::Point& point) = 0;
  32
  33   // Gets the end points of the current selection. The end points |anchor| and
  34   // |focus| must be the cursor rect for the logical start and logical end of
  35   // selection (in local coordinates):
  36   // ____________________________________
  37   // | textfield with |selected text|   |
  38   // ------------------------------------
  39   //                  ^anchor       ^focus
  40   //
  41   // Visually, anchor could be to the right of focus in the figure above - it
  42   // depends on the selection direction.
  43   virtual void GetSelectionEndPoints(ui::SelectionBound* anchor,
  44                                      ui::SelectionBound* focus) = 0;
  45
  46   // Gets the bounds of the client view in its local coordinates.
  47   virtual gfx::Rect GetBounds() = 0;
  48
  49   // Gets the NativeView hosting the client.
  50   virtual gfx::NativeView GetNativeView() const = 0;
  51
  52   // Converts a point to/from screen coordinates from/to client view.
  53   virtual void ConvertPointToScreen(gfx::Point* point) = 0;
  54   virtual void ConvertPointFromScreen(gfx::Point* point) = 0;
  55
  56   // Returns true if the editable draws its own handles (hence, the
  57   // TouchEditingControllerDeprecated need not draw handles).
  58   virtual bool DrawsHandles() = 0;
  59
  60   // Tells the editable to open context menu.
  61   virtual void OpenContextMenu(const gfx::Point& anchor) = 0;
  62
  63   // Tells the editable to end touch editing and destroy touch selection
  64   // controller it owns.
  65   virtual void DestroyTouchSelection() = 0;
  66
  67  protected:
  68   ~TouchEditable() override {}
  69 };
  70
  71 // This defines the callback interface for other code to be notified of changes
  72 // in the state of a TouchEditable.
  73 class UI_BASE_EXPORT TouchEditingControllerDeprecated {
  74  public:
  75   virtual ~TouchEditingControllerDeprecated() {}
  76
  77   // Creates a TouchEditingControllerDeprecated. Caller owns the returned
  78   // object.
  79   static TouchEditingControllerDeprecated* Create(
  80       TouchEditable* client_view);
  81
  82   // Notifies the controller that the selection has changed.
  83   virtual void SelectionChanged() = 0;
  84
  85   // Returns true if the user is currently dragging one of the handles.
  86   virtual bool IsHandleDragInProgress() = 0;
  87
  88   // Hides visible handles. According to the value of |quick|, handles might
  89   // fade out quickly or slowly.
  90   virtual void HideHandles(bool quick) = 0;
  91 };
  92
  93 class UI_BASE_EXPORT TouchEditingControllerFactory {
  94  public:
  95   static void SetInstance(TouchEditingControllerFactory* instance);
  96
  97   virtual TouchEditingControllerDeprecated* Create(TouchEditable* client_view)
  98       = 0;
  99
 100  protected:
 101   virtual ~TouchEditingControllerFactory() {}
 102 };
 103
 104 }  // namespace ui
 105
 106 #endif  // UI_BASE_TOUCH_TOUCH_EDITING_CONTROLLER_H_