simgear/canvas/CanvasEvent.hxx

   1 // Canvas Event for event model similar to DOM Level 3 Event Model
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef CANVAS_EVENT_HXX_
  20 #define CANVAS_EVENT_HXX_
  21
  22 #include "canvas_fwd.hxx"
  23
  24 namespace simgear
  25 {
  26 namespace canvas
  27 {
  28
  29   class Event
  30   {
  31     public:
  32
  33       enum Type
  34       {
  35         UNKNOWN,
  36 #       define ENUM_MAPPING(name, str) name,
  37 #         include "CanvasEventTypes.hxx"
  38 #       undef ENUM_MAPPING
  39         USER_TYPE ///<! first unused id to be used for user defined types (not
  40                   ///   implemented yet)
  41       };
  42
  43       Type              type;
  44       ElementWeakPtr    target;
  45       double            time;
  46       bool              propagation_stopped;
  47
  48       Event();
  49
  50       // We need a vtable to allow nasal::Ghost to determine the dynamic type
  51       // of the actual event instances.
  52       virtual ~Event();
  53
  54       Type getType() const;
  55       std::string getTypeString() const;
  56
  57       ElementWeakPtr getTarget() const;
  58
  59       double getTime() const;
  60
  61       void stopPropagation();
  62
  63       static Type strToType(const std::string& str);
  64
  65   };
  66
  67 } // namespace canvas
  68 } // namespace simgear
  69
  70 #endif /* CANVAS_EVENT_HXX_ */