KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_footprint_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) 2016 Mario Luzeiro <[email protected]>
5 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
6 * Copyright (C) 2015 Dick Hollenbeck, [email protected]
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
28#include <bitmaps.h>
29#include <board_commit.h>
31#include <board.h>
32#include <footprint.h>
33#include <confirm.h>
35#include <filename_resolver.h>
36#include <pcb_edit_frame.h>
37#include <pcbnew_settings.h>
38#include <pgm_base.h>
39#include <project_pcb.h>
40#include <kiplatform/ui.h>
49
50
51int DIALOG_FOOTPRINT_PROPERTIES::m_page = 0; // remember the last open page during session
52
53
55 FOOTPRINT* aFootprint ) :
57 m_frame( aParent ),
58 m_footprint( aFootprint ),
59 m_posX( aParent, m_XPosLabel, m_ModPositionX, m_XPosUnit ),
60 m_posY( aParent, m_YPosLabel, m_ModPositionY, m_YPosUnit ),
61 m_orientation( aParent, m_orientationLabel, m_orientationCtrl, nullptr ),
62 m_netClearance( aParent, m_NetClearanceLabel, m_NetClearanceCtrl, m_NetClearanceUnits ),
63 m_solderMask( aParent, m_SolderMaskMarginLabel, m_SolderMaskMarginCtrl,
64 m_SolderMaskMarginUnits ),
65 m_solderPaste( aParent, m_SolderPasteMarginLabel, m_SolderPasteMarginCtrl,
66 m_SolderPasteMarginUnits ),
67 m_solderPasteRatio( aParent, m_PasteMarginRatioLabel, m_PasteMarginRatioCtrl,
68 m_PasteMarginRatioUnits ),
69 m_returnValue( FP_PROPS_CANCEL ),
70 m_initialized( false ),
71 m_gridSize( 0, 0 ),
72 m_lastRequestedSize( 0, 0 )
73{
74 // Create the 3D models page
76 m_NoteBook->AddPage( m_3dPanel, _("3D Models"), false );
77
79 m_NoteBook->AddPage( m_embeddedFiles, _( "Embedded Files" ) );
80
81 // Configure display origin transforms
84
86
87 m_delayedErrorMessage = wxEmptyString;
88 m_delayedFocusGrid = nullptr;
91 m_initialFocus = false;
92
93 // Give an icon
94 wxIcon icon;
95 icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_modedit ) );
96 SetIcon( icon );
97
98 // Give a bit more room for combobox editors
99 m_itemsGrid->SetDefaultRowSize( m_itemsGrid->GetDefaultRowSize() + 4 );
100
102 m_itemsGrid->PushEventHandler( new GRID_TRICKS( m_itemsGrid ) );
103
104 // Show/hide text item columns according to the user's preference
106 m_itemsGrid->ShowHideColumns( cfg->m_FootprintTextShownColumns );
107
108 m_orientation.SetUnits( EDA_UNITS::DEGREES );
110
111 // Set predefined rotations in combo dropdown, according to the locale floating point
112 // separator notation
113 double rot_list[] = { 0.0, 90.0, -90.0, 180.0 };
114
115 for( size_t ii = 0; ii < m_orientationCtrl->GetCount() && ii < 4; ++ii )
116 m_orientationCtrl->SetString( ii, wxString::Format( "%.1f", rot_list[ii] ) );
117
118 // Set font size for items showing long strings:
119 wxFont infoFont = KIUI::GetInfoFont( this );
120 m_libraryIDLabel->SetFont( infoFont );
121 m_tcLibraryID->SetFont( infoFont );
122
123 infoFont.SetStyle( wxFONTSTYLE_ITALIC );
124 m_staticTextInfoCopper->SetFont( infoFont );
125 m_staticTextInfoPaste->SetFont( infoFont );
126
127 m_NoteBook->SetSelection( m_page );
128
129 if( m_page == 0 )
130 {
134 }
135 else if( m_page == 1 )
136 {
138 }
139
141
142 m_solderPasteRatio.SetUnits( EDA_UNITS::PERCENT );
144
145 // Configure button logos
146 m_bpAdd->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
147 m_bpDelete->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
148
149 m_tcLibraryID->SetBackgroundColour( KIPLATFORM::UI::GetDialogBGColour() );
150
151 // We can't set the tab order through wxWidgets due to shortcomings in their mnemonics
152 // implementation on MSW
153 m_tabOrder = {
165 m_cbDNP,
172 };
173
175
176 // The 3D model tab was added after the base dtor. The final dialog size needs to be set
177 // accordingly.
178 SetSizer( m_GeneralBoxSizer );
179 Layout();
180 m_GeneralBoxSizer->Fit( this );
181
183}
184
185
187{
188 PCBNEW_SETTINGS* cfg = nullptr;
189
190 try
191 {
192 cfg = m_frame->GetPcbNewSettings();
193 }
194 catch( const std::runtime_error& e )
195 {
196 wxFAIL_MSG( e.what() );
197 }
198
199 if( cfg )
200 {
202 }
203
204 // Prevents crash bug in wxGrid's d'tor
206
207 // Delete the GRID_TRICKS.
208 m_itemsGrid->PopEventHandler( true );
209
210 // free the memory used by all models, otherwise models which were
211 // browsed but not used would consume memory
213
214 // the GL canvas has to be visible before it is destroyed
215 m_page = m_NoteBook->GetSelection();
216 m_NoteBook->SetSelection( 1 );
217}
218
219
221{
223 {
225 Close();
226 }
227}
228
229
231{
233 {
235 Close();
236 }
237}
238
239
241{
243 {
245 Close();
246 }
247}
248
249
251{
253 {
255 Close();
256 }
257}
258
259
261{
262 if( !wxDialog::TransferDataToWindow() )
263 return false;
264
265 if( !m_PanelGeneral->TransferDataToWindow() )
266 return false;
267
268 // Add the models to the panel
270 return false;
271
273 return false;
274
275 // Footprint Fields
276 for( PCB_FIELD* srcField : m_footprint->GetFields() )
277 {
278 PCB_FIELD field( *srcField );
280
281 m_fields->push_back( field );
282 }
283
284 // notify the grid
285 wxGridTableMessage tmsg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
287 m_itemsGrid->ProcessTableMessage( tmsg );
288
289 // Footprint Properties
290
293
294 m_BoardSideCtrl->SetSelection( (m_footprint->GetLayer() == B_Cu) ? 1 : 0 );
295
296 EDA_ANGLE orientation = m_footprint->GetOrientation();
298
299 m_cbLocked->SetValue( m_footprint->IsLocked() );
300 m_cbLocked->SetToolTip( _( "Locked footprints cannot be freely moved and oriented on the "
301 "canvas and can only be selected when the 'Locked items' checkbox "
302 "is checked in the selection filter." ) );
303
305 m_componentType->SetSelection( 0 );
306 else if( m_footprint->GetAttributes() & FP_SMD )
307 m_componentType->SetSelection( 1 );
308 else
309 m_componentType->SetSelection( 2 );
310
315 m_cbDNP->SetValue( m_footprint->GetAttributes() & FP_DNP );
316
317 // Local Clearances
318
319 if( m_footprint->GetLocalClearance().has_value() )
321 else
322 m_netClearance.SetValue( wxEmptyString );
323
324 if( m_footprint->GetLocalSolderMaskMargin().has_value() )
326 else
327 m_solderMask.SetValue( wxEmptyString );
328
329 if( m_footprint->GetLocalSolderPasteMargin().has_value() )
331 else
332 m_solderPaste.SetValue( wxEmptyString );
333
336 else
337 m_solderPasteRatio.SetValue( wxEmptyString );
338
340
342 {
343 default:
344 case ZONE_CONNECTION::INHERITED: m_ZoneConnectionChoice->SetSelection( 0 ); break;
345 case ZONE_CONNECTION::FULL: m_ZoneConnectionChoice->SetSelection( 1 ); break;
346 case ZONE_CONNECTION::THERMAL: m_ZoneConnectionChoice->SetSelection( 2 ); break;
347 case ZONE_CONNECTION::NONE: m_ZoneConnectionChoice->SetSelection( 3 ); break;
348 }
349
350 // Show the footprint's FPID.
351 m_tcLibraryID->SetValue( m_footprint->GetFPID().Format() );
352
353 for( int col = 0; col < m_itemsGrid->GetNumberCols(); col++ )
354 {
355 m_itemsGrid->SetColMinimalWidth( col, m_itemsGrid->GetVisibleWidth( col, true, false ) );
356
357 // Adjust the column size.
358 int col_size = m_itemsGrid->GetVisibleWidth( col );
359
360 if( col == PFC_LAYER ) // This one's a drop-down. Check all possible values.
361 {
362 BOARD* board = m_footprint->GetBoard();
363
364 for( PCB_LAYER_ID layer : board->GetEnabledLayers().Seq() )
365 col_size = std::max( col_size, GetTextExtent( board->GetLayerName( layer ) ).x );
366
367 // Swatch and gaps:
368 col_size += KiROUND( 14 * GetDPIScaleFactor() ) + 12;
369 }
370
371 if( m_itemsGrid->IsColShown( col ) )
372 m_itemsGrid->SetColSize( col, col_size );
373 }
374
375 m_itemsGrid->SetRowLabelSize( 0 );
376
377 Layout();
379 m_initialized = true;
380
381 return true;
382}
383
384
386{
388 return false;
389
390 if( !DIALOG_SHIM::Validate() )
391 return false;
392
393 // Validate texts.
394 for( size_t i = 0; i < m_fields->size(); ++i )
395 {
396 PCB_FIELD& field = m_fields->at( i );
397
398 // Check for missing field names.
399 if( field.GetName( false ).IsEmpty() )
400 {
402 m_delayedErrorMessage = wxString::Format( _( "Fields must have a name." ) );
405
406 return false;
407 }
408
410 int maxSize = pcbIUScale.mmToIU( TEXT_MAX_SIZE_MM );
411 int width = m_frame->ValueFromString( m_itemsGrid->GetCellValue( i, PFC_WIDTH ) );
412 int height = m_frame->ValueFromString( m_itemsGrid->GetCellValue( i, PFC_HEIGHT ) );
413
414 if( width < minSize )
415 {
416 wxString min = m_frame->StringFromValue( minSize, true );
417
418 m_itemsGrid->SetCellValue( i, PFC_WIDTH, min );
419
421 m_delayedErrorMessage = wxString::Format( _( "Text width must be at least %s." ), min );
424
425 return false;
426 }
427 else if( width > maxSize )
428 {
429 wxString max = m_frame->StringFromValue( maxSize, true );
430
431 m_itemsGrid->SetCellValue( i, PFC_WIDTH, max );
432
434 m_delayedErrorMessage = wxString::Format( _( "Text width must be at most %s." ), max );
437
438 return false;
439 }
440
441 if( height < minSize )
442 {
443 wxString min = m_frame->StringFromValue( minSize, true );
444
445 m_itemsGrid->SetCellValue( i, PFC_HEIGHT, min );
446
448 m_delayedErrorMessage = wxString::Format( _( "Text height must be at least %s." ), min );
451
452 return false;
453 }
454 else if( height > maxSize )
455 {
456 wxString max = m_frame->StringFromValue( maxSize, true );
457
458 m_itemsGrid->SetCellValue( i, PFC_HEIGHT, max );
459
461 m_delayedErrorMessage = wxString::Format( _( "Text height must be at most %s." ), max );
464
465 return false;
466 }
467
468 // Test for acceptable values for thickness and size and clamp if fails
469 int maxPenWidth = ClampTextPenSize( field.GetTextThickness(), field.GetTextSize() );
470
471 if( field.GetTextThickness() > maxPenWidth )
472 {
473 wxString clamped = m_frame->StringFromValue( maxPenWidth, true );
474
475 m_itemsGrid->SetCellValue( i, PFC_THICKNESS, clamped );
476
478 m_delayedErrorMessage = wxString::Format( _( "Text thickness is too large for the "
479 "text size.\n"
480 "It will be clamped at %s." ),
481 clamped );
484
485 return false;
486 }
487 }
488
489 if( !m_netClearance.Validate( 0, INT_MAX ) )
490 return false;
491
492 return true;
493}
494
495
497{
498 if( !Validate() )
499 return false;
500
502 return false;
503
504 // This only commits the editor, model updating is done below so it is inside
505 // the commit
507 return false;
508
510 return false;
511
512 auto view = m_frame->GetCanvas()->GetView();
513 BOARD_COMMIT commit( m_frame );
514 commit.Modify( m_footprint );
515
516 // Update fields
517 for( size_t ii = 0; ii < m_fields->size(); ++ii )
518 {
519 PCB_FIELD& field = m_fields->at( ii );
521 }
522
523 size_t i = 0;
524
525 for( PCB_FIELD* field : m_footprint->GetFields() )
526 {
527 // copy grid table entries till we run out, then delete any remaining texts
528 if( i < m_fields->size() )
529 *field = m_fields->at( i++ );
530 else
531 field->DeleteStructure();
532 }
533
534 // if there are still grid table entries, create new fields for them
535 while( i < m_fields->size() )
536 {
537 view->Add( m_footprint->AddField( m_fields->at( i++ ) ) );
538 }
539
540 // Initialize masks clearances
541 if( m_netClearance.IsNull() )
543 else
545
546 if( m_solderMask.IsNull() )
548 else
550
551 if( m_solderPaste.IsNull() )
553 else
555
558 else
560
561 switch( m_ZoneConnectionChoice->GetSelection() )
562 {
563 default:
564 case 0: m_footprint->SetLocalZoneConnection( ZONE_CONNECTION::INHERITED ); break;
565 case 1: m_footprint->SetLocalZoneConnection( ZONE_CONNECTION::FULL ); break;
566 case 2: m_footprint->SetLocalZoneConnection( ZONE_CONNECTION::THERMAL ); break;
567 case 3: m_footprint->SetLocalZoneConnection( ZONE_CONNECTION::NONE ); break;
568 }
569
570 // Set Footprint Position
572 m_footprint->SetPosition( pos );
573 m_footprint->SetLocked( m_cbLocked->GetValue() );
574
575 int attributes = 0;
576
577 switch( m_componentType->GetSelection() )
578 {
579 case 0: attributes |= FP_THROUGH_HOLE; break;
580 case 1: attributes |= FP_SMD; break;
581 default: break;
582 }
583
584 if( m_boardOnly->GetValue() )
585 attributes |= FP_BOARD_ONLY;
586
587 if( m_excludeFromPosFiles->GetValue() )
588 attributes |= FP_EXCLUDE_FROM_POS_FILES;
589
590 if( m_excludeFromBOM->GetValue() )
591 attributes |= FP_EXCLUDE_FROM_BOM;
592
593 if( m_cbDNP->GetValue() )
594 attributes |= FP_DNP;
595
596 if( m_noCourtyards->GetValue() )
597 attributes |= FP_ALLOW_MISSING_COURTYARD;
598
599 if( m_allowSolderMaskBridges->GetValue() )
600 attributes |= FP_ALLOW_SOLDERMASK_BRIDGES;
601
602 m_footprint->SetAttributes( attributes );
603
605
606 if( m_footprint->GetOrientation() != orient )
608
609 // Set component side, that also have effect on the fields positions on board
610 bool change_layer = false;
611 if( m_BoardSideCtrl->GetSelection() == 0 ) // layer req = COMPONENT
612 {
613 if( m_footprint->GetLayer() == B_Cu )
614 change_layer = true;
615 }
616 else if( m_footprint->GetLayer() == F_Cu )
617 change_layer = true;
618
619 if( change_layer )
620 {
623 }
624
625 // Copy the models from the panel to the footprint
626 std::vector<FP_3DMODEL>& panelList = m_3dPanel->GetModelList();
627 std::vector<FP_3DMODEL>* fpList = &m_footprint->Models();
628 fpList->clear();
629 fpList->insert( fpList->end(), panelList.begin(), panelList.end() );
630
631 // This is a simple edit, we must create an undo entry
632 if( m_footprint->GetEditFlags() == 0 ) // i.e. not edited, or moved
633 commit.Push( _( "Edit Footprint Properties" ) );
634
636 return true;
637}
638
639
641{
643 return;
644
647
648 newField.SetVisible( false );
649 newField.SetLayer( m_footprint->GetLayer() == F_Cu ? F_Fab : B_Fab );
650 newField.SetFPRelativePosition( { 0, 0 } );
652
653 m_fields->push_back( newField );
654
655 // notify the grid
656 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
657 m_itemsGrid->ProcessTableMessage( msg );
658
659 m_itemsGrid->SetFocus();
660 m_itemsGrid->MakeCellVisible( m_fields->size() - 1, 0 );
661 m_itemsGrid->SetGridCursor( m_fields->size() - 1, 0 );
662
663 m_itemsGrid->EnableCellEditControl( true );
664 m_itemsGrid->ShowCellEditControl();
665
666 OnModify();
667}
668
669
671{
673 return;
674
675 wxArrayInt selectedRows = m_itemsGrid->GetSelectedRows();
676
677 if( selectedRows.empty() && m_itemsGrid->GetGridCursorRow() >= 0 )
678 selectedRows.push_back( m_itemsGrid->GetGridCursorRow() );
679
680 if( selectedRows.empty() )
681 return;
682
683 for( int row : selectedRows )
684 {
685
686 if( row < m_fields->GetMandatoryRowCount() )
687 {
688 DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
690 return;
691 }
692 }
693
694 m_itemsGrid->CommitPendingChanges( true /* quiet mode */ );
695 m_itemsGrid->ClearSelection();
696
697 // Reverse sort so deleting a row doesn't change the indexes of the other rows.
698 selectedRows.Sort( []( int* first, int* second ) { return *second - *first; } );
699
700 for( int row : selectedRows )
701 {
702 m_fields->erase( m_fields->begin() + row );
703
704 // notify the grid
705 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
706 m_itemsGrid->ProcessTableMessage( msg );
707
708 if( m_itemsGrid->GetNumberRows() > 0 )
709 {
710 m_itemsGrid->MakeCellVisible( std::max( 0, row-1 ), m_itemsGrid->GetGridCursorCol() );
711 m_itemsGrid->SetGridCursor( std::max( 0, row-1 ), m_itemsGrid->GetGridCursorCol() );
712 }
713 }
714
715 OnModify();
716}
717
718
720{
721 // Account for scroll bars
723
724 itemsWidth -= m_itemsGrid->GetRowLabelSize();
725
726 for( int i = 0; i < m_itemsGrid->GetNumberCols(); i++ )
727 {
728 if( i == 1 )
729 continue;
730
731 itemsWidth -= m_itemsGrid->GetColSize( i );
732 }
733
734 m_itemsGrid->SetColSize(
735 1, std::max( itemsWidth, m_itemsGrid->GetVisibleWidth( 0, true, false ) ) );
736
737 // Update the width of the 3D panel
739}
740
741
743{
744 if( !m_initialized )
745 return;
746
747 // Handle a grid error. This is delayed to OnUpdateUI so that we can change focus
748 // even when the original validation was triggered from a killFocus event, and so
749 // that the corresponding notebook page can be shown in the background when triggered
750 // from an OK.
751 if( m_delayedFocusRow >= 0 )
752 {
753 // We will re-enter this routine if an error dialog is displayed, so make sure we
754 // zero out our member variables first.
755 wxGrid* grid = m_delayedFocusGrid;
756 int row = m_delayedFocusRow;
757 int col = m_delayedFocusColumn;
758 wxString msg = m_delayedErrorMessage;
759
760 m_delayedFocusGrid = nullptr;
763 m_delayedErrorMessage = wxEmptyString;
764
765 if( !msg.IsEmpty() )
766 {
767 // Do not use DisplayErrorMessage(); it screws up window order on Mac
768 DisplayError( nullptr, msg );
769 }
770
771 grid->SetFocus();
772 grid->MakeCellVisible( row, col );
773
774 // Selecting the first grid item only makes sense for the
775 // items grid
776 if( !m_initialFocus || grid == m_itemsGrid )
777 {
778 grid->SetGridCursor( row, col );
779
780 if( !( col == 0 && row < m_fields->GetMandatoryRowCount() ) )
781 grid->EnableCellEditControl( true );
782
783 grid->ShowCellEditControl();
784
785 if( grid == m_itemsGrid && row == 0 && col == 0 )
786 {
787 auto referenceEditor = grid->GetCellEditor( 0, 0 );
788
789 if( auto textEntry = dynamic_cast<wxTextEntry*>( referenceEditor->GetControl() ) )
790 KIUI::SelectReferenceNumber( textEntry );
791
792 referenceEditor->DecRef();
793 }
794 }
795
796 m_initialFocus = false;
797 }
798}
799
800
802{
803 wxSize new_size = aEvent.GetSize();
804
805 if( ( !m_itemsGrid->IsCellEditControlShown() || m_lastRequestedSize != new_size )
806 && m_gridSize != new_size )
807 {
808 m_gridSize = new_size;
809
810 // A trick to fix a cosmetic issue: when, in m_itemsGrid, a layer selector widget has
811 // the focus (is activated in column 6) when resizing the grid, the widget is not moved.
812 // So just change the widget having the focus in this case
813 if( m_NoteBook->GetSelection() == 0 && !m_itemsGrid->HasFocus() )
814 {
815 int col = m_itemsGrid->GetGridCursorCol();
816
817 if( col == 6 ) // a layer selector widget can be activated
818 m_itemsGrid->SetFocus();
819 }
820
822 }
823
824 // We store this value to check whether the dialog is changing size. This might indicate
825 // that the user is scaling the dialog with an editor shown. Some editors do not close
826 // (at least on GTK) when the user drags a dialog corner
827 m_lastRequestedSize = new_size;
828
829 // Always propagate for a grid repaint (needed if the height changes, as well as width)
830 aEvent.Skip();
831
832}
833
834
835void DIALOG_FOOTPRINT_PROPERTIES::OnPageChanging( wxNotebookEvent& aEvent )
836{
838 aEvent.Veto();
839}
840
841
842void DIALOG_FOOTPRINT_PROPERTIES::OnCheckBox( wxCommandEvent& event )
843{
844 if( m_initialized )
845 OnModify();
846}
847
848
849void DIALOG_FOOTPRINT_PROPERTIES::OnCombobox( wxCommandEvent& event )
850{
851 if( m_initialized )
852 OnModify();
853}
854
855
856void DIALOG_FOOTPRINT_PROPERTIES::OnText( wxCommandEvent& event )
857{
858 if( m_initialized )
859 OnModify();
860}
861
862
863void DIALOG_FOOTPRINT_PROPERTIES::OnChoice( wxCommandEvent& event )
864{
865 if( m_initialized )
866 OnModify();
867}
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
Definition: bitmap.cpp:110
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:290
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:47
void SetFPRelativePosition(const VECTOR2I &aPos)
Definition: board_item.cpp:341
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:295
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:817
wxString ConvertCrossReferencesToKIIDs(const wxString &aSource) const
Convert cross-references back and forth between ${refDes:field} and ${kiid:field}.
Definition: board.cpp:1594
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:613
wxString ConvertKIIDsToCrossReferences(const wxString &aSource) const
Definition: board.cpp:1648
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Modify a given item in the model.
Definition: commit.h:108
Class DIALOG_FOOTPRINT_PROPERTIES_BASE.
void OnDeleteField(wxCommandEvent &) override
void OnUpdateUI(wxUpdateUIEvent &) override
void OnAddField(wxCommandEvent &) override
void OnText(wxCommandEvent &event) override
void OnCombobox(wxCommandEvent &event) override
PANEL_FP_PROPERTIES_3D_MODEL * m_3dPanel
void OnGridSize(wxSizeEvent &aEvent) override
void OnPageChanging(wxNotebookEvent &event) override
void EditLibraryFootprint(wxCommandEvent &) override
DIALOG_FOOTPRINT_PROPERTIES(PCB_EDIT_FRAME *aParent, FOOTPRINT *aFootprint)
void OnChoice(wxCommandEvent &event) override
void EditFootprint(wxCommandEvent &) override
void OnCheckBox(wxCommandEvent &event) override
void UpdateFootprint(wxCommandEvent &) override
void ChangeFootprint(wxCommandEvent &) override
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:250
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:102
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void OnModify()
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
EDA_ANGLE Normalize()
Definition: eda_angle.h:221
EDA_ANGLE Normalize180()
Definition: eda_angle.h:260
EDA_ITEM_FLAGS GetEditFlags() const
Definition: eda_item.h:133
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:98
virtual void SetVisible(bool aVisible)
Definition: eda_text.cpp:377
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:268
int GetTextThickness() const
Definition: eda_text.h:126
VECTOR2I GetTextSize() const
Definition: eda_text.h:248
void SetPosition(const VECTOR2I &aPos) override
Definition: footprint.cpp:2434
ZONE_CONNECTION GetLocalZoneConnection() const
Definition: footprint.h:286
void SetLocked(bool isLocked) override
Set the #MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: footprint.h:419
EDA_ANGLE GetOrientation() const
Definition: footprint.h:225
void SetLocalSolderPasteMarginRatio(std::optional< double > aRatio)
Definition: footprint.h:283
PCB_FIELD * AddField(const PCB_FIELD &aField)
Add a field to the symbol.
Definition: footprint.cpp:653
void SetAttributes(int aAttributes)
Definition: footprint.h:289
std::optional< int > GetLocalSolderPasteMargin() const
Definition: footprint.h:279
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: footprint.cpp:2337
int GetNextFieldId() const
Return the next ID for a field for this footprint.
Definition: footprint.h:742
std::optional< int > GetLocalClearance() const
Definition: footprint.h:273
int GetAttributes() const
Definition: footprint.h:288
void SetLocalZoneConnection(ZONE_CONNECTION aType)
Definition: footprint.h:285
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:234
const LIB_ID & GetFPID() const
Definition: footprint.h:246
bool IsLocked() const override
Definition: footprint.h:409
std::optional< double > GetLocalSolderPasteMarginRatio() const
Definition: footprint.h:282
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: footprint.cpp:2372
void GetFields(std::vector< PCB_FIELD * > &aVector, bool aVisibleOnly) const
Populate a std::vector with PCB_TEXTs.
Definition: footprint.cpp:647
std::vector< FP_3DMODEL > & Models()
Definition: footprint.h:218
void SetLocalSolderMaskMargin(std::optional< int > aMargin)
Definition: footprint.h:277
void SetLocalClearance(std::optional< int > aClearance)
Definition: footprint.h:274
std::optional< int > GetLocalSolderMaskMargin() const
Definition: footprint.h:276
void SetLocalSolderPasteMargin(std::optional< int > aMargin)
Definition: footprint.h:280
VECTOR2I GetPosition() const override
Definition: footprint.h:222
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
UTF8 Format() const
Definition: lib_id.cpp:118
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:295
bool TransferDataToWindow() override
bool TransferDataFromWindow() override
std::vector< FP_3DMODEL > & GetModelList()
FLIP_DIRECTION m_FlipDirection
wxString m_FootprintTextShownColumns
PCBNEW_SETTINGS * GetPcbNewSettings() const
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Return the BOARD_DESIGN_SETTINGS for the open project.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
The main frame for Pcbnew.
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
Definition: pcb_field.cpp:92
void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings) override
Definition: pcb_text.cpp:303
static S3D_CACHE * Get3DCacheManager(PROJECT *aProject, bool updateProjDir=false)
Return a pointer to an instance of the 3D cache manager.
Definition: project_pcb.cpp:77
void FlushCache(bool closePlugins=true)
Free all data in the cache and by default closes all plugins.
Definition: 3d_cache.cpp:524
void SetBitmap(const wxBitmapBundle &aBmp)
wxString StringFromValue(double aValue, bool aAddUnitLabel=false, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aValue in internal units into a united string.
int ValueFromString(const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
Converts aTextValue in aUnits to internal units used by the frame.
virtual long long int GetValue()
Return the current value in Internal Units.
virtual void SetPrecision(int aLength)
Normally not needed, but can be used to set the precision when using internal units that are floats (...
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...
virtual EDA_ANGLE GetAngleValue()
virtual void SetNegativeZero()
Definition: unit_binder.h:73
virtual double GetDoubleValue()
Return the current value in Internal Units.
virtual void SetAngleValue(const EDA_ANGLE &aValue)
virtual void SetDoubleValue(double aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
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.
virtual void SetValue(long long int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
void SetCoordType(ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType)
Set the current origin transform mode.
Definition: unit_binder.h:200
bool IsNull() const
Return true if the control holds no value (ie: empty string, not 0).
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=true, bool aKeep=false)
Calculate the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:778
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:496
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:277
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:451
wxString GetShownColumnsAsString()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:466
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:646
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:170
This file is part of the common library.
const int minSize
Push and Shove router track width and via size dialog.
#define _(s)
Declaration of the eda_3d_viewer class.
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
Definition: eda_text.h:47
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
Definition: eda_text.h:48
@ FP_SMD
Definition: footprint.h:80
@ FP_DNP
Definition: footprint.h:87
@ FP_ALLOW_MISSING_COURTYARD
Definition: footprint.h:86
@ FP_EXCLUDE_FROM_POS_FILES
Definition: footprint.h:81
@ FP_BOARD_ONLY
Definition: footprint.h:83
@ FP_EXCLUDE_FROM_BOM
Definition: footprint.h:82
@ FP_THROUGH_HOLE
Definition: footprint.h:79
@ FP_ALLOW_SOLDERMASK_BRIDGES
Definition: footprint.h:85
int ClampTextPenSize(int aPenSize, int aSize, bool aStrict)
Pen width should not allow characters to become cluttered up in their own fatness.
Definition: gr_text.cpp:72
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ B_Cu
Definition: layer_ids.h:65
@ F_Fab
Definition: layer_ids.h:119
@ F_Cu
Definition: layer_ids.h:64
@ B_Fab
Definition: layer_ids.h:118
wxColour GetDialogBGColour()
Definition: wxgtk/ui.cpp:61
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: wxgtk/ui.cpp:252
KICOMMON_API wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:155
KICOMMON_API void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: ui_common.cpp:229
@ PFC_HEIGHT
@ PFC_THICKNESS
see class PGM_BASE
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
wxString GetUserFieldName(int aFieldNdx, bool aTranslateForHI)
#define DO_TRANSLATE