comphelper::ConfigurationProperty< T, U > Struct Template Reference

A type-safe wrapper around a (non-localized) configuration property. More...

#include <configuration.hxx>

Static Public Member Functions
static bool	isReadOnly ()
	Get the read-only status of the given (non-localized) configuration property. More...
static U	get ()
	Get the value of the given (non-localized) configuration property. More...
static void	set (U const &value, std::shared_ptr< ConfigurationChanges > const &batch)
	Set the value of the given (non-localized) configuration property, via a given changes batch. More...

Private Member Functions
	ConfigurationProperty (const ConfigurationProperty &)=delete
ConfigurationProperty &	operator= (const ConfigurationProperty &)=delete
	ConfigurationProperty ()=delete
	~ConfigurationProperty ()=delete

Detailed Description

template<typename T, typename U>
struct comphelper::ConfigurationProperty< T, U >

A type-safe wrapper around a (non-localized) configuration property.

Automatically generated headers for the various configuration properties derive from this template and make available its member functions to access each given configuration property.

Definition at line 200 of file configuration.hxx.

Constructor & Destructor Documentation

ConfigurationProperty() [1/2]

template<typename T , typename U >

comphelper::ConfigurationProperty< T, U >::ConfigurationProperty ( const ConfigurationProperty< T, U > &  )

privatedelete

ConfigurationProperty() [2/2]

template<typename T , typename U >

comphelper::ConfigurationProperty< T, U >::ConfigurationProperty ( )

privatedelete

~ConfigurationProperty()

template<typename T , typename U >

comphelper::ConfigurationProperty< T, U >::~ConfigurationProperty ( )

privatedelete

Member Function Documentation

get()

template<typename T , typename U >

static U comphelper::ConfigurationProperty< T, U >::get ( )

inlinestatic

Get the value of the given (non-localized) configuration property.

For nillable properties, U is of type std::optional<U'>.

Definition at line 212 of file configuration.hxx.

References a, comphelper::detail::Convert< T >::fromAny(), comphelper::detail::ConfigurationWrapper::get(), getPropertyValue(), and U.

isReadOnly()

template<typename T , typename U >

static bool comphelper::ConfigurationProperty< T, U >::isReadOnly ( )

inlinestatic

Get the read-only status of the given (non-localized) configuration property.

Definition at line 204 of file configuration.hxx.

References comphelper::detail::ConfigurationWrapper::get(), and comphelper::detail::ConfigurationWrapper::isReadOnly().

operator=()

template<typename T , typename U >

ConfigurationProperty & comphelper::ConfigurationProperty< T, U >::operator= ( const ConfigurationProperty< T, U > &  )

privatedelete

set()

template<typename T , typename U >

static void comphelper::ConfigurationProperty< T, U >::set ( U const &  value, std::shared_ptr< ConfigurationChanges > const &  batch  )

inlinestatic

Set the value of the given (non-localized) configuration property, via a given changes batch.

For nillable properties, U is of type std::optional<U'>.

Definition at line 226 of file configuration.hxx.

References comphelper::detail::ConfigurationWrapper::setPropertyValue(), and value.

---

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

• configuration.hxx