vstringproperty.h

Go to the documentation of this file.

/************************************************************************
 **
 **  @file   vstringproperty.h
 **  @author Roman Telezhynskyi <dismine(at)gmail.com>
 **  @date   27 8, 2014
 **
 **  @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 VSTRINGPROPERTY_H
#define VSTRINGPROPERTY_H
 
#include <qcompilerdetection.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 a string property
class VStringProperty : public VProperty
{
    Q_OBJECT
public:
                        VStringProperty(const QString &name, const QMap<QString, QVariant> &settings);
 
    explicit            VStringProperty(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;
 
    void                setReadOnly(bool readOnly);
    void                setOsSeparator(bool separator);
    void                setClearButtonEnable(bool value);
 
    //! Sets the settings.
    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;
 
    virtual void        updateParent(const QVariant &value) Q_DECL_OVERRIDE;
 
    int                 getTypeForParent() const;
    void                setTypeForParent(int value);
 
protected:
    bool                readOnly;
    int                 typeForParent;
    bool                clearButton;
    bool                m_osSeparator;
 
    virtual bool        eventFilter(QObject *object, QEvent *event) Q_DECL_OVERRIDE;
 
private:
    Q_DISABLE_COPY(VStringProperty)
};
 
}
#endif // VSTRINGPROPERTY_H