PropertyObject.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 PROPERTYOBJECT_H
#define PROPERTYOBJECT_H
 
// Qt includes
#include <QObject>
 
// CamiTK includes
#include "CamiTKAPI.h"
#include "Property.h"
#include "InterfacePersistence.h"
 
namespace camitk {

        saveToSettings("mySection")
    \endcode
 
    See the Application class for an example of a property object load/save to settings.
 
 *  @see ObjectController, Property
 */
class CAMITK_API PropertyObject : public QObject, public InterfacePersistence {
 
    Q_OBJECT
 
public:
    PropertyObject(QString name);

    ~PropertyObject() override;

    virtual bool addProperty(Property*);

    Q_INVOKABLE virtual const camitk::Property* getProperty(QString name) const;
    Q_INVOKABLE virtual camitk::Property* getProperty(QString name);

    virtual void removeProperty(Property*);

    virtual unsigned int getNumberOfProperties() const;

    virtual QString getPropertyName(unsigned int index) const;

    virtual QVariant getPropertyValue(unsigned int index);

    virtual QVariant getPropertyValue(const QString name) const;

    void loadFromSettings(const QString& settingGroupName);

    void saveToSettings(const QString& settingGroupName);

    static QString toCamelCase(const QString&);

    virtual QVariant toVariant() const override;

    virtual void fromVariant(const QVariant&) override;

    virtual QUuid getUuid() const override;

    virtual bool setUuid(QUuid) override;
 
private:
    QMap<QString, Property*> propertiesMap;
};
 
}
 
#endif // PROPERTYOBJECT_H