third_party/WebKit/Source/core/events/EventQueue.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All Rights Reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  */
  26
  27 #ifndef EventQueue_h
  28 #define EventQueue_h
  29
  30 #include "core/CoreExport.h"
  31 #include "platform/heap/Handle.h"
  32 #include "wtf/HashMap.h"
  33 #include "wtf/HashSet.h"
  34 #include "wtf/PassOwnPtr.h"
  35
  36 namespace blink {
  37
  38 class Event;
  39
  40 class CORE_EXPORT EventQueue : public NoBaseWillBeGarbageCollectedFinalized<EventQueue> {
  41 public:
  42     virtual ~EventQueue() { }
  43     DEFINE_INLINE_VIRTUAL_TRACE() { }
  44     virtual bool enqueueEvent(PassRefPtrWillBeRawPtr<Event>) = 0;
  45     virtual bool cancelEvent(Event*) = 0;
  46     // The accumulated and all the future events will be discarded, no events will be dispatched anymore.
  47     virtual void close() = 0;
  48 };
  49
  50 }
  51
  52 #endif // EventQueue_h