1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_VIEWS_CONTROLS_TEXTFIELD_TEXTFIELD_CONTROLLER_H_
#define UI_VIEWS_CONTROLS_TEXTFIELD_TEXTFIELD_CONTROLLER_H_
#include <set>
#include <string>
#include "ui/base/clipboard/clipboard_buffer.h"
#include "ui/base/clipboard/clipboard_format_type.h"
#include "ui/base/dragdrop/mojom/drag_drop_types.mojom-forward.h"
#include "ui/base/dragdrop/os_exchange_data.h"
#include "ui/views/view.h"
#include "ui/views/views_export.h"
namespace ui {
class KeyEvent;
class MouseEvent;
class GestureEvent;
class SimpleMenuModel;
} // namespace ui
namespace views {
class Textfield;
// This defines the callback interface for other code to be notified of changes
// in the state of a text field.
class VIEWS_EXPORT TextfieldController {
public:
// This method is called whenever the text in the field is changed by the
// user. It won't be called if the text is changed by calling
// Textfield::SetText() or Textfield::AppendText().
virtual void ContentsChanged(Textfield* sender,
const std::u16string& new_contents) {}
// Called to get notified about keystrokes in the edit.
// Returns true if the message was handled and should not be processed
// further. If it returns false the processing continues.
virtual bool HandleKeyEvent(Textfield* sender, const ui::KeyEvent& key_event);
// Called to get notified about mouse events in the edit.
// Returns true if the message was handled and should not be processed
// further. Currently, only mouse down events and mouse wheel events are sent
// here.
virtual bool HandleMouseEvent(Textfield* sender,
const ui::MouseEvent& mouse_event);
// Called to get notified about gesture events in the edit.
// Returns true if the message was handled and should not be processed
// further. Currently, only tap events are sent here.
virtual bool HandleGestureEvent(Textfield* sender,
const ui::GestureEvent& gesture_event);
// Called before performing a user action that may change the textfield.
// It's currently only supported by Views implementation.
virtual void OnBeforeUserAction(Textfield* sender) {}
// Called after performing a user action that may change the textfield.
// It's currently only supported by Views implementation.
virtual void OnAfterUserAction(Textfield* sender) {}
// Called after performing a Cut or Copy operation.
virtual void OnAfterCutOrCopy(ui::ClipboardBuffer clipboard_buffer) {}
// Called after performing a Paste operation.
virtual void OnAfterPaste() {}
// Called after the textfield has written drag data to give the controller a
// chance to modify the drag data.
virtual void OnWriteDragData(ui::OSExchangeData* data) {}
// Called after the textfield has set default drag operations to give the
// controller a chance to update them.
virtual void OnGetDragOperationsForTextfield(int* drag_operations) {}
// Enables the controller to append to the accepted drop formats.
virtual void AppendDropFormats(
int* formats,
std::set<ui::ClipboardFormatType>* format_types) {}
// Called when a drop of dragged data happens on the textfield. This method is
// called before regular handling of the drop. If this returns a drag
// operation other than `ui::mojom::DragOperation::kNone`, regular handling is
// skipped.
virtual ui::mojom::DragOperation OnDrop(const ui::DropTargetEvent& event);
// Called to get async drop callback to be run later.
virtual views::View::DropCallback CreateDropCallback(
const ui::DropTargetEvent& event);
// Gives the controller a chance to modify the context menu contents.
virtual void UpdateContextMenu(ui::SimpleMenuModel* menu_contents) {}
protected:
virtual ~TextfieldController() = default;
};
} // namespace views
#endif // UI_VIEWS_CONTROLS_TEXTFIELD_TEXTFIELD_CONTROLLER_H_
|