Viewer.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef VIEWER_H
#define VIEWER_H
 
// -- Core stuff
#include "CamiTKAPI.h"
 
// -- QT stuff
#include <QObject>
#include <QPixmap>
 
// -- QT stuff classes
class QToolBar;
class QMenu;
class QPixMap;
class QWidget;
class QDockWidget;
class QLayout;
 
namespace camitk {
class Component;
class ViewerExtension;
class Property;
class PropertyObject;
class ViewerDockStyle;
 
class CAMITK_API Viewer : public QObject {
    Q_OBJECT
 
public:
 
    enum ViewerType {
        EMBEDDED,    
        DOCKED,      
    };
 
    Q_ENUM(ViewerType)
 
    
    Viewer(QString name, ViewerType type = EMBEDDED);
 
    virtual ~Viewer() override;
 
    QString getName() const {
        return name;
    };
 
    QString getDescription() const {
        return description;
    };
 
    void setType(ViewerType);
 
    ViewerType getType();
 
    virtual bool setDockWidget(QDockWidget*);
 
    virtual QDockWidget* getDockWidget();
 
    virtual bool setEmbedder(QLayout*);
 
    virtual QLayout* getEmbedder();
 
    virtual void refresh(Viewer* whoIsAsking = nullptr) = 0;
 
    virtual PropertyObject* getPropertyObject() {
        return nullptr;
    };
 
    virtual QMenu* getMenu() {
        return nullptr;
    };
 
    virtual QToolBar* getToolBar() {
        return nullptr;
    };
 
    virtual void setVisible(bool);
 
    virtual void setToolBarVisibility(bool);
 
    virtual bool getToolBarVisibility();
 
    virtual QPixmap getIcon();
 
 
    CAMITK_API_DEPRECATED("Please use getComponentClassNames() instead") QStringList getComponents();
    QStringList getComponentClassNames();
 
signals:
 
    void selectionChanged();
 
protected:
    virtual QWidget* getWidget() = 0;
 
    void selectionChanged(ComponentList& compSet);
 
    void selectionChanged(Component* comp);
 
    void clearSelection();
 
    void setIcon(QPixmap icon);
 
 
    CAMITK_API_DEPRECATED("Please use setComponentClassNames() instead") void setComponents(QStringList);
    void setComponentClassNames(QStringList);
 
    void setDescription(QString);
 
private:
    QString name;
 
    QString description;
 
    bool toolbarVisibility;
 
    QPixmap icon;
 
    ViewerDockStyle* dockWidgetStyle;
 
    QStringList componentClassNames;
 
    ViewerType type;
 
    QDockWidget* dockWidget;
 
    QLayout* embedder;
};
 
}
 
#endif // VIEWER_H