paramEditorWidget.h

/* ********************************************************************
itom measurement system
URL: http://www.uni-stuttgart.de/ito
Copyright (C) 2020, Institut fuer Technische Optik (ITO),
Universitaet Stuttgart, Germany

This file is part of itom.

itom 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.

itom 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 itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef PARAMEDITORWIDGET_H
#define PARAMEDITORWIDGET_H


#include "commonWidgets.h"

#include "common/sharedStructuresQt.h"
#include "common/param.h"

#include <qwidget.h>
#include <qscopedpointer.h>
#include <qpointer.h>
#include <qvector.h>

class ParamEditorModel;
class ParamEditorWidgetPrivate;
class QtProperty;
class QtBrowserItem;
class QTimerEvent;

namespace ito {
        class AddInBase; //forward declaration
};

class ITOMWIDGETS_EXPORT ParamEditorWidget : public QWidget
{
    Q_OBJECT

        Q_PROPERTY(QPointer<ito::AddInBase> plugin READ plugin WRITE setPlugin)
    Q_PROPERTY(int indentation READ indentation WRITE setIndentation)
    Q_PROPERTY(bool rootIsDecorated READ rootIsDecorated WRITE setRootIsDecorated)
    Q_PROPERTY(bool alternatingRowColors READ alternatingRowColors WRITE setAlternatingRowColors)
    Q_PROPERTY(bool headerVisible READ isHeaderVisible WRITE setHeaderVisible)
    Q_PROPERTY(ResizeMode resizeMode READ resizeMode WRITE setResizeMode)
    Q_PROPERTY(int splitterPosition READ splitterPosition WRITE setSplitterPosition)
    Q_PROPERTY(bool propertiesWithoutValueMarked READ propertiesWithoutValueMarked WRITE setPropertiesWithoutValueMarked)
    Q_PROPERTY(bool readonly READ readonly WRITE setReadonly)
    Q_PROPERTY(bool showDescriptions READ showDescriptions WRITE setShowDescriptions)
    Q_PROPERTY(QStringList filteredCategories READ filteredCategories WRITE setFilteredCategories)
    Q_PROPERTY(bool immediatelyModifyPluginParamsAfterChange READ immediatelyModifyPluginParamsAfterChange WRITE setImmediatelyModifyPluginParamsAfterChange)
    Q_PROPERTY(int numChangedParameters READ numberOfChangedParameters)
        Q_PROPERTY(bool collapsed READ collapsed WRITE setCollapsed)
    Q_PROPERTY(bool popupSlider READ popupSlider WRITE setPopupSlider);

    Q_CLASSINFO("prop://plugin", "Actuator or dataIO instance whose parameters are observed and set by this widget.")
    Q_CLASSINFO("prop://indentation", "Indentation level of child items in the tree.")
    Q_CLASSINFO("prop://rootIsDecorated", "Slightly changes the visualization of root and child elements.")
    Q_CLASSINFO("prop://alternatingRowColors", "En- or disables alternating row colors.")
    Q_CLASSINFO("prop://headerVisible", "Indicates if the header line (property, value) is visible.")
    Q_CLASSINFO("prop://resizeMode", "Sets the mode how the columns can be resized.")
    Q_CLASSINFO("prop://splitterPosition", "Width of the first column (not possible if resizeMode is set to Stretch).")
    Q_CLASSINFO("prop://propertiesWithoutValueMarked", "If True, category values are marked with a dark gray background.")
    Q_CLASSINFO("prop://readonly", "Indicates if widget is readonly or if values can be changed.")
    Q_CLASSINFO("prop://showDescriptions", "If True, a text box is visible below the properties to show an information text about the currently set entry.")
    Q_CLASSINFO("prop://filteredCategories", "If empty, all categories are shown. Else pass a list of category names to only show these categories.")
    Q_CLASSINFO("prop://immediatelyModifyPluginParamsAfterChange", "If true (default), changed values in the widget will be immediately sent to the connected plugin, calling its 'setParam' method. Else, changed values will be stored in a temporary list and can be sent later (using applyChangedParameters).")
    Q_CLASSINFO("prop://numChangedParameters", "Number of changed parameters, that have not been applied to the plugin yet.")
        Q_CLASSINFO("prop://collapsed", "If true, collapse all items in the tree or load new items collapsed, else expand the full tree. (default: false)")
    Q_CLASSINFO("prop://popupSlider", "If a slider widget (slider + spinbox) is used for corresponding floating point number parameters, the slider is displayed as popup window when hovering the spinbox. If false, the slider is always displayed left to the spinbox.")

public:
    enum ResizeMode
    {
        Interactive,
        Stretch,
        Fixed,
        ResizeToContents
    };

    //Q_ENUM exposes a meta object to the enumeration types, such that the key names for the enumeration
    //values are always accessible.
    Q_ENUM(ResizeMode)

    
        ParamEditorWidget(QWidget* parent = 0);
    
        virtual ~ParamEditorWidget();

        QPointer<ito::AddInBase> plugin() const;
        void setPlugin(QPointer<ito::AddInBase> plugin);

    void refresh();

    int indentation() const;
    void setIndentation(int i);

        bool collapsed() const;
        void setCollapsed(bool c);

    bool popupSlider() const;
    void setPopupSlider(bool popup);

    bool rootIsDecorated() const;
    void setRootIsDecorated(bool show);

    bool alternatingRowColors() const;
    void setAlternatingRowColors(bool enable);

    bool readonly() const;
    void setReadonly(bool enable);

    bool isHeaderVisible() const;
    void setHeaderVisible(bool visible);

    ResizeMode resizeMode() const;
    void setResizeMode(ResizeMode mode);

    int splitterPosition() const;
    void setSplitterPosition(int position);

    void setPropertiesWithoutValueMarked(bool mark);
    bool propertiesWithoutValueMarked() const;

    void setShowDescriptions(bool show);
    bool showDescriptions() const;

    void setFilteredCategories(const QStringList &filteredCategories);
    QStringList filteredCategories() const;

    void setImmediatelyModifyPluginParamsAfterChange(bool immediateChange);
    bool immediatelyModifyPluginParamsAfterChange() const;

    int numberOfChangedParameters() const;

    QVector<QSharedPointer<ito::ParamBase> > getAndResetChangedParameters();

protected:
    enum MessageLevel 
    {
        msgLevelNo = 0,          
        msgLevelErrorOnly = 1,   
        msgLevelWarningOnly = 2, 
        msgLevelWarningAndError = msgLevelErrorOnly | msgLevelWarningOnly 
    };

    ito::RetVal setPluginParameter(QSharedPointer<ito::ParamBase> param, MessageLevel msgLevel = msgLevelWarningAndError) const;
    ito::RetVal setPluginParameters(const QVector<QSharedPointer<ito::ParamBase> > params, MessageLevel msgLevel = msgLevelWarningAndError) const;
    ito::RetVal observeInvocation(ItomSharedSemaphore *waitCond, MessageLevel msgLevel) const;

    ito::RetVal addParam(const ito::Param &param);
    ito::RetVal addParamInt(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamChar(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamDouble(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamString(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamOthers(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamInterval(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamRect(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamIntArray(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamCharArray(const ito::Param &param, QtProperty *groupProperty);
    ito::RetVal addParamDoubleArray(const ito::Param &param, QtProperty *groupProperty);

    ito::RetVal loadPlugin(QPointer<ito::AddInBase> plugin);

protected:
    void timerEvent(QTimerEvent *event);

private:
        QScopedPointer<ParamEditorWidgetPrivate> d_ptr;

        Q_DECLARE_PRIVATE(ParamEditorWidget);
        Q_DISABLE_COPY(ParamEditorWidget);

private slots:
    void valueChanged(QtProperty* prop, int value);
    void valueChanged(QtProperty* prop, char value);
    void valueChanged(QtProperty* prop, double value);
    void valueChanged(QtProperty* prop, int num, const char* values);
    void valueChanged(QtProperty* prop, int num, const int* values);
    void valueChanged(QtProperty* prop, int num, const double* values);
    void valueChanged(QtProperty* prop, const QByteArray &value);
    void valueChanged(QtProperty* prop, int min, int max);
    void valueChanged(QtProperty* prop, int left, int top, int width, int height);

    void currentItemChanged(QtBrowserItem *);

    void parametersChanged(QMap<QString, ito::Param> parameters);

public slots:
    ito::RetVal applyChangedParameters();

};

#endif