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;

#include <QWidget>
#include <QVariant>

#include "qgsfilewidget.h"




class GUI_EXPORT QgsExternalResourceWidget : public QWidget
{

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

    explicit QgsExternalResourceWidget( QWidget *parent = 0 );

    QVariant documentPath( QVariant::Type type = QVariant::String ) const;
    void setDocumentPath( const QVariant& documentPath );

    QgsFileWidget* 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( const QgsFileWidget::RelativeStorage& relativeStorage );


    QString defaultRoot() const;

    void setDefaultRoot( const QString& defaultRoot );

  signals:
    void valueChanged( const QString& );

  private slots:
    void loadDocument( const QString& path );

  private:
    void updateDocumentViewer();

    QString resolvePath( const QString& path );

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

    QgsFileWidget* mFileWidget;
    QgsPixmapLabel* mPixmapLabel;
#ifdef WITH_QTWEBKIT
    QWebView* mWebView;
#endif

};

#endif // QGSEXTERNALRESOURCEWIDGET_H