libcore/asobj/AsBroadcaster.h

   1 //
   2 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010,
   3 //   2011 Free Software Foundation, Inc
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program 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
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19 #ifndef GNASH_ASBROADCASTER_H
  20 #define GNASH_ASBROADCASTER_H
  21
  22 // Forward declarations
  23 namespace gnash {
  24         class as_value;
  25         class as_object;
  26         class fn_call;
  27     struct ObjectURI;
  28 }
  29
  30 namespace gnash {
  31
  32 /// AsBroadcaster facilities
  33 class AsBroadcaster {
  34
  35 public:
  36
  37         /// Initialize the given object as an AsBroadcaster
  38         //
  39         /// This method set the addListener,removeListener and broadcastMessage
  40         /// AS methods with the object, and set the _listners array member.
  41         ///
  42         /// It is exposed so that Stage,TextField,Key,Mouse and Selection
  43         /// can call this internally.
  44         ///
  45         /// The AsBroadcaster_init will take care of registering
  46         /// the _global.AsBroadcaster object and its 'initialize'
  47         /// method for user-defined broadcasters initialization
  48         ///
  49         static void initialize(as_object& obj);
  50
  51         /// Return the global AsBroadcaster
  52         /// (the native one, immune to any override)
  53         ///
  54         static as_object* getAsBroadcaster();
  55
  56     static void registerNative(as_object &global);
  57
  58     static void init(as_object& global, const ObjectURI& uri);
  59
  60 };
  61
  62 } // end of gnash namespace
  63
  64 #endif
  65