STOFFVariable< T > Struct Template Reference

a generic variable template: value + flag to know if the variable is set More...

#include <libstaroffice_internal.hxx>

Public Member Functions

 STOFFVariable ()
 constructor More...
 
 STOFFVariable (T const &def)
 constructor with a default value More...
 
 STOFFVariable (STOFFVariable const &orig)
 copy constructor More...
 
STOFFVariableoperator= (STOFFVariable const &orig)
 copy operator More...
 
STOFFVariableoperator= (T const &val)
 set a value More...
 
void insert (STOFFVariable const &orig)
 update the current value if orig is set More...
 
T const * operator-> () const
 operator* More...
 
T * operator-> ()
 operator* More...
 
T const & operator* () const
 operator* More...
 
T & operator* ()
 operator* More...
 
T const & get () const
 return the current value More...
 
bool isSet () const
 return true if the variable is set More...
 
void setSet (bool newVal)
 define if the variable is set More...
 

Protected Attributes

m_data
 the value More...
 
bool m_set
 a flag to know if the variable is set or not More...
 

Detailed Description

template<class T>
struct STOFFVariable< T >

a generic variable template: value + flag to know if the variable is set

Note
the variable is considered set as soon a new value is set or when its content is acceded by a function which returns a not-const reference... You can use the function setSet to unset it.

Constructor & Destructor Documentation

◆ STOFFVariable() [1/3]

template<class T >
STOFFVariable< T >::STOFFVariable ( )
inline

constructor

◆ STOFFVariable() [2/3]

template<class T >
STOFFVariable< T >::STOFFVariable ( T const &  def)
inlineexplicit

constructor with a default value

◆ STOFFVariable() [3/3]

template<class T >
STOFFVariable< T >::STOFFVariable ( STOFFVariable< T > const &  orig)
inline

copy constructor

Member Function Documentation

◆ get()

template<class T >
T const& STOFFVariable< T >::get ( ) const
inline

return the current value

◆ insert()

template<class T >
void STOFFVariable< T >::insert ( STOFFVariable< T > const &  orig)
inline

update the current value if orig is set

◆ isSet()

template<class T >
bool STOFFVariable< T >::isSet ( ) const
inline

return true if the variable is set

◆ operator*() [1/2]

template<class T >
T const& STOFFVariable< T >::operator* ( ) const
inline

operator*

◆ operator*() [2/2]

template<class T >
T& STOFFVariable< T >::operator* ( )
inline

operator*

◆ operator->() [1/2]

template<class T >
T const* STOFFVariable< T >::operator-> ( ) const
inline

operator*

◆ operator->() [2/2]

template<class T >
T* STOFFVariable< T >::operator-> ( )
inline

operator*

◆ operator=() [1/2]

template<class T >
STOFFVariable& STOFFVariable< T >::operator= ( STOFFVariable< T > const &  orig)
inline

copy operator

◆ operator=() [2/2]

template<class T >
STOFFVariable& STOFFVariable< T >::operator= ( T const &  val)
inline

set a value

◆ setSet()

template<class T >
void STOFFVariable< T >::setSet ( bool  newVal)
inline

define if the variable is set

Member Data Documentation

◆ m_data

◆ m_set


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

Generated on Sat May 29 2021 22:54:04 for libstaroffice by doxygen 1.8.14