libcore/Button.h

   1 //
   2 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software
   3 //   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
  20 // SWF buttons.  Mouse-sensitive update/display, actions, etc.
  21
  22
  23 #ifndef GNASH_BUTTON_H
  24 #define GNASH_BUTTON_H
  25
  26 #include "smart_ptr.h"
  27 #include "InteractiveObject.h" // for inheritance
  28
  29 #include <boost/intrusive_ptr.hpp>
  30 #include <vector>
  31 #include <set>
  32
  33 // Forward declarations.
  34 namespace gnash {
  35     namespace SWF {
  36         class DefineButtonTag;
  37     }
  38 }
  39
  40 namespace gnash {
  41 //
  42 // Button
  43 //
  44
  45 class Button : public InteractiveObject
  46 {
  47 public:
  48
  49         typedef std::vector<DisplayObject*> DisplayObjects;
  50         typedef std::vector<const DisplayObject*> ConstDisplayObjects;
  51
  52     /// A container for holding the id of active button records.
  53     typedef std::set<int> ActiveRecords;
  54
  55         enum mouse_flags
  56         {
  57                 FLAG_IDLE = 0,
  58                 FLAG_OVER = 1,
  59                 FLAG_DOWN = 2,
  60                 OVER_DOWN = FLAG_OVER | FLAG_DOWN,
  61
  62                 // aliases
  63                 OVER_UP = FLAG_OVER,
  64                 OUT_DOWN = FLAG_DOWN
  65         };
  66
  67         enum MouseState
  68         {
  69                 MOUSESTATE_UP = 0,
  70                 MOUSESTATE_DOWN,
  71                 MOUSESTATE_OVER,
  72                 MOUSESTATE_HIT
  73         };
  74
  75     /// Construct a Button
  76     //
  77     /// A button should always have an associated object.
  78         Button(as_object* object, const SWF::DefineButtonTag* def,
  79             DisplayObject* parent);
  80
  81         ~Button();
  82
  83     static const char* mouseStateName(MouseState s);
  84
  85         bool mouseEnabled() const { return true; }
  86
  87     virtual bool trackAsMenu();
  88
  89         // called from keypress listener only
  90         void notifyEvent(const event_id& id);
  91
  92     /// Render this Button.
  93         virtual void display(Renderer& renderer, const Transform& xform);
  94
  95         void set_current_state(MouseState new_state);
  96
  97         /// \brief
  98         /// Return the topmost entity that the given point covers.
  99         /// NULL if none.
 100         //
 101         /// I.e. check against ourself.
 102         ///
 103         virtual InteractiveObject* topmostMouseEntity(boost::int32_t x,
 104             boost::int32_t y);
 105
 106         virtual void mouseEvent(const event_id& event);
 107
 108     virtual bool handleFocus();
 109
 110         void add_invalidated_bounds(InvalidatedRanges& ranges, bool force);
 111
 112         virtual SWFRect getBounds() const;
 113
 114         // See dox in DisplayObject.h
 115         bool pointInShape(boost::int32_t x, boost::int32_t y) const;
 116
 117         bool isEnabled();
 118
 119         /// Properly destroy contained DisplayObjects
 120         void destroy();
 121
 122     /// Do ActionScript construction of the Button.
 123     //
 124     /// (1) Register this button instance as a live DisplayObject
 125     /// (2) Construct all button state DisplayObjects.
 126     //
 127     /// @param init     An init object, which can be passed when constructing
 128     ///                 Buttons with attachMovie, but is never used.
 129     virtual void construct(as_object* init = 0);
 130
 131 #ifdef USE_SWFTREE
 132         // Override to append button DisplayObjects info, see dox in DisplayObject.h
 133         virtual InfoTree::iterator getMovieInfo(InfoTree& tr,
 134             InfoTree::iterator it);
 135 #endif
 136
 137 protected:
 138
 139         /// Properly unload contained DisplayObjects
 140         virtual bool unloadChildren();
 141
 142         /// Mark reachable resources (for the GC)
 143         //
 144         /// These are:
 145         ///     - this char's definition (_def)
 146         ///     - the vector of state DisplayObjects (_stateCharacters)
 147         ///     - the vector of hit DisplayObjects (_hitCharacters)
 148         ///
 149         void markOwnResources() const;
 150
 151 private:
 152
 153         /// Returns all DisplayObjects that are active based on the current state.
 154         //
 155         /// The "_visible" property does not matter here.
 156         ///
 157         /// @param list
 158         ///     The container to push active DisplayObjects into
 159         ///
 160         /// @param includeUnloaded
 161         ///     If true, include unloaded but still reachable chars in the records slot.
 162         ///
 163         void getActiveCharacters(DisplayObjects& list, bool includeUnloaded=false);
 164
 165     /// Returns all DisplayObjects that are active based on the current state.
 166     //
 167     /// This is a const method because the returned DisplayObjects cannot be
 168     /// modified.
 169     ///
 170     /// @param list     The container to push unmodifiable DisplayObjects into.
 171         void getActiveCharacters(ConstDisplayObjects& list) const;
 172
 173         /// Returns all DisplayObjects (record nums) that should be active on
 174     /// the given state.
 175         //
 176         /// @param list
 177         ///     The set to push active DisplayObjects record number into
 178         ///
 179         /// @param state
 180         ///     The state we're interested in
 181         ///
 182         void get_active_records(ActiveRecords& list, MouseState state);
 183
 184         /// Return version of the SWF containing the button definition.
 185     virtual int getDefinitionVersion() const;
 186
 187         MouseState _mouseState;
 188
 189     const boost::intrusive_ptr<const SWF::DefineButtonTag> _def;
 190
 191         DisplayObjects _stateCharacters;
 192
 193         DisplayObjects _hitCharacters;
 194
 195
 196 };
 197
 198
 199 /// Initialize the global Button class
 200 void button_class_init(as_object& global, const ObjectURI& uri);
 201
 202 void registerButtonNative(as_object& global);
 203
 204 }       // end namespace gnash
 205
 206
 207 #endif // GNASH_BUTTON_H
 208
 209
 210 // Local Variables:
 211 // mode: C++
 212 // c-basic-offset: 8
 213 // tab-width: 8
 214 // indent-tabs-mode: t
 215 // End: