qgsexternalresourcewidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsexternalresourcewidget.h
 
 ---------------------
 begin                : 16.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 QGSEXTERNALRESOURCEWIDGET_H
#define QGSEXTERNALRESOURCEWIDGET_H
 
class QWebView;
class QgsPixmapLabel;
class QgsMediaWidget;
class QgsMessageBar;
class QgsExternalStorageFileWidget;
class QgsExternalStorageFetchedContent;
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsfilewidget.h"
 
#include <QPointer>
#include <QVariant>
#include <QWidget>
 
#ifdef SIP_RUN
//%ModuleHeaderCode
// fix to allow compilation with sip that for some reason
// doesn't add this include to the file where the code from
// ConvertToSubClassCode goes.
#include <qgsexternalresourcewidget.h>
 
#include <qgsexternalstoragefilewidget.h>
//%End
#endif
 

class GUI_EXPORT QgsExternalResourceWidget : public QWidget
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsExternalResourceWidget *>( sipCpp ) )
      sipType = sipType_QgsExternalResourceWidget;
    else
      sipType = NULL;
    SIP_END
#endif
 
    Q_OBJECT
    Q_PROPERTY( bool fileWidgetVisible READ fileWidgetVisible WRITE setFileWidgetVisible )
    Q_PROPERTY( DocumentViewerContent documentViewerContent READ documentViewerContent WRITE setDocumentViewerContent )
    Q_PROPERTY( int documentViewerHeight READ documentViewerHeight WRITE setDocumentViewerHeight )
    Q_PROPERTY( int documentViewerWidth READ documentViewerWidth WRITE setDocumentViewerWidth )
    Q_PROPERTY( QgsFileWidget::RelativeStorage relativeStorage READ relativeStorage WRITE setRelativeStorage )
    Q_PROPERTY( QString defaultRoot READ defaultRoot WRITE setDefaultRoot )
 
  public:
    enum DocumentViewerContent
    {
      NoContent,
      Image,
      Web,
      Audio, // since QGIS 3.30
      Video, // since QGIS 3.30
    };

    explicit QgsExternalResourceWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    QVariant documentPath( QMetaType::Type type = QMetaType::Type::QString ) const;

    Q_DECL_DEPRECATED QVariant documentPath( QVariant::Type type ) const SIP_DEPRECATED;
 
    void setDocumentPath( const QVariant &documentPath );

    QgsExternalStorageFileWidget *fileWidget();

    bool fileWidgetVisible() const;
    void setFileWidgetVisible( bool visible );

    QgsExternalResourceWidget::DocumentViewerContent documentViewerContent() const;
    void setDocumentViewerContent( QgsExternalResourceWidget::DocumentViewerContent content );

    int documentViewerHeight() const;

    void setDocumentViewerHeight( int height );
    int documentViewerWidth() const;

    void setDocumentViewerWidth( int width );

    void setReadOnly( bool readOnly );

    QgsFileWidget::RelativeStorage relativeStorage() const;

    void setRelativeStorage( QgsFileWidget::RelativeStorage relativeStorage );
 

    QString defaultRoot() const;

    void setDefaultRoot( const QString &defaultRoot );

    void setStorageType( const QString &storageType );

    QString storageType() const;

    void setStorageAuthConfigId( const QString &authCfg );

    QString storageAuthConfigId() const;

    void setMessageBar( QgsMessageBar *messageBar );

    QgsMessageBar *messageBar() const;
 
  signals:
    void valueChanged( const QString &value );
 
  private slots:
    void loadDocument( const QString &path );
    void onFetchFinished();
 
  private:
    void updateDocumentViewer();

    void updateDocumentContent( const QString &filePath );

    void clearContent();
 
    QString resolvePath( const QString &path );

    bool mFileWidgetVisible = true;
 
    DocumentViewerContent mDocumentViewerContent = NoContent;
    int mDocumentViewerHeight = 0;
    int mDocumentViewerWidth = 0;
 
    QgsFileWidget::RelativeStorage mRelativeStorage = QgsFileWidget::Absolute;
    QString mDefaultRoot; // configured default root path for QgsFileWidget::RelativeStorage::RelativeDefaultPath

    QgsExternalStorageFileWidget *mFileWidget = nullptr;
    QgsPixmapLabel *mPixmapLabel = nullptr;
#ifdef WITH_QTWEBKIT
    QWebView *mWebView = nullptr;
#endif
    QgsMediaWidget *mMediaWidget = nullptr;
 
    QLabel *mLoadingLabel = nullptr;
    QLabel *mErrorLabel = nullptr;
    QMovie *mLoadingMovie = nullptr;
    QPointer<QgsExternalStorageFetchedContent> mContent;
 
    friend class TestQgsExternalResourceWidgetWrapper;
};
 
#endif // QGSEXTERNALRESOURCEWIDGET_H