DynExp::ParamsBase::DummyParam Class Reference

Dummy parameter which is to be owned once by parameter classes that do not contain any other parameter. It ensures the presence of the respective level in the XML hierarchy. Parameter is skipped when saving/loading because of its empty name. More...

Inheritance diagram for DynExp::ParamsBase::DummyParam:

Public Member Functions
	DummyParam (ParamsBase &Owner)
Public Member Functions inherited from DynExp::ParamsBase::ParamBase
	ParamBase (const ParamBase &)=delete
ParamBase &	operator= (const ParamBase &)=delete
QDomElement	ToXMLNode (QDomDocument &Document) const
	Converts this parameter to a Qt dom element (describing an XML node containing this parameter's name and value). More...
void	FromXMLNode (const QDomElement &XMLElement)
	Restores this parameter's value from the given Qt dom element (describing an XML node) More...
bool	Validate ()
	Checks whether a valid value is assigned to this parameter. This function is not const since it is also intended to reset the parameter if it is invalid. More...
void	Reset ()
	Resets this parameter to its default value. More...
bool	IsUserEditable () const noexcept
	Returns ParamBase::UserEditable. More...
std::string_view	GetParamName () const noexcept
	Returns ParamBase::ParamName. More...
std::string_view	GetParamTitle () const noexcept
	Returns ParamBase::ParamTitle. More...
std::string_view	GetParamDescription () const noexcept
	Returns ParamBase::ParamDescription. More...
bool	GetNeedsResetToApplyChange () const noexcept
	Returns ParamBase::NeedsResetToApplyChange. More...

Private Member Functions
virtual void	ToXMLNodeChild (QDomDocument &Document, QDomElement &XMLElement) const override
	Converts this parameter to a Qt dom element (describing an XML node containing this parameter's name and value). More...
virtual void	FromXMLNodeChild (const QDomElement &XMLElement) override
	Restores this parameter's value from the given Qt dom element (describing an XML node) More...
virtual void	AddToDialogChild (ParamsConfigDialog &Dialog) override
	Appends this parameter to a settings dialog making it configurable by the user. More...
virtual void	ResetChild () override
	Resets this parameter to its default value. More...

Additional Inherited Members
Public Attributes inherited from DynExp::ParamsBase::ParamBase
ParamsBaseOnlyType	ParamsBaseOnly
	Provides the class ParamsBase access to some private members of class ParamBase. More...
Protected Member Functions inherited from DynExp::ParamsBase::ParamBase
	ParamBase (ParamsBase &Owner, std::string ParamName, std::string_view ParamTitle, std::string_view ParamDescription, bool NeedsResetToApplyChange)
	Base constructor of any parameter to be used if a parameter should be displayed in a settings dialog (UserEditable is set to true). More...
	ParamBase (ParamsBase &Owner, std::string ParamName)
	Base constructor of any parameter to be used if a parameter should not be displayed in a settings dialog (UserEditable is set to false). More...
virtual	~ParamBase ()=0
const auto &	GetOwner () const noexcept
	Returns the ParamsBase instance owning this ParamBase instance. More...
auto &	GetOwner () noexcept
	Returns the ParamsBase instance owning this ParamBase instance. More...

Detailed Description

Dummy parameter which is to be owned once by parameter classes that do not contain any other parameter. It ensures the presence of the respective level in the XML hierarchy. Parameter is skipped when saving/loading because of its empty name.

Definition at line 521 of file Object.h.

Constructor & Destructor Documentation

DummyParam()

DynExp::ParamsBase::DummyParam::DummyParam ( ParamsBase &  Owner )

inline

Definition at line 524 of file Object.h.

Member Function Documentation

AddToDialogChild()

virtual void DynExp::ParamsBase::DummyParam::AddToDialogChild ( ParamsConfigDialog &  Dialog )

inlineoverrideprivatevirtual

Appends this parameter to a settings dialog making it configurable by the user.

Parameters

Dialog

Reference to the settings dialog to append the parameter to

Implements DynExp::ParamsBase::ParamBase.

Definition at line 529 of file Object.h.

FromXMLNodeChild()

virtual void DynExp::ParamsBase::DummyParam::FromXMLNodeChild ( const QDomElement &  XMLElement )

inlineoverrideprivatevirtual

Restores this parameter's value from the given Qt dom element (describing an XML node)

Parameters

XMLElement

Qt dom element containing information about this parameter.

Implements DynExp::ParamsBase::ParamBase.

Definition at line 528 of file Object.h.

ResetChild()

virtual void DynExp::ParamsBase::DummyParam::ResetChild ( )

inlineoverrideprivatevirtual

Resets this parameter to its default value.

Implements DynExp::ParamsBase::ParamBase.

Definition at line 530 of file Object.h.

ToXMLNodeChild()

virtual void DynExp::ParamsBase::DummyParam::ToXMLNodeChild ( QDomDocument &  Document, QDomElement &  XMLElement  ) const

inlineoverrideprivatevirtual

Converts this parameter to a Qt dom element (describing an XML node containing this parameter's name and value).

Parameters

Document	Qt dom document within to create the dom element.
XMLElement	Qt dom element to save information about this parameter to.

Implements DynExp::ParamsBase::ParamBase.

Definition at line 527 of file Object.h.

---

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

• Object.h