QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsSettingsProxy Class Reference

A helper class for access to either a temporary QgsSettings object or the thread local object. More...

#include <qgssettingsproxy.h>

Public Member Functions

 QgsSettingsProxy (QgsSettings *settings=nullptr)
 Constructor for QgsSettingsProxy.
 
QgsSettingsoperator* ()
 Returns a reference to the proxied QgsSettings object.
 
QgsSettingsoperator-> ()
 Returns a pointer to the proxied QgsSettings object.
 

Detailed Description

A helper class for access to either a temporary QgsSettings object or the thread local object.

Note
Not available in Python bindings
Since
QGIS 3.36

Definition at line 34 of file qgssettingsproxy.h.

Constructor & Destructor Documentation

◆ QgsSettingsProxy()

QgsSettingsProxy::QgsSettingsProxy ( QgsSettings settings = nullptr)
explicit

Constructor for QgsSettingsProxy.

If settings is set, then this object will proxy calls to that settings object. Otherwise a temporary QgsSettings object will be created for the lifetime of the proxy.

Definition at line 17 of file qgssettingsproxy.cpp.

Member Function Documentation

◆ operator*()

QgsSettings & QgsSettingsProxy::operator* ( )
inline

Returns a reference to the proxied QgsSettings object.

Definition at line 57 of file qgssettingsproxy.h.

◆ operator->()

QgsSettings * QgsSettingsProxy::operator-> ( )
inline

Returns a pointer to the proxied QgsSettings object.

Definition at line 49 of file qgssettingsproxy.h.


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