QgsMapSettingsUtils Class Reference

Utilities for map settings. More...

#include <qgsmapsettingsutils.h>

Public Types
enum class	EffectsCheckFlag : int { IgnoreGeoPdfSupportedEffects = 1 << 0 }
	Flags for controlling the behavior of containsAdvancedEffects() More...
typedef QFlags< EffectsCheckFlag >	EffectsCheckFlags

Static Public Member Functions
static QStringList	containsAdvancedEffects (const QgsMapSettings &mapSettings, EffectsCheckFlags flags=QgsMapSettingsUtils::EffectsCheckFlags())
	Checks whether any of the layers attached to a map settings object contain advanced effects.
static QString	worldFileContent (const QgsMapSettings &mapSettings)
	Creates the content of a world file.
static void	worldFileParameters (const QgsMapSettings &mapSettings, double &a, double &b, double &c, double &d, double &e, double &f)
	Computes the six parameters of a world file.

Detailed Description

Utilities for map settings.

Definition at line 31 of file qgsmapsettingsutils.h.

Member Typedef Documentation

EffectsCheckFlags

typedef QFlags< EffectsCheckFlag > QgsMapSettingsUtils::EffectsCheckFlags

Definition at line 44 of file qgsmapsettingsutils.h.

Member Enumeration Documentation

EffectsCheckFlag

enum class QgsMapSettingsUtils::EffectsCheckFlag : int

strong

Flags for controlling the behavior of containsAdvancedEffects()

Since

QGIS 3.14

Enumerator
IgnoreGeoPdfSupportedEffects	Ignore advanced effects which are supported in geospatial PDF exports.

Definition at line 40 of file qgsmapsettingsutils.h.

Member Function Documentation

containsAdvancedEffects()

QStringList QgsMapSettingsUtils::containsAdvancedEffects ( const QgsMapSettings &  mapSettings, EffectsCheckFlags  flags = QgsMapSettingsUtils::EffectsCheckFlags()  )

static

Checks whether any of the layers attached to a map settings object contain advanced effects.

The optional flags argument can be used to fine-tune the check behavior.

Definition at line 28 of file qgsmapsettingsutils.cpp.

worldFileContent()

QString QgsMapSettingsUtils::worldFileContent ( const QgsMapSettings &  mapSettings )

static

Creates the content of a world file.

Parameters

mapSettings

map settings

Note

Uses 17 places of precision for all numbers output

Definition at line 122 of file qgsmapsettingsutils.cpp.

worldFileParameters()

void QgsMapSettingsUtils::worldFileParameters ( const QgsMapSettings &  mapSettings, double &  a, double &  b, double &  c, double &  d, double &  e, double &  f  )

static

Computes the six parameters of a world file.

Parameters

mapSettings	map settings
a	the a parameter
b	the b parameter
c	the c parameter
d	the d parameter
e	the e parameter
f	the f parameter

Since

QGIS 3.10

Definition at line 77 of file qgsmapsettingsutils.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgsmapsettingsutils.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/core/qgsmapsettingsutils.cpp