cc_tools_qt::property::field::Optional Class Reference

#include "cc_tools_qt/property/field.h"

Detailed Description

Class to contain all the properties relevant to comms::field::Optional fields.

Inheritance diagram for cc_tools_qt::property::field::Optional:

Public Member Functions
	Optional ()
	Default constructor.
	Optional (const Optional &)
	Copy constructor.
	Optional (const QVariant &props)
	Construct from QVariant containing QVariantMap.
	Optional (const QVariantMap &props)
	Construct from QVariantMap.
	Optional (Optional &&)
	Move constructor.
	~Optional () noexcept
	Destructor.
QVariantMap	asMap () const
	Retrieve all properties as map.
const QVariantMap &	field () const
	Get access to contained field's properties.
Optional &	field (const QVariantMap &fieldProps)
	Set contained field's properties.
Optional &	field (QVariantMap &&fieldProps)
	Set contained field's properties.
Optional &	hidden (bool value=true)
	Set whether the field is hidden.
Optional &	hiddenWhenReadOnly (bool value=true)
	Set whether the field must be hidden when cannot be modified.
bool	isHidden () const
	Check the field is hidden.
bool	isHiddenWhenReadOnly () const
	Check the field is hidden when readOnly.
bool	isReadOnly () const
	Check whether the field cannot be modified.
bool	isSerialisedHidden () const
	Check the serialisation part is hidden.
bool	isUncheckable () const
	Check field is uncheckable.
const QString &	name () const
	Get name of the field.
Optional &	name (const char *value)
	Set name value.
Optional &	name (const QString &value)
	Set name value.
Optional &	operator= (const Optional &)
	Copy assignment.
Optional &	operator= (Optional &&)
	Move assignment.
Optional &	readOnly (bool value=true)
	Set whether the field cannot be modified.
Optional &	serialisedHidden (bool value=true)
	Set whether the serialised part is hidden.
void	setName (const char *value)
	Update the name value.
void	setName (const QString &value)
	Update the name value.
void	setTo (QVariantMap &props) const
	Copy all the properties value into provided properties map.
Optional &	uncheckable (bool value=true)
	(Un)Mark the field uncheckable.

Static Protected Member Functions
template<typename TValueType >
static TValueType	getElemFrom (const QVariantMap &props, const QString &name, const TValueType &defaultVal=TValueType())
	read element value from the map
template<typename U >
static void	setElemTo (U &&val, const QString &name, QVariantMap &props)
	set element value to the map

Member Function Documentation

getElemFrom()

template<typename TValueType >

static TValueType cc_tools_qt::property::field::Common::getElemFrom ( const QVariantMap &  props, const QString &  name, const TValueType &  defaultVal = TValueType()  )

staticprotectedinherited

read element value from the map

Parameters

[in]	props	Properties map
[in]	name	Property name
[in]	defaultVal	Value to return if not found in map

Returns

Value of found property in the map

hidden()

Optional & cc_tools_qt::property::field::CommonBase< Optional >::hidden ( bool  value = true )

inherited

Set whether the field is hidden.

Returns

reference to derived class

hiddenWhenReadOnly()

Optional & cc_tools_qt::property::field::CommonBase< Optional >::hiddenWhenReadOnly ( bool  value = true )

inherited

Set whether the field must be hidden when cannot be modified.

Returns

reference to derived class

isUncheckable()

bool cc_tools_qt::property::field::Optional::isUncheckable

(

)

const

Check field is uncheckable.

Uncheckable means that the user cannot manually mark the field as existing/missing independently.

name() [1/2]

Optional & cc_tools_qt::property::field::CommonBase< Optional >::name ( const char *  value )

inherited

Set name value.

Returns

reference to derived class

name() [2/2]

Optional & cc_tools_qt::property::field::CommonBase< Optional >::name ( const QString &  value )

inherited

Set name value.

Returns

reference to derived class

readOnly()

Optional & cc_tools_qt::property::field::CommonBase< Optional >::readOnly ( bool  value = true )

inherited

Set whether the field cannot be modified.

Returns

reference to derived class

serialisedHidden()

Optional & cc_tools_qt::property::field::CommonBase< Optional >::serialisedHidden ( bool  value = true )

inherited

Set whether the serialised part is hidden.

Returns

reference to derived class

setElemTo()

template<typename U >

static void cc_tools_qt::property::field::Common::setElemTo ( U &&  val, const QString &  name, QVariantMap &  props  )

staticprotectedinherited

set element value to the map

Parameters

[in]	val	Value to set
[in]	name	Name of the property
[in,out]	props	Map to update

---

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

• lib/include/cc_tools_qt/property/field.h