QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
qgsguiutils.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsguiutils.h - Constants used throughout the QGIS GUI.
3 ------------
4 Date : 11-Jan-2006
5 Copyright : (C) 2006 by Tom Elwertowski
6 Email : telwertowski at users dot sourceforge dot net
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15#ifndef QGSGUIUTILS_H
16#define QGSGUIUTILS_H
17
18#include <QPair>
19#include <QWidget>
20#include <QStringList>
21#include "qgis_gui.h"
22#include "qgis.h"
23
24#define SIP_NO_FILE
25
26class QFont;
27
34namespace QgsGuiUtils
35{
36
54 static const Qt::WindowFlags ModalDialogFlags = Qt::WindowFlags();
55
60 constexpr double CANVAS_MAGNIFICATION_MIN = 0.1;
61
66 // Must be a factor of 2, so zooming in to max from 100% then zooming back out will result in 100% mag
67 constexpr double CANVAS_MAGNIFICATION_MAX = 16.0;
68
91 bool GUI_EXPORT openFilesRememberingFilter( QString const &filterName,
92 QString const &filters, QStringList &selectedFiles, QString &enc, QString &title,
93 bool cancelAll = false );
94
104 QPair<QString, QString> GUI_EXPORT getSaveAsImageName( QWidget *parent, const QString &message, const QString &defaultFilename = QString() );
105
114 QString GUI_EXPORT createFileFilter_( QString const &longName, QString const &glob );
115
122 QString GUI_EXPORT createFileFilter_( QString const &format );
123
135 QFont GUI_EXPORT getFont( bool &ok, const QFont &initial, const QString &title = QString() );
136
144 bool GUI_EXPORT restoreGeometry( QWidget *widget, const QString &keyName = QString() );
145
152 void GUI_EXPORT saveGeometry( QWidget *widget, const QString &keyName = QString() );
153
161 QString createWidgetKey( QWidget *widget, const QString &keyName = QString() );
162
172 int GUI_EXPORT scaleIconSize( int standardSize );
173
180 QSize GUI_EXPORT iconSize( bool dockableToolbar = false );
181
188 QSize GUI_EXPORT panelIconSize( QSize size );
189
199 QString GUI_EXPORT displayValueWithMaximumDecimals( const Qgis::DataType dataType, const double value, bool displayTrailingZeroes = false );
200
205 int GUI_EXPORT significantDigits( const Qgis::DataType rasterDataType );
206
207}
208
217class GUI_EXPORT QWidgetUpdateBlocker
218{
219 public:
220
226 QWidgetUpdateBlocker( QWidget *widget );
227
232
234
238 void release();
239
240 private:
241
242 QWidget *mWidget = nullptr;
243};
244
255{
256 public:
257
262 QgsTemporaryCursorOverride( const QCursor &cursor );
263
265
269 void release();
270
271 private:
272
273 bool mHasOverride = true;
274
275};
276
287{
288 public:
289
295
297
301 void restore();
302
303 private:
304
305 std::vector< QCursor > mCursors;
306
307};
308
309#endif // QGSGUIUTILS_H
Temporarily disables updates for a QWidget for the lifetime of the object.
QWidgetUpdateBlocker(const QWidgetUpdateBlocker &other)=delete
QWidgetUpdateBlocker cannot be copied.
QWidgetUpdateBlocker & operator=(const QWidgetUpdateBlocker &other)=delete
QWidgetUpdateBlocker cannot be copied.
DataType
Raster data types.
Definition qgis.h:288
Temporarily sets a cursor override for the QApplication for the lifetime of the object.
Temporarily removes all cursor overrides for the QApplication for the lifetime of the object.
The QgsGuiUtils namespace contains constants and helper functions used throughout the QGIS GUI.
constexpr double CANVAS_MAGNIFICATION_MIN
Minimum magnification level allowed in map canvases.
Definition qgsguiutils.h:60
bool restoreGeometry(QWidget *widget, const QString &keyName)
Restore the wigget geometry from settings.
QSize iconSize(bool dockableToolbar)
Returns the user-preferred size of a window's toolbar icons.
QString createWidgetKey(QWidget *widget, const QString &keyName)
Creates a key for the given widget that can be used to store related data in settings.
QPair< QString, QString > GUI_EXPORT getSaveAsImageName(QWidget *parent, const QString &message, const QString &defaultFilename)
A helper function to get an image name from the user.
int scaleIconSize(int standardSize)
Scales an icon size to compensate for display pixel density, making the icon size hi-dpi friendly,...
int significantDigits(const Qgis::DataType rasterDataType)
Returns the maximum number of significant digits a for the given rasterDataType.
void saveGeometry(QWidget *widget, const QString &keyName)
Save the wigget geometry into settings.
QFont getFont(bool &ok, const QFont &initial, const QString &title)
Show font selection dialog.
bool GUI_EXPORT openFilesRememberingFilter(QString const &filterName, QString const &filters, QStringList &selectedFiles, QString &enc, QString &title, bool cancelAll)
Open files, preferring to have the default file selector be the last one used, if any; also,...
QString createFileFilter_(QString const &longName, QString const &glob)
Convenience function for readily creating file filters.
QSize panelIconSize(QSize size)
Returns dockable panel toolbar icon width based on the provided window toolbar width.
constexpr double CANVAS_MAGNIFICATION_MAX
Maximum magnification level allowed in map canvases.
Definition qgsguiutils.h:67
QString displayValueWithMaximumDecimals(const Qgis::DataType dataType, const double value, bool displayTrailingZeroes)
Returns a localized string representation of the value with the appropriate number of decimals suppor...