QGIS API Documentation  3.11.0-Master (68611307d7)
Public Member Functions | List of all members
QgsOptional< T > Class Template Reference

QgsOptional is a container for other classes and adds an additional enabled/disabled flag. More...

#include <qgsoptional.h>

Public Member Functions

 QgsOptional ()=default
 A QgsOptional is disabled by default if default constructed. More...
 
 QgsOptional (const T &data)
 A QgsOptional is enabled by default if constructed with payload. More...
 
 QgsOptional (const T &data, bool enabled)
 A QgsOptional constructed with enabled status and data. More...
 
data () const
 Access the payload data. More...
 
bool enabled () const
 Check if this optional is enabled. More...
 
 operator bool () const
 Boolean operator. More...
 
const T * operator-> () const
 Access the payload data. More...
 
bool operator== (const QgsOptional< T > &other) const
 Compare this QgsOptional to another one. More...
 
void setData (const T &data)
 Set the payload data. More...
 
void setEnabled (bool enabled)
 Set if this optional is enabled. More...
 

Detailed Description

template<typename T>
class QgsOptional< T >

QgsOptional is a container for other classes and adds an additional enabled/disabled flag.

Often it is used for configuration options which can be enabled or disabled but also have more internal configuration information that should not be lost when disabling and re-enabling.

Note
For Python you need to use implementations for specific template classes
Not available in Python bindings (although SIP file is present for specific implementations).
Since
QGIS 3.0

Definition at line 36 of file qgsoptional.h.

Constructor & Destructor Documentation

◆ QgsOptional() [1/3]

template<typename T>
QgsOptional< T >::QgsOptional ( )
default

A QgsOptional is disabled by default if default constructed.

◆ QgsOptional() [2/3]

template<typename T>
QgsOptional< T >::QgsOptional ( const T &  data)
inline

A QgsOptional is enabled by default if constructed with payload.

Definition at line 48 of file qgsoptional.h.

◆ QgsOptional() [3/3]

template<typename T>
QgsOptional< T >::QgsOptional ( const T &  data,
bool  enabled 
)
inline

A QgsOptional constructed with enabled status and data.

Definition at line 57 of file qgsoptional.h.

Member Function Documentation

◆ data()

template<typename T>
T QgsOptional< T >::data ( ) const
inline

Access the payload data.

Since
QGIS 3.0

Definition at line 119 of file qgsoptional.h.

◆ enabled()

template<typename T>
bool QgsOptional< T >::enabled ( ) const
inline

Check if this optional is enabled.

Since
QGIS 3.0

Definition at line 89 of file qgsoptional.h.

◆ operator bool()

template<typename T>
QgsOptional< T >::operator bool ( ) const
inline

Boolean operator.

Will return true if this optional is enabled.

Definition at line 79 of file qgsoptional.h.

◆ operator->()

template<typename T>
const T* QgsOptional< T >::operator-> ( ) const
inline

Access the payload data.

Since
QGIS 3.0

Definition at line 109 of file qgsoptional.h.

◆ operator==()

template<typename T>
bool QgsOptional< T >::operator== ( const QgsOptional< T > &  other) const
inline

Compare this QgsOptional to another one.

This will compare the enabled flag and call the == operator of the contained class.

Since
QGIS 3.0

Definition at line 71 of file qgsoptional.h.

◆ setData()

template<typename T>
void QgsOptional< T >::setData ( const T &  data)
inline

Set the payload data.

Since
QGIS 3.0

Definition at line 129 of file qgsoptional.h.

◆ setEnabled()

template<typename T>
void QgsOptional< T >::setEnabled ( bool  enabled)
inline

Set if this optional is enabled.

Since
QGIS 3.0

Definition at line 99 of file qgsoptional.h.


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