libcore/swf_event.h

   1 // swf_event.h -- clip events (PlaceObject-defined)
   2 //
   3 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010,
   4 //   2011 Free Software Foundation, Inc
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 3 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19
  20 #ifndef GNASH_SWF_EVENT_H
  21 #define GNASH_SWF_EVENT_H
  22
  23 #include "event_id.h" // for composition
  24
  25 namespace gnash {
  26     class action_buffer;
  27 }
  28
  29 namespace gnash {
  30
  31 //
  32 // swf_event
  33 //
  34
  35 /// For embedding event handlers in place_object_2
  36 //
  37 /// TODO: move under parser dir !
  38 ///
  39 class swf_event
  40 {
  41 public:
  42
  43         swf_event(const event_id& ev, action_buffer& buf)
  44                 :
  45                 m_event(ev),
  46                 m_action_buffer(buf)
  47         {
  48         }
  49
  50         swf_event(const swf_event& o)
  51                 :
  52                 m_event(o.m_event),
  53                 m_action_buffer(o.m_action_buffer)
  54         {
  55         }
  56
  57         const action_buffer& action() const {
  58                 return m_action_buffer;
  59         }
  60
  61         const event_id& event() const {
  62                 return m_event;
  63         }
  64
  65 private:
  66
  67         /// System event id
  68         event_id m_event;
  69
  70         /// Action buffer associated with this event
  71         //
  72         /// The buffer is externally owned
  73         /// (by PlaceObject tag in this design)
  74         /// and may be shared between multiple swf_events
  75         ///
  76         const action_buffer& m_action_buffer;
  77
  78         /// Can't assign to an swf_event
  79         void operator=(const swf_event& /*s*/);
  80 };
  81
  82
  83 }       // end namespace gnash
  84
  85
  86 #endif // GNASH_SWF_EVENT_H