vfileproperty.h

Go to the documentation of this file.

/************************************************************************
 **
 **  @file   vfileproperty.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 VFILEPROPERTY_H
#define VFILEPROPERTY_H
 
#include <qcompilerdetection.h>
#include <QMetaObject>
#include <QObject>
#include <QPointer>
#include <QString>
#include <QStringList>
#include <QStyleOptionViewItem>
#include <QVariant>
#include <Qt>
#include <QtGlobal>
 
#include "../vproperty.h"
 
namespace VPE
{
 
class VFileProperty : public VProperty
{
    Q_OBJECT
public:
    explicit VFileProperty(const QString &name);
 
    //! The destructor
    virtual ~VFileProperty() Q_DECL_OVERRIDE;
 
    //! Sets the file filters. The file filters have to be like the ones passed a QFileOpenDialog.
    virtual void setFileFilters(const QString& filefilters);
 
    //! Returns the current file filters as a string
    virtual QString getFileFilters() const;
 
    //! Set file
    virtual void setFile(const QString& file);
 
    //! Get file
    virtual QString getFile() const;
 
    //! Get the data how it should be displayed
    virtual QVariant data (int column = DPC_Name, int role = Qt::DisplayRole) const Q_DECL_OVERRIDE;
 
    //! 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;
 
    //! Sets the property's data to the editor (returns false, if the standard delegate should do that)
    virtual bool setEditorData(QWidget* editor) 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: "FileFilters" - value: File filters in the same format the QFileDialog expects it
    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;
 
    //! Returns whether this is a file (false) or a directory (true)
    virtual bool isDirectory() const;
 
    //! Sets whether this is a file (false) or a directory (true)
    virtual void setDirectory(bool is_directory);
 
private:
    Q_DISABLE_COPY(VFileProperty)
};
 
}
 
#endif // VFILEPROPERTY_H