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
19 * along with this program. If not, see <https://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:
43 wxAnyToSTD_OPTIONAL_INT_VARIANTRegistrationImpl( wxVariantDataFactory factory ) :
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 }
63
64private:
65 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
66 {
67 return wxTypeId(a) == wxTypeId(b);
68 }
69
70 static wxAnyValueTypeScopedPtr s_instance;
71};
72
73
74wxAnyValueTypeScopedPtr
75wxAnyToSTD_OPTIONAL_INT_VARIANTRegistrationImpl::s_instance( new wxAnyValueTypeImpl<std::optional<int>>() );
76
77
79 s_wxAnyToSTD_OPTIONAL_INT_VARIANTRegistration( &STD_OPTIONAL_INT_VARIANT_DATA::VariantDataFactory );
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 }
105
106private:
107 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
108 {
109 return wxTypeId(a) == wxTypeId(b);
110 }
111
112 static wxAnyValueTypeScopedPtr s_instance;
113};
114
115
116wxAnyValueTypeScopedPtr
117wxAnyToSTD_OPTIONAL_DOUBLE_VARIANTRegistrationImpl::s_instance( new wxAnyValueTypeImpl<std::optional<double>>() );
118
119
121 s_wxAnyToSTD_OPTIONAL_DOUBLE_VARIANTRegistration( &STD_OPTIONAL_DOUBLE_VARIANT_DATA::VariantDataFactory );
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 }
147
148private:
149 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
150 {
151 return wxTypeId(a) == wxTypeId(b);
152 }
153
154 static wxAnyValueTypeScopedPtr s_instance;
155};
156
157
158wxAnyValueTypeScopedPtr 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 }
188
189private:
190 static bool AreSameClasses(const wxAnyValueType& a, const wxAnyValueType& b)
191 {
192 return wxTypeId(a) == wxTypeId(b);
193 }
194
195 static wxAnyValueTypeScopedPtr s_instance;
196};
197
198
199wxAnyValueTypeScopedPtr wxAnyToCOLOR4D_VARIANTRegistrationImpl::s_instance( 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 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_DISTANCE::StringToDistance should not be used." ) );
342}
343
344
345#if wxCHECK_VERSION( 3, 3, 0 )
346wxString PGPROPERTY_DISTANCE::DistanceToString( wxVariant& aVariant,
347 wxPGPropValFormatFlags aFlags ) const
348#else
349wxString PGPROPERTY_DISTANCE::DistanceToString( wxVariant& aVariant, int aFlags ) const
350#endif
351{
352 if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
353 {
354 double distanceIU = aVariant.GetDouble();
355 ORIGIN_TRANSFORMS& transforms = m_parentFrame->GetOriginTransforms();
356 distanceIU = transforms.ToDisplay( distanceIU, m_coordType );
357 return m_parentFrame->StringFromValue( distanceIU, true, EDA_DATA_TYPE::DISTANCE );
358 }
359
360 long distanceIU;
361
362 if( aVariant.GetType() == wxT( "std::optional<int>" ) )
363 {
364 auto* variantData = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aVariant.GetData() );
365
366 if( !variantData->Value().has_value() )
367 return wxEmptyString;
368
369 distanceIU = variantData->Value().value();
370 }
371 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
372 {
373 distanceIU = aVariant.GetLong();
374 }
375 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONGLONG )
376 {
377 distanceIU = static_cast<long>( aVariant.GetLongLong().GetValue() );
378 }
379 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_ULONGLONG )
380 {
381 distanceIU = static_cast<long>( aVariant.GetULongLong().GetValue() );
382 }
383 else
384 {
385 wxFAIL_MSG( wxT( "Expected int (or std::optional<int>) value type" ) );
386 return wxEmptyString;
387 }
388
389 ORIGIN_TRANSFORMS& transforms = m_parentFrame->GetOriginTransforms();
390
391 distanceIU = transforms.ToDisplay( static_cast<long long int>( distanceIU ), m_coordType );
392
393 return m_parentFrame->StringFromValue( distanceIU, true, EDA_DATA_TYPE::DISTANCE );
394}
395
396
398 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
399 m_parentFrame( aParentFrame )
400{
401}
402
403
404#if wxCHECK_VERSION( 3, 3, 0 )
405bool PGPROPERTY_AREA::StringToValue( wxVariant& aVariant, const wxString& aText,
406 wxPGPropValFormatFlags aArgFlags ) const
407#else
408bool PGPROPERTY_AREA::StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags ) const
409#endif
410{
411 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_AREA::StringToValue should not be used." ) );
412}
413
414
415#if wxCHECK_VERSION( 3, 3, 0 )
416wxString PGPROPERTY_AREA::ValueToString( wxVariant& aVariant, wxPGPropValFormatFlags aArgFlags ) const
417#else
418wxString PGPROPERTY_AREA::ValueToString( wxVariant& aVariant, int aArgFlags ) const
419#endif
420{
421 wxLongLongNative areaIU;
422
423 if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONGLONG )
424 {
425 areaIU = aVariant.GetLongLong();
426 }
427 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
428 {
429 areaIU = wxLongLongNative( aVariant.GetLong() );
430 }
431 else
432 {
433 wxFAIL_MSG( wxString::Format( wxS( "Unexpected variant type in PGPROPERTY_AREA: %s" ), aVariant.GetType() ) );
434 return wxEmptyString;
435 }
436
437 return m_parentFrame->StringFromValue( areaIU.ToDouble(), true, EDA_DATA_TYPE::AREA );
438}
439
440
442{
443 return nullptr;
444}
445
446
448 wxUIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
449 PGPROPERTY_DISTANCE( aParentFrame, ORIGIN_TRANSFORMS::NOT_A_COORD )
450{
451}
452
453
454bool PGPROPERTY_SIZE::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
455{
456 if( aValue.GetType() == wxT( "std::optional<int>" ) )
457 {
458 auto* data = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aValue.GetData() );
459
460 if( !data->Value().has_value() )
461 return wxEmptyString;
462
463 wxVariant value( data->Value().value() );
464 return wxUIntProperty::ValidateValue( value, aValidationInfo );
465 }
466
467 return wxUIntProperty::ValidateValue( aValue, aValidationInfo );
468}
469
470
472{
473 return nullptr;
474}
475
476
478 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
479 PGPROPERTY_DISTANCE( aParentFrame, aCoordType )
480{
481}
482
483
485{
486 return nullptr;
487}
488
489
491 wxFloatProperty( wxPG_LABEL, wxPG_LABEL, 0 )
492{
493 SetEditor( PG_RATIO_EDITOR::EDITOR_NAME );
494}
495
496
497const wxPGEditor* PGPROPERTY_RATIO::DoGetEditorClass() const
498{
499 wxCHECK_MSG( m_customEditor, wxPGEditor_TextCtrl,
500 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_RATIO!" ) );
501 return m_customEditor;
502}
503
504
505#if wxCHECK_VERSION( 3, 3, 0 )
506bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText,
507 wxPGPropValFormatFlags aArgFlags ) const
508#else
509bool PGPROPERTY_RATIO::StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags ) const
510#endif
511{
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, wxPGPropValFormatFlags aArgFlags ) const
518#else
519wxString PGPROPERTY_RATIO::ValueToString( wxVariant& aVariant, int aArgFlags ) const
520#endif
521{
522 double value;
523
524 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
525 {
526 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
527
528 if( !variantData->Value().has_value() )
529 return wxEmptyString;
530
531 value = variantData->Value().value();
532 }
533 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
534 {
535 value = aVariant.GetDouble();
536 }
537 else
538 {
539 wxFAIL_MSG( wxT( "Expected double (or std::optional<double>) value type" ) );
540 return wxEmptyString;
541 }
542
543 return wxString::Format( wxS( "%g" ), value );
544}
545
546
547bool PGPROPERTY_RATIO::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
548{
549 if( aValue.GetType() == wxT( "std::optional<double>" ) )
550 {
551 auto* data = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aValue.GetData() );
552
553 if( !data->Value().has_value() )
554 return wxEmptyString;
555
556 wxVariant value( data->Value().value() );
557 return wxFloatProperty::ValidateValue( value, aValidationInfo );
558 }
559
560 return wxFloatProperty::ValidateValue( aValue, aValidationInfo );
561}
562
563
565{
566 return nullptr;
567}
568
569
570#if wxCHECK_VERSION( 3, 3, 0 )
571bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText,
572 wxPGPropValFormatFlags aArgFlags ) const
573#else
574bool PGPROPERTY_ANGLE::StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags ) const
575#endif
576{
577 double value = 0.0;
578
579 if( !aText.ToDouble( &value ) )
580 {
581 aVariant.MakeNull();
582 return true;
583 }
584
585 value *= m_scale;
586
587 if( aVariant.IsNull() || aVariant.GetDouble() != value )
588 {
589 aVariant = value;
590 return true;
591 }
592
593 return false;
594}
595
596
597#if wxCHECK_VERSION( 3, 3, 0 )
598wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant, wxPGPropValFormatFlags aArgFlags ) const
599#else
600wxString PGPROPERTY_ANGLE::ValueToString( wxVariant& aVariant, int aArgFlags ) const
601#endif
602{
603 if( aVariant.GetType() == wxT( "std::optional<double>" ) )
604 {
605 auto* variantData = static_cast<STD_OPTIONAL_DOUBLE_VARIANT_DATA*>( aVariant.GetData() );
606
607 if( variantData->Value().has_value() )
608 return wxString::Format( wxS( "%g\u00B0" ), variantData->Value().value() / m_scale );
609 else
610 return wxEmptyString;
611 }
612 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_DOUBLE )
613 {
614 return wxString::Format( wxS( "%g\u00B0" ), aVariant.GetDouble() / m_scale );
615 }
616 else if( aVariant.GetType() == wxS( "EDA_ANGLE" ) )
617 {
618 wxString ret;
619 static_cast<EDA_ANGLE_VARIANT_DATA*>( aVariant.GetData() )->Write( ret );
620 return ret;
621 }
622 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
623 {
624 return wxString::Format( wxS( "%g\u00B0" ), (double) aVariant.GetLong() / m_scale );
625 }
626 else
627 {
628 wxCHECK_MSG( false, wxEmptyString, wxS( "Unexpected variant type in PGPROPERTY_ANGLE" ) );
629 }
630}
631
632
634{
635 return nullptr;
636}
637
638
640{
641 wxSize size( 16, -1 );
642
643 if( wxPropertyGrid* pg = GetGrid() )
644 size = pg->FromDIP( size );
645
646 return size;
647}
648
649
650void PGPROPERTY_COLORENUM::OnCustomPaint( wxDC& aDC, const wxRect& aRect, wxPGPaintData& aPaintData )
651{
652 int index = aPaintData.m_choiceItem;
653
654 if( index < 0 )
655 index = GetIndex();
656
657 // GetIndex can return -1 when the control hasn't been set up yet
658 if( index < 0 || index >= static_cast<int>( GetChoices().GetCount() ) )
659 return;
660
661 wxColour color = GetColor( GetChoices().GetValue( index ) );
662
663 if( color == wxNullColour )
664 return;
665
666 aDC.SetPen( *wxTRANSPARENT_PEN );
667 aDC.SetBrush( wxBrush( color ) );
668 aDC.DrawRectangle( aRect );
669
670 aPaintData.m_drawnWidth = aRect.width;
671}
672
673
674#if wxCHECK_VERSION( 3, 3, 0 )
675wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue, wxPGPropValFormatFlags aFlags ) const
676#else
677wxString PGPROPERTY_STRING::ValueToString( wxVariant& aValue, int aFlags ) const
678#endif
679{
680 if( aValue.GetType() != wxPG_VARIANT_TYPE_STRING )
681 return wxEmptyString;
682
683 return UnescapeString( aValue.GetString() );
684}
685
686
687#if wxCHECK_VERSION( 3, 3, 0 )
688bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString,
689 wxPGPropValFormatFlags aArgFlags ) const
690#else
691bool PGPROPERTY_STRING::StringToValue( wxVariant& aVariant, const wxString& aString, int aFlags ) const
692#endif
693{
694 aVariant = EscapeString( aString, CTX_QUOTED_STR );
695 return true;
696}
697
698
699PGPROPERTY_BOOL::PGPROPERTY_BOOL( const wxString& aLabel, const wxString& aName, bool aValue ) :
700 wxBoolProperty( aLabel, aName, aValue )
701{
703}
704
705
706const wxPGEditor* PGPROPERTY_BOOL::DoGetEditorClass() const
707{
708 wxCHECK_MSG( m_customEditor, wxPGEditor_CheckBox,
709 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_BOOL!" ) );
710 return m_customEditor;
711}
712
713
714PGPROPERTY_COLOR4D::PGPROPERTY_COLOR4D( const wxString& aLabel, const wxString& aName,
715 COLOR4D aValue, COLOR4D aBackgroundColor ) :
716 wxStringProperty( aLabel, aName, aValue.ToCSSString() ),
717 m_backgroundColor( aBackgroundColor )
718{
719 SetEditor( PG_COLOR_EDITOR::EDITOR_NAME );
720#if wxCHECK_VERSION( 3, 3, 1 )
721 SetFlag( wxPGFlags::NoEditor );
722#elif wxCHECK_VERSION( 3, 3, 0 )
723 SetFlag( wxPGPropertyFlags::NoEditor );
724#else
725 SetFlag( wxPG_PROP_NOEDITOR );
726#endif
727}
728
729
730#if wxCHECK_VERSION( 3, 3, 0 )
731bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString,
732 wxPGPropValFormatFlags aArgFlags ) const
733#else
734bool PGPROPERTY_COLOR4D::StringToValue( wxVariant& aVariant, const wxString& aString, int aFlags ) const
735#endif
736{
737 aVariant.SetData( new COLOR4D_VARIANT_DATA( aString ) );
738 return true;
739}
740
741
742#if wxCHECK_VERSION( 3, 3, 0 )
743wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue, wxPGPropValFormatFlags aFlags ) const
744#else
745wxString PGPROPERTY_COLOR4D::ValueToString( wxVariant& aValue, int aFlags ) const
746#endif
747{
748 wxString ret;
749
750 if( aValue.IsType( wxS( "COLOR4D" ) ) )
751 static_cast<COLOR4D_VARIANT_DATA*>( aValue.GetData() )->Write( ret );
752 else
753 return wxStringProperty::ValueToString( aValue, aFlags );
754
755 return ret;
756}
757
758
760 wxIntProperty( wxPG_LABEL, wxPG_LABEL, 0 ),
761 m_parentFrame( aParentFrame )
762{
763}
764
765
766#if wxCHECK_VERSION( 3, 3, 0 )
767bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText,
768 wxPGPropValFormatFlags aArgFlags ) const
769#else
770bool PGPROPERTY_TIME::StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags ) const
771#endif
772{
773 wxCHECK_MSG( false, false, wxS( "PGPROPERTY_RATIO::StringToValue should not be used." ) );
774}
775
776
777#if wxCHECK_VERSION( 3, 3, 0 )
778wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant, wxPGPropValFormatFlags aArgFlags ) const
779#else
780wxString PGPROPERTY_TIME::ValueToString( wxVariant& aVariant, int aArgFlags ) const
781#endif
782{
783 int value;
784
785 if( aVariant.GetType() == wxT( "std::optional<int>" ) )
786 {
787 auto* variantData = static_cast<STD_OPTIONAL_INT_VARIANT_DATA*>( aVariant.GetData() );
788
789 if( !variantData->Value().has_value() )
790 return wxEmptyString;
791
792 value = variantData->Value().value();
793 }
794 else if( aVariant.GetType() == wxPG_VARIANT_TYPE_LONG )
795 {
796 value = static_cast<int>( aVariant.GetInteger() );
797 }
798 else
799 {
800 wxFAIL_MSG( wxT( "Expected int (or std::optional<int>) value type" ) );
801 return wxEmptyString;
802 }
803
804 return m_parentFrame->StringFromValue( value, true, EDA_DATA_TYPE::TIME );
805}
806
807
808bool PGPROPERTY_TIME::ValidateValue( wxVariant& aValue, wxPGValidationInfo& aValidationInfo ) const
809{
810 return true;
811}
812
813
815{
816 return nullptr;
817}
818
819
820PGPROPERTY_NET::PGPROPERTY_NET( const wxPGChoices& aChoices ) :
821 wxEnumProperty( wxPG_LABEL, wxPG_LABEL, const_cast<wxPGChoices&>( aChoices ) )
822{
823 SetEditor( wxS( "PG_NET_SELECTOR_EDITOR" ) );
824}
825
826
827const wxPGEditor* PGPROPERTY_NET::DoGetEditorClass() const
828{
829 wxCHECK_MSG( m_customEditor, wxPGEditor_Choice,
830 wxT( "Make sure to RegisterEditorClass() for PGPROPERTY_NET!" ) );
831
832 return m_customEditor;
833}
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:101
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:314
ORIGIN_TRANSFORMS::COORD_TYPES_T CoordType() const
Definition property.h:317
virtual bool HasChoices() const
Return true if this PROPERTY has a limited set of possible values.
Definition property.h:247
const wxString & Name() const
Definition property.h:221
virtual const wxPGChoices & Choices() const
Return a limited set of possible values (e.g.
Definition property.h:227
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:79
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.