Button.h

Go to the documentation of this file.

// 
//   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
//   Free Software Foundation, Inc
// 
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//

// SWF buttons.  Mouse-sensitive update/display, actions, etc.


#ifndef GNASH_BUTTON_H
#define GNASH_BUTTON_H

#include <boost/intrusive_ptr.hpp>
#include <vector>
#include <set>

#include "InteractiveObject.h" 
#include "GnashKey.h"

// Forward declarations.
namespace gnash {
    namespace SWF {
        class DefineButtonTag;
    }
}

namespace gnash {

class Button : public InteractiveObject
{
public:

    typedef std::vector<DisplayObject*> DisplayObjects;
    typedef std::vector<const DisplayObject*> ConstDisplayObjects;
    
    typedef std::set<int> ActiveRecords;

    enum mouse_flags
    {
        FLAG_IDLE = 0,
        FLAG_OVER = 1,
        FLAG_DOWN = 2,
        OVER_DOWN = FLAG_OVER | FLAG_DOWN,

        // aliases
        OVER_UP = FLAG_OVER,
        OUT_DOWN = FLAG_DOWN
    };

    enum MouseState
    {
        MOUSESTATE_UP = 0,
        MOUSESTATE_DOWN,
        MOUSESTATE_OVER,
        MOUSESTATE_HIT
    };

    //
    Button(as_object* object, const SWF::DefineButtonTag* def,
            DisplayObject* parent);

    ~Button();

    bool mouseEnabled() const { return true; }

    virtual bool trackAsMenu();

    void keyPress(key::code c);

    virtual void display(Renderer& renderer, const Transform& xform);
    
    void set_current_state(MouseState new_state);

    //
    virtual InteractiveObject* topmostMouseEntity(boost::int32_t x,
            boost::int32_t y);
    
    virtual void mouseEvent(const event_id& event);

    virtual bool handleFocus();

    void add_invalidated_bounds(InvalidatedRanges& ranges, bool force);
    
    virtual SWFRect getBounds() const;
    
    // See dox in DisplayObject.h
    bool pointInShape(boost::int32_t x, boost::int32_t y) const;

    bool isEnabled();

    void destroy();

    //
    //
    virtual void construct(as_object* init = 0);

#ifdef USE_SWFTREE
    // Override to append button DisplayObjects info, see dox in DisplayObject.h
    virtual InfoTree::iterator getMovieInfo(InfoTree& tr,
            InfoTree::iterator it);
#endif

protected:
    
    virtual bool unloadChildren();

    //
    void markOwnResources() const;

private:

    //
    void getActiveCharacters(DisplayObjects& list, bool includeUnloaded=false);

    //
    void getActiveCharacters(ConstDisplayObjects& list) const;

    //
    void get_active_records(ActiveRecords& list, MouseState state);

    virtual int getDefinitionVersion() const;
    
    MouseState _mouseState;
    
    const boost::intrusive_ptr<const SWF::DefineButtonTag> _def;

    DisplayObjects _stateCharacters;

    DisplayObjects _hitCharacters;

};

std::ostream& operator<<(std::ostream& o, const Button::MouseState& st);

void button_class_init(as_object& global, const ObjectURI& uri);

void registerButtonNative(as_object& global);

} // namespace gnash


#endif // GNASH_BUTTON_H


// Local Variables:
// mode: C++
// c-basic-offset: 8 
// tab-width: 8
// indent-tabs-mode: t
// End: