blob: ad84e603eafdbd74cc55582879f456395d38e6c0 [file] [log] [blame]
// Copyright 2013 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.
#include <vector>
#include "base/macros.h"
#include "ui/events/event_dispatcher.h"
#include "ui/events/events_export.h"
namespace ui {
class Event;
class EventSink;
class EventRewriter;
// EventSource receives events from the native platform (e.g. X11, win32 etc.)
// and sends the events to an EventSink.
class EVENTS_EXPORT EventSource {
virtual ~EventSource();
virtual EventSink* GetEventSink() = 0;
// Adds a rewriter to modify events before they are sent to the
// EventSink. The rewriter must be explicitly removed from the
// EventSource before the rewriter is destroyed. The EventSource
// does not take ownership of the rewriter.
void AddEventRewriter(EventRewriter* rewriter);
void RemoveEventRewriter(EventRewriter* rewriter);
// Sends the event through all rewriters and onto the source's EventSink.
EventDispatchDetails SendEventToSink(Event* event);
// Send the event to the sink after rewriting; subclass overrides may queue
// events before delivery, i.e. for the WindowService.
virtual EventDispatchDetails DeliverEventToSink(Event* event);
// Sends the event through the rewriters and onto the source's EventSink.
// If |rewriter| is valid, |event| is only sent to the subsequent rewriters.
// This is used for asynchronous reposting of events processed by |rewriter|.
EventDispatchDetails SendEventToSinkFromRewriter(
Event* event,
const EventRewriter* rewriter);
friend class EventRewriter;
friend class EventSourceTestApi;
typedef std::vector<EventRewriter*> EventRewriterList;
EventRewriterList rewriter_list_;
} // namespace ui