QGIS API Documentation  3.23.0-Master (22c16f2067)
Public Types | Static Public Member Functions | List of all members
QgsMapSettingsUtils Class Reference

Utilities for map settings. More...

#include <qgsmapsettingsutils.h>

Public Types

enum class  EffectsCheckFlag { IgnoreGeoPdfSupportedEffects = 1 << 0 }
 Flags for controlling the behavior of containsAdvancedEffects() More...
 

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. More...
 
static QString worldFileContent (const QgsMapSettings &mapSettings)
 Creates the content of a world file. More...
 
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. More...
 

Detailed Description

Utilities for map settings.

Since
QGIS 3.0

Definition at line 32 of file qgsmapsettingsutils.h.

Member Enumeration Documentation

◆ EffectsCheckFlag

Flags for controlling the behavior of containsAdvancedEffects()

Since
QGIS 3.14
Enumerator
IgnoreGeoPdfSupportedEffects 

Ignore advanced effects which are supported in GeoPDF exports.

Definition at line 41 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 27 of file qgsmapsettingsutils.cpp.

◆ worldFileContent()

QString QgsMapSettingsUtils::worldFileContent ( const QgsMapSettings mapSettings)
static

Creates the content of a world file.

Parameters
mapSettingsmap settings
Note
Uses 17 places of precision for all numbers output

Definition at line 130 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
mapSettingsmap settings
athe a parameter
bthe b parameter
cthe c parameter
dthe d parameter
ethe e parameter
fthe f parameter
Since
QGIS 3.10

Definition at line 85 of file qgsmapsettingsutils.cpp.


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