guielement.h

/*
 * Orca-Robotics Project: Components for robotics 
 *               http://orca-robotics.sf.net/
 * Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This copy of Orca is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef HYDROQGUI_GUI_ELEMENT_H
#define HYDROQGUI_GUI_ELEMENT_H

#include <string>
#include <assert.h>
#include <QString>
#include <QColor>
#include <QMouseEvent>
#include <hydroutil/uncopyable.h>
#include <hydroqguielementutil/ihumanmanager.h>
#include <hydroqguielementutil/mouseeventmanager.h>
#include <hydroqguielementutil/shortcutkeymanager.h>

class QSplitter;

namespace hydroqgui {
    class GuiElementSet;
};

namespace hydroqguielementutil
{

struct GuiElementInfo 
{
    GuiElementInfo( const char *pPlatform,
                    const char *pUniqueId,
                    const char *pType )
        : platform(pPlatform),
          uniqueId(pUniqueId),
          type(pType)
        {}
    QString platform;
    QString uniqueId;
    QString type;
};


struct GuiElementStuff 
{
    GuiElementStuff() :
        humanManager(0),
        mouseEventManager(0),
        shortcutKeyManager(0),
        guiElementSet(0),
        spaceBottomRight(0)
    {};

    IHumanManager*      humanManager;
    MouseEventManager*  mouseEventManager;
    ShortcutKeyManager* shortcutKeyManager;
    hydroqgui::GuiElementSet* guiElementSet;
    QSplitter* spaceBottomRight;
};


class GuiElement : public hydroutil::Uncopyable
{                                 
public:
    
    GuiElement( const GuiElementInfo &guiElementInfo )
        : platform_(guiElementInfo.platform),
          uniqueId_(guiElementInfo.uniqueId),
          type_(guiElementInfo.type)
        {}
    
    virtual ~GuiElement() {};

    virtual bool isInGlobalCS() { return false; };

    virtual bool isPermanentElement() const { return false; }

    virtual void update () {};

    virtual QStringList contextMenu() { return QStringList(); };
    
    virtual void execute( int action ) {};
    
    virtual void setColor( QColor color ) {};

    virtual void setUseTransparency( bool useTransparency ) {};

    virtual void setFocus( bool inFocus ) {};
    
    virtual void noLongerMouseEventReceiver() {assert(!"unimplemented noLongerMouseEventReceiver");}

    virtual void mousePressEvent(QMouseEvent *e) {assert(!"unimplemented mouse function");}
    virtual void mouseMoveEvent(QMouseEvent *e) {assert(!"unimplemented mouse function");}
    virtual void mouseReleaseEvent(QMouseEvent *e) {assert(!"unimplemented mouse function");}
    virtual void mouseDoubleClickEvent(QMouseEvent *e) {assert(!"unimplemented mouse function");} 
    
    QString platform() { return platform_; };
    
    QString uniqueId() { return uniqueId_; };
    
    QString type() { return type_; };  

    static void setGuiElementStuff( const GuiElementStuff& stuff ) { _stuff=stuff; };
    
protected :

    static GuiElementStuff _stuff;

private:
    QString platform_;
    QString uniqueId_;
    QString type_;
};

} // namespace

#endif