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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
// 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_EVENTS_EVENT_TARGET_H_
#define UI_EVENTS_EVENT_TARGET_H_
#include <memory>
#include <vector>
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ptr_exclusion.h"
#include "base/scoped_observation_traits.h"
#include "ui/events/event_handler.h"
#include "ui/events/events_export.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/point_f.h"
namespace ui {
class EventDispatcher;
class EventTargeter;
class EventTargetIterator;
class LocatedEvent;
class EVENTS_EXPORT EventTarget {
public:
class DispatcherApi {
public:
explicit DispatcherApi(EventTarget* target) : target_(target) {}
DispatcherApi(const DispatcherApi&) = delete;
DispatcherApi& operator=(const DispatcherApi&) = delete;
private:
DispatcherApi();
raw_ptr<EventTarget> target_;
};
EventTarget();
EventTarget(const EventTarget&) = delete;
EventTarget& operator=(const EventTarget&) = delete;
virtual ~EventTarget();
virtual bool CanAcceptEvent(const Event& event) = 0;
// Returns the parent EventTarget in the event-target tree.
virtual EventTarget* GetParentTarget() = 0;
// Returns an iterator an EventTargeter can use to iterate over the list of
// child EventTargets.
virtual std::unique_ptr<EventTargetIterator> GetChildIterator() const = 0;
// Returns the EventTargeter that should be used to find the target for an
// event in the subtree rooted at this EventTarget.
virtual EventTargeter* GetEventTargeter() = 0;
// Updates the states in |event| (e.g. location) to be suitable for |target|,
// so that |event| can be dispatched to |target|.
virtual void ConvertEventToTarget(const EventTarget* target,
LocatedEvent* event) const;
// Get |event|'s screen location, using the EventTarget's screen location.
virtual gfx::PointF GetScreenLocationF(const LocatedEvent& event) const;
gfx::Point GetScreenLocation(const LocatedEvent& event) const;
// Priority levels for PreTargetHandlers.
enum class Priority {
// The Accessibility level is the highest, and gets events before
// other priority levels. This allows accessibility features to
// modify events directly from the user. Note that Ash accessibility
// features should not use this directly, but instead should go
// through ash::Shell::AddAccessibilityEventHandler to allow for
// fine-grained control of ordering amongst themselves.
kAccessibility,
// System priority EventHandlers get events before default level, and
// should be used for drag and drop, menus, etc.
kSystem,
// The default level should be used by most EventHandlers.
kDefault,
};
// Adds a handler to receive events before the target. The handler must be
// explicitly removed from the target before the handler is destroyed. The
// EventTarget does not take ownership of the handler.
void AddPreTargetHandler(EventHandler* handler);
void AddPreTargetHandler(EventHandler* handler, Priority priority);
void RemovePreTargetHandler(EventHandler* handler);
// Adds a handler to receive events after the target. The handler must be
// explicitly removed from the target before the handler is destroyed. The
// EventTarget does not take ownership of the handler.
void AddPostTargetHandler(EventHandler* handler);
void RemovePostTargetHandler(EventHandler* handler);
// Returns true if the event pre target list is empty.
bool IsPreTargetListEmpty() const;
// Sets |target_handler| as |target_handler_| and returns the old handler.
EventHandler* SetTargetHandler(EventHandler* target_handler);
bool HasTargetHandler() const { return target_handler_ != nullptr; }
protected:
EventHandler* target_handler() { return target_handler_; }
private:
friend class EventDispatcher;
friend class EventTargetTestApi;
// A handler with a priority.
struct PrioritizedHandler {
// RAW_PTR_EXCLUSION: Performance reasons: based on this sampling profiler
// result on ChromeOS. go/brp-cros-prof-diff-20230403
RAW_PTR_EXCLUSION EventHandler* handler = nullptr;
Priority priority = Priority::kDefault;
bool operator<(const PrioritizedHandler& ph) const {
return priority < ph.priority;
}
};
using EventHandlerPriorityList = std::vector<PrioritizedHandler>;
// Returns the list of handlers that should receive the event before the
// target. The handlers from the outermost target are first in the list, and
// the handlers on |this| are the last in the list.
void GetPreTargetHandlers(EventHandlerList* list);
// Returns the list of handlers that should receive the event after the
// target. The handlers from the outermost target are last in the list, and
// the handlers on |this| are the first in the list.
void GetPostTargetHandlers(EventHandlerList* list);
EventHandlerPriorityList pre_target_list_;
EventHandlerList post_target_list_;
raw_ptr<EventHandler, DanglingUntriaged> target_handler_ = nullptr;
};
} // namespace ui
namespace base {
template <>
struct ScopedObservationTraits<ui::EventTarget, ui::EventHandler> {
static void AddObserver(ui::EventTarget* source, ui::EventHandler* observer) {
source->AddPreTargetHandler(observer);
}
static void RemoveObserver(ui::EventTarget* source,
ui::EventHandler* observer) {
source->RemovePreTargetHandler(observer);
}
};
} // namespace base
#endif // UI_EVENTS_EVENT_TARGET_H_
|