KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pg_properties.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2020-2023 CERN
5 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
6 * @author Maciej Suminski <[email protected]>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 3
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#include <wx/dc.h>
23#include <wx/propgrid/propgrid.h>
24
25#include <macros.h>
26#include <validators.h>
27#include <eda_draw_frame.h>
28#include <eda_units.h>
35#include <properties/property.h>
36#include <string_utils.h>
38
39
40class wxAnyToSTD_OPTIONAL_INT_VARIANTRegistrationImpl : public wxAnyToVariantRegistration
41{
42public:
44 : wxAnyToVariantRegistration( factory )
45 {
46 }
47
48public:
49 static bool IsSameClass(const wxAnyValueType* otherType)
50 {
51 return AreSameClasses( *s_instance.get(), *otherType );
52 }
53
54 static wxAnyValueType* GetInstance()
55 {
56 return s_instance.get();
57 }
58
59 virtual wxAnyValueType* GetAssociatedType() override
60 {
62 }
63private:
64 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
65 {
66 return wxTypeId(a) == wxTypeId(b);
67 }
68
69 static wxAnyValueTypeScopedPtr s_instance;
70};
71
72
74 new wxAnyValueTypeImpl<std::optional<int>>() );
75
76
78 s_wxAnyToSTD_OPTIONAL_INT_VARIANTRegistration(
80
81
82class wxAnyToSTD_OPTIONAL_DOUBLE_VARIANTRegistrationImpl : public wxAnyToVariantRegistration
83{
84public:
86 : wxAnyToVariantRegistration( factory )
87 {
88 }
89
90public:
91 static bool IsSameClass(const wxAnyValueType* otherType)
92 {
93 return AreSameClasses( *s_instance.get(), *otherType );
94 }
95
96 static wxAnyValueType* GetInstance()
97 {
98 return s_instance.get();
99 }
100
101 virtual wxAnyValueType* GetAssociatedType() override
102 {
104 }
105private:
106 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
107 {
108 return wxTypeId(a) == wxTypeId(b);
109 }
110
111 static wxAnyValueTypeScopedPtr s_instance;
112};
113
114
116 new wxAnyValueTypeImpl<std::optional<double>>() );
117
118
120 s_wxAnyToSTD_OPTIONAL_DOUBLE_VARIANTRegistration(
122
123
124class wxAnyToEDA_ANGLE_VARIANTRegistrationImpl : public wxAnyToVariantRegistration
125{
126public:
127 wxAnyToEDA_ANGLE_VARIANTRegistrationImpl( wxVariantDataFactory factory )
128 : wxAnyToVariantRegistration( factory )
129 {
130 }
131
132public:
133 static bool IsSameClass(const wxAnyValueType* otherType)
134 {
135 return AreSameClasses( *s_instance.get(), *otherType );
136 }
137
138 static wxAnyValueType* GetInstance()
139 {
140 return s_instance.get();
141 }
142
143 virtual wxAnyValueType* GetAssociatedType() override
144 {
146 }
147private:
148 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
149 {
150 return wxTypeId(a) == wxTypeId(b);
151 }
152
153 static wxAnyValueTypeScopedPtr s_instance;
154};
155
156
157wxAnyValueTypeScopedPtr
158 wxAnyToEDA_ANGLE_VARIANTRegistrationImpl::s_instance( new wxAnyValueTypeImpl<EDA_ANGLE>() );
159
160
162 s_wxAnyToEDA_ANGLE_VARIANTRegistration( &EDA_ANGLE_VARIANT_DATA::VariantDataFactory );
163
164
165class wxAnyToCOLOR4D_VARIANTRegistrationImpl : public wxAnyToVariantRegistration
166{
167public:
168 wxAnyToCOLOR4D_VARIANTRegistrationImpl( wxVariantDataFactory factory )
169 : wxAnyToVariantRegistration( factory )
170 {
171 }
172
173public:
174 static bool IsSameClass(const wxAnyValueType* otherType)
175 {
176 return AreSameClasses( *s_instance.get(), *otherType );
177 }
178
179 static wxAnyValueType* GetInstance()
180 {
181 return s_instance.get();
182 }
183
184 virtual wxAnyValueType* GetAssociatedType() override
185 {
187 }
188private:
189 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
190 {
191 return wxTypeId(a) == wxTypeId(b);
192 }
193
194 static wxAnyValueTypeScopedPtr s_instance;
195};
196
197
199 new wxAnyValueTypeImpl<KIGFX::COLOR4D>() );
200
201
203 s_wxAnyToCOLOR4D_VARIANTRegistration( &COLOR4D_VARIANT_DATA::VariantDataFactory );
204
205
206wxPGProperty* PGPropertyFactory( const PROPERTY_BASE* aProperty, EDA_DRAW_FRAME* aFrame )
207{
208 wxPGProperty* ret = nullptr;
209 PROPERTY_DISPLAY display = aProperty->Display();
210
211 switch( display )
212 {
214 ret = new PGPROPERTY_TIME( aFrame );
215 ret->SetEditor( PG_UNIT_EDITOR::BuildEditorName( aFrame ) );
216 break;
217
219 ret = new PGPROPERTY_SIZE( aFrame );
220 ret->SetEditor( PG_UNIT_EDITOR::BuildEditorName( aFrame ) );
221 break;
222
224 ret = new PGPROPERTY_AREA( aFrame );
225 ret->SetEditor( PG_UNIT_EDITOR::BuildEditorName( aFrame ) );
226 break;
227
229 ret = new PGPROPERTY_COORD( aFrame, aProperty->CoordType() );
230 ret->SetEditor( PG_UNIT_EDITOR::BuildEditorName( aFrame ) );
231 break;
232
235 {
237
238 if( display == PROPERTY_DISPLAY::PT_DECIDEGREE )
239 prop->SetScale( 10.0 );
240
241 ret = prop;
242 ret->SetEditor( PG_UNIT_EDITOR::BuildEditorName( aFrame ) );
243 break;
244 }
245
247 ret = new PGPROPERTY_RATIO();
248 break;
249
251 ret = new PGPROPERTY_NET( aProperty->Choices() );
252 break;
253
254 default:
255 wxFAIL;
257 /* fall through */
259 {
260 // Create a corresponding wxPGProperty
261 size_t typeId = aProperty->TypeHash();
262
263 // Enum property
264 if( aProperty->HasChoices() )
265 {
266 const_cast<PROPERTY_BASE*>( aProperty )->TranslateChoices();
267
268 // I do not know why enum property takes a non-const reference to wxPGChoices..
269 ret = new wxEnumProperty( wxPG_LABEL, wxPG_LABEL,
270 const_cast<wxPGChoices&>( aProperty->Choices() ) );
271 }
272 else if( typeId == TYPE_HASH( int ) || typeId == TYPE_HASH( long ) )
273 {
274 ret = new wxIntProperty();
275 }
276 else if( typeId == TYPE_HASH( unsigned int ) || typeId == TYPE_HASH( unsigned long ) )
277 {
278 ret = new wxUIntProperty();
279 }
280 else if( typeId == TYPE_HASH( float ) || typeId == TYPE_HASH( double ) )
281 {
282 ret = new wxFloatProperty();
283 }
284 else if( typeId == TYPE_HASH( bool ) )
285 {
286 ret = new PGPROPERTY_BOOL();
287 }
288 else if( typeId == TYPE_HASH( wxString ) )
289 {
290 ret = new PGPROPERTY_STRING();
291 }
292 else if( typeId == TYPE_HASH( COLOR4D ) )
293 {
294 ret = new PGPROPERTY_COLOR4D();
295 }
296 else
297 {
298 wxFAIL_MSG( wxString::Format( wxS( "Property %s not supported by PGPropertyFactory" ),
299 aProperty->Name() ) );
300 ret = new wxPropertyCategory();
301 ret->Enable( false );
302 }
303
304 break;
305 }
306 }
307
308 if( ret )
309 {
310 ret->SetLabel( wxGetTranslation( aProperty->Name() ) );
311 ret->SetName( aProperty->Name() );
312 ret->SetHelpString( wxGetTranslation( aProperty->Name() ) );
313 ret->SetClientData( const_cast<PROPERTY_BASE*>( aProperty ) );
314 }
315
316 return ret;
317}
318
319
322 m_parentFrame( aParentFrame ),
323 m_coordType( aCoordType )
324{
325}
326
327
331
332
333#if wxCHECK_VERSION( 3, 3, 0 )
334bool PGPROPERTY_DISTANCE::StringToDistance( wxVariant& aVariant, const wxString& aText,
335 wxPGPropValFormatFlags aFlags ) const
336#else
337bool PGPROPERTY_DISTANCE::StringToDistance( wxVariant& aVariant, const wxString& aText,
338 int aFlags ) const
339#endif
340{
341 // TODO(JE): Are there actual use cases for this?
342 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_DISTANCE::StringToDistance should not be used." ) );
343}
344
345
346#if wxCHECK_VERSION( 3, 3, 0 )
347wxString PGPROPERTY_DISTANCE::DistanceToString( wxVariant& aVariant,
348 wxPGPropValFormatFlags aFlags ) const
349#else
350wxString PGPROPERTY_DISTANCE::DistanceToString( wxVariant& aVariant, int aFlags ) const
351#endif
352{
353 if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
354 {
355 double distanceIU = aVariant.GetDouble();
356 ORIGIN_TRANSFORMS& transforms = m_parentFrame->GetOriginTransforms();
357 distanceIU = transforms.ToDisplay( distanceIU, m_coordType );
358 return m_parentFrame->StringFromValue( distanceIU, true, EDA_DATA_TYPE::DISTANCE );
359 }
360
361 long distanceIU;
362
363 if( aVariant.GetType() == wxT( "std::optional<int>" ) )
364 {
365 auto* variantData = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aVariant.GetData() );
366
367 if( !variantData->Value().has_value() )
368 return wxEmptyString;
369
370 distanceIU = variantData->Value().value();
371 }
372 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
373 {
374 distanceIU = aVariant.GetLong();
375 }
376 else
377 {
378 wxFAIL_MSG( wxT( "Expected int (or std::optional<int>) value type" ) );
379 return wxEmptyString;
380 }
381
382 ORIGIN_TRANSFORMS& transforms = m_parentFrame->GetOriginTransforms();
383
384 distanceIU = transforms.ToDisplay( static_cast<long long int>( distanceIU ), m_coordType );
385
386 return m_parentFrame->StringFromValue( distanceIU, true, EDA_DATA_TYPE::DISTANCE );
387}
388
389
391 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
392 m_parentFrame( aParentFrame )
393{
394}
395
396
397#if wxCHECK_VERSION( 3, 3, 0 )
398bool PGPROPERTY_AREA::StringToValue( wxVariant& aVariant, const wxString& aText,
399 wxPGPropValFormatFlags aArgFlags ) const
400#else
401bool PGPROPERTY_AREA::StringToValue( wxVariant& aVariant, const wxString& aText,
402 int aArgFlags ) const
403#endif
404{
405 // TODO(JE): Are there actual use cases for this?
406 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_AREA::StringToValue should not be used." ) );
407}
408
409
410#if wxCHECK_VERSION( 3, 3, 0 )
411wxString PGPROPERTY_AREA::ValueToString( wxVariant& aVariant,
412 wxPGPropValFormatFlags aArgFlags ) const
413#else
414wxString PGPROPERTY_AREA::ValueToString( wxVariant& aVariant, int aArgFlags ) const
415#endif
416{
417 wxLongLongNative areaIU;
418
419 if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONGLONG )
420 {
421 areaIU = aVariant.GetLongLong();
422 }
423 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
424 {
425 areaIU = wxLongLongNative( aVariant.GetLong() );
426 }
427 else
428 {
429 wxFAIL_MSG( wxString::Format( wxS( "Unexpected variant type in PGPROPERTY_AREA: %s" ),
430 aVariant.GetType() ) );
431 return wxEmptyString;
432 }
433
434 return m_parentFrame->StringFromValue( areaIU.ToDouble(), true, EDA_DATA_TYPE::AREA );
435}
436
437
439{
440 return nullptr;
441}
442
443
445 wxUIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
446 PGPROPERTY_DISTANCE( aParentFrame, ORIGIN_TRANSFORMS::NOT_A_COORD )
447{
448}
449
450
451bool PGPROPERTY_SIZE::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
452{
453 if( aValue.GetType() == wxT( "std::optional<int>" ) )
454 {
455 auto* data = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aValue.GetData() );
456
457 if( !data->Value().has_value() )
458 return wxEmptyString;
459
460 wxVariant value( data->Value().value() );
461 return wxUIntProperty::ValidateValue( value, aValidationInfo );
462 }
463
464 return wxUIntProperty::ValidateValue( aValue, aValidationInfo );
465}
466
467
469{
470 return nullptr;
471}
472
473
476 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
477 PGPROPERTY_DISTANCE( aParentFrame, aCoordType )
478{
479}
480
481
483{
484 return nullptr;
485}
486
487
489 wxFloatProperty( wxPG_LABEL, wxPG_LABEL, 0 )
490{
491 SetEditor( PG_RATIO_EDITOR::EDITOR_NAME );
492}
493
494
495const wxPGEditor* PGPROPERTY_RATIO::DoGetEditorClass() const
496{
497 wxCHECK_MSG( m_customEditor, wxPGEditor_TextCtrl,
498 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_RATIO!" ) );
499 return m_customEditor;
500}
501
502
503#if wxCHECK_VERSION( 3, 3, 0 )
504bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText,
505 wxPGPropValFormatFlags aArgFlags ) const
506#else
507bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText,
508 int aArgFlags ) const
509#endif
510{
511 // TODO(JE): Are there actual use cases for this?
512 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_RATIO::StringToValue should not be used." ) );
513}
514
515
516#if wxCHECK_VERSION( 3, 3, 0 )
517wxString PGPROPERTY_RATIO::ValueToString( wxVariant& aVariant,
518 wxPGPropValFormatFlags aArgFlags ) const
519#else
520wxString PGPROPERTY_RATIO::ValueToString( wxVariant& aVariant, int aArgFlags ) const
521#endif
522{
523 double value;
524
525 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
526 {
527 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
528
529 if( !variantData->Value().has_value() )
530 return wxEmptyString;
531
532 value = variantData->Value().value();
533 }
534 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
535 {
536 value = aVariant.GetDouble();
537 }
538 else
539 {
540 wxFAIL_MSG( wxT( "Expected double (or std::optional<double>) value type" ) );
541 return wxEmptyString;
542 }
543
544 return wxString::Format( wxS( "%g" ), value );
545}
546
547
548bool PGPROPERTY_RATIO::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
549{
550 if( aValue.GetType() == wxT( "std::optional<double>" ) )
551 {
552 auto* data = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aValue.GetData() );
553
554 if( !data->Value().has_value() )
555 return wxEmptyString;
556
557 wxVariant value( data->Value().value() );
558 return wxFloatProperty::ValidateValue( value, aValidationInfo );
559 }
560
561 return wxFloatProperty::ValidateValue( aValue, aValidationInfo );
562}
563
564
566{
567 return nullptr;
568}
569
570
571#if wxCHECK_VERSION( 3, 3, 0 )
572bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText,
573 wxPGPropValFormatFlags aArgFlags ) const
574#else
575bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText,
576 int aArgFlags ) const
577#endif
578{
579 double value = 0.0;
580
581 if( !aText.ToDouble( &value ) )
582 {
583 aVariant.MakeNull();
584 return true;
585 }
586
587 value *= m_scale;
588
589 if( aVariant.IsNull() || aVariant.GetDouble() != value )
590 {
591 aVariant = value;
592 return true;
593 }
594
595 return false;
596}
597
598
599#if wxCHECK_VERSION( 3, 3, 0 )
600wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant,
601 wxPGPropValFormatFlags aArgFlags ) const
602#else
603wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant, int aArgFlags ) const
604#endif
605{
606 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
607 {
608 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
609
610 if( variantData->Value().has_value() )
611 return wxString::Format( wxS( "%g\u00B0" ), variantData->Value().value() / m_scale );
612 else
613 return wxEmptyString;
614 }
615 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
616 {
617 return wxString::Format( wxS( "%g\u00B0" ), aVariant.GetDouble() / m_scale );
618 }
619 else if( aVariant.GetType() == wxS( "EDA_ANGLE" ) )
620 {
621 wxString ret;
622 static_cast<EDA_ANGLE_VARIANT_DATA*>( aVariant.GetData() )->Write( ret );
623 return ret;
624 }
625 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
626 {
627 return wxString::Format( wxS( "%g\u00B0" ), (double) aVariant.GetLong() / m_scale );
628 }
629 else
630 {
631 wxCHECK_MSG( false, wxEmptyString, wxS( "Unexpected variant type in PGPROPERTY_ANGLE" ) );
632 }
633}
634
635
637{
638 return nullptr;
639}
640
641
643{
644 wxSize size( 16, -1 );
645
646 if( wxPropertyGrid* pg = GetGrid() )
647 size = pg->FromDIP( size );
648
649 return size;
650}
651
652
653void PGPROPERTY_COLORENUM::OnCustomPaint( wxDC& aDC, const wxRect& aRect,
654 wxPGPaintData& aPaintData )
655{
656 int index = aPaintData.m_choiceItem;
657
658 if( index < 0 )
659 index = GetIndex();
660
661 // GetIndex can return -1 when the control hasn't been set up yet
662 if( index < 0 || index >= static_cast<int>( GetChoices().GetCount() ) )
663 return;
664
665 wxColour color = GetColor( GetChoices().GetValue( index ) );
666
667 if( color == wxNullColour )
668 return;
669
670 aDC.SetPen( *wxTRANSPARENT_PEN );
671 aDC.SetBrush( wxBrush( color ) );
672 aDC.DrawRectangle( aRect );
673
674 aPaintData.m_drawnWidth = aRect.width;
675}
676
677
678#if wxCHECK_VERSION( 3, 3, 0 )
679wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue,
680 wxPGPropValFormatFlags aFlags ) const
681#else
682wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue, int aFlags ) const
683#endif
684{
685 if( aValue.GetType() != wxPG_VARIANT_TYPE_STRING )
686 return wxEmptyString;
687
688 return UnescapeString( aValue.GetString() );
689}
690
691
692#if wxCHECK_VERSION( 3, 3, 0 )
693bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString,
694 wxPGPropValFormatFlags aArgFlags ) const
695#else
696bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString,
697 int aFlags ) const
698#endif
699{
700 aVariant = EscapeString( aString, CTX_QUOTED_STR );
701 return true;
702}
703
704
705PGPROPERTY_BOOL::PGPROPERTY_BOOL( const wxString& aLabel, const wxString& aName, bool aValue ) :
706 wxBoolProperty( aLabel, aName, aValue )
707{
709}
710
711
712const wxPGEditor* PGPROPERTY_BOOL::DoGetEditorClass() const
713{
714 wxCHECK_MSG( m_customEditor, wxPGEditor_CheckBox,
715 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_BOOL!" ) );
716 return m_customEditor;
717}
718
719
720PGPROPERTY_COLOR4D::PGPROPERTY_COLOR4D( const wxString& aLabel, const wxString& aName,
721 COLOR4D aValue, COLOR4D aBackgroundColor ) :
722 wxStringProperty( aLabel, aName, aValue.ToCSSString() ),
723 m_backgroundColor( aBackgroundColor )
724{
725 SetEditor( PG_COLOR_EDITOR::EDITOR_NAME );
726#if wxCHECK_VERSION( 3, 3, 1 )
727 SetFlag( wxPGFlags::NoEditor );
728#elif wxCHECK_VERSION( 3, 3, 0 )
729 SetFlag( wxPGPropertyFlags::NoEditor );
730#else
731 SetFlag( wxPG_PROP_NOEDITOR );
732#endif
733}
734
735
736#if wxCHECK_VERSION( 3, 3, 0 )
737bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString,
738 wxPGPropValFormatFlags aArgFlags ) const
739#else
740bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString,
741 int aFlags ) const
742#endif
743{
744 aVariant.SetData( new COLOR4D_VARIANT_DATA( aString ) );
745 return true;
746}
747
748
749#if wxCHECK_VERSION( 3, 3, 0 )
750wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue,
751 wxPGPropValFormatFlags aFlags ) const
752#else
753wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue, int aFlags ) const
754#endif
755{
756 wxString ret;
757
758 if( aValue.IsType( wxS( "COLOR4D" ) ) )
759 static_cast<COLOR4D_VARIANT_DATA*>( aValue.GetData() )->Write( ret );
760 else
761 return wxStringProperty::ValueToString( aValue, aFlags );
762
763 return ret;
764}
765
766
768 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
769 m_parentFrame( aParentFrame )
770{
771}
772
773
774#if wxCHECK_VERSION( 3, 3, 0 )
775bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText,
776 wxPGPropValFormatFlags aArgFlags ) const
777#else
778bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText,
779 int aArgFlags ) const
780#endif
781{
782 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_RATIO::StringToValue should not be used." ) );
783}
784
785
786#if wxCHECK_VERSION( 3, 3, 0 )
787wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant,
788 wxPGPropValFormatFlags aArgFlags ) const
789#else
790wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant, int aArgFlags ) const
791#endif
792{
793 int value;
794
795 if( aVariant.GetType() == wxT( "std::optional<int>" ) )
796 {
797 auto* variantData = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aVariant.GetData() );
798
799 if( !variantData->Value().has_value() )
800 return wxEmptyString;
801
802 value = variantData->Value().value();
803 }
804 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
805 {
806 value = static_cast<int>( aVariant.GetInteger() );
807 }
808 else
809 {
810 wxFAIL_MSG( wxT( "Expected int (or std::optional<int>) value type" ) );
811 return wxEmptyString;
812 }
813
814 return m_parentFrame->StringFromValue( value, true, EDA_DATA_TYPE::TIME );
815}
816
817
818bool PGPROPERTY_TIME::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
819{
820 return true;
821}
822
823
825{
826 return nullptr;
827}
828
829
830PGPROPERTY_NET::PGPROPERTY_NET( const wxPGChoices& aChoices ) :
831 wxEnumProperty( wxPG_LABEL, wxPG_LABEL, const_cast<wxPGChoices&>( aChoices ) )
832{
833 SetEditor( wxS( "PG_NET_SELECTOR_EDITOR" ) );
834}
835
836
837const wxPGEditor* PGPROPERTY_NET::DoGetEditorClass() const
838{
839 wxCHECK_MSG( m_customEditor, wxPGEditor_Choice,
840 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_NET!" ) );
841
842 return m_customEditor;
843}
int index
bool Write(wxString &aString) const override
static wxVariantData * VariantDataFactory(const wxAny &aAny)
static wxVariantData * VariantDataFactory(const wxAny &aAny)
bool Write(wxString &aString) const override
The base class for create windows for drawing purpose.
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:105
A class to perform either relative or absolute display origin transforms for a single axis of a point...
virtual int ToDisplay(int aValue, COORD_TYPES_T aCoordType) const
COORD_TYPES_T
The supported Display Origin Transform types.
A wxEnumProperty that displays a color next to the enum value.
void SetScale(double aScale)
wxString ValueToString(wxVariant &aVariant, int aArgFlags=0) const override
double m_scale
< Scale factor to convert between raw and displayed value
wxValidator * DoGetValidator() const override
Do not perform PG validation; the UX is not what we want.
bool StringToValue(wxVariant &aVariant, const wxString &aText, int aArgFlags=0) const override
PGPROPERTY_AREA(EDA_DRAW_FRAME *aParentFrame)
wxString ValueToString(wxVariant &aVariant, int aArgFlags=0) const override
wxValidator * DoGetValidator() const override
bool StringToValue(wxVariant &aVariant, const wxString &aText, int aArgFlags=0) const override
EDA_DRAW_FRAME * m_parentFrame
const wxPGEditor * DoGetEditorClass() const override
PGPROPERTY_BOOL(const wxString &aLabel=wxPG_LABEL, const wxString &aName=wxPG_LABEL, bool aValue=false)
KIGFX::COLOR4D m_backgroundColor
Used for rendering colors with opacity.
bool StringToValue(wxVariant &aVariant, const wxString &aText, int aFlags=0) const override
wxString ValueToString(wxVariant &aValue, int aFlags=0) const override
PGPROPERTY_COLOR4D(const wxString &aLabel=wxPG_LABEL, const wxString &aName=wxPG_LABEL, KIGFX::COLOR4D aValue=KIGFX::COLOR4D::UNSPECIFIED, KIGFX::COLOR4D aBackground=KIGFX::COLOR4D::UNSPECIFIED)
wxColour GetColor(int aValue)
wxSize OnMeasureImage(int aItem=-1) const override
void OnCustomPaint(wxDC &aDC, const wxRect &aRect, wxPGPaintData &aPaintData) override
Customized wxPGProperty class to handle angles.
PGPROPERTY_COORD(EDA_DRAW_FRAME *aParentFrame, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType)
wxValidator * DoGetValidator() const override
EDA_DRAW_FRAME * m_parentFrame
wxString DistanceToString(wxVariant &aVariant, int aArgFlags=0) const
bool StringToDistance(wxVariant &aVariant, const wxString &aText, int aArgFlags=0) const
virtual ~PGPROPERTY_DISTANCE()=0
ORIGIN_TRANSFORMS::COORD_TYPES_T m_coordType
PGPROPERTY_DISTANCE(EDA_DRAW_FRAME *aParentFrame, ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType)
PGPROPERTY_NET(const wxPGChoices &aChoices=wxPGChoices())
const wxPGEditor * DoGetEditorClass() const override
wxValidator * DoGetValidator() const override
bool ValidateValue(wxVariant &aValue, wxPGValidationInfo &aValidationInfo) const override
bool StringToValue(wxVariant &aVariant, const wxString &aText, int aArgFlags=0) const override
wxString ValueToString(wxVariant &aVariant, int aArgFlags=0) const override
const wxPGEditor * DoGetEditorClass() const override
wxValidator * DoGetValidator() const override
bool ValidateValue(wxVariant &aValue, wxPGValidationInfo &aValidationInfo) const override
PGPROPERTY_SIZE(EDA_DRAW_FRAME *aParentFrame)
wxString ValueToString(wxVariant &aValue, int aFlags=0) const override
bool StringToValue(wxVariant &aVariant, const wxString &aString, int aFlags=0) const override
bool StringToValue(wxVariant &aVariant, const wxString &aText, int aArgFlags=0) const override
wxString ValueToString(wxVariant &aVariant, int aArgFlags=0) const override
EDA_DRAW_FRAME * m_parentFrame
PGPROPERTY_TIME(EDA_DRAW_FRAME *aParentFrame)
wxValidator * DoGetValidator() const override
bool ValidateValue(wxVariant &aValue, wxPGValidationInfo &aValidationInfo) const override
static const wxString EDITOR_NAME
Definition pg_editors.h:75
static const wxString EDITOR_NAME
Definition pg_editors.h:91
static const wxString EDITOR_NAME
Definition pg_editors.h:117
static wxString BuildEditorName(EDA_DRAW_FRAME *aFrame)
virtual size_t TypeHash() const =0
Return type-id of the property type.
PROPERTY_DISPLAY Display() const
Definition property.h:308
ORIGIN_TRANSFORMS::COORD_TYPES_T CoordType() const
Definition property.h:311
virtual bool HasChoices() const
Return true if this PROPERTY has a limited set of possible values.
Definition property.h:246
const wxString & Name() const
Definition property.h:220
virtual const wxPGChoices & Choices() const
Return a limited set of possible values (e.g.
Definition property.h:226
std::optional< double > Value() const
static wxVariantData * VariantDataFactory(const wxAny &aAny)
std::optional< int > Value() const
static wxVariantData * VariantDataFactory(const wxAny &aAny)
wxAnyToCOLOR4D_VARIANTRegistrationImpl(wxVariantDataFactory factory)
static wxAnyValueType * GetInstance()
static bool AreSameClasses(const wxAnyValueType &a, const wxAnyValueType &b)
static bool IsSameClass(const wxAnyValueType *otherType)
virtual wxAnyValueType * GetAssociatedType() override
static wxAnyValueTypeScopedPtr s_instance
static wxAnyValueTypeScopedPtr s_instance
static bool IsSameClass(const wxAnyValueType *otherType)
virtual wxAnyValueType * GetAssociatedType() override
wxAnyToEDA_ANGLE_VARIANTRegistrationImpl(wxVariantDataFactory factory)
static bool AreSameClasses(const wxAnyValueType &a, const wxAnyValueType &b)
static bool IsSameClass(const wxAnyValueType *otherType)
wxAnyToSTD_OPTIONAL_DOUBLE_VARIANTRegistrationImpl(wxVariantDataFactory factory)
virtual wxAnyValueType * GetAssociatedType() override
static bool AreSameClasses(const wxAnyValueType &a, const wxAnyValueType &b)
static bool AreSameClasses(const wxAnyValueType &a, const wxAnyValueType &b)
virtual wxAnyValueType * GetAssociatedType() override
static bool IsSameClass(const wxAnyValueType *otherType)
wxAnyToSTD_OPTIONAL_INT_VARIANTRegistrationImpl(wxVariantDataFactory factory)
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition macros.h:83
wxPGProperty * PGPropertyFactory(const PROPERTY_BASE *aProperty, EDA_DRAW_FRAME *aFrame)
Customized abstract wxPGProperty class to handle coordinate/size units.
#define TYPE_HASH(x)
Definition property.h:74
PROPERTY_DISPLAY
Common property types.
Definition property.h:61
@ PT_DEGREE
Angle expressed in degrees.
Definition property.h:66
@ PT_COORD
Coordinate expressed in distance units (mm/inch)
Definition property.h:65
@ PT_RATIO
Definition property.h:68
@ PT_DECIDEGREE
Angle expressed in decidegrees.
Definition property.h:67
@ PT_AREA
Area expressed in distance units-squared (mm/inch)
Definition property.h:64
@ PT_DEFAULT
Default property for a given type.
Definition property.h:62
@ PT_SIZE
Size expressed in distance units (mm/inch)
Definition property.h:63
@ PT_NET
Net selection property.
Definition property.h:70
@ PT_TIME
Time expressed in ps.
Definition property.h:69
wxString UnescapeString(const wxString &aSource)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
@ CTX_QUOTED_STR
Custom text control validator definitions.