qgsfilecontentsourcelineedit.h

Go to the documentation of this file.

/***************************************************************************
 qgsfilecontentsourcelineedit.h
 ---------------------
 begin                : July 2018
 copyright            : (C) 2018 by Nyall Dawson
 email                : nyall dot dawson at gmail 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 QGSFILECONTENTSOURCELINEEDIT_H
#define QGSFILECONTENTSOURCELINEEDIT_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QWidget>
 
class QgsFileDropEdit;
class QToolButton;
class QgsMessageBar;
class QgsPropertyOverrideButton;

class GUI_EXPORT QgsAbstractFileContentSourceLineEdit : public QWidget SIP_ABSTRACT
{
    Q_OBJECT
    Q_PROPERTY( QString source READ source WRITE setSource NOTIFY sourceChanged )
 
  public:
    QgsAbstractFileContentSourceLineEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setMessageBar( QgsMessageBar *bar );

    QgsMessageBar *messageBar() const;

    QString source() const;

    void setLastPathSettingsKey( const QString &key );

    QgsPropertyOverrideButton *propertyOverrideToolButton() const { return mPropertyOverrideButton; }

    void setPropertyOverrideToolButtonVisible( bool visible );
 
  public slots:

    void setSource( const QString &source );
 
  signals:

    void sourceChanged( const QString &source );
 
  private:
#ifndef SIP_RUN

    virtual QString fileFilter( bool includeAllFiles ) const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString selectFileTitle() const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString fileFromUrlTitle() const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString fileFromUrlText() const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString embedFileTitle() const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString extractFileTitle() const = 0; // cppcheck-suppress pureVirtualCall

    virtual QString defaultSettingsKey() const = 0; // cppcheck-suppress pureVirtualCall

#endif
 
  protected:
    SIP_SKIP QgsFileDropEdit *mFileLineEdit = nullptr;
 
  private slots:
    void selectFile();
    void selectUrl();
    void embedFile();
    void extractFile();
    void mFileLineEdit_textEdited( const QString &text );
 
  private:
    enum Mode
    {
      ModeFile,
      ModeBase64,
    };
 
    Mode mMode = ModeFile;
    bool mPropertyOverrideButtonVisible = false;
 
    QToolButton *mFileToolButton = nullptr;
    QgsPropertyOverrideButton *mPropertyOverrideButton = nullptr;
    QString mLastPathKey;
    QString mBase64;
    QgsMessageBar *mMessageBar = nullptr;
 
    QString defaultPath() const;
    QString settingsKey() const;
};
 

class GUI_EXPORT QgsPictureSourceLineEditBase : public QgsAbstractFileContentSourceLineEdit
{
    Q_OBJECT
  public:
    enum Format
    {
      Svg,           
      Image,         
      AnimatedImage, 
    };

    QgsPictureSourceLineEditBase( QWidget *parent SIP_TRANSFERTHIS = nullptr )
      : QgsAbstractFileContentSourceLineEdit( parent )
    {}

    void setMode( Format format ) { mFormat = format; }
 
  protected:
    QgsPictureSourceLineEditBase( Format format, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
  private:
    Format mFormat = Svg;
 
#ifndef SIP_RUN
    QString fileFilter( bool includeAllFiles ) const final;
    QString selectFileTitle() const final;
    QString fileFromUrlTitle() const final;
    QString fileFromUrlText() const final;
    QString embedFileTitle() const final;
    QString extractFileTitle() const final;
    QString defaultSettingsKey() const final;
#endif
};
 

class GUI_EXPORT QgsSvgSourceLineEdit : public QgsPictureSourceLineEditBase
{
    Q_OBJECT
  public:
    QgsSvgSourceLineEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr )
      : QgsPictureSourceLineEditBase( Svg, parent )
    {}
};

class GUI_EXPORT QgsImageSourceLineEdit : public QgsPictureSourceLineEditBase
{
    Q_OBJECT
  public:
    QgsImageSourceLineEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr )
      : QgsPictureSourceLineEditBase( Image, parent )
    {}
};
 

class GUI_EXPORT QgsAnimatedImageSourceLineEdit : public QgsPictureSourceLineEditBase
{
    Q_OBJECT
  public:
    QgsAnimatedImageSourceLineEdit( QWidget *parent SIP_TRANSFERTHIS = nullptr )
      : QgsPictureSourceLineEditBase( AnimatedImage, parent )
    {}
};
 
#endif // QGSFILECONTENTSOURCELINEEDIT_H