KiCad PCB EDA Suite
UNIT_BINDER Class Reference

#include <unit_binder.h>

Inheritance diagram for UNIT_BINDER:

Public Member Functions

 UNIT_BINDER (EDA_DRAW_FRAME *aParent, wxStaticText *aLabel, wxWindow *aValueCtrl, wxStaticText *aUnitLabel, bool aAllowEval=true)
 
 ~UNIT_BINDER () override
 
virtual void SetUnits (EDA_UNITS aUnits)
 Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DEGREES for angular controls. More...
 
virtual void SetNegativeZero ()
 
virtual void SetPrecision (int aLength)
 Normally not needed, but can be used to set the precision when using internal units that are floats (not integers) like DEGREES or PERCENT. More...
 
void SetDataType (EDA_DATA_TYPE aDataType)
 Used to override the datatype of the displayed property (default is DISTANCE) More...
 
virtual void SetValue (int aValue)
 Set new value (in Internal Units) for the text field, taking care of units conversion. More...
 
void SetValue (const wxString &aValue)
 
virtual void SetDoubleValue (double aValue)
 Set new value (in Internal Units) for the text field, taking care of units conversion. More...
 
virtual void ChangeValue (int aValue)
 Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT triggering the update routine. More...
 
void ChangeValue (const wxString &aValue)
 
virtual void ChangeDoubleValue (double aValue)
 Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT triggering the update routine. More...
 
virtual long long int GetValue ()
 Return the current value in Internal Units. More...
 
virtual double GetDoubleValue ()
 Return the current value in Internal Units. More...
 
bool IsIndeterminate () const
 Return true if the control holds the indeterminate value (for instance, if it represents a multiple selection of differing values). More...
 
wxString GetOriginalText () const
 Return the pre-evaluated text (or the current text if evaluation is not supported). More...
 
virtual bool Validate (double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED)
 Validate the control against the given range, informing the user of any errors found. More...
 
void SetLabel (const wxString &aLabel)
 
void Enable (bool aEnable)
 Enable/disable the label, widget and units label. More...
 
void Show (bool aShow, bool aResize=false)
 Show/hide the label, widget and units label. More...
 
ORIGIN_TRANSFORMS::COORD_TYPES_T GetCoordType () const
 Get the origin transforms coordinate type. More...
 
void SetCoordType (ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType)
 Set the current origin transform mode. More...
 

Protected Member Functions

void onSetFocus (wxFocusEvent &aEvent)
 
void onKillFocus (wxFocusEvent &aEvent)
 
void delayedFocusHandler (wxCommandEvent &aEvent)
 
void onUnitsChanged (wxCommandEvent &aEvent)
 
double setPrecision (double aValue, bool aValueUsesUserUnits)
 When m_precision > 0 truncate the value aValue to show only m_precision digits in mantissa. More...
 

Protected Attributes

EDA_DRAW_FRAMEm_frame
 The bound widgets. More...
 
wxStaticText * m_label
 
wxWindow * m_valueCtrl
 
wxStaticText * m_unitLabel
 Can be nullptr. More...
 
EDA_UNITS m_units
 
bool m_negativeZero
 Indicates "-0" should be displayed for 0. More...
 
EDA_DATA_TYPE m_dataType
 
int m_precision
 0 to 6 More...
 
wxString m_errorMessage
 
NUMERIC_EVALUATOR m_eval
 
bool m_allowEval
 
bool m_needsEval
 
long m_selStart
 Selection start and end of the original text. More...
 
long m_selEnd
 
ORIGIN_TRANSFORMSm_originTransforms
 A reference to an ORIGIN_TRANSFORMS object. More...
 
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
 Type of coordinate for display origin transforms. More...
 

Detailed Description

Definition at line 41 of file unit_binder.h.

Constructor & Destructor Documentation

◆ UNIT_BINDER()

UNIT_BINDER::UNIT_BINDER ( EDA_DRAW_FRAME aParent,
wxStaticText *  aLabel,
wxWindow *  aValueCtrl,
wxStaticText *  aUnitLabel,
bool  aAllowEval = true 
)
Parameters
aParentis the parent EDA_DRAW_FRAME.
aLabelis the static text used to label the text input widget (note: the label text, trimmed of its colon, will also be used in error messages)
aValueCtrlis the control used to edit or display the given value (wxTextCtrl, wxComboBox, wxStaticText, etc.).
aUnitLabelis the units label displayed after the text input widget Can be nullptr.
aAllowEvalindicates aTextInput's content should be eval'ed before storing

Definition at line 40 of file unit_binder.cpp.

41  :
42  m_frame( aParent ),
43  m_label( aLabel ),
44  m_valueCtrl( aValueCtrl ),
45  m_unitLabel( aUnitLabel ),
46  m_negativeZero( false ),
48  m_precision( 0 ),
49  m_eval( aParent->GetUserUnits() ),
52 {
53  m_units = aParent->GetUserUnits();
54  m_allowEval = allowEval && dynamic_cast<wxTextEntry*>( m_valueCtrl );
55  m_needsEval = false;
56  m_selStart = 0;
57  m_selEnd = 0;
58 
59  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
60 
61  if( textEntry )
62  {
63  // Use ChangeValue() instead of SetValue() so we don't generate events.
64  if( m_negativeZero )
65  textEntry->ChangeValue( wxT( "-0" ) );
66  else
67  textEntry->ChangeValue( wxT( "0" ) );
68  }
69 
70  if( m_unitLabel )
72 
73  m_valueCtrl->Connect( wxEVT_SET_FOCUS, wxFocusEventHandler( UNIT_BINDER::onSetFocus ),
74  nullptr, this );
75  m_valueCtrl->Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( UNIT_BINDER::onKillFocus ),
76  nullptr, this );
77  Connect( DELAY_FOCUS, wxCommandEventHandler( UNIT_BINDER::delayedFocusHandler ), nullptr,
78  this );
79 
80  m_frame->Connect( UNITS_CHANGED, wxCommandEventHandler( UNIT_BINDER::onUnitsChanged ),
81  nullptr, this );
82 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
EDA_DRAW_FRAME * m_frame
The bound widgets.
Definition: unit_binder.h:203
void delayedFocusHandler(wxCommandEvent &aEvent)
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
virtual ORIGIN_TRANSFORMS & GetOriginTransforms()
Return a reference to the default ORIGIN_TRANSFORMS object.
bool m_needsEval
Definition: unit_binder.h:220
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:424
EDA_UNITS m_units
Definition: unit_binder.h:211
wxStaticText * m_label
Definition: unit_binder.h:206
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_negativeZero
Indicates "-0" should be displayed for 0.
Definition: unit_binder.h:212
int m_precision
0 to 6
Definition: unit_binder.h:214
bool m_allowEval
Definition: unit_binder.h:219
void onKillFocus(wxFocusEvent &aEvent)
void onSetFocus(wxFocusEvent &aEvent)
void onUnitsChanged(wxCommandEvent &aEvent)
long m_selStart
Selection start and end of the original text.
Definition: unit_binder.h:222
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References delayedFocusHandler(), GetAbbreviatedUnitsLabel(), EDA_BASE_FRAME::GetUserUnits(), m_allowEval, m_dataType, m_frame, m_needsEval, m_negativeZero, m_selEnd, m_selStart, m_unitLabel, m_units, m_valueCtrl, onKillFocus(), onSetFocus(), and onUnitsChanged().

◆ ~UNIT_BINDER()

UNIT_BINDER::~UNIT_BINDER ( )
override

Definition at line 85 of file unit_binder.cpp.

86 {
87  m_frame->Disconnect( UNITS_CHANGED, wxCommandEventHandler( UNIT_BINDER::onUnitsChanged ),
88  nullptr, this );
89 }
EDA_DRAW_FRAME * m_frame
The bound widgets.
Definition: unit_binder.h:203
void onUnitsChanged(wxCommandEvent &aEvent)

References m_frame, and onUnitsChanged().

Member Function Documentation

◆ ChangeDoubleValue()

void UNIT_BINDER::ChangeDoubleValue ( double  aValue)
virtual

Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT triggering the update routine.

The value will be truncated according to the precision set by SetPrecision() (if not <= 0).

Definition at line 302 of file unit_binder.cpp.

303 {
304  double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType );
305  displayValue = setPrecision( displayValue, false );
306 
307  if( displayValue == 0 && m_negativeZero )
308  ChangeValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
309  else
310  ChangeValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
311 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
bool m_negativeZero
Indicates "-0" should be displayed for 0.
Definition: unit_binder.h:212
virtual int ToDisplay(int aValue, COORD_TYPES_T aCoordType) const
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:204
double setPrecision(double aValue, bool aValueUsesUserUnits)
When m_precision > 0 truncate the value aValue to show only m_precision digits in mantissa.
virtual void ChangeValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT trigger...

References ChangeValue(), m_coordType, m_dataType, m_negativeZero, m_originTransforms, m_units, setPrecision(), StringFromValue(), and ORIGIN_TRANSFORMS::ToDisplay().

Referenced by DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), and DIALOG_PAD_PROPERTIES::updateRoundRectCornerValues().

◆ ChangeValue() [1/2]

void UNIT_BINDER::ChangeValue ( int  aValue)
virtual

Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT triggering the update routine.

Definition at line 290 of file unit_binder.cpp.

291 {
292  double value = aValue;
293  double displayValue = m_originTransforms.ToDisplay( value, m_coordType );
294 
295  if( displayValue == 0 && m_negativeZero )
296  ChangeValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false ) );
297  else
298  ChangeValue( StringFromValue( m_units, displayValue, false ) );
299 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
EDA_UNITS m_units
Definition: unit_binder.h:211
bool m_negativeZero
Indicates "-0" should be displayed for 0.
Definition: unit_binder.h:212
virtual int ToDisplay(int aValue, COORD_TYPES_T aCoordType) const
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:204
virtual void ChangeValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion WITHOUT trigger...

References m_coordType, m_negativeZero, m_originTransforms, m_units, StringFromValue(), and ORIGIN_TRANSFORMS::ToDisplay().

Referenced by ChangeDoubleValue(), DIALOG_PAD_PROPERTIES::initValues(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), DIALOG_TRACK_VIA_PROPERTIES::onViaSelect(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ ChangeValue() [2/2]

void UNIT_BINDER::ChangeValue ( const wxString &  aValue)

Definition at line 314 of file unit_binder.cpp.

315 {
316  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
317  wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
318 
319  if( textEntry )
320  textEntry->ChangeValue( aValue );
321  else if( staticText )
322  staticText->SetLabel( aValue );
323 
324  if( m_allowEval )
325  m_eval.Clear();
326 
327  if( m_unitLabel )
329 }
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:424
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_allowEval
Definition: unit_binder.h:219

References NUMERIC_EVALUATOR::Clear(), GetAbbreviatedUnitsLabel(), m_allowEval, m_dataType, m_eval, m_unitLabel, m_units, and m_valueCtrl.

◆ delayedFocusHandler()

void UNIT_BINDER::delayedFocusHandler ( wxCommandEvent &  aEvent)
protected

Definition at line 191 of file unit_binder.cpp.

192 {
193  if( !m_errorMessage.IsEmpty() )
194  DisplayError( m_valueCtrl->GetParent(), m_errorMessage );
195 
196  m_errorMessage = wxEmptyString;
197  m_valueCtrl->SetFocus();
198 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
wxString m_errorMessage
Definition: unit_binder.h:216
wxWindow * m_valueCtrl
Definition: unit_binder.h:207

References DisplayError(), m_errorMessage, and m_valueCtrl.

Referenced by UNIT_BINDER().

◆ Enable()

◆ GetCoordType()

ORIGIN_TRANSFORMS::COORD_TYPES_T UNIT_BINDER::GetCoordType ( ) const
inline

Get the origin transforms coordinate type.

Returns
the origin transforms coordinate type

Definition at line 169 of file unit_binder.h.

170  {
171  return m_coordType;
172  }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229

References m_coordType.

◆ GetDoubleValue()

double UNIT_BINDER::GetDoubleValue ( )
virtual

Return the current value in Internal Units.

The returned value will be truncated according to the precision set by SetPrecision() (if not <= 0)

Definition at line 375 of file unit_binder.cpp.

376 {
377  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
378  wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
379  wxString value;
380 
381  if( textEntry )
382  {
383  if( m_needsEval && m_eval.Process( textEntry->GetValue() ) )
384  value = m_eval.Result();
385  else
386  value = textEntry->GetValue();
387  }
388  else if( staticText )
389  {
390  value = staticText->GetLabel();
391  }
392  else
393  {
394  return 0.0;
395  }
396 
397  double displayValue = DoubleValueFromString( m_units, value, m_dataType );
398  displayValue = setPrecision( displayValue, false );
399 
400  return m_originTransforms.FromDisplay( displayValue, m_coordType );
401 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
bool m_needsEval
Definition: unit_binder.h:220
EDA_UNITS m_units
Definition: unit_binder.h:211
bool Process(const wxString &aString)
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
wxString Result() const
virtual int FromDisplay(int aValue, COORD_TYPES_T aCoordType) const
double setPrecision(double aValue, bool aValueUsesUserUnits)
When m_precision > 0 truncate the value aValue to show only m_precision digits in mantissa.
double DoubleValueFromString(EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:307

References DoubleValueFromString(), ORIGIN_TRANSFORMS::FromDisplay(), m_coordType, m_dataType, m_eval, m_needsEval, m_originTransforms, m_units, m_valueCtrl, NUMERIC_EVALUATOR::Process(), NUMERIC_EVALUATOR::Result(), and setPrecision().

Referenced by DIALOG_POSITION_RELATIVE::GetTranslationInIU(), DIALOG_MOVE_EXACT::GetTranslationInIU(), DIALOG_POSITION_RELATIVE::OnClear(), DIALOG_POSITION_RELATIVE::OnOkClick(), DIALOG_POSITION_RELATIVE::OnPolarChanged(), DIALOG_MOVE_EXACT::OnPolarChanged(), DIALOG_MOVE_EXACT::OnTextChanged(), DIALOG_PAD_PROPERTIES::padValuesOK(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_MOVE_EXACT::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ GetOriginalText()

wxString UNIT_BINDER::GetOriginalText ( ) const

Return the pre-evaluated text (or the current text if evaluation is not supported).

Used primarily to remember values between dialog invocations.

Definition at line 415 of file unit_binder.cpp.

416 {
417  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
418  wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
419 
420  if( m_allowEval )
421  return m_eval.OriginalText();
422  else if( textEntry )
423  return textEntry->GetValue();
424  else if( staticText )
425  return staticText->GetLabel();
426  else
427  return wxEmptyString;
428 }
wxString OriginalText() const
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_allowEval
Definition: unit_binder.h:219

References m_allowEval, m_eval, m_valueCtrl, and NUMERIC_EVALUATOR::OriginalText().

Referenced by DIALOG_MOVE_EXACT::TransferDataFromWindow().

◆ GetValue()

long long int UNIT_BINDER::GetValue ( )
virtual

Return the current value in Internal Units.

Definition at line 332 of file unit_binder.cpp.

333 {
334  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
335  wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
336  wxString value;
337 
338  if( textEntry )
339  {
340  if( m_needsEval && m_eval.Process( textEntry->GetValue() ) )
341  value = m_eval.Result();
342  else
343  value = textEntry->GetValue();
344  }
345  else if( staticText )
346  {
347  value = staticText->GetLabel();
348  }
349  else
350  {
351  return 0;
352  }
353 
354  long long int displayValue = ValueFromString( m_units, value, m_dataType );
355  return m_originTransforms.FromDisplay( displayValue, m_coordType );
356 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
bool m_needsEval
Definition: unit_binder.h:220
EDA_UNITS m_units
Definition: unit_binder.h:211
bool Process(const wxString &aString)
long long int ValueFromString(EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application.
Definition: base_units.cpp:416
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
wxString Result() const
virtual int FromDisplay(int aValue, COORD_TYPES_T aCoordType) const

References ORIGIN_TRANSFORMS::FromDisplay(), m_coordType, m_dataType, m_eval, m_needsEval, m_originTransforms, m_units, m_valueCtrl, NUMERIC_EVALUATOR::Process(), NUMERIC_EVALUATOR::Result(), and ValueFromString().

Referenced by DIALOG_PNS_LENGTH_TUNING_SETTINGS::AcceptOptions(), DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CREATE_ARRAY::calculateCircularArrayProperties(), PROPERTIES_FRAME::CopyPrmsFromPanelToGeneral(), PROPERTIES_FRAME::CopyPrmsFromPanelToItem(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog(), DIALOG_LIB_NEW_SYMBOL::GetPinTextPosition(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), WX_UNIT_ENTRY_DIALOG::GetValue(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::onPaintPolyPanel(), DIALOG_PIN_PROPERTIES::OnPropertiesChange(), onUnitsChanged(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), DIALOG_PAD_PROPERTIES::padValuesOK(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_PLOT_SCHEMATIC::setHpglPenWidth(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataFromWindow(), PANEL_SETUP_FORMATTING::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), PANEL_SETUP_MASK_AND_PASTE::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FIELD_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_CREATE_ARRAY::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), MWAVE_POLYGONAL_SHAPE_DLG::TransferDataFromWindow(), DIALOG_COPPER_ZONE::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), DIALOG_PAD_PRIMITIVES_TRANSFORM::Transform(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate(), Validate(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ IsIndeterminate()

bool UNIT_BINDER::IsIndeterminate ( ) const

Return true if the control holds the indeterminate value (for instance, if it represents a multiple selection of differing values).

Definition at line 404 of file unit_binder.cpp.

405 {
406  wxTextEntry* te = dynamic_cast<wxTextEntry*>( m_valueCtrl );
407 
408  if( te )
409  return te->GetValue() == INDETERMINATE_STATE || te->GetValue() == INDETERMINATE_ACTION;
410 
411  return false;
412 }
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
#define INDETERMINATE_ACTION
Definition: base_units.h:48
#define INDETERMINATE_STATE
Used for holding indeterminate values, such as with multiple selections holding different values or c...
Definition: base_units.h:47

References INDETERMINATE_ACTION, INDETERMINATE_STATE, and m_valueCtrl.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_JUNCTION_PROPS::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ onKillFocus()

void UNIT_BINDER::onKillFocus ( wxFocusEvent &  aEvent)
protected

Definition at line 149 of file unit_binder.cpp.

150 {
151  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
152 
153  if( m_allowEval && textEntry )
154  {
155  if( m_eval.Process( textEntry->GetValue() ) )
156  {
157  textEntry->GetSelection( &m_selStart, &m_selEnd );
158  wxString sel = textEntry->GetStringSelection();
159 
160  textEntry->ChangeValue( m_eval.Result() );
161 
162 #ifdef __WXGTK__
163  // Manually copy the selected text to the primary selection clipboard
164  if( wxTheClipboard->Open() )
165  {
166  bool clipTarget = wxTheClipboard->IsUsingPrimarySelection();
167  wxTheClipboard->UsePrimarySelection( true );
168  wxTheClipboard->SetData( new wxTextDataObject( sel ) );
169  wxTheClipboard->UsePrimarySelection( clipTarget );
170  wxTheClipboard->Close();
171  }
172 #endif
173  }
174 
175  m_needsEval = false;
176  }
177 
178  aEvent.Skip();
179 }
bool m_needsEval
Definition: unit_binder.h:220
bool Process(const wxString &aString)
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_allowEval
Definition: unit_binder.h:219
wxString Result() const
long m_selStart
Selection start and end of the original text.
Definition: unit_binder.h:222

References m_allowEval, m_eval, m_needsEval, m_selEnd, m_selStart, m_valueCtrl, NUMERIC_EVALUATOR::Process(), and NUMERIC_EVALUATOR::Result().

Referenced by UNIT_BINDER().

◆ onSetFocus()

void UNIT_BINDER::onSetFocus ( wxFocusEvent &  aEvent)
protected

Definition at line 128 of file unit_binder.cpp.

129 {
130  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
131 
132  if( m_allowEval && textEntry )
133  {
134  wxString oldStr = m_eval.OriginalText();
135 
136  if( oldStr.length() && oldStr != textEntry->GetValue() )
137  {
138  textEntry->SetValue( oldStr );
139  textEntry->SetSelection( m_selStart, m_selEnd );
140  }
141 
142  m_needsEval = true;
143  }
144 
145  aEvent.Skip();
146 }
wxString OriginalText() const
bool m_needsEval
Definition: unit_binder.h:220
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_allowEval
Definition: unit_binder.h:219
long m_selStart
Selection start and end of the original text.
Definition: unit_binder.h:222

References m_allowEval, m_eval, m_needsEval, m_selEnd, m_selStart, m_valueCtrl, and NUMERIC_EVALUATOR::OriginalText().

Referenced by UNIT_BINDER().

◆ onUnitsChanged()

void UNIT_BINDER::onUnitsChanged ( wxCommandEvent &  aEvent)
protected

Definition at line 116 of file unit_binder.cpp.

117 {
118  int temp = (int) GetValue();
119 
121 
122  SetValue( temp );
123 
124  aEvent.Skip();
125 }
EDA_DRAW_FRAME * m_frame
The bound widgets.
Definition: unit_binder.h:203
virtual void SetUnits(EDA_UNITS aUnits)
Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DE...
Definition: unit_binder.cpp:92
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
virtual long long int GetValue()
Return the current value in Internal Units.
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References EDA_BASE_FRAME::GetUserUnits(), GetValue(), m_frame, SetUnits(), and SetValue().

Referenced by UNIT_BINDER(), and ~UNIT_BINDER().

◆ SetCoordType()

◆ SetDataType()

void UNIT_BINDER::SetDataType ( EDA_DATA_TYPE  aDataType)

Used to override the datatype of the displayed property (default is DISTANCE)

Parameters
aDataTypeis the datatype to use for the units text display

Definition at line 107 of file unit_binder.cpp.

108 {
109  m_dataType = aDataType;
110 
111  if( m_unitLabel )
113 }
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:424
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208

References GetAbbreviatedUnitsLabel(), m_dataType, m_unitLabel, and m_units.

Referenced by DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetDoubleValue()

void UNIT_BINDER::SetDoubleValue ( double  aValue)
virtual

Set new value (in Internal Units) for the text field, taking care of units conversion.

The value will be truncated according to the precision set by SetPrecision() (if not <= 0).

Definition at line 260 of file unit_binder.cpp.

261 {
262  double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType );
263  displayValue = setPrecision( displayValue, false );
264 
265  if( displayValue == 0 && m_negativeZero )
266  SetValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
267  else
268  SetValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
269 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
bool m_negativeZero
Indicates "-0" should be displayed for 0.
Definition: unit_binder.h:212
virtual int ToDisplay(int aValue, COORD_TYPES_T aCoordType) const
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:204
double setPrecision(double aValue, bool aValueUsesUserUnits)
When m_precision > 0 truncate the value aValue to show only m_precision digits in mantissa.

References m_coordType, m_dataType, m_negativeZero, m_originTransforms, m_units, setPrecision(), SetValue(), StringFromValue(), and ORIGIN_TRANSFORMS::ToDisplay().

Referenced by PROPERTIES_FRAME::CopyPrmsFromGeneralToPanel(), PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_POSITION_RELATIVE::OnClear(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), DIALOG_POSITION_RELATIVE::OnPolarChanged(), DIALOG_MOVE_EXACT::OnPolarChanged(), PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetLabel()

void UNIT_BINDER::SetLabel ( const wxString &  aLabel)

Definition at line 431 of file unit_binder.cpp.

432 {
433  m_label->SetLabel( aLabel );
434 }
wxStaticText * m_label
Definition: unit_binder.h:206

References m_label.

Referenced by DIALOG_POSITION_RELATIVE::updateDialogControls(), and DIALOG_MOVE_EXACT::updateDialogControls().

◆ SetNegativeZero()

virtual void UNIT_BINDER::SetNegativeZero ( )
inlinevirtual

◆ SetPrecision()

void UNIT_BINDER::SetPrecision ( int  aLength)
virtual

Normally not needed, but can be used to set the precision when using internal units that are floats (not integers) like DEGREES or PERCENT.

Not used for integer values in IU

Parameters
aLengthis the number of digits for mantissa (0 = no truncation) must be <= 6

Definition at line 101 of file unit_binder.cpp.

102 {
103  m_precision = std::min( aLength, 6 );
104 }
int m_precision
0 to 6
Definition: unit_binder.h:214

References m_precision.

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES().

◆ setPrecision()

double UNIT_BINDER::setPrecision ( double  aValue,
bool  aValueUsesUserUnits 
)
protected

When m_precision > 0 truncate the value aValue to show only m_precision digits in mantissa.

used in GetDoubleValue to return a rounded value. Mainly for units set to DEGREES.

Parameters
aValueis the value to modify.
aValueUsesUserUnitsmust be set to true if aValue is a user value, and set to false if aValue is a internal unit value.
Returns
the "rounded" value.

Definition at line 359 of file unit_binder.cpp.

360 {
361  if( m_precision > 1 )
362  {
363  int scale = pow( 10, m_precision );
364  long long tmp = aValueUsesUserUnits ? aValue : To_User_Unit( m_units, aValue ) * scale;
365  aValue = static_cast<double>( tmp ) / scale;
366 
367  if( !aValueUsesUserUnits )
368  aValue = From_User_Unit( m_units, aValue );
369  }
370 
371  return aValue;
372 }
EDA_UNITS m_units
Definition: unit_binder.h:211
int m_precision
0 to 6
Definition: unit_binder.h:214
double To_User_Unit(EDA_UNITS aUnit, double aValue)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:68
const int scale
double From_User_Unit(EDA_UNITS aUnits, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:282

References From_User_Unit(), m_precision, m_units, scale, and To_User_Unit().

Referenced by ChangeDoubleValue(), GetDoubleValue(), and SetDoubleValue().

◆ SetUnits()

void UNIT_BINDER::SetUnits ( EDA_UNITS  aUnits)
virtual

Normally not needed (as the UNIT_BINDER inherits from the parent frame), but can be used to set to DEGREES for angular controls.

Definition at line 92 of file unit_binder.cpp.

93 {
94  m_units = aUnits;
95 
96  if( m_unitLabel )
98 }
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:424
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208

References GetAbbreviatedUnitsLabel(), m_dataType, m_unitLabel, and m_units.

Referenced by DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PAD_PRIMITIVES_TRANSFORM::DIALOG_PAD_PRIMITIVES_TRANSFORM(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::DIALOG_PNS_LENGTH_TUNING_SETTINGS(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), onUnitsChanged(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_FORMATTING::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_POSITION_RELATIVE::updateDialogControls(), and DIALOG_MOVE_EXACT::updateDialogControls().

◆ SetValue() [1/2]

void UNIT_BINDER::SetValue ( int  aValue)
virtual

Set new value (in Internal Units) for the text field, taking care of units conversion.

Definition at line 248 of file unit_binder.cpp.

249 {
250  double value = aValue;
251  double displayValue = m_originTransforms.ToDisplay( value, m_coordType );
252 
253  if( displayValue == 0 && m_negativeZero )
254  SetValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
255  else
256  SetValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
257 }
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
Type of coordinate for display origin transforms.
Definition: unit_binder.h:229
ORIGIN_TRANSFORMS & m_originTransforms
A reference to an ORIGIN_TRANSFORMS object.
Definition: unit_binder.h:226
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
bool m_negativeZero
Indicates "-0" should be displayed for 0.
Definition: unit_binder.h:212
virtual int ToDisplay(int aValue, COORD_TYPES_T aCoordType) const
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:204

References m_coordType, m_dataType, m_negativeZero, m_originTransforms, m_units, StringFromValue(), and ORIGIN_TRANSFORMS::ToDisplay().

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CREATE_ARRAY::calculateCircularArrayProperties(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PANEL_SETUP_FORMATTING::ImportSettingsFrom(), DIALOG_PLOT::init_Dialog(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_POSITION_RELATIVE::OnClear(), DIALOG_MOVE_EXACT::OnClear(), DIALOG_PAD_PROPERTIES::OnOffsetCheckbox(), DIALOG_PAD_PROPERTIES::OnPadToDieCheckbox(), DIALOG_GRID_SETTINGS::OnResetGridOriginClick(), onUnitsChanged(), MWAVE_POLYGONAL_SHAPE_DLG::ReadDataShapeDescr(), DIALOG_JUNCTION_PROPS::resetDefaults(), DIALOG_LINE_WIRE_BUS_PROPERTIES::resetDefaults(), SetDoubleValue(), DIALOG_LIB_NEW_SYMBOL::SetPinTextPosition(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), PANEL_SYM_EDITING_OPTIONS::TransferDataToWindow(), PANEL_SETUP_FORMATTING::TransferDataToWindow(), DIALOG_JUNCTION_PROPS::TransferDataToWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow(), DIALOG_TRACK_VIA_SIZE::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::TransferDataToWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::TransferDataToWindow(), DIALOG_TARGET_PROPERTIES::TransferDataToWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), PANEL_SETUP_MASK_AND_PASTE::TransferDataToWindow(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ SetValue() [2/2]

void UNIT_BINDER::SetValue ( const wxString &  aValue)

Definition at line 272 of file unit_binder.cpp.

273 {
274  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
275  wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
276 
277  if( textEntry )
278  textEntry->SetValue( aValue );
279  else if( staticText )
280  staticText->SetLabel( aValue );
281 
282  if( m_allowEval )
283  m_eval.Clear();
284 
285  if( m_unitLabel )
287 }
wxString GetAbbreviatedUnitsLabel(EDA_UNITS aUnit, EDA_DATA_TYPE aType)
Get the units string for a given units type.
Definition: base_units.cpp:424
EDA_UNITS m_units
Definition: unit_binder.h:211
EDA_DATA_TYPE m_dataType
Definition: unit_binder.h:213
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208
NUMERIC_EVALUATOR m_eval
Definition: unit_binder.h:218
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
bool m_allowEval
Definition: unit_binder.h:219

References NUMERIC_EVALUATOR::Clear(), GetAbbreviatedUnitsLabel(), m_allowEval, m_dataType, m_eval, m_unitLabel, m_units, and m_valueCtrl.

◆ Show()

void UNIT_BINDER::Show ( bool  aShow,
bool  aResize = false 
)

Show/hide the label, widget and units label.

Parameters
aShowcalled for the Show() routine in wx
aResizeif true, the element will be sized to 0 on hide and -1 on show

Definition at line 447 of file unit_binder.cpp.

448 {
449  m_label->Show( aShow );
450  m_valueCtrl->Show( aShow );
451 
452  if( m_unitLabel )
453  m_unitLabel->Show( aShow );
454 
455  if( aResize )
456  {
457  if( aShow )
458  {
459  m_label->SetSize( -1, -1 );
460  m_valueCtrl->SetSize( -1, -1 );
461 
462  if( m_unitLabel )
463  m_unitLabel->SetSize( -1, -1 );
464  }
465  else
466  {
467  m_label->SetSize( 0, 0 );
468  m_valueCtrl->SetSize( 0, 0 );
469 
470  if( m_unitLabel )
471  m_unitLabel->SetSize( 0, 0 );
472  }
473  }
474 }
wxStaticText * m_label
Definition: unit_binder.h:206
wxStaticText * m_unitLabel
Can be nullptr.
Definition: unit_binder.h:208
wxWindow * m_valueCtrl
Definition: unit_binder.h:207

References m_label, m_unitLabel, and m_valueCtrl.

Referenced by PROPERTIES_FRAME::CopyPrmsFromItemToPanel(), DIALOG_PAD_PROPERTIES::OnUpdateUI(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow().

◆ Validate()

bool UNIT_BINDER::Validate ( double  aMin,
double  aMax,
EDA_UNITS  aUnits = EDA_UNITS::UNSCALED 
)
virtual

Validate the control against the given range, informing the user of any errors found.

Parameters
aMina minimum value for validation
aMaxa maximum value for validation
aUnitsthe units of the min/max parameters (use UNSCALED for internal units)
Returns
false on error.

Definition at line 201 of file unit_binder.cpp.

202 {
203  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
204 
205  if( !textEntry
206  || textEntry->GetValue() == INDETERMINATE_ACTION
207  || textEntry->GetValue() == INDETERMINATE_STATE )
208  {
209  return true;
210  }
211 
212  // TODO: Validate() does not currently support m_dataType being anything other than DISTANCE
213  // Note: aMin and aMax are not always given in internal units
214  if( GetValue() < From_User_Unit( aUnits, aMin ) )
215  {
216  double val_min_iu = From_User_Unit( aUnits, aMin );
217  m_errorMessage = wxString::Format( _( "%s must be at least %s." ),
219  StringFromValue( m_units, val_min_iu, true ) );
220 
221  textEntry->SelectAll();
222 
223  // Don't focus directly; we might be inside a KillFocus event handler
224  wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) );
225 
226  return false;
227  }
228 
229  if( GetValue() > From_User_Unit( aUnits, aMax ) )
230  {
231  double val_max_iu = From_User_Unit( aUnits, aMax );
232  m_errorMessage = wxString::Format( _( "%s must be less than %s." ),
234  StringFromValue( m_units, val_max_iu, true ) );
235 
236  textEntry->SelectAll();
237 
238  // Don't focus directly; we might be inside a KillFocus event handler
239  wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) );
240 
241  return false;
242  }
243 
244  return true;
245 }
wxString m_errorMessage
Definition: unit_binder.h:216
wxString valueDescriptionFromLabel(wxStaticText *aLabel)
EDA_UNITS m_units
Definition: unit_binder.h:211
wxStaticText * m_label
Definition: unit_binder.h:206
#define _(s)
wxWindow * m_valueCtrl
Definition: unit_binder.h:207
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual long long int GetValue()
Return the current value in Internal Units.
wxString StringFromValue(EDA_UNITS aUnits, double aValue, bool aAddUnitSymbol, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:204
#define INDETERMINATE_ACTION
Definition: base_units.h:48
#define INDETERMINATE_STATE
Used for holding indeterminate values, such as with multiple selections holding different values or c...
Definition: base_units.h:47
double From_User_Unit(EDA_UNITS aUnits, double aValue)
Return in internal units the value "val" given in a real unit such as "in", "mm" or "deg".
Definition: base_units.cpp:282

References _, Format(), From_User_Unit(), GetValue(), INDETERMINATE_ACTION, INDETERMINATE_STATE, m_errorMessage, m_label, m_units, m_valueCtrl, StringFromValue(), and valueDescriptionFromLabel().

Referenced by DIALOG_PNS_LENGTH_TUNING_SETTINGS::AcceptOptions(), DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_AND_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAGES_SETTINGS::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate(), and DIALOG_FOOTPRINT_PROPERTIES::Validate().

Member Data Documentation

◆ m_allowEval

bool UNIT_BINDER::m_allowEval
protected

◆ m_coordType

ORIGIN_TRANSFORMS::COORD_TYPES_T UNIT_BINDER::m_coordType
protected

Type of coordinate for display origin transforms.

Definition at line 229 of file unit_binder.h.

Referenced by ChangeDoubleValue(), ChangeValue(), GetCoordType(), GetDoubleValue(), GetValue(), SetCoordType(), SetDoubleValue(), and SetValue().

◆ m_dataType

EDA_DATA_TYPE UNIT_BINDER::m_dataType
protected

◆ m_errorMessage

wxString UNIT_BINDER::m_errorMessage
protected

Definition at line 216 of file unit_binder.h.

Referenced by delayedFocusHandler(), and Validate().

◆ m_eval

NUMERIC_EVALUATOR UNIT_BINDER::m_eval
protected

◆ m_frame

EDA_DRAW_FRAME* UNIT_BINDER::m_frame
protected

The bound widgets.

Definition at line 203 of file unit_binder.h.

Referenced by onUnitsChanged(), UNIT_BINDER(), and ~UNIT_BINDER().

◆ m_label

wxStaticText* UNIT_BINDER::m_label
protected

Definition at line 206 of file unit_binder.h.

Referenced by Enable(), SetLabel(), Show(), and Validate().

◆ m_needsEval

bool UNIT_BINDER::m_needsEval
protected

Definition at line 220 of file unit_binder.h.

Referenced by GetDoubleValue(), GetValue(), onKillFocus(), onSetFocus(), and UNIT_BINDER().

◆ m_negativeZero

bool UNIT_BINDER::m_negativeZero
protected

Indicates "-0" should be displayed for 0.

Definition at line 212 of file unit_binder.h.

Referenced by ChangeDoubleValue(), ChangeValue(), SetDoubleValue(), SetNegativeZero(), SetValue(), and UNIT_BINDER().

◆ m_originTransforms

ORIGIN_TRANSFORMS& UNIT_BINDER::m_originTransforms
protected

A reference to an ORIGIN_TRANSFORMS object.

Definition at line 226 of file unit_binder.h.

Referenced by ChangeDoubleValue(), ChangeValue(), GetDoubleValue(), GetValue(), SetDoubleValue(), and SetValue().

◆ m_precision

int UNIT_BINDER::m_precision
protected

0 to 6

Definition at line 214 of file unit_binder.h.

Referenced by SetPrecision(), and setPrecision().

◆ m_selEnd

long UNIT_BINDER::m_selEnd
protected

Definition at line 223 of file unit_binder.h.

Referenced by onKillFocus(), onSetFocus(), and UNIT_BINDER().

◆ m_selStart

long UNIT_BINDER::m_selStart
protected

Selection start and end of the original text.

Definition at line 222 of file unit_binder.h.

Referenced by onKillFocus(), onSetFocus(), and UNIT_BINDER().

◆ m_unitLabel

wxStaticText* UNIT_BINDER::m_unitLabel
protected

Can be nullptr.

Currently used units.

Definition at line 208 of file unit_binder.h.

Referenced by ChangeValue(), Enable(), SetDataType(), SetUnits(), SetValue(), Show(), and UNIT_BINDER().

◆ m_units

◆ m_valueCtrl


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