KiCad PCB EDA Suite
Loading...
Searching...
No Matches
TRANSLINE_PRM Class Reference

A class to handle one parameter of transline. More...

#include <transline_ident.h>

Public Member Functions

 TRANSLINE_PRM (PRM_TYPE aType, PRMS_ID aId, const char *aKeywordCfg="", const wxString &aDlgLabel=wxEmptyString, const wxString &aToolTip=wxEmptyString, double aValue=0.0, bool aConvUnit=false)
 
double ToUserUnit ()
 
double FromUserUnit ()
 

Public Attributes

PRM_TYPE m_Type
 
PRMS_ID m_Id
 
std::string m_KeyWord
 
wxString m_DlgLabel
 
wxString m_ToolTip
 
double m_Value
 
double m_DefaultValue
 
double m_NormalizedValue
 
bool m_ConvUnit
 
void * m_ValueCtrl
 
void * m_UnitCtrl
 
int m_UnitSelection
 

Detailed Description

A class to handle one parameter of transline.

Definition at line 62 of file transline_ident.h.

Constructor & Destructor Documentation

◆ TRANSLINE_PRM()

TRANSLINE_PRM::TRANSLINE_PRM ( PRM_TYPE  aType,
PRMS_ID  aId,
const char *  aKeywordCfg = "",
const wxString &  aDlgLabel = wxEmptyString,
const wxString &  aToolTip = wxEmptyString,
double  aValue = 0.0,
bool  aConvUnit = false 
)
Parameters
aKeywordCfgis the keyword used in config to identify the parameter only ASCII7 keyword is valid.
aDlgLabelis a I18n string used to identify the parameter in dialog. usually aDlgLabel is same as aKeywordCfg, but translatable.

Definition at line 45 of file transline_ident.cpp.

References m_ConvUnit, m_DefaultValue, m_DlgLabel, m_Id, m_KeyWord, m_NormalizedValue, m_ToolTip, m_Type, m_UnitCtrl, m_UnitSelection, m_Value, and m_ValueCtrl.

Member Function Documentation

◆ FromUserUnit()

double TRANSLINE_PRM::FromUserUnit ( )

Definition at line 73 of file transline_ident.cpp.

References m_UnitCtrl.

◆ ToUserUnit()

double TRANSLINE_PRM::ToUserUnit ( )

Definition at line 64 of file transline_ident.cpp.

References m_ConvUnit, and m_UnitCtrl.

Referenced by PANEL_TRANSLINE::SetPrmValue().

Member Data Documentation

◆ m_ConvUnit

bool TRANSLINE_PRM::m_ConvUnit

◆ m_DefaultValue

double TRANSLINE_PRM::m_DefaultValue

◆ m_DlgLabel

wxString TRANSLINE_PRM::m_DlgLabel

Definition at line 82 of file transline_ident.h.

Referenced by TRANSLINE_PRM(), and PANEL_TRANSLINE::TranslineTypeSelection().

◆ m_Id

◆ m_KeyWord

std::string TRANSLINE_PRM::m_KeyWord

Definition at line 81 of file transline_ident.h.

Referenced by TRANSLINE_PRM().

◆ m_NormalizedValue

double TRANSLINE_PRM::m_NormalizedValue

◆ m_ToolTip

wxString TRANSLINE_PRM::m_ToolTip

Definition at line 83 of file transline_ident.h.

Referenced by TRANSLINE_PRM(), and PANEL_TRANSLINE::TranslineTypeSelection().

◆ m_Type

PRM_TYPE TRANSLINE_PRM::m_Type

Definition at line 79 of file transline_ident.h.

Referenced by TRANSLINE_PRM(), and PANEL_TRANSLINE::TranslineTypeSelection().

◆ m_UnitCtrl

◆ m_UnitSelection

int TRANSLINE_PRM::m_UnitSelection

◆ m_Value

◆ m_ValueCtrl


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