OpenOrienteering::CRSTemplateParameter Class Reference

Abstract base class for parameters in CRSTemplates. More...

#include <crs_template.h>

Inheritance diagram for OpenOrienteering::CRSTemplateParameter:

Public Types
using	WidgetObserver = CRSParameterWidgetObserver

Public Member Functions
	CRSTemplateParameter (const QString &id, const QString &name)
	Constructs a new parameter with the given identifier and name. More...
	CRSTemplateParameter (const CRSTemplateParameter &)=delete
	CRSTemplateParameter (CRSTemplateParameter &&)=delete
virtual	~CRSTemplateParameter ()
	Destructor. More...
CRSTemplateParameter &	operator= (const CRSTemplateParameter &)=delete
CRSTemplateParameter &	operator= (CRSTemplateParameter &&)=delete
QString	id () const
	Returns the parameter's permanent unique ID. More...
QString	name () const
	Returns the parameter's display name. More...
virtual QWidget *	createEditor (WidgetObserver &widget_observer) const =0
	Creates a widget which can be used to edit the value. More...
virtual std::vector< QString >	specValues (const QString &edit_value) const
	Return a list of actual specification parameters values from a value in storage format. More...
virtual QString	value (const QWidget *edit_widget) const =0
	Return the widget's value(s) in form of a single string. More...
virtual void	setValue (QWidget *edit_widget, const QString &value)=0
	Sets the widget to a stored value. More...

Detailed Description

Abstract base class for parameters in CRSTemplates.

Member Typedef Documentation

WidgetObserver

using OpenOrienteering::CRSTemplateParameter::WidgetObserver = CRSParameterWidgetObserver

Constructor & Destructor Documentation

CRSTemplateParameter() [1/3]

OpenOrienteering::CRSTemplateParameter::CRSTemplateParameter	(	const QString &	id,
		const QString &	name
	)

Constructs a new parameter with the given identifier and name.

CRSTemplateParameter() [2/3]

OpenOrienteering::CRSTemplateParameter::CRSTemplateParameter ( const CRSTemplateParameter &  )

delete

CRSTemplateParameter() [3/3]

OpenOrienteering::CRSTemplateParameter::CRSTemplateParameter ( CRSTemplateParameter &&  )

delete

~CRSTemplateParameter()

OpenOrienteering::CRSTemplateParameter::~CRSTemplateParameter ( )

virtual

Destructor.

Member Function Documentation

createEditor()

virtual QWidget* OpenOrienteering::CRSTemplateParameter::createEditor ( WidgetObserver &  widget_observer ) const

pure virtual

Creates a widget which can be used to edit the value.

The widget should be simple in the sense that it can be used as a field in a QFormLayout, together with the parameter's label.

Implemented in OpenOrienteering::CRSTemplates::IntRangeParameter, OpenOrienteering::CRSTemplates::UTMZoneParameter, OpenOrienteering::CRSTemplates::FullSpecParameter, and OpenOrienteering::CRSTemplates::TextParameter.

id()

QString OpenOrienteering::CRSTemplateParameter::id ( ) const

inline

Returns the parameter's permanent unique ID.

name()

QString OpenOrienteering::CRSTemplateParameter::name ( ) const

inline

Returns the parameter's display name.

operator=() [1/2]

CRSTemplateParameter& OpenOrienteering::CRSTemplateParameter::operator= ( const CRSTemplateParameter &  )

delete

operator=() [2/2]

CRSTemplateParameter& OpenOrienteering::CRSTemplateParameter::operator= ( CRSTemplateParameter &&  )

delete

setValue()

virtual void OpenOrienteering::CRSTemplateParameter::setValue ( QWidget *  edit_widget, const QString &  value  )

pure virtual

Sets the widget to a stored value.

See also

CRSTemplateParameter::value

Implemented in OpenOrienteering::CRSTemplates::IntRangeParameter, OpenOrienteering::CRSTemplates::UTMZoneParameter, OpenOrienteering::CRSTemplates::FullSpecParameter, and OpenOrienteering::CRSTemplates::TextParameter.

specValues()

std::vector< QString > OpenOrienteering::CRSTemplateParameter::specValues ( const QString &  edit_value ) const

virtual

Return a list of actual specification parameters values from a value in storage format.

The default implementation returns a vector which contains just the single edit_value.

Reimplemented in OpenOrienteering::CRSTemplates::IntRangeParameter, and OpenOrienteering::CRSTemplates::UTMZoneParameter.

value()

virtual QString OpenOrienteering::CRSTemplateParameter::value ( const QWidget *  edit_widget ) const

pure virtual

Return the widget's value(s) in form of a single string.

This string can be stored and used for restoring the widget.

See also

CRSTemplateParameter::setValue

Implemented in OpenOrienteering::CRSTemplates::IntRangeParameter, OpenOrienteering::CRSTemplates::UTMZoneParameter, and OpenOrienteering::CRSTemplates::TextParameter.

---

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

• src/core/crs_template.h (e042dca on 26 Aug 2018)
• src/core/crs_template.cpp (c0c3bc8 on 7 Oct 2019)