Property.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 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 PROPERTY_H
#define PROPERTY_H
 
#include <QVariant>
#include <QStringList>
#include <QIcon>
 
#include "CamiTKAPI.h"
 
namespace camitk {
 
class CAMITK_API Property {
 
public:
    Property(QString name, const QVariant& variant, QString description, QString unit);
 
    Property(Property&);
 
    virtual ~Property() = default;
 
    const QString& getName() const;
 
    const QVariant& getInitialValue() const;
 
    void setReadOnly(bool);
 
    bool getReadOnly() const;
 
    void setDescription(QString);
 
    const QString& getDescription() const;
 
    void setUnit(QString);
 
    const QString& getUnit() const;
 
    void setAttribute(const QString& attribute, const QVariant& value);
 
    QVariant getAttribute(QString attName);
 
    QStringList getAttributeList();
 
    void setEnumTypeName(QString);
 
    void setEnumTypeName(QString enumTypeName, QObject* objectDeclaringTheEnum);
 
    QString getEnumTypeName() const;
 
    QString getEnumValueAsString(const QObject* objectDeclaringTheEnum) const;
 
    QMap<int, QIcon> getEnumIcons() const;
 
    void setEnumIcons(const QMap<int, QIcon>& enumIcons);
 
    void setGroupName(QString groupName);
 
    QString getGroupName() const;
 
    static Property* getProperty(QObject* object, QString name);
 
    static QJsonObject getPropertyInformation(QObject* object, QString name);
 
    static QString getValueAsString(QVariant v);
 
private:
    QString name;
 
    QString groupName;
 
    QVariant initialValue;
 
    QString description;
 
    QString unit;
 
    bool readOnly;
 
    QMap<QString, QVariant> attributeValues;
 
    QString enumTypeName;
 
    QMap<int, QIcon> enumIcons;
};
 
}
 
#endif // PROPERTY_H