vnumberproperty.h

Go to the documentation of this file.

/************************************************************************
 **
 **  @file   vnumberproperty.h
 **  @author hedgeware <internal(at)hedgeware.net>
 **  @date
 **
 **  @brief
 **  @copyright
 **  All rights reserved. This program and the accompanying materials
 **  are made available under the terms of the GNU Lesser General Public License
 **  (LGPL) version 2.1 which accompanies this distribution, and is available at
 **  http://www.gnu.org/licenses/lgpl-2.1.html
 **
 **  This library 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 for more details.
 **
 *************************************************************************/
 
#ifndef VNUMBERPROPERTY_H
#define VNUMBERPROPERTY_H
 
#include <qcompilerdetection.h>
#include <stddef.h>
#include <QMap>
#include <QMetaObject>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QStyleOptionViewItem>
#include <QVariant>
#include <QtGlobal>
 
#include "../vproperty.h"
 
namespace VPE
{
 
 
//! Class for holding an integer property
class SpinboxProperty : public VProperty
{
    Q_OBJECT
public:
    SpinboxProperty(const QString &name, const QMap<QString, QVariant> &settings);
 
    explicit SpinboxProperty(const QString &name);
 
    //! Returns an editor widget, or NULL if it doesn't supply one
    //! \param parent The widget to which the editor will be added as a child
    //! \options Render options
    //! \delegate A pointer to the QAbstractItemDelegate requesting the editor. This can be used to connect signals and
    //! slots.
    virtual QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &options,
                                  const QAbstractItemDelegate *delegate) Q_DECL_OVERRIDE;
 
    //! Gets the data from the widget
    virtual QVariant getEditorData(const QWidget *editor) const Q_DECL_OVERRIDE;
 
    //! Sets the settings. Available settings:
    //!
    //! key: "Min" - value: Minimum number as integer
    //! key: "Max" - value: Maximum number as integer
    virtual void setSetting(const QString &key, const QVariant &value) Q_DECL_OVERRIDE;
 
    //! Get the settings. This function has to be implemented in a subclass in order to have an effect
    virtual QVariant getSetting(const QString &key) const Q_DECL_OVERRIDE;
 
    //! Returns the list of keys of the property's settings
    virtual QStringList getSettingKeys() const Q_DECL_OVERRIDE;
 
    //! Returns a string containing the type of the property
    virtual QString type() const Q_DECL_OVERRIDE;
 
    //! Clones this property
    //! \param include_children Indicates whether to also clone the children
    //! \param container If a property is being passed here, no new VProperty is being created but instead it is tried
    //! to fill all the data into container. This can also be used when subclassing this function.
    //! \return Returns the newly created property (or container, if it was not NULL)
    Q_REQUIRED_RESULT virtual VProperty *clone(bool include_children = true,
                                               VProperty *container = nullptr) const Q_DECL_OVERRIDE;
public slots:
    void valueChanged(int i);
protected:
    double minValue, maxValue, singleStep;
 
    static const int StandardMin;// = -1000000;
    static const int StandardMax;// = 1000000;
 
private:
    Q_DISABLE_COPY(SpinboxProperty)
};
 
 
//! Class for holding a double property
class DoubleSpinboxProperty : public SpinboxProperty
{
    Q_OBJECT
public:
    DoubleSpinboxProperty(const QString &name, const QMap<QString, QVariant> &settings);
 
    explicit DoubleSpinboxProperty(const QString &name);
 
    //! Returns an editor widget, or NULL if it doesn't supply one
    //! \param parent The widget to which the editor will be added as a child
    //! \options Render options
    //! \delegate A pointer to the QAbstractItemDelegate requesting the editor. This can be used to connect signals and
    //! slots.
    virtual QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &options,
                                  const QAbstractItemDelegate *delegate);
 
    //! Gets the data from the widget
    virtual QVariant getEditorData(const QWidget *editor) const;
 
    //! Sets the settings. Available settings:
    //!
    //! key: "Min" - value: Minimum number as integer
    //! key: "Max" - value: Maximum number as integer
    virtual void setSetting(const QString &key, const QVariant &value);
 
    //! Get the settings. This function has to be implemented in a subclass in order to have an effect
    virtual QVariant getSetting(const QString &key) const;
 
    //! Returns the list of keys of the property's settings
    virtual QStringList getSettingKeys() const;
 
    //! Returns a string containing the type of the property
    virtual QString type() const;
 
    //! Clones this property
    //! \param include_children Indicates whether to also clone the children
    //! \param container If a property is being passed here, no new VProperty is being created but instead it is tried
    //! to fill all the data into container. This can also be used when subclassing this function.
    //! \return Returns the newly created property (or container, if it was not NULL)
    virtual VProperty *clone(bool include_children = true, VProperty *container = NULL) const;
 
protected:
    //! Number of decimals after the decimal point
    int Precision;
 
    const static double StandardPrecision;// = 5;
 
private:
    Q_DISABLE_COPY(DoubleSpinboxProperty)
};
 
 
}
 
#endif // VNUMBERPROPERTY_H