qgsguiutils.h

Go to the documentation of this file.

/***************************************************************************
    qgsguiutils.h - Constants used throughout the QGIS GUI.
     ------------
    Date                 : 11-Jan-2006
    Copyright            : (C) 2006 by Tom Elwertowski
    Email                : telwertowski at users dot sourceforge dot net
 ***************************************************************************
 *                                                                         *
 *   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 QGSGUIUTILS_H
#define QGSGUIUTILS_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgswkbtypes.h"
 
#include <QPair>
#include <QStringList>
#include <QWidget>
 
#define SIP_NO_FILE
 
class QFont;
class QMainWindow;
class QDockWidget;

namespace QgsGuiUtils
{

  static const Qt::WindowFlags ModalDialogFlags = Qt::WindowFlags();

  constexpr double CANVAS_MAGNIFICATION_MIN = 0.1;

  // Must be a factor of 2, so zooming in to max from 100% then zooming back out will result in 100% mag
  constexpr double CANVAS_MAGNIFICATION_MAX = 16.0;

  bool GUI_EXPORT openFilesRememberingFilter( QString const &filterName, QString const &filters, QStringList &selectedFiles, QString &enc, QString &title, bool cancelAll = false );

  QPair<QString, QString> GUI_EXPORT getSaveAsImageName( QWidget *parent, const QString &message, const QString &defaultFilename = QString() );

  QString GUI_EXPORT createFileFilter_( QString const &longName, QString const &glob );

  QString GUI_EXPORT createFileFilter_( QString const &format );

  QFont GUI_EXPORT getFont( bool &ok, const QFont &initial, const QString &title = QString() );

  bool GUI_EXPORT restoreGeometry( QWidget *widget, const QString &keyName = QString() );

  void GUI_EXPORT saveGeometry( QWidget *widget, const QString &keyName = QString() );

  QString createWidgetKey( QWidget *widget, const QString &keyName = QString() );

  int GUI_EXPORT scaleIconSize( int standardSize );

  QSize GUI_EXPORT iconSize( bool dockableToolbar = false );

  QSize GUI_EXPORT panelIconSize( QSize size );

  QString GUI_EXPORT displayValueWithMaximumDecimals( const Qgis::DataType dataType, const double value, bool displayTrailingZeroes = false );

  int GUI_EXPORT significantDigits( const Qgis::DataType rasterDataType );

  bool GUI_EXPORT isNonStandardGeoPackageGeometryType( Qgis::WkbType wkbType );

  bool GUI_EXPORT warnAboutNonStandardGeoPackageGeometryType( Qgis::WkbType wkbType, QWidget *parent, const QString &dialogTitle, bool showDialog = true, bool *isNonStandard = nullptr );

  GUI_EXPORT void addDockWidget( QMainWindow *window, Qt::DockWidgetArea area, QDockWidget *dockwidget );

  GUI_EXPORT void addTabifiedDockWidget( QMainWindow *window, Qt::DockWidgetArea area, QDockWidget *dockWidget, const QStringList &tabifyWith = QStringList(), bool raiseTab = false );
 
 
} // namespace QgsGuiUtils

class GUI_EXPORT QWidgetUpdateBlocker
{
  public:
    QWidgetUpdateBlocker( QWidget *widget );
 
    QWidgetUpdateBlocker( const QWidgetUpdateBlocker &other ) = delete;
    QWidgetUpdateBlocker &operator=( const QWidgetUpdateBlocker &other ) = delete;
 
    ~QWidgetUpdateBlocker();

    void release();
 
  private:
    QWidget *mWidget = nullptr;
};

class GUI_EXPORT QgsTemporaryCursorOverride
{
  public:
    QgsTemporaryCursorOverride( const QCursor &cursor );
 
    ~QgsTemporaryCursorOverride();

    void release();
 
  private:
    bool mHasOverride = true;
};

class GUI_EXPORT QgsTemporaryCursorRestoreOverride
{
  public:
    QgsTemporaryCursorRestoreOverride();
 
    ~QgsTemporaryCursorRestoreOverride();

    void restore();
 
  private:
    std::vector<QCursor> mCursors;
};
 
#endif // QGSGUIUTILS_H