simgear/canvas/events/CustomEvent.hxx

   1 ///@file Canvas user defined event
   2 //
   3 // Copyright (C) 2014  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_CUSTOM_EVENT_HXX_
  20 #define CANVAS_CUSTOM_EVENT_HXX_
  21
  22 #include <simgear/canvas/CanvasEvent.hxx>
  23 #include <simgear/structure/map.hxx>
  24
  25 namespace simgear
  26 {
  27 namespace canvas
  28 {
  29
  30   class CustomEvent:
  31     public Event
  32   {
  33     public:
  34
  35       /**
  36        *
  37        * @param type_str    Event type name (if name does not exist yet it will
  38        *                    be registered as new event type)
  39        * @param data        Optional user data stored in event
  40        */
  41       CustomEvent( std::string const& type_str,
  42                    bool bubbles = false,
  43                    StringMap const& data = StringMap() );
  44
  45       /**
  46        *
  47        * @param type_id     Event type id
  48        * @param data        Optional user data stored in event
  49        */
  50       CustomEvent( int type_id,
  51                    bool bubbles = false,
  52                    StringMap const& data = StringMap() );
  53
  54       /**
  55        * Set user data
  56        */
  57       void setDetail(StringMap const& data);
  58
  59       /**
  60        * Get user data
  61        */
  62       StringMap const& getDetail() const { return detail; }
  63
  64       virtual bool canBubble() const { return bubbles; }
  65
  66       StringMap detail; //<! user data map
  67       bool bubbles;
  68   };
  69
  70 } // namespace canvas
  71 } // namespace simgear
  72
  73 #endif /* CANVAS_CUSTOM_EVENT_HXX_ */