qgsexternalstoragefilewidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsexternalstoragefilewidget.h
  --------------------------------------
  Date                 : August 2021
  Copyright            : (C) 2021 by Julien Cabieces
  Email                : julien dot cabieces at oslandia dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSEXTERNALSTORAGEFILEWIDGET_H
#define QGSEXTERNALSTORAGEFILEWIDGET_H
 
class QLabel;
class QToolButton;
class QVariant;
class QHBoxLayout;
class QProgressBar;
class QgsExternalStorage;
class QgsMessageBar;
 
#include "qgsexpression.h"
#include "qgsexpressioncontext.h"
#include "qgsfilewidget.h"
 
#include <QFileDialog>
#include <QWidget>

class GUI_EXPORT QgsExternalStorageFileWidget : public QgsFileWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsExternalStorageFileWidget *>( sipCpp ) )
      sipType = sipType_QgsExternalStorageFileWidget;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
    Q_PROPERTY( QString storageType READ storageType WRITE setStorageType )
    Q_PROPERTY( QString auth READ storageAuthConfigId WRITE setStorageAuthConfigId )
    Q_PROPERTY( QString storageUrlExpression READ storageUrlExpressionString WRITE setStorageUrlExpression )
 
  public:
    explicit QgsExternalStorageFileWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setStorageType( const QString &storageType );

    QString storageType() const;

    QgsExternalStorage *externalStorage() const;

    void setStorageAuthConfigId( const QString &authCfg );

    const QString &storageAuthConfigId() const;

    void setStorageUrlExpression( const QString &urlExpression );

    QString storageUrlExpressionString() const;

    QgsExpression *storageUrlExpression() const;

    void setExpressionContext( const QgsExpressionContext &context );

    const QgsExpressionContext &expressionContext() const;

    void setMessageBar( QgsMessageBar *messageBar );

    QgsMessageBar *messageBar() const;

    static QgsExpressionContextScope *createFileWidgetScope();
 
    void setReadOnly( bool readOnly ) override;
 
  protected:
    void updateLayout() override;
 
    void setSelectedFileNames( QStringList fileNames ) override;

    void addFileWidgetScope();
 
    void dragEnterEvent( QDragEnterEvent *event ) override;
 
    void dropEvent( QDropEvent *event ) override;
 
  private:
    // stores \a fileNames files using current external storage.
    // This is a recursive method, \a storedUrls contains urls for previously stored
    // fileNames. When all files have been successfully stored, current mFilePath
    // is updated
    void storeExternalFiles( QStringList fileNames, QStringList storedUrls = QStringList() );

    void updateAcceptDrops();
 
    bool mStoreInProgress = false;
 
    QgsExternalStorage *mExternalStorage = nullptr;
    QString mAuthCfg;
    std::unique_ptr<QgsExpression> mStorageUrlExpression;
    QgsExpressionContext mExpressionContext;
    QgsExpressionContextScope *mScope = nullptr;
 
    QLabel *mProgressLabel = nullptr;
    QProgressBar *mProgressBar = nullptr;
    QToolButton *mCancelButton = nullptr;
    QgsMessageBar *mMessageBar = nullptr;
 
    friend class TestQgsExternalResourceWidgetWrapper;
    friend class TestQgsExternalStorageFileWidget;
};
 
#endif // QGSEXTERNALSTORAGEFILEWIDGET_H