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 wxCHECK( aVariant.GetType() == wxPG_VARIANT_TYPE_LONGLONG, wxEmptyString );
418
419 wxLongLongNative areaIU = aVariant.GetLongLong();
420
421 return m_parentFrame->StringFromValue( areaIU.ToDouble(), true, EDA_DATA_TYPE::AREA );
422}
423
424
426{
427 return nullptr;
428}
429
430
432 wxUIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
433 PGPROPERTY_DISTANCE( aParentFrame, ORIGIN_TRANSFORMS::NOT_A_COORD )
434{
435}
436
437
438bool PGPROPERTY_SIZE::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
439{
440 if( aValue.GetType() == wxT( "std::optional<int>" ) )
441 {
442 auto* data = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aValue.GetData() );
443
444 if( !data->Value().has_value() )
445 return wxEmptyString;
446
447 wxVariant value( data->Value().value() );
448 return wxUIntProperty::ValidateValue( value, aValidationInfo );
449 }
450
451 return wxUIntProperty::ValidateValue( aValue, aValidationInfo );
452}
453
454
456{
457 return nullptr;
458}
459
460
463 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
464 PGPROPERTY_DISTANCE( aParentFrame, aCoordType )
465{
466}
467
468
470{
471 return nullptr;
472}
473
474
476 wxFloatProperty( wxPG_LABEL, wxPG_LABEL, 0 )
477{
478 SetEditor( PG_RATIO_EDITOR::EDITOR_NAME );
479}
480
481
482const wxPGEditor* PGPROPERTY_RATIO::DoGetEditorClass() const
483{
484 wxCHECK_MSG( m_customEditor, wxPGEditor_TextCtrl,
485 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_RATIO!" ) );
486 return m_customEditor;
487}
488
489
490#if wxCHECK_VERSION( 3, 3, 0 )
491bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText,
492 wxPGPropValFormatFlags aArgFlags ) const
493#else
494bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText,
495 int aArgFlags ) const
496#endif
497{
498 // TODO(JE): Are there actual use cases for this?
499 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_RATIO::StringToValue should not be used." ) );
500}
501
502
503#if wxCHECK_VERSION( 3, 3, 0 )
504wxString PGPROPERTY_RATIO::ValueToString( wxVariant& aVariant,
505 wxPGPropValFormatFlags aArgFlags ) const
506#else
507wxString PGPROPERTY_RATIO::ValueToString( wxVariant& aVariant, int aArgFlags ) const
508#endif
509{
510 double value;
511
512 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
513 {
514 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
515
516 if( !variantData->Value().has_value() )
517 return wxEmptyString;
518
519 value = variantData->Value().value();
520 }
521 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
522 {
523 value = aVariant.GetDouble();
524 }
525 else
526 {
527 wxFAIL_MSG( wxT( "Expected double (or std::optional<double>) value type" ) );
528 return wxEmptyString;
529 }
530
531 return wxString::Format( wxS( "%g" ), value );
532}
533
534
535bool PGPROPERTY_RATIO::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
536{
537 if( aValue.GetType() == wxT( "std::optional<double>" ) )
538 {
539 auto* data = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aValue.GetData() );
540
541 if( !data->Value().has_value() )
542 return wxEmptyString;
543
544 wxVariant value( data->Value().value() );
545 return wxFloatProperty::ValidateValue( value, aValidationInfo );
546 }
547
548 return wxFloatProperty::ValidateValue( aValue, aValidationInfo );
549}
550
551
553{
554 return nullptr;
555}
556
557
558#if wxCHECK_VERSION( 3, 3, 0 )
559bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText,
560 wxPGPropValFormatFlags aArgFlags ) const
561#else
562bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText,
563 int aArgFlags ) const
564#endif
565{
566 double value = 0.0;
567
568 if( !aText.ToDouble( &value ) )
569 {
570 aVariant.MakeNull();
571 return true;
572 }
573
574 value *= m_scale;
575
576 if( aVariant.IsNull() || aVariant.GetDouble() != value )
577 {
578 aVariant = value;
579 return true;
580 }
581
582 return false;
583}
584
585
586#if wxCHECK_VERSION( 3, 3, 0 )
587wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant,
588 wxPGPropValFormatFlags aArgFlags ) const
589#else
590wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant, int aArgFlags ) const
591#endif
592{
593 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
594 {
595 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
596
597 if( variantData->Value().has_value() )
598 return wxString::Format( wxS( "%g\u00B0" ), variantData->Value().value() / m_scale );
599 else
600 return wxEmptyString;
601 }
602 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
603 {
604 return wxString::Format( wxS( "%g\u00B0" ), aVariant.GetDouble() / m_scale );
605 }
606 else if( aVariant.GetType() == wxS( "EDA_ANGLE" ) )
607 {
608 wxString ret;
609 static_cast<EDA_ANGLE_VARIANT_DATA*>( aVariant.GetData() )->Write( ret );
610 return ret;
611 }
612 else
613 {
614 wxCHECK_MSG( false, wxEmptyString, wxS( "Unexpected variant type in PGPROPERTY_ANGLE" ) );
615 }
616}
617
618
620{
621 return nullptr;
622}
623
624
626{
627 wxSize size( 16, -1 );
628
629 if( wxPropertyGrid* pg = GetGrid() )
630 size = pg->FromDIP( size );
631
632 return size;
633}
634
635
636void PGPROPERTY_COLORENUM::OnCustomPaint( wxDC& aDC, const wxRect& aRect,
637 wxPGPaintData& aPaintData )
638{
639 int index = aPaintData.m_choiceItem;
640
641 if( index < 0 )
642 index = GetIndex();
643
644 // GetIndex can return -1 when the control hasn't been set up yet
645 if( index < 0 || index >= static_cast<int>( GetChoices().GetCount() ) )
646 return;
647
648 wxColour color = GetColor( GetChoices().GetValue( index ) );
649
650 if( color == wxNullColour )
651 return;
652
653 aDC.SetPen( *wxTRANSPARENT_PEN );
654 aDC.SetBrush( wxBrush( color ) );
655 aDC.DrawRectangle( aRect );
656
657 aPaintData.m_drawnWidth = aRect.width;
658}
659
660
661#if wxCHECK_VERSION( 3, 3, 0 )
662wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue,
663 wxPGPropValFormatFlags aFlags ) const
664#else
665wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue, int aFlags ) const
666#endif
667{
668 if( aValue.GetType() != wxPG_VARIANT_TYPE_STRING )
669 return wxEmptyString;
670
671 return UnescapeString( aValue.GetString() );
672}
673
674
675#if wxCHECK_VERSION( 3, 3, 0 )
676bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString,
677 wxPGPropValFormatFlags aArgFlags ) const
678#else
679bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString,
680 int aFlags ) const
681#endif
682{
683 aVariant = EscapeString( aString, CTX_QUOTED_STR );
684 return true;
685}
686
687
688PGPROPERTY_BOOL::PGPROPERTY_BOOL( const wxString& aLabel, const wxString& aName, bool aValue ) :
689 wxBoolProperty( aLabel, aName, aValue )
690{
692}
693
694
695const wxPGEditor* PGPROPERTY_BOOL::DoGetEditorClass() const
696{
697 wxCHECK_MSG( m_customEditor, wxPGEditor_CheckBox,
698 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_BOOL!" ) );
699 return m_customEditor;
700}
701
702
703PGPROPERTY_COLOR4D::PGPROPERTY_COLOR4D( const wxString& aLabel, const wxString& aName,
704 COLOR4D aValue, COLOR4D aBackgroundColor ) :
705 wxStringProperty( aLabel, aName, aValue.ToCSSString() ),
706 m_backgroundColor( aBackgroundColor )
707{
708 SetEditor( PG_COLOR_EDITOR::EDITOR_NAME );
709#if wxCHECK_VERSION( 3, 3, 1 )
710 SetFlag( wxPGFlags::NoEditor );
711#elif wxCHECK_VERSION( 3, 3, 0 )
712 SetFlag( wxPGPropertyFlags::NoEditor );
713#else
714 SetFlag( wxPG_PROP_NOEDITOR );
715#endif
716}
717
718
719#if wxCHECK_VERSION( 3, 3, 0 )
720bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString,
721 wxPGPropValFormatFlags aArgFlags ) const
722#else
723bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString,
724 int aFlags ) const
725#endif
726{
727 aVariant.SetData( new COLOR4D_VARIANT_DATA( aString ) );
728 return true;
729}
730
731
732#if wxCHECK_VERSION( 3, 3, 0 )
733wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue,
734 wxPGPropValFormatFlags aFlags ) const
735#else
736wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue, int aFlags ) const
737#endif
738{
739 wxString ret;
740
741 if( aValue.IsType( wxS( "COLOR4D" ) ) )
742 static_cast<COLOR4D_VARIANT_DATA*>( aValue.GetData() )->Write( ret );
743 else
744 return wxStringProperty::ValueToString( aValue, aFlags );
745
746 return ret;
747}
748
749
751 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
752 m_parentFrame( aParentFrame )
753{
754}
755
756
757#if wxCHECK_VERSION( 3, 3, 0 )
758bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText,
759 wxPGPropValFormatFlags aArgFlags ) const
760#else
761bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText,
762 int aArgFlags ) const
763#endif
764{
765 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_RATIO::StringToValue should not be used." ) );
766}
767
768
769#if wxCHECK_VERSION( 3, 3, 0 )
770wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant,
771 wxPGPropValFormatFlags aArgFlags ) const
772#else
773wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant, int aArgFlags ) const
774#endif
775{
776 int value;
777
778 if( aVariant.GetType() == wxT( "std::optional<int>" ) )
779 {
780 auto* variantData = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aVariant.GetData() );
781
782 if( !variantData->Value().has_value() )
783 return wxEmptyString;
784
785 value = variantData->Value().value();
786 }
787 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
788 {
789 value = static_cast<int>( aVariant.GetInteger() );
790 }
791 else
792 {
793 wxFAIL_MSG( wxT( "Expected int (or std::optional<int>) value type" ) );
794 return wxEmptyString;
795 }
796
797 return m_parentFrame->StringFromValue( value, true, EDA_DATA_TYPE::TIME );
798}
799
800
801bool PGPROPERTY_TIME::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
802{
803 return true;
804}
805
806
808{
809 return nullptr;
810}
811
812
813PGPROPERTY_NET::PGPROPERTY_NET( const wxPGChoices& aChoices ) :
814 wxEnumProperty( wxPG_LABEL, wxPG_LABEL, const_cast<wxPGChoices&>( aChoices ) )
815{
816 SetEditor( wxS( "PG_NET_SELECTOR_EDITOR" ) );
817}
818
819
820const wxPGEditor* PGPROPERTY_NET::DoGetEditorClass() const
821{
822 wxCHECK_MSG( m_customEditor, wxPGEditor_Choice,
823 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_NET!" ) );
824
825 return m_customEditor;
826}
int color
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:104
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.