QGIS API Documentation 4.1.0-Master (376402f9aeb)
Loading...
Searching...
No Matches
QgsSettingsRegistryGui Class Reference

Used for settings introspection and collects all QgsSettingsEntry instances of GUI. More...

#include <qgssettingsregistrygui.h>

Inheritance diagram for QgsSettingsRegistryGui:

Public Member Functions

 QgsSettingsRegistryGui ()
 ~QgsSettingsRegistryGui () override
Public Member Functions inherited from QgsSettingsRegistry
 QgsSettingsRegistry ()
virtual ~QgsSettingsRegistry ()
void addSubRegistry (const QgsSettingsRegistry *settingsRegistry)
 Append a child settingsRegistry to the register.
void removeSubRegistry (const QgsSettingsRegistry *settingsRegistry)
 Remove a child settingsRegistry from the register.
QList< const QgsSettingsEntryBase * > settingEntries () const
 Returns the list of registered QgsSettingsEntryBase.
const QgsSettingsEntryBasesettingsEntry (const QString &key, bool searchChildRegistries=true) const
 Returns the QgsSettingsEntry with the given key or nullptr if not found.
QList< const QgsSettingsRegistry * > subRegistries () const
 Returns the list of registered child QgsSettingsRegistry.

Static Public Attributes

static const QgsSettingsEntryBoolsettingsCadFloaterActive = new QgsSettingsEntryBool( u"floater-active"_s, QgsSettingsTree::sTreeCad, false, u"Whether the CAD floater widget is active"_s )
 Settings entry CAD floater active state.
static const QgsSettingsEntryColorsettingsDefaultMeasureColor = new QgsSettingsEntryColor( u"default-measure-color"_s, QgsSettingsTree::sTreeQgis, QColor( 222, 155, 67 ), u"Default measure tool color"_s )
 Settings entry default measure tool color.
static const QgsSettingsEntryBoolsettingsEnableAntiAliasing = new QgsSettingsEntryBool( u"enable-anti-aliasing"_s, QgsSettingsTree::sTreeQgis, true, u"Whether anti-aliasing is enabled for rendering"_s )
 Settings entry whether anti-aliasing is enabled for rendering.
static const QgsSettingsEntryBoolsettingsFormatLayerName = new QgsSettingsEntryBool( u"format-layer-name"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to format layer names for better readability"_s )
 Settings entry whether to format layer names.
static const QgsSettingsEntryDoublesettingsMagnifierFactorDefault = new QgsSettingsEntryDouble( u"magnifier-factor-default"_s, QgsSettingsTree::sTreeQgis, 1.0, u"Default magnifier factor"_s )
 Settings entry default magnifier factor.
static const QgsSettingsEntryIntegersettingsMapUpdateInterval = new QgsSettingsEntryInteger( u"map-update-interval"_s, QgsSettingsTree::sTreeQgis, 250, u"Map update interval in milliseconds"_s )
 Settings entry map update interval in milliseconds.
static const QgsSettingsEntryIntegersettingsMessageTimeout = new QgsSettingsEntryInteger( u"message-timeout"_s, QgsSettingsTree::sTreeQgis, 5, u"Timeout in seconds for message bar messages"_s )
 Settings entry message timeout in seconds.
static const QgsSettingsEntryBoolsettingsNativeColorDialogs = new QgsSettingsEntryBool( u"native-color-dialogs"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to use native color dialogs"_s )
 Settings entry whether to use native color dialogs.
static const QgsSettingsEntryBoolsettingsNewLayersVisible = new QgsSettingsEntryBool( u"new-layers-visible"_s, QgsSettingsTree::sTreeQgis, true, u"Whether newly added layers are visible by default"_s )
 Settings entry whether newly added layers are visible.
static const QgsSettingsEntryBoolsettingsOpenSublayersInGroup = new QgsSettingsEntryBool( u"open-sublayers-in-group"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to open sublayers in a group"_s )
 Settings entry whether to open sublayers in a group.
static const QgsSettingsEntryStringsettingsRasterDefaultPalette = new QgsSettingsEntryString( u"default-palette"_s, QgsSettingsTree::sTreeRaster, QString(), u"Default color ramp palette name for raster layers"_s )
 Settings entry default raster color ramp palette name.
static const QgsSettingsEntryBoolsettingsRasterHistogramDrawLines = new QgsSettingsEntryBool( u"draw-lines"_s, QgsSettingsTree::sTreeRasterHistogram, true, u"Whether to draw the raster histogram as lines"_s )
 Settings entry raster histogram draw lines.
static const QgsSettingsEntryBoolsettingsRasterHistogramShowMarkers = new QgsSettingsEntryBool( u"show-markers"_s, QgsSettingsTree::sTreeRasterHistogram, false, u"Whether to show markers on the raster histogram"_s )
 Settings entry raster histogram show markers.
static const QgsSettingsEntryBoolsettingsRasterHistogramUpdateStyleToMinMax = new QgsSettingsEntryBool( u"update-style-to-min-max"_s, QgsSettingsTree::sTreeRasterHistogram, true, u"Whether to update the style when histogram changes to min/max values"_s )
 Settings entry raster histogram update style to min/max.
static const QgsSettingsEntryBoolsettingsRasterHistogramZoomToMinMax = new QgsSettingsEntryBool( u"zoom-to-min-max"_s, QgsSettingsTree::sTreeRasterHistogram, false, u"Whether to zoom the raster histogram to min/max values"_s )
 Settings entry raster histogram zoom to min/max.
static const QgsSettingsEntryBoolsettingsRespectScreenDPI = new QgsSettingsEntryBool( u"respect-screen-dpi"_s, QgsSettingsTree::sTreeGui, false )
 Settings entry respect screen dpi.
static const QgsSettingsEntryBoolsettingsReverseWheelZoom = new QgsSettingsEntryBool( u"reverse-wheel-zoom"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to reverse the direction of wheel zoom"_s )
 Settings entry reverse wheel zoom.
static const QgsSettingsEntryDoublesettingsSegmentationTolerance = new QgsSettingsEntryDouble( u"segmentation-tolerance"_s, QgsSettingsTree::sTreeQgis, 0.01745, u"Segmentation tolerance for curved geometries"_s )
 Settings entry segmentation tolerance for curved geometries.
static const QgsSettingsEntryEnumFlag< QgsAbstractGeometry::SegmentationToleranceType > * settingsSegmentationToleranceType
 Settings entry segmentation tolerance type for curved geometries.
static const QgsSettingsEntryDoublesettingsZoomFactor = new QgsSettingsEntryDouble( u"zoom-factor"_s, QgsSettingsTree::sTreeQgis, 2.0, u"Zoom factor for map canvas and other views"_s )
 Settings entry zoom factor.

Additional Inherited Members

Protected Member Functions inherited from QgsSettingsRegistry
bool addSettingsEntry (const QgsSettingsEntryBase *settingsEntry)
 Adds settingsEntry to the registry.
Q_DECL_DEPRECATED void addSettingsEntryGroup (const QgsSettingsEntryGroup *settingsGroup)
 Adds a group of setting to the registry.

Detailed Description

Used for settings introspection and collects all QgsSettingsEntry instances of GUI.

Since
QGIS 3.22

Definition at line 39 of file qgssettingsregistrygui.h.

Constructor & Destructor Documentation

◆ QgsSettingsRegistryGui()

QgsSettingsRegistryGui::QgsSettingsRegistryGui ( )

Definition at line 100 of file qgssettingsregistrygui.cpp.

◆ ~QgsSettingsRegistryGui()

QgsSettingsRegistryGui::~QgsSettingsRegistryGui ( )
override

Definition at line 180 of file qgssettingsregistrygui.cpp.

Member Data Documentation

◆ settingsCadFloaterActive

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsCadFloaterActive = new QgsSettingsEntryBool( u"floater-active"_s, QgsSettingsTree::sTreeCad, false, u"Whether the CAD floater widget is active"_s )
static

Settings entry CAD floater active state.

Definition at line 52 of file qgssettingsregistrygui.h.

◆ settingsDefaultMeasureColor

const QgsSettingsEntryColor * QgsSettingsRegistryGui::settingsDefaultMeasureColor = new QgsSettingsEntryColor( u"default-measure-color"_s, QgsSettingsTree::sTreeQgis, QColor( 222, 155, 67 ), u"Default measure tool color"_s )
static

Settings entry default measure tool color.

Definition at line 103 of file qgssettingsregistrygui.h.

◆ settingsEnableAntiAliasing

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsEnableAntiAliasing = new QgsSettingsEntryBool( u"enable-anti-aliasing"_s, QgsSettingsTree::sTreeQgis, true, u"Whether anti-aliasing is enabled for rendering"_s )
static

Settings entry whether anti-aliasing is enabled for rendering.

Definition at line 82 of file qgssettingsregistrygui.h.

◆ settingsFormatLayerName

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsFormatLayerName = new QgsSettingsEntryBool( u"format-layer-name"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to format layer names for better readability"_s )
static

Settings entry whether to format layer names.

Definition at line 88 of file qgssettingsregistrygui.h.

◆ settingsMagnifierFactorDefault

const QgsSettingsEntryDouble * QgsSettingsRegistryGui::settingsMagnifierFactorDefault = new QgsSettingsEntryDouble( u"magnifier-factor-default"_s, QgsSettingsTree::sTreeQgis, 1.0, u"Default magnifier factor"_s )
static

Settings entry default magnifier factor.

Definition at line 97 of file qgssettingsregistrygui.h.

◆ settingsMapUpdateInterval

const QgsSettingsEntryInteger * QgsSettingsRegistryGui::settingsMapUpdateInterval = new QgsSettingsEntryInteger( u"map-update-interval"_s, QgsSettingsTree::sTreeQgis, 250, u"Map update interval in milliseconds"_s )
static

Settings entry map update interval in milliseconds.

Definition at line 94 of file qgssettingsregistrygui.h.

◆ settingsMessageTimeout

const QgsSettingsEntryInteger * QgsSettingsRegistryGui::settingsMessageTimeout = new QgsSettingsEntryInteger( u"message-timeout"_s, QgsSettingsTree::sTreeQgis, 5, u"Timeout in seconds for message bar messages"_s )
static

Settings entry message timeout in seconds.

Definition at line 79 of file qgssettingsregistrygui.h.

◆ settingsNativeColorDialogs

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsNativeColorDialogs = new QgsSettingsEntryBool( u"native-color-dialogs"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to use native color dialogs"_s )
static

Settings entry whether to use native color dialogs.

Definition at line 85 of file qgssettingsregistrygui.h.

◆ settingsNewLayersVisible

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsNewLayersVisible = new QgsSettingsEntryBool( u"new-layers-visible"_s, QgsSettingsTree::sTreeQgis, true, u"Whether newly added layers are visible by default"_s )
static

Settings entry whether newly added layers are visible.

Definition at line 73 of file qgssettingsregistrygui.h.

◆ settingsOpenSublayersInGroup

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsOpenSublayersInGroup = new QgsSettingsEntryBool( u"open-sublayers-in-group"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to open sublayers in a group"_s )
static

Settings entry whether to open sublayers in a group.

Definition at line 91 of file qgssettingsregistrygui.h.

◆ settingsRasterDefaultPalette

const QgsSettingsEntryString * QgsSettingsRegistryGui::settingsRasterDefaultPalette = new QgsSettingsEntryString( u"default-palette"_s, QgsSettingsTree::sTreeRaster, QString(), u"Default color ramp palette name for raster layers"_s )
static

Settings entry default raster color ramp palette name.

Definition at line 76 of file qgssettingsregistrygui.h.

◆ settingsRasterHistogramDrawLines

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsRasterHistogramDrawLines = new QgsSettingsEntryBool( u"draw-lines"_s, QgsSettingsTree::sTreeRasterHistogram, true, u"Whether to draw the raster histogram as lines"_s )
static

Settings entry raster histogram draw lines.

Definition at line 64 of file qgssettingsregistrygui.h.

◆ settingsRasterHistogramShowMarkers

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsRasterHistogramShowMarkers = new QgsSettingsEntryBool( u"show-markers"_s, QgsSettingsTree::sTreeRasterHistogram, false, u"Whether to show markers on the raster histogram"_s )
static

Settings entry raster histogram show markers.

Definition at line 55 of file qgssettingsregistrygui.h.

◆ settingsRasterHistogramUpdateStyleToMinMax

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsRasterHistogramUpdateStyleToMinMax = new QgsSettingsEntryBool( u"update-style-to-min-max"_s, QgsSettingsTree::sTreeRasterHistogram, true, u"Whether to update the style when histogram changes to min/max values"_s )
static

Settings entry raster histogram update style to min/max.

Definition at line 61 of file qgssettingsregistrygui.h.

◆ settingsRasterHistogramZoomToMinMax

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsRasterHistogramZoomToMinMax = new QgsSettingsEntryBool( u"zoom-to-min-max"_s, QgsSettingsTree::sTreeRasterHistogram, false, u"Whether to zoom the raster histogram to min/max values"_s )
static

Settings entry raster histogram zoom to min/max.

Definition at line 58 of file qgssettingsregistrygui.h.

◆ settingsRespectScreenDPI

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsRespectScreenDPI = new QgsSettingsEntryBool( u"respect-screen-dpi"_s, QgsSettingsTree::sTreeGui, false )
static

Settings entry respect screen dpi.

Definition at line 49 of file qgssettingsregistrygui.h.

◆ settingsReverseWheelZoom

const QgsSettingsEntryBool * QgsSettingsRegistryGui::settingsReverseWheelZoom = new QgsSettingsEntryBool( u"reverse-wheel-zoom"_s, QgsSettingsTree::sTreeQgis, false, u"Whether to reverse the direction of wheel zoom"_s )
static

Settings entry reverse wheel zoom.

Definition at line 70 of file qgssettingsregistrygui.h.

◆ settingsSegmentationTolerance

const QgsSettingsEntryDouble * QgsSettingsRegistryGui::settingsSegmentationTolerance = new QgsSettingsEntryDouble( u"segmentation-tolerance"_s, QgsSettingsTree::sTreeQgis, 0.01745, u"Segmentation tolerance for curved geometries"_s )
static

Settings entry segmentation tolerance for curved geometries.

Definition at line 100 of file qgssettingsregistrygui.h.

◆ settingsSegmentationToleranceType

const QgsSettingsEntryEnumFlag< QgsAbstractGeometry::SegmentationToleranceType > * QgsSettingsRegistryGui::settingsSegmentationToleranceType
static
Initial value:
QgsAbstractGeometry::SegmentationToleranceType>( u"segmentation-tolerance-type"_s, QgsSettingsTree::sTreeQgis, QgsAbstractGeometry::MaximumAngle, u"Segmentation tolerance type for curved geometries"_s )
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle.
@ MaximumAngle
Maximum angle between generating radii (lines from arc center to output vertices).
A template class for enum and flag settings entry.
static QgsSettingsTreeNode * sTreeQgis

Settings entry segmentation tolerance type for curved geometries.

Definition at line 106 of file qgssettingsregistrygui.h.

◆ settingsZoomFactor

const QgsSettingsEntryDouble * QgsSettingsRegistryGui::settingsZoomFactor = new QgsSettingsEntryDouble( u"zoom-factor"_s, QgsSettingsTree::sTreeQgis, 2.0, u"Zoom factor for map canvas and other views"_s )
static

Settings entry zoom factor.

Definition at line 67 of file qgssettingsregistrygui.h.


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