widget.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_AURORA_WIDGET_H
#define ENGINES_AURORA_WIDGET_H

#include <list>

#include <boost/noncopyable.hpp>

#include "src/common/types.h"
#include "src/common/ustring.h"

namespace Engines {

class GUI;

class Widget : boost::noncopyable {
public:
    Widget(GUI &gui, const Common::UString &tag);
    virtual ~Widget();

    const Common::UString &getTag() const; 

    virtual void setTag(const Common::UString &tag);

    bool isActive   () const; 
    bool isVisible  () const; 
    bool isDisabled () const; 
    bool isInvisible() const; 

    virtual void show(); 
    virtual void hide(); 

    Widget *getParent();
    const Widget *getParent() const;

    Widget *getChild(const Common::UString &childTag);

    virtual void setPosition(float x, float y, float z);

    virtual void movePosition(float x, float y, float z);

    virtual void getPosition(float &x, float &y, float &z) const;

    virtual float getWidth () const; 
    virtual float getHeight() const; 

    virtual void setDisabled(bool disabled);   
    virtual void setInvisible(bool invisible); 

    virtual void enter(); 
    virtual void leave(); 

    virtual void mouseMove(uint8 state, float x, float y);
    virtual void mouseDown(uint8 state, float x, float y);
    virtual void mouseUp(uint8 state, float x, float y);
    virtual void mouseWheel(uint8 state, int x, int y);

    virtual void mouseDblClick(uint8 state, float x, float y);

    virtual void subActive(Widget &widget);

    void remove(); 

    virtual void addSub(Widget &widget);         
    virtual void addChild(Widget &widget);       
    virtual void addGroupMember(Widget &widget); 

    virtual void removeSub(Widget &widget);         
    virtual void removeChild(Widget &widget);       
    virtual void removeGroupMember(Widget &widget); 

protected:
    GUI *_gui; 

    Common::UString _tag; 

    Widget *_parent; 
    Widget *_owner;  

    std::list<Widget *> _subWidgets;   
    std::list<Widget *> _children;     
    std::list<Widget *> _groupMembers; 

    virtual void signalGroupMemberActive();

    void setActive(bool active); 
    void raiseCallbackActive(Widget &widget);

private:
    bool _active;    
    bool _visible;   
    bool _disabled;  
    bool _invisible; 

    float _x; 
    float _y; 
    float _z; 

    uint8  _lastClickButton;
    uint32 _lastClickTime;
    float  _lastClickX;
    float  _lastClickY;

    friend class GUI;
};

} // End of namespace Engines

#endif // ENGINES_AURORA_WIDGET_H