experiments/include/componentui.h

/********************************************************************************
 *  FARSA Experiments Library                                                   *
 *  Copyright (C) 2007-2012                                                     *
 *  Gianluca Massera <emmegian@yahoo.it>                                        *
 *  Stefano Nolfi <stefano.nolfi@istc.cnr.it>                                   *
 *  Tomassino Ferrauto <tomassino.ferrauto@istc.cnr.it>                         *
 *                                                                              *
 *  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 2 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  *
 ********************************************************************************/

#ifndef COMPONENTUI_H
#define COMPONENTUI_H

#include "experimentsconfig.h"
#include <QString>

class QMenu;
class QMenuBar;
class QWidget;

namespace farsa {

class FARSA_EXPERIMENTS_TEMPLATE ComponentUIViewer {
public:
    ComponentUIViewer() { /* nothing to do*/ };
    ComponentUIViewer( QWidget* viewer, QString menuText, QString iconFilename=QString(), QString tooltip=QString() )
        : viewer(viewer), menuText(menuText), iconFilename(iconFilename), tooltip(tooltip) { /*nothing to do*/ };
    QWidget* viewer;
    QString menuText;
    QString iconFilename;
    QString tooltip;
};

class FARSA_EXPERIMENTS_TEMPLATE ComponentUI {
public:
    virtual ~ComponentUI() { /*nothing to do*/ };
    virtual void fillActionsMenu( QMenu* actionsMenu ) = 0;
    virtual QList<ComponentUIViewer> getViewers( QWidget* parent, Qt::WindowFlags flags ) = 0;
    virtual void addAdditionalMenus( QMenuBar* menuBar ) { /*by default don't add nothing*/ };
};

} // end namespace farsa

#endif