WIZARD_STRING_PARAMETER Class Reference

#include <footprint_wizard.h>

Inheritance diagram for WIZARD_STRING_PARAMETER:

Public Member Functions
void	Reset () override
kiapi::common::types::WizardParameter	Pack (bool aCompact=true) override
	Packs the current state of this parameter back into a protobuf message.
void	FromProto (const kiapi::common::types::WizardStringParameter &aProto)

Static Public Member Functions
static std::unique_ptr< WIZARD_PARAMETER >	Create (const kiapi::common::types::WizardParameter &aProto)
static wxString	ParameterCategoryName (kiapi::common::types::WizardParameterCategory aCategory)

Public Attributes
wxString	value
wxString	default_value
std::optional< wxString >	validation_regex
wxString	identifier
wxString	name
wxString	description
kiapi::common::types::WizardParameterCategory	category = kiapi::common::types::WPC_UNKNOWN
kiapi::common::types::WizardParameterDataType	type = kiapi::common::types::WPDT_UNKNOWN

Detailed Description

Definition at line 112 of file footprint_wizard.h.

Member Function Documentation

Create()

std::unique_ptr< WIZARD_PARAMETER > WIZARD_PARAMETER::Create ( const kiapi::common::types::WizardParameter & aProto )

staticinherited

Definition at line 215 of file footprint_wizard.cpp.

References WIZARD_BOOL_PARAMETER::FromProto(), WIZARD_INT_PARAMETER::FromProto(), WIZARD_REAL_PARAMETER::FromProto(), and WIZARD_STRING_PARAMETER::FromProto().

Referenced by WIZARD_INFO::FromProto().

FromProto()

void WIZARD_STRING_PARAMETER::FromProto

(

const kiapi::common::types::WizardStringParameter &

aProto

)

Definition at line 385 of file footprint_wizard.cpp.

References default_value, validation_regex, and value.

Referenced by WIZARD_PARAMETER::Create().

Pack()

kiapi::common::types::WizardParameter WIZARD_STRING_PARAMETER::Pack ( bool aCompact = true )

overridevirtual

Packs the current state of this parameter back into a protobuf message.

Parameters

aCompact

will only include the identifier and value if true

Returns

a protobuf message describing this parameter

Reimplemented from WIZARD_PARAMETER.

Definition at line 326 of file footprint_wizard.cpp.

References default_value, WIZARD_PARAMETER::Pack(), and value.

ParameterCategoryName()

wxString WIZARD_PARAMETER::ParameterCategoryName ( kiapi::common::types::WizardParameterCategory aCategory )

staticinherited

Definition at line 197 of file footprint_wizard.cpp.

References _.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::RebuildParameters().

Reset()

void WIZARD_STRING_PARAMETER::Reset ( )

inlineoverridevirtual

Implements WIZARD_PARAMETER.

Definition at line 115 of file footprint_wizard.h.

References default_value, and value.

Member Data Documentation

category

kiapi::common::types::WizardParameterCategory WIZARD_PARAMETER::category = kiapi::common::types::WPC_UNKNOWN

inherited

Definition at line 63 of file footprint_wizard.h.

Referenced by Pack().

default_value

wxString WIZARD_STRING_PARAMETER::default_value

Definition at line 119 of file footprint_wizard.h.

Referenced by FromProto(), Pack(), and Reset().

description

wxString WIZARD_PARAMETER::description

inherited

Definition at line 62 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

identifier

wxString WIZARD_PARAMETER::identifier

inherited

Definition at line 60 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

name

wxString WIZARD_PARAMETER::name

inherited

Definition at line 61 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

type

kiapi::common::types::WizardParameterDataType WIZARD_PARAMETER::type = kiapi::common::types::WPDT_UNKNOWN

inherited

Definition at line 64 of file footprint_wizard.h.

Referenced by FOOTPRINT_WIZARD_PROPERTIES_PANEL::createPGProperty(), and Pack().

validation_regex

std::optional<wxString> WIZARD_STRING_PARAMETER::validation_regex

Definition at line 120 of file footprint_wizard.h.

Referenced by FromProto().

value

wxString WIZARD_STRING_PARAMETER::value

Definition at line 118 of file footprint_wizard.h.

Referenced by FromProto(), Pack(), and Reset().

---

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

• footprint_wizard.h
• footprint_wizard.cpp