qgsfilewidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsfilewidget.h

 ---------------------
 begin                : 17.12.2015
 copyright            : (C) 2015 by Denis Rouzaud
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSFILEWIDGET_H
#define QGSFILEWIDGET_H

class QLabel;
class QToolButton;
class QVariant;

class QgsFilterLineEdit;

#include <QWidget>

class GUI_EXPORT QgsFileWidget : public QWidget
{
    Q_OBJECT
    Q_PROPERTY( bool fileWidgetButtonVisible READ fileWidgetButtonVisible WRITE setFileWidgetButtonVisible )
    Q_PROPERTY( bool useLink READ useLink WRITE setUseLink )
    Q_PROPERTY( bool fullUrl READ fullUrl WRITE setFullUrl )
    Q_PROPERTY( QString dialogTitle READ dialogTitle WRITE setDialogTitle )
    Q_PROPERTY( QString filter READ filter WRITE setFilter )
    Q_PROPERTY( QString defaultRoot READ defaultRoot WRITE setDefaultRoot )
    Q_PROPERTY( StorageMode storageMode READ storageMode WRITE setStorageMode )
    Q_PROPERTY( RelativeStorage relativeStorage READ relativeStorage WRITE setRelativeStorage )

  public:
    enum StorageMode
    {
      GetFile,
      GetDirectory
    };

    enum RelativeStorage
    {
      Absolute,
      RelativeProject,
      RelativeDefaultPath
    };

    explicit QgsFileWidget( QWidget *parent = 0 );

    ~QgsFileWidget();

    QString filePath();

    void setFilePath( QString path );

    void setReadOnly( bool readOnly );

    QString dialogTitle() const;
    void setDialogTitle( const QString& title );

    QString filter() const;
    void setFilter( const QString &filter );

    bool fileWidgetButtonVisible() const;
    void setFileWidgetButtonVisible( bool visible );

    bool useLink() const;
    void setUseLink( bool useLink );

    bool fullUrl() const;
    void setFullUrl( bool fullUrl );

    QString defaultRoot() const;
    void setDefaultRoot( const QString& defaultRoot );

    QgsFileWidget::StorageMode storageMode() const;
    void setStorageMode( QgsFileWidget::StorageMode storageMode );

    QgsFileWidget::RelativeStorage relativeStorage() const;
    void setRelativeStorage( QgsFileWidget::RelativeStorage relativeStorage );

  signals:
    void fileChanged( const QString& );

  private slots:
    void openFileDialog();
    void textEdited( const QString& path );

  private:
    QString mFilePath;
    bool mButtonVisible;
    bool mUseLink;
    bool mFullUrl;
    QString mDialogTitle;
    QString mFilter;
    QString mDefaultRoot;
    StorageMode mStorageMode;
    RelativeStorage mRelativeStorage;

    QLabel* mLinkLabel;
    QgsFilterLineEdit* mLineEdit;
    QToolButton* mFileWidgetButton;

    QString toUrl( const QString& path ) const;

    QString relativePath( const QString& filePath, bool removeRelative ) const;

    friend class TestQgsFileWidget;
};

#endif // QGSFILEWIDGET_H