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 QHBoxLayout;
class QgsFileDropEdit;
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgshighlightablelineedit.h"
 
#include <QFileDialog>
#include <QWidget>

class GUI_EXPORT QgsFileWidget : public QWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsFileWidget *>( sipCpp ) )
      sipType = sipType_QgsFileWidget;
    else
      sipType = NULL;
    SIP_END
#endif
 
    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 )
    Q_PROPERTY( QFileDialog::Options options READ options WRITE setOptions )
 
  public:

    enum StorageMode
    {
      GetFile,          
      GetDirectory,     
      GetMultipleFiles, 
      SaveFile,         
    };
    Q_ENUM( StorageMode )
 
    
    enum RelativeStorage
    {
      Absolute,
      RelativeProject,
      RelativeDefaultPath
    };
    Q_ENUM( RelativeStorage )
 
    
    explicit QgsFileWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QString filePath() const;

    static QStringList splitFilePaths( const QString &path );

    void setFilePath( const QString &path );

    virtual void setReadOnly( bool readOnly );

    QString dialogTitle() const;

    void setDialogTitle( const QString &title );

    QString filter() const;

    void setFilter( const QString &filter );

    QFileDialog::Options options() const;

    void setOptions( QFileDialog::Options options );

    void setSelectedFilter( const QString &selectedFilter ) { mSelectedFilter = selectedFilter; }

    QString selectedFilter() const { return mSelectedFilter; }

    void setConfirmOverwrite( bool confirmOverwrite ) { mConfirmOverwrite = confirmOverwrite; }

    bool confirmOverwrite() const { return mConfirmOverwrite; }

    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 );

    QgsFilterLineEdit *lineEdit();
 
  signals:

    void fileChanged( const QString &path );
 
  private slots:
    void openFileDialog();
    void textEdited( const QString &path );
    void editLink();
    void fileDropped( const QString &filePath );
 
  protected:

    virtual void updateLayout();

    virtual void setSelectedFileNames( QStringList fileNames );

    static bool isMultiFiles( const QString &path );

    void setFilePaths( const QStringList &filePaths );
 
    QString mFilePath;
    bool mButtonVisible = true;
    bool mUseLink = false;
    bool mFullUrl = false;
    bool mReadOnly = false;
    bool mIsLinkEdited = false;
    QString mDialogTitle;
    QString mFilter;
    QString mSelectedFilter;
    QString mDefaultRoot;
    bool mConfirmOverwrite = true;
    StorageMode mStorageMode = GetFile;
    RelativeStorage mRelativeStorage = Absolute;
    QFileDialog::Options mOptions = QFileDialog::Options();
 
    QLabel *mLinkLabel = nullptr;
    QgsFileDropEdit *mLineEdit = nullptr;
    QToolButton *mLinkEditButton = nullptr;
    QToolButton *mFileWidgetButton = nullptr;
    QHBoxLayout *mLayout = nullptr;

    QString toUrl( const QString &path ) const;

    QString relativePath( const QString &filePath, bool removeRelative ) const;
 
    // QWidget interface
  public:
    QSize minimumSizeHint() const override;
 
    friend class TestQgsFileWidget;
    friend class TestQgsExternalStorageFileWidget;
    friend class TestQgsExternalResourceWidgetWrapper;
};

 
 
#ifndef SIP_RUN

class GUI_EXPORT QgsFileDropEdit : public QgsHighlightableLineEdit
{
    Q_OBJECT
 
  public:
    QgsFileDropEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    void setStorageMode( QgsFileWidget::StorageMode storageMode ) { mStorageMode = storageMode; }
 
    void setFilters( const QString &filters );

    QStringList acceptableFilePaths( QDropEvent *event ) const;
 
  signals:

    void fileDropped( const QString &filePath );
 
  protected:
    QString acceptableFilePath( QDropEvent *event ) const;
 
    void dragEnterEvent( QDragEnterEvent *event ) override;
    void dragLeaveEvent( QDragLeaveEvent *event ) override;
    void dropEvent( QDropEvent *event ) override;
 
  private:
    QStringList mAcceptableExtensions;
    QgsFileWidget::StorageMode mStorageMode = QgsFileWidget::GetFile;
    friend class TestQgsFileWidget;
};
 
#endif
 
#endif // QGSFILEWIDGET_H