KiCad PCB EDA Suite
DIALOG_BOARD_REANNOTATE Class Reference

#include <dialog_board_reannotate.h>

Inheritance diagram for DIALOG_BOARD_REANNOTATE:
DIALOG_BOARD_REANNOTATE_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 DIALOG_BOARD_REANNOTATE (PCB_EDIT_FRAME *aParentFrame)
 
 ~DIALOG_BOARD_REANNOTATE ()
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void OnModify ()
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
void SetupStandardButtons (std::map< int, wxString > aLabels={})
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
bool HasKiway () const
 Safety check before asking for the Kiway reference. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 

Protected Member Functions

virtual void OnClose (wxCloseEvent &event)
 
void finishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void setSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int horizPixelsFromDU (int x) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxNotebook * m_notebook
 
wxPanel * m_StandardOptions
 
wxRadioButton * m_Down_Right
 
wxStaticBitmap * reannotate_down_right_bitmap
 
wxRadioButton * m_Right_Down
 
wxStaticBitmap * reannotate_right_down_bitmap
 
wxRadioButton * m_Down_Left
 
wxStaticBitmap * reannotate_down_left_bitmap
 
wxRadioButton * m_Left_Down
 
wxStaticBitmap * reannotate_left_down_bitmap
 
wxRadioButton * m_Up_Right
 
wxStaticBitmap * reannotate_up_right_bitmap
 
wxRadioButton * m_Right_Up
 
wxStaticBitmap * reannotate_right_up_bitmap
 
wxRadioButton * m_Up_Left
 
wxStaticBitmap * reannotate_up_left_bitmap
 
wxRadioButton * m_Left_Up
 
wxStaticBitmap * reannotate_left_up_bitmap
 
wxStaticText * m_staticText9
 
wxChoice * m_locationChoice
 
wxStaticText * m_SortGridText
 
wxChoice * m_GridChoice
 
wxStaticText * AnnotateLabel
 
wxRadioButton * m_AnnotateAll
 
wxRadioButton * m_AnnotateFront
 
wxRadioButton * m_AnnotateBack
 
wxRadioButton * m_AnnotateSelection
 
wxPanel * m_Advanced
 
wxStaticText * m_FrontRefDesStartText
 
wxTextCtrl * m_FrontRefDesStart
 
wxStaticText * m_BottomRefDesStartText
 
wxTextCtrl * m_BackRefDesStart
 
wxCheckBox * m_RemoveFrontPrefix
 
wxCheckBox * m_RemoveBackPrefix
 
wxStaticText * m_FrontPrefixText
 
wxTextCtrl * m_FrontPrefix
 
wxStaticText * m_BackPrefixText
 
wxTextCtrl * m_BackPrefix
 
wxCheckBox * m_ExcludeLocked
 
wxStaticText * m_ExcludeListText
 
wxTextCtrl * m_ExcludeList
 
WX_HTML_REPORT_PANELm_MessageWindow
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 
wxSize m_initialSize
 

Private Member Functions

void GetParameters (void)
 
void InitValues (void)
 Copy saved app settings to the dialog. More...
 
void OnApplyClick (wxCommandEvent &event) override
 
void OnCloseClick (wxCommandEvent &event) override
 
void FilterFrontPrefix (wxCommandEvent &event) override
 
void FilterBackPrefix (wxCommandEvent &event) override
 
void ShowReport (const wxString &aMessage, SEVERITY aSeverity)
 Break report into strings separated by
and sent to the reporter. More...
 
void LogFootprints (const wxString &aMessage, const std::vector< RefDesInfo > &aFootprints)
 Create a list of the footprints and their coordinates. More...
 
void LogChangePlan (void)
 Create an audit trail of the changes. More...
 
bool ReannotateBoard (void)
 Actually reannotate the board. More...
 
bool BuildFootprintList (std::vector< RefDesInfo > &aBadRefDes)
 Build the footprint lists, sort it, filter for excludes, then build the change list. More...
 
void BuildUnavailableRefsList ()
 Build list of unavailable references. E.g. unselected footprints or locked footprints. More...
 
void BuildChangeArray (std::vector< RefDesInfo > &aFootprints, unsigned int aStartRefDes, const wxString &aPrefix, bool aRemovePrefix, std::vector< RefDesInfo > &aBadRefDes)
 Scan through the footprint arrays and create the from -> to array. More...
 
RefDesChangeGetNewRefDes (FOOTPRINT *aFootprint)
 
int RoundToGrid (int aCoord, int aGrid)
 Round an int coordinate to a suitable grid. More...
 
wxString CoordTowxString (int aX, int aY)
 Convert coordinates to wxString. More...
 
void MakeSampleText (wxString &aMessage)
 Make the text to summarize what is about to happen. More...
 
void FilterPrefix (wxTextCtrl *aPrefix)
 Check to make sure the prefix (if there is one) is properly constructed. More...
 
RefDesTypeStrGetOrBuildRefDesInfo (const wxString &aRefDesPrefix, unsigned int aStartRefDes=0)
 Get the structure representing the information currently held for aRefDesPrefix or create one if it doesn't exist. More...
 
void OnCloseWindow (wxCloseEvent &aEvent)
 Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
 
void OnButton (wxCommandEvent &aEvent)
 Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
 
void OnGridEditorShown (wxGridEvent &event)
 
void OnGridEditorHidden (wxGridEvent &event)
 
 DECLARE_EVENT_TABLE ()
 

Private Attributes

std::vector< wxRadioButton * > m_sortButtons
 
std::vector< wxRadioButton * > m_scopeRadioButtons
 
std::vector< wxStaticBitmap * > Bitmaps
 
PCB_EDIT_FRAMEm_frame
 
FOOTPRINTS m_footprints
 
PCB_SELECTION m_selection
 
std::vector< RefDesChangem_changeArray
 
std::vector< RefDesInfom_frontFootprints
 
std::vector< RefDesInfom_backFootprints
 
std::vector< RefDesTypeStrm_refDesTypes
 
std::vector< wxString > m_excludeArray
 
int m_sortCode
 
int m_gridIndex
 
int m_annotationScope
 
int m_severity
 
double m_sortGridx
 
double m_sortGridy
 
wxString m_frontPrefixString
 
wxString m_backPrefixString
 
wxString m_validPrefixes
 
APP_SETTINGS_BASEm_settings
 
APP_SETTINGS_BASEm_Config
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Detailed Description

Definition at line 100 of file dialog_board_reannotate.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_BOARD_REANNOTATE()

DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE ( PCB_EDIT_FRAME aParentFrame)

Definition at line 99 of file dialog_board_reannotate.cpp.

100 : DIALOG_BOARD_REANNOTATE_BASE( aParentFrame ),
101 m_footprints( aParentFrame->GetBoard()->Footprints() )
102{
103 m_frame = aParentFrame;
105 InitValues();
106
107 m_FrontRefDesStart->SetValidator( wxTextValidator( wxFILTER_DIGITS ) );
108 m_BackRefDesStart->SetValidator( wxTextValidator( wxFILTER_DIGITS ) );
109
110 m_sdbSizerOK->SetLabel( _( "Reannotate PCB" ) );
111 m_sdbSizerCancel->SetLabel( _( "Close" ) );
112 m_sdbSizer->Layout();
113
114 m_settings = aParentFrame->config();
115 wxArrayString gridslist;
116 GRID_MENU::BuildChoiceList( &gridslist, m_settings, aParentFrame );
117
118 if( -1 == m_gridIndex ) // If no default loaded
119 m_gridIndex = m_settings->m_Window.grid.last_size_idx; // Get the current grid size
120
123
124 m_GridChoice->Set( gridslist );
125 m_GridChoice->SetSelection( m_gridIndex );
126
127 for( wxRadioButton* button : m_sortButtons )
128 button->SetValue( false );
129
130 m_sortButtons[m_sortCode]->SetValue( true );
131
133
134 if( !m_selection.Empty() )
136
137 for( wxRadioButton* button : m_scopeRadioButtons )
138 button->SetValue( false );
139
140 m_scopeRadioButtons[m_annotationScope]->SetValue( true );
141
150
151 m_ExcludeList->SetToolTip( m_ExcludeListText->GetToolTipText() );
152 m_GridChoice->SetToolTip( m_SortGridText->GetToolTipText() );
153
154 m_MessageWindow->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
155
157}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
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:105
@ reannotate_down_left
@ reannotate_up_right
@ reannotate_right_down
@ reannotate_up_left
@ reannotate_left_down
@ reannotate_down_right
@ reannotate_left_up
@ reannotate_right_up
WINDOW_SETTINGS m_Window
Definition: app_settings.h:181
FOOTPRINTS & Footprints()
Definition: board.h:282
DIALOG_BOARD_REANNOTATE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Geographical Reannotation"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
std::vector< wxRadioButton * > m_scopeRadioButtons
void InitValues(void)
Copy saved app settings to the dialog.
std::vector< wxRadioButton * > m_sortButtons
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
static void BuildChoiceList(wxArrayString *aGridsList, APP_SETTINGS_BASE *aCfg, EDA_DRAW_FRAME *aParent)
Definition: grid_menu.cpp:85
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:93
const VECTOR2D & GetGridSize() const
Return the grid size.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
BOARD * GetBoard() const
The selection tool: currently supports:
bool Empty() const
Checks if there is anything selected.
Definition: selection.h:98
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
void SetFileName(const wxString &aReportFileName)
@ AnnotateSelected
#define _(s)
GRID_SETTINGS grid
Definition: app_settings.h:90

References _, AnnotateSelected, GRID_MENU::BuildChoiceList(), EDA_BASE_FRAME::config(), SELECTION::Empty(), DIALOG_SHIM::finishDialogSettings(), PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetGridSize(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), WINDOW_SETTINGS::grid, InitValues(), KiBitmap(), Kiface(), KIFACE_BASE::KifaceSettings(), GRID_SETTINGS::last_size_idx, m_annotationScope, DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart, m_Config, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeListText, m_frame, DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_GridChoice, m_gridIndex, DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, m_scopeRadioButtons, DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizer, DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizerCancel, DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizerOK, m_selection, m_settings, m_sortButtons, m_sortCode, DIALOG_BOARD_REANNOTATE_BASE::m_SortGridText, m_sortGridx, m_sortGridy, APP_SETTINGS_BASE::m_Window, KIWAY_HOLDER::Prj(), reannotate_down_left, DIALOG_BOARD_REANNOTATE_BASE::reannotate_down_left_bitmap, reannotate_down_right, DIALOG_BOARD_REANNOTATE_BASE::reannotate_down_right_bitmap, reannotate_left_down, DIALOG_BOARD_REANNOTATE_BASE::reannotate_left_down_bitmap, reannotate_left_up, DIALOG_BOARD_REANNOTATE_BASE::reannotate_left_up_bitmap, reannotate_right_down, DIALOG_BOARD_REANNOTATE_BASE::reannotate_right_down_bitmap, reannotate_right_up, DIALOG_BOARD_REANNOTATE_BASE::reannotate_right_up_bitmap, reannotate_up_left, DIALOG_BOARD_REANNOTATE_BASE::reannotate_up_left_bitmap, reannotate_up_right, DIALOG_BOARD_REANNOTATE_BASE::reannotate_up_right_bitmap, WX_HTML_REPORT_PANEL::SetFileName(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ~DIALOG_BOARD_REANNOTATE()

DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE ( )

Definition at line 160 of file dialog_board_reannotate.cpp.

161{
162 GetParameters(); // Get the current menu settings
164 cfg->m_Reannotate.sort_on_fp_location = m_locationChoice->GetSelection() == 0;
168
173
176 cfg->m_Reannotate.front_prefix = m_FrontPrefix->GetValue();
177 cfg->m_Reannotate.back_prefix = m_BackPrefix->GetValue();
178 cfg->m_Reannotate.exclude_list = m_ExcludeList->GetValue();
180}
DIALOG_REANNOTATE m_Reannotate
PCBNEW_SETTINGS * GetPcbNewSettings() const

References PCBNEW_SETTINGS::DIALOG_REANNOTATE::annotation_choice, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_refdes_start, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_list, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_locked, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_refdes_start, WX_HTML_REPORT_PANEL::GetFileName(), GetParameters(), PCB_BASE_FRAME::GetPcbNewSettings(), PCBNEW_SETTINGS::DIALOG_REANNOTATE::grid_index, m_annotationScope, DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeLocked, m_frame, DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart, m_gridIndex, DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice, DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, PCBNEW_SETTINGS::m_Reannotate, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveBackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveFrontPrefix, m_severity, m_sortCode, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_file_name, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_severity, PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_code, and PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_on_fp_location.

Member Function Documentation

◆ BuildChangeArray()

void DIALOG_BOARD_REANNOTATE::BuildChangeArray ( std::vector< RefDesInfo > &  aFootprints,
unsigned int  aStartRefDes,
const wxString &  aPrefix,
bool  aRemovePrefix,
std::vector< RefDesInfo > &  aBadRefDes 
)
private

Scan through the footprint arrays and create the from -> to array.

Definition at line 835 of file dialog_board_reannotate.cpp.

839{
840 size_t prefixsize = aPrefix.size();
841
842 bool haveprefix = ( 0 != prefixsize ); // Do I have a prefix?
843 bool addprefix = haveprefix & !aRemovePrefix; // Yes- and I'm not removing it
844 aRemovePrefix &= haveprefix; // Only remove if I have a prefix
845
846 bool prefixpresent; // Prefix found
847
848 wxString logstring = ( aFootprints.front().Front ) ? _( "\n\nFront Footprints" )
849 : _( "\n\nBack Footprints" );
850 LogFootprints( logstring, aFootprints );
851
852 if( 0 != aStartRefDes ) // Initialize the change array if present
853 {
854 for( size_t i = 0; i < m_refDesTypes.size(); i++ )
855 m_refDesTypes[i].LastUsedRefDes = aStartRefDes;
856 }
857
858
859 for( RefDesInfo fpData : aFootprints )
860 {
861 RefDesChange change;
862
863 change.Uuid = fpData.Uuid;
864 change.Action = fpData.Action;
865 change.OldRefDesString = fpData.RefDesString;
866 change.NewRefDes = fpData.RefDesString;
867 change.Front = fpData.Front;
868
869 if( fpData.RefDesString.IsEmpty() )
870 fpData.Action = EmptyRefDes;
871
872 if( ( change.Action == EmptyRefDes ) || ( change.Action == InvalidRefDes ) )
873 {
874 m_changeArray.push_back( change );
875 aBadRefDes.push_back( fpData );
876 continue;
877 }
878
879 if( change.Action == UpdateRefDes )
880 {
881 prefixpresent = ( 0 == fpData.RefDesType.find( aPrefix ) );
882
883 if( addprefix && !prefixpresent )
884 fpData.RefDesType.insert( 0, aPrefix ); // Add prefix once only
885
886 if( aRemovePrefix && prefixpresent ) // If there is a prefix remove it
887 fpData.RefDesType.erase( 0, prefixsize );
888
889 RefDesTypeStr* refDesInfo = GetOrBuildRefDesInfo( fpData.RefDesType, aStartRefDes );
890 unsigned int newRefDesNumber = refDesInfo->LastUsedRefDes + 1;
891
892 while( refDesInfo->UnavailableRefs.count( newRefDesNumber ) )
893 newRefDesNumber++;
894
895 change.NewRefDes = refDesInfo->RefDesType + std::to_string( newRefDesNumber );
896 refDesInfo->LastUsedRefDes = newRefDesNumber;
897 }
898
899 m_changeArray.push_back( change );
900 }
901}
std::vector< RefDesChange > m_changeArray
RefDesTypeStr * GetOrBuildRefDesInfo(const wxString &aRefDesPrefix, unsigned int aStartRefDes=0)
Get the structure representing the information currently held for aRefDesPrefix or create one if it d...
void LogFootprints(const wxString &aMessage, const std::vector< RefDesInfo > &aFootprints)
Create a list of the footprints and their coordinates.
std::vector< RefDesTypeStr > m_refDesTypes
unsigned int LastUsedRefDes
std::set< unsigned int > UnavailableRefs

References _, RefDesChange::Action, EmptyRefDes, RefDesChange::Front, GetOrBuildRefDesInfo(), InvalidRefDes, RefDesTypeStr::LastUsedRefDes, LogFootprints(), m_changeArray, m_refDesTypes, RefDesChange::NewRefDes, RefDesChange::OldRefDesString, RefDesTypeStr::RefDesType, RefDesTypeStr::UnavailableRefs, UpdateRefDes, and RefDesChange::Uuid.

Referenced by BuildFootprintList().

◆ BuildFootprintList()

bool DIALOG_BOARD_REANNOTATE::BuildFootprintList ( std::vector< RefDesInfo > &  aBadRefDes)
private

Build the footprint lists, sort it, filter for excludes, then build the change list.

Returns
true if success, false if errors

Definition at line 631 of file dialog_board_reannotate.cpp.

632{
633 bool annotateSelected = m_AnnotateSelection->GetValue();
634 bool annotateFront = m_AnnotateFront->GetValue(); // Unless only doing back
635 bool annotateBack = m_AnnotateBack->GetValue(); // Unless only doing front
636 bool skipLocked = m_ExcludeLocked->GetValue();
637
638 int errorcount = 0;
639 size_t firstnum = 0;
640
641 m_frontFootprints.clear();
642 m_backFootprints.clear();
643 m_excludeArray.clear();
645
646 std::vector<KIID> selected;
647
648 if( annotateSelected )
649 {
650 for( EDA_ITEM* item : m_selection )
651 {
652 // Get the timestamps of selected footprints
653 if( item->Type() == PCB_FOOTPRINT_T )
654 selected.push_back( item->m_Uuid );
655 }
656 }
657
658 wxString exclude;
659
660 // Break exclude list into words.
661 for( auto thischar : m_ExcludeList->GetValue() )
662 {
663 if( ( ' ' == thischar ) || ( ',' == thischar ) )
664 {
665 m_excludeArray.push_back( exclude );
666 exclude.clear();
667 }
668 else
669 exclude += thischar;
670
671 if( !exclude.empty() )
672 m_excludeArray.push_back( exclude );
673 }
674
675 RefDesInfo fpData;
676 bool useModuleLocation = m_locationChoice->GetSelection() == 0;
677
678 for( FOOTPRINT* footprint : m_footprints )
679 {
680 fpData.Uuid = footprint->m_Uuid;
681 fpData.RefDesString = footprint->GetReference();
682 fpData.FPID = footprint->GetFPID();
683 fpData.x = useModuleLocation ? footprint->GetPosition().x
684 : footprint->Reference().GetPosition().x;
685 fpData.y = useModuleLocation ? footprint->GetPosition().y
686 : footprint->Reference().GetPosition().y;
687 fpData.roundedx = RoundToGrid( fpData.x, m_sortGridx ); // Round to sort
688 fpData.roundedy = RoundToGrid( fpData.y, m_sortGridy );
689 fpData.Front = footprint->GetLayer() == F_Cu;
690 fpData.Action = UpdateRefDes; // Usually good
691
692 if( fpData.RefDesString.IsEmpty() )
693 {
694 fpData.Action = EmptyRefDes;
695 }
696 else
697 {
698 firstnum = fpData.RefDesString.find_first_of( wxT( "0123456789" ) );
699
700 if( std::string::npos == firstnum )
701 fpData.Action = InvalidRefDes; // do not change ref des such as 12 or +1, or L
702 }
703
704 // Get the type (R, C, etc)
705 fpData.RefDesType = fpData.RefDesString.substr( 0, firstnum );
706
707 for( wxString excluded : m_excludeArray )
708 {
709 if( excluded == fpData.RefDesType ) // Am I supposed to exclude this type?
710 {
711 fpData.Action = Exclude; // Yes
712 break;
713 }
714 }
715
716 if(( fpData.Front && annotateBack ) || // If a front fp and doing backs only
717 ( !fpData.Front && annotateFront ) || // If a back fp and doing front only
718 ( footprint->IsLocked() && skipLocked ) ) // If excluding locked and it is locked
719 {
720 fpData.Action = Exclude;
721 }
722
723 if( annotateSelected )
724 { // If only annotating selected c
725 fpData.Action = Exclude; // Assume it isn't selected
726
727 for( KIID sel : selected )
728 {
729 if( fpData.Uuid == sel )
730 { // Found in selected footprints
731 fpData.Action = UpdateRefDes; // Update it
732 break;
733 }
734 }
735 }
736
737 if( fpData.Front )
738 m_frontFootprints.push_back( fpData );
739 else
740 m_backFootprints.push_back( fpData );
741 }
742
743 // Determine the sort order for the front.
745
746 // Sort the front footprints.
747 sort( m_frontFootprints.begin(), m_frontFootprints.end(), ModuleCompare );
748
749 // Determine the sort order for the back.
751
752 // Sort the back footprints.
753 sort( m_backFootprints.begin(), m_backFootprints.end(), ModuleCompare );
754
755 m_refDesTypes.clear();
756 m_changeArray.clear();
757
759
760 if( !m_frontFootprints.empty() )
761 {
763 m_FrontPrefix->GetValue(), m_RemoveFrontPrefix->GetValue(), aBadRefDes );
764 }
765
766 if( !m_backFootprints.empty() )
767 {
769 m_BackPrefix->GetValue(), m_RemoveBackPrefix->GetValue(), aBadRefDes );
770 }
771
772 if( !m_changeArray.empty() )
773 sort( m_changeArray.begin(), m_changeArray.end(), ChangeArrayCompare );
774
776
777 size_t changearraysize = m_changeArray.size();
778
779 for( size_t i = 0; i < changearraysize; i++ ) // Scan through for duplicates if update or skip
780 {
781 if( ( m_changeArray[i].Action != EmptyRefDes )
782 && ( m_changeArray[i].Action != InvalidRefDes ) )
783 {
784 for( size_t j = i + 1; j < changearraysize; j++ )
785 {
786 if( m_changeArray[i].NewRefDes == m_changeArray[j].NewRefDes )
787 {
788 ShowReport( wxString::Format( _( "Duplicate instances of %s" ),
789 m_changeArray[j].NewRefDes ),
791
792 if( errorcount++ > MAXERROR )
793 {
794 ShowReport( _( "Aborted: too many errors" ), RPT_SEVERITY_ERROR );
795 break;
796 }
797 }
798 }
799 }
800
801 if( errorcount > MAXERROR )
802 break;
803 }
804
805 return ( 0 == errorcount );
806}
void BuildChangeArray(std::vector< RefDesInfo > &aFootprints, unsigned int aStartRefDes, const wxString &aPrefix, bool aRemovePrefix, std::vector< RefDesInfo > &aBadRefDes)
Scan through the footprint arrays and create the from -> to array.
std::vector< wxString > m_excludeArray
std::vector< RefDesInfo > m_frontFootprints
int RoundToGrid(int aCoord, int aGrid)
Round an int coordinate to a suitable grid.
void BuildUnavailableRefsList()
Build list of unavailable references. E.g. unselected footprints or locked footprints.
void LogChangePlan(void)
Create an audit trail of the changes.
void ShowReport(const wxString &aMessage, SEVERITY aSeverity)
Break report into strings separated by and sent to the reporter.
std::vector< RefDesInfo > m_backFootprints
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
Definition: kiid.h:45
int BackDirectionsArray[]
int FrontDirectionsArray[]
static bool ModuleCompare(const RefDesInfo &aA, const RefDesInfo &aB)
Compare function to sort footprints.
#define SetSortCodes(DirArray, Code)
static bool ChangeArrayCompare(const RefDesChange &aA, const RefDesChange &aB)
Compare function used to compare ChangeArray element for sort.
#define MAXERROR
@ F_Cu
Definition: layer_ids.h:64
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
@ RPT_SEVERITY_ERROR
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:88

References _, RefDesInfo::Action, BackDirectionsArray, BuildChangeArray(), BuildUnavailableRefsList(), ChangeArrayCompare(), EmptyRefDes, Exclude, F_Cu, BOARD::Footprints(), Format(), RefDesInfo::FPID, RefDesInfo::Front, FrontDirectionsArray, PCB_BASE_FRAME::GetBoard(), InvalidRefDes, LogChangePlan(), DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateBack, DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateFront, DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateSelection, m_backFootprints, DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart, m_changeArray, m_excludeArray, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeLocked, m_footprints, m_frame, m_frontFootprints, DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice, m_refDesTypes, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveBackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveFrontPrefix, m_selection, m_sortCode, m_sortGridx, m_sortGridy, MAXERROR, ModuleCompare(), PCB_FOOTPRINT_T, RefDesInfo::RefDesString, RefDesInfo::RefDesType, RefDesInfo::roundedx, RefDesInfo::roundedy, RoundToGrid(), RPT_SEVERITY_ERROR, SetSortCodes, ShowReport(), UpdateRefDes, RefDesInfo::Uuid, RefDesInfo::x, and RefDesInfo::y.

Referenced by ReannotateBoard().

◆ BuildUnavailableRefsList()

void DIALOG_BOARD_REANNOTATE::BuildUnavailableRefsList ( )
private

Build list of unavailable references. E.g. unselected footprints or locked footprints.

Definition at line 808 of file dialog_board_reannotate.cpp.

809{
810 std::vector<RefDesInfo> excludedFootprints;
811
812 for( RefDesInfo fpData : m_frontFootprints )
813 {
814 if( fpData.Action == Exclude )
815 excludedFootprints.push_back( fpData );
816 }
817
818 for( RefDesInfo fpData : m_backFootprints )
819 {
820 if( fpData.Action == Exclude )
821 excludedFootprints.push_back( fpData );
822 }
823
824 for( RefDesInfo fpData : excludedFootprints )
825 {
826 if( fpData.Action == Exclude )
827 {
828 RefDesTypeStr* refDesInfo = GetOrBuildRefDesInfo( fpData.RefDesType );
829 refDesInfo->UnavailableRefs.insert( UTIL::GetRefDesNumber( fpData.RefDesString ) );
830 }
831 }
832}
int GetRefDesNumber(const wxString &aRefDes)
Get the numeric suffix from a refdes - e.g.

References Exclude, GetOrBuildRefDesInfo(), UTIL::GetRefDesNumber(), m_backFootprints, m_frontFootprints, and RefDesTypeStr::UnavailableRefs.

Referenced by BuildFootprintList().

◆ CoordTowxString()

wxString DIALOG_BOARD_REANNOTATE::CoordTowxString ( int  aX,
int  aY 
)
private

Convert coordinates to wxString.

Returns
the string

Definition at line 481 of file dialog_board_reannotate.cpp.

482{
483 return wxString::Format( wxT( "%s, %s" ),
486}
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:103
EDA_UNITS m_units
Definition: dialog_shim.h:202

References Format(), DIALOG_SHIM::m_units, and MessageTextFromValue().

Referenced by LogFootprints(), and ReannotateBoard().

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )
privateinherited

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 319 of file dialog_shim.cpp.

320{
321 // so we can do logging of this state change:
322 return wxDialog::Enable( enable );
323}

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 487 of file dialog_shim.cpp.

488{
489 // Hook up validator and transfer data from controls handling so quasi-modal dialogs
490 // handle validation in the same way as other dialogs.
491 if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
492 return;
493
494 SetReturnCode( retCode );
495
496 if( !IsQuasiModal() )
497 {
498 wxFAIL_MSG( wxT( "Either DIALOG_SHIM::EndQuasiModal was called twice, or ShowQuasiModal"
499 "wasn't called" ) );
500 return;
501 }
502
503 if( m_qmodal_loop )
504 {
505 if( m_qmodal_loop->IsRunning() )
506 m_qmodal_loop->Exit( 0 );
507 else
508 m_qmodal_loop->ScheduleExit( 0 );
509
510 m_qmodal_loop = nullptr;
511 }
512
514 m_qmodal_parent_disabler = nullptr;
515
516 Show( false );
517}
bool Show(bool show) override
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:218
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:215

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, and DIALOG_SHIM::Show().

Referenced by EDA_3D_CONTROLLER::Main(), NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FilterBackPrefix()

void DIALOG_BOARD_REANNOTATE::FilterBackPrefix ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOARD_REANNOTATE_BASE.

Definition at line 265 of file dialog_board_reannotate.cpp.

266{
268}
void FilterPrefix(wxTextCtrl *aPrefix)
Check to make sure the prefix (if there is one) is properly constructed.

References FilterPrefix(), and DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix.

◆ FilterFrontPrefix()

void DIALOG_BOARD_REANNOTATE::FilterFrontPrefix ( wxCommandEvent &  event)
overrideprivatevirtual

◆ FilterPrefix()

void DIALOG_BOARD_REANNOTATE::FilterPrefix ( wxTextCtrl *  aPrefix)
private

Check to make sure the prefix (if there is one) is properly constructed.

Definition at line 211 of file dialog_board_reannotate.cpp.

212{
213 std::string tmps = VALIDPREFIX;
214
215 if( aPrefix->GetValue().empty() )
216 return; //Should never happen
217
218 char lastc = aPrefix->GetValue().Last();
219
220 if( isalnum( (int) lastc ) )
221 return;
222
223 if( std::string::npos != tmps.find( lastc ) )
224 return;
225
226 tmps = aPrefix->GetValue();
227 aPrefix->Clear();
228 tmps.pop_back();
229 aPrefix->AppendText( tmps );
230}
#define VALIDPREFIX

References VALIDPREFIX.

Referenced by FilterBackPrefix(), and FilterFrontPrefix().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 158 of file dialog_shim.cpp.

159{
160 // must be called from the constructor of derived classes,
161 // when all widgets are initialized, and therefore their size fixed
162
163 // SetSizeHints fixes the minimal size of sizers in the dialog
164 // (SetSizeHints calls Fit(), so no need to call it)
165 GetSizer()->SetSizeHints( this );
166}

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PAGED_DIALOG::finishInitialization(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ GetNewRefDes()

RefDesChange * DIALOG_BOARD_REANNOTATE::GetNewRefDes ( FOOTPRINT aFootprint)
private
Returns
the new reference for this footprint.

Definition at line 904 of file dialog_board_reannotate.cpp.

905{
906 size_t i;
907
908 for( i = 0; i < m_changeArray.size(); i++ )
909 {
910 if( aFootprint->m_Uuid == m_changeArray[i].Uuid )
911 return ( &m_changeArray[i] );
912 }
913
914 ShowReport( _( "Footprint not found in changelist" ) + wxS( " " ) + aFootprint->GetReference(),
916
917 return nullptr; // Should never happen
918}
const KIID m_Uuid
Definition: eda_item.h:494
const wxString & GetReference() const
Definition: footprint.h:468

References _, FOOTPRINT::GetReference(), m_changeArray, EDA_ITEM::m_Uuid, RPT_SEVERITY_ERROR, and ShowReport().

Referenced by ReannotateBoard().

◆ GetOrBuildRefDesInfo()

RefDesTypeStr * DIALOG_BOARD_REANNOTATE::GetOrBuildRefDesInfo ( const wxString &  aRefDesPrefix,
unsigned int  aStartRefDes = 0 
)
private

Get the structure representing the information currently held for aRefDesPrefix or create one if it doesn't exist.

Definition at line 233 of file dialog_board_reannotate.cpp.

235{
236 unsigned int requiredLastRef = ( aStartRefDes == 0 ? 1 : aStartRefDes ) - 1;
237
238 for( size_t i = 0; i < m_refDesTypes.size(); i++ ) // See if it is in the types array
239 {
240 if( m_refDesTypes[i].RefDesType == aRefDesPrefix ) // Found it!
241 {
242 m_refDesTypes[i].LastUsedRefDes = std::max( m_refDesTypes[i].LastUsedRefDes,
243 requiredLastRef );
244
245 return &m_refDesTypes[i];
246 }
247 }
248
249 // Wasn't in the types array so add it
250 RefDesTypeStr newtype;
251 newtype.RefDesType = aRefDesPrefix;
252 newtype.LastUsedRefDes = requiredLastRef;
253 m_refDesTypes.push_back( newtype );
254
255 return &m_refDesTypes.back();
256}

References RefDesTypeStr::LastUsedRefDes, m_refDesTypes, and RefDesTypeStr::RefDesType.

Referenced by BuildChangeArray(), and BuildUnavailableRefsList().

◆ GetParameters()

void DIALOG_BOARD_REANNOTATE::GetParameters ( void  )
private

Definition at line 376 of file dialog_board_reannotate.cpp.

377{
378 m_sortCode = 0; // Convert radio button to sort direction code
379
380 for( wxRadioButton* sortbuttons : m_sortButtons )
381 {
382 if( sortbuttons->GetValue() )
383 break;
384
385 m_sortCode++;
386 }
387
388 if( m_sortCode >= (int) m_sortButtons.size() )
389 m_sortCode = 0;
390
392 m_backPrefixString = m_BackPrefix->GetValue();
393
394 // Get the chosen sort grid for rounding
395 m_gridIndex = m_GridChoice->GetSelection();
396
397 if( m_gridIndex >= ( int ) m_settings->m_Window.grid.sizes.size() )
398 {
403 }
404 else
405 {
409 }
410
412
413 for( wxRadioButton* button : m_scopeRadioButtons )
414 {
415 if( button->GetValue() )
416 break;
417 else
419 }
420
422}
double DoubleValueFromString(EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType)
Function DoubleValueFromString converts aTextValue to a double.
Definition: base_units.cpp:276
void SetLazyUpdate(bool aLazyUpdate)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
wxString user_grid_x
Definition: app_settings.h:54
wxString user_grid_y
Definition: app_settings.h:55
std::vector< wxString > sizes
Definition: app_settings.h:53

References AnnotateAll, DoubleValueFromString(), WINDOW_SETTINGS::grid, m_annotationScope, DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix, m_backPrefixString, DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefix, m_frontPrefixString, DIALOG_BOARD_REANNOTATE_BASE::m_GridChoice, m_gridIndex, DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, m_scopeRadioButtons, m_settings, m_sortButtons, m_sortCode, m_sortGridx, m_sortGridy, APP_SETTINGS_BASE::m_Window, MILS, WX_HTML_REPORT_PANEL::SetLazyUpdate(), GRID_SETTINGS::sizes, GRID_SETTINGS::user_grid_x, and GRID_SETTINGS::user_grid_y.

Referenced by OnApplyClick(), and ~DIALOG_BOARD_REANNOTATE().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46{ return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

64 {
65 return m_kiway != nullptr;
66 }
KIWAY * m_kiway
Definition: kiway_holder.h:84

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 176 of file dialog_shim.cpp.

177{
178 wxSize sz( x, 0 );
179 return ConvertDialogToPixels( sz ).x;
180}

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), and DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ InitValues()

void DIALOG_BOARD_REANNOTATE::InitValues ( void  )
private

Copy saved app settings to the dialog.

Definition at line 183 of file dialog_board_reannotate.cpp.

References PCBNEW_SETTINGS::DIALOG_REANNOTATE::annotation_choice, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::back_refdes_start, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_list, PCBNEW_SETTINGS::DIALOG_REANNOTATE::exclude_locked, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::front_refdes_start, PCB_BASE_FRAME::GetPcbNewSettings(), PCBNEW_SETTINGS::DIALOG_REANNOTATE::grid_index, m_annotationScope, DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeLocked, m_frame, DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart, m_gridIndex, DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice, DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, PCBNEW_SETTINGS::m_Reannotate, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveBackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveFrontPrefix, m_severity, m_sortCode, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_back_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::remove_front_prefix, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_file_name, PCBNEW_SETTINGS::DIALOG_REANNOTATE::report_severity, WX_HTML_REPORT_PANEL::SetFileName(), PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_code, and PCBNEW_SETTINGS::DIALOG_REANNOTATE::sort_on_fp_location.

Referenced by DIALOG_BOARD_REANNOTATE().

◆ IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 128 of file dialog_shim.h.

129 {
130 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
131 !e.ShiftDown() && !e.MetaDown();
132 }

◆ IsQuasiModal()

◆ IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar,
const wxKeyEvent &  e 
)
inlinestaticinherited

Definition at line 134 of file dialog_shim.h.

135 {
136 return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
137 e.ShiftDown() && !e.MetaDown();
138 }

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

54 {
55 wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56 return *m_kiway;
57 }

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AskToSaveChanges(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), PCB_EDIT_FRAME::OnNetlistChanged(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), SIM_PLOT_FRAME::onProbe(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), SIM_PLOT_FRAME::onTune(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), PCB_BASE_FRAME::SelectLibrary(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItems(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDIT_FRAME::TestStandalone(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ LogChangePlan()

void DIALOG_BOARD_REANNOTATE::LogChangePlan ( void  )
private

Create an audit trail of the changes.

Definition at line 503 of file dialog_board_reannotate.cpp.

504{
505 int i = 1;
506 wxString message;
507
508 message.Printf( _( "\n\nThere are %i types of reference designations\n"
509 "**********************************************************\n" ),
510 (int) m_refDesTypes.size() );
511
512 for( RefDesTypeStr Type : m_refDesTypes ) // Show all the types of refdes
513 message += Type.RefDesType + ( 0 == ( i++ % 16 ) ? wxT( "\n" ) : wxS( " " ) );
514
515 if( !m_excludeArray.empty() )
516 {
517 wxString excludes;
518
519 for( wxString& exclude : m_excludeArray ) // Show the refdes we are excluding
520 excludes += exclude + wxS( " " );
521
522 message += wxString::Format( _( "\nExcluding: %s from reannotation\n\n" ), excludes );
523 }
524
525 message += _( "\n Change Array\n***********************\n" );
526
527 for( const RefDesChange& change : m_changeArray )
528 {
529 message += wxString::Format( wxT( "%s -> %s %s %s\n" ),
530 change.OldRefDesString,
531 change.NewRefDes,
532 ActionMessage[change.Action],
533 UpdateRefDes != change.Action ? _( " will be ignored" )
534 : wxT( "" ) );
535 }
536
537 ShowReport( message, RPT_SEVERITY_INFO );
538}
wxString ActionMessage[]
@ RPT_SEVERITY_INFO

References _, ActionMessage, Format(), m_changeArray, m_excludeArray, m_refDesTypes, RPT_SEVERITY_INFO, ShowReport(), and UpdateRefDes.

Referenced by BuildFootprintList().

◆ LogFootprints()

void DIALOG_BOARD_REANNOTATE::LogFootprints ( const wxString &  aMessage,
const std::vector< RefDesInfo > &  aFootprints 
)
private

Create a list of the footprints and their coordinates.

Definition at line 541 of file dialog_board_reannotate.cpp.

543{
544 wxString message = aMessage;
545
546 if( aFootprints.empty() )
547 message += _( "\nNo footprints" );
548 else
549 {
550 int i = 1;
551 bool fpLocations = m_locationChoice->GetSelection() == 0;
552
553 message += wxString::Format( _( "\n*********** Sort on %s ***********" ),
554 fpLocations ? _( "Footprint Coordinates" )
555 : _( "Reference Designator Coordinates" ) );
556
557 message += wxString::Format( _( "\nSort Code %d" ), m_sortCode );
558
559 for( const RefDesInfo& mod : aFootprints )
560 {
561 message += wxString::Format( _( "\n%d %s UUID: [%s], X, Y: %s, Rounded X, Y, %s" ),
562 i++,
563 mod.RefDesString,
564 mod.Uuid.AsString(),
565 CoordTowxString( mod.x, mod.y ),
566 CoordTowxString( mod.roundedx, mod.roundedy ) );
567 }
568 }
569
570 ShowReport( message, RPT_SEVERITY_INFO );
571}
wxString CoordTowxString(int aX, int aY)
Convert coordinates to wxString.

References _, CoordTowxString(), Format(), DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice, m_sortCode, RPT_SEVERITY_INFO, and ShowReport().

Referenced by BuildChangeArray().

◆ MakeSampleText()

void DIALOG_BOARD_REANNOTATE::MakeSampleText ( wxString &  aMessage)
private

Make the text to summarize what is about to happen.

Definition at line 301 of file dialog_board_reannotate.cpp.

302{
303 aMessage.Printf( _( "\n%s footprints will be reannotated." ),
305
306 if( !m_ExcludeList->GetValue().empty() )
307 {
308 aMessage += wxString::Format( _( "\nAny reference types %s will not be annotated." ),
309 m_ExcludeList->GetValue() );
310 }
311
312 if( m_ExcludeLocked->GetValue() )
313 aMessage += wxString::Format( _( "\nLocked footprints will not be annotated" ) );
314
315 if( !m_AnnotateBack->GetValue() )
316 {
317 aMessage += wxString::Format( _( "\nFront footprints will start at %s" ),
318 m_FrontRefDesStart->GetValue() );
319 }
320
321 if( !m_AnnotateFront->GetValue() )
322 {
323 bool frontPlusOne = ( 0 == wxAtoi( m_BackRefDesStart->GetValue() ) )
324 && !m_AnnotateBack->GetValue();
325
326 aMessage += wxString::Format( _( "\nBack footprints will start at %s." ),
327 frontPlusOne ? _( "the last front footprint + 1" ) :
328 m_BackRefDesStart->GetValue() );
329 }
330
331 if( !m_FrontPrefix->GetValue().empty() )
332 {
333 if( m_RemoveFrontPrefix->GetValue() )
334 {
335 aMessage += wxString::Format( _( "\nFront footprints starting with '%s' will have "
336 "the prefix removed." ),
337 m_FrontPrefix->GetValue() );
338 }
339 else
340 {
341 aMessage += wxString::Format( _( "\nFront footprints will have '%s' inserted as a "
342 "prefix." ),
343 m_FrontPrefix->GetValue() );
344 }
345 }
346
347 if( !m_BackPrefix->GetValue().empty() )
348 {
349 if( m_RemoveBackPrefix->GetValue() )
350 {
351 aMessage += wxString::Format( _( "\nBack footprints starting with '%s' will have the "
352 "prefix removed." ),
353 m_BackPrefix->GetValue() );
354 }
355 else
356 {
357 aMessage += wxString::Format( _( "\nBack footprints will have '%s' inserted as a "
358 "prefix." ),
359 m_BackPrefix->GetValue() );
360 }
361 }
362
363 bool fpLocation = m_locationChoice->GetSelection() == 0;
364
365 aMessage += wxString::Format( _( "\nPrior to sorting by %s, the coordinates of which will be "
366 "rounded to a %s, %s grid." ),
367 fpLocation ? _( "footprint location" )
368 : _( "reference designator location" ),
371
372 ShowReport( aMessage, RPT_SEVERITY_INFO );
373}
wxString AnnotateString[]

References _, AnnotateString, Format(), DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateBack, DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateFront, m_annotationScope, DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList, DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeLocked, DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart, DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveBackPrefix, DIALOG_BOARD_REANNOTATE_BASE::m_RemoveFrontPrefix, m_sortGridx, m_sortGridy, DIALOG_SHIM::m_units, MessageTextFromValue(), RPT_SEVERITY_INFO, and ShowReport().

Referenced by OnApplyClick().

◆ OnApplyClick()

void DIALOG_BOARD_REANNOTATE::OnApplyClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOARD_REANNOTATE_BASE.

Definition at line 271 of file dialog_board_reannotate.cpp.

272{
273 wxString warning;
274
275 if( m_frame->GetBoard()->IsEmpty() )
276 {
277 ShowReport( _( "No PCB to reannotate!" ), RPT_SEVERITY_ERROR );
278 return;
279 }
280
281 GetParameters(); // Figure out how this is to be done
282 MakeSampleText( warning );
283
284 if( !IsOK( m_frame, warning ) )
285 return;
286
287 if( ReannotateBoard() )
288 {
289 ShowReport( _( "PCB successfully reannotated" ), RPT_SEVERITY_ACTION );
290 ShowReport( _( "PCB annotation changes should be synchronized with schematic using "
291 "the \"Update Schematic from PCB\" tool." ), RPT_SEVERITY_WARNING );
292 }
293
295 m_MessageWindow->Flush( false );
296 m_frame->GetCanvas()->Refresh(); // Redraw
297 m_frame->OnModify(); // Need to save file on exit.
298}
bool IsEmpty() const
Definition: board.h:330
void MakeSampleText(wxString &aMessage)
Make the text to summarize what is about to happen.
bool ReannotateBoard(void)
Actually reannotate the board.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void OnModify() override
Must be called after a board change to set the modified flag.
void Flush(bool aSort=false)
Set the visible severity filter.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:342
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ACTION

References _, WX_HTML_REPORT_PANEL::Flush(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), GetParameters(), BOARD::IsEmpty(), IsOK(), m_frame, DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, MakeSampleText(), PCB_EDIT_FRAME::OnModify(), ReannotateBoard(), EDA_DRAW_PANEL_GAL::Refresh(), RPT_SEVERITY_ACTION, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, WX_HTML_REPORT_PANEL::SetLazyUpdate(), and ShowReport().

◆ OnButton()

void DIALOG_SHIM::OnButton ( wxCommandEvent &  aEvent)
privateinherited

Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 533 of file dialog_shim.cpp.

534{
535 const int id = aEvent.GetId();
536
537 // If we are pressing a button to exit, we need to enable the escapeID
538 // otherwise the dialog does not process cancel
539 if( id == wxID_CANCEL )
540 SetEscapeId( wxID_ANY );
541
542 if( IsQuasiModal() )
543 {
544 if( id == GetAffirmativeId() )
545 {
546 EndQuasiModal( id );
547 }
548 else if( id == wxID_APPLY )
549 {
550 // Dialogs that provide Apply buttons should make sure data is valid before
551 // allowing a transfer, as there is no other way to indicate failure
552 // (i.e. the dialog can't refuse to close as it might with OK, because it
553 // isn't closing anyway)
554 if( Validate() )
555 {
556 ignore_unused( TransferDataFromWindow() );
557 }
558 }
559 else if( id == GetEscapeId() || (id == wxID_CANCEL && GetEscapeId() == wxID_ANY) )
560 {
561 EndQuasiModal( wxID_CANCEL );
562 }
563 else // not a standard button
564 {
565 aEvent.Skip();
566 }
567
568 return;
569 }
570
571 // This is mandatory to allow wxDialogBase::OnButton() to be called.
572 aEvent.Skip();
573}
void EndQuasiModal(int retCode)
void ignore_unused(const T &)
Definition: ignore.h:24

References DIALOG_SHIM::EndQuasiModal(), ignore_unused(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in HK_PROMPT_DIALOG, DIALOG_CHOOSE_SYMBOL, and HTML_MESSAGE_BOX.

Definition at line 576 of file dialog_shim.cpp.

577{
578 if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
579 {
580 if( m_parentFrame )
581 {
583 return;
584 }
585 }
586 // shift-return (Mac default) or Ctrl-Return (GTK) for OK
587 else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
588 {
589 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
590 return;
591 }
592 else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
593 {
594 wxWindow* currentWindow = wxWindow::FindFocus();
595 int currentIdx = -1;
596 int delta = aEvt.ShiftDown() ? -1 : 1;
597
598 auto advance =
599 [&]( int& idx )
600 {
601 // Wrap-around modulus
602 int size = m_tabOrder.size();
603 idx = ( ( idx + delta ) % size + size ) % size;
604 };
605
606 for( size_t i = 0; i < m_tabOrder.size(); ++i )
607 {
608 if( m_tabOrder[i] == currentWindow )
609 {
610 currentIdx = (int) i;
611 break;
612 }
613 }
614
615 if( currentIdx >= 0 )
616 {
617 advance( currentIdx );
618
619 //todo: We don't currently have non-textentry dialog boxes but this will break if
620 // we add them.
621#ifdef __APPLE__
622 while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
623 advance( currentIdx );
624#endif
625
626 m_tabOrder[ currentIdx ]->SetFocus();
627 return;
628 }
629 }
630
631 aEvt.Skip();
632}
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:222
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:220
virtual void ToggleUserUnits()
constexpr int delta

References delta, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), and DIALOG_TEXTBOX_PROPERTIES::~DIALOG_TEXTBOX_PROPERTIES().

◆ OnClose()

virtual void DIALOG_BOARD_REANNOTATE_BASE::OnClose ( wxCloseEvent &  event)
inlineprotectedvirtualinherited

◆ OnCloseClick()

void DIALOG_BOARD_REANNOTATE::OnCloseClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_BOARD_REANNOTATE_BASE.

Definition at line 205 of file dialog_board_reannotate.cpp.

206{
207 EndDialog( wxID_OK );
208}

◆ OnCloseWindow()

void DIALOG_SHIM::OnCloseWindow ( wxCloseEvent &  aEvent)
privateinherited

Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 520 of file dialog_shim.cpp.

521{
522 if( IsQuasiModal() )
523 {
524 EndQuasiModal( wxID_CANCEL );
525 return;
526 }
527
528 // This is mandatory to allow wxDialogBase::OnCloseWindow() to be called.
529 aEvent.Skip();
530}

References DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnGridEditorHidden()

void DIALOG_SHIM::OnGridEditorHidden ( wxGridEvent &  event)
privateinherited

Definition at line 642 of file dialog_shim.cpp.

643{
644 SetEscapeId( wxID_ANY );
645 event.Skip();
646}

◆ OnGridEditorShown()

void DIALOG_SHIM::OnGridEditorShown ( wxGridEvent &  event)
privateinherited

Definition at line 635 of file dialog_shim.cpp.

636{
637 SetEscapeId( wxID_NONE );
638 event.Skip();
639}

◆ OnModify()

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 387 of file dialog_shim.cpp.

388{
390 {
392
393 selectAllInTextCtrls( GetChildren() );
394
397 else
398 KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
399
400 m_firstPaintEvent = false;
401 }
402
403 event.Skip();
404}
bool m_firstPaintEvent
Definition: dialog_shim.h:212
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:213
static void selectAllInTextCtrls(wxWindowList &children)
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

37{
38 return Kiway().Prj();
39}
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:192

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::GetLastPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), SCH_EDIT_FRAME::LoadProject(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), PCB_EDIT_FRAME::onBoardLoaded(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_NETLIST_IMPORT::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChanged(), DIALOG_BOARD_SETUP::OnPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::readNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), PCB_EDIT_FRAME::RunEeschema(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_BASE_FRAME::SaveSettings(), SIM_PLOT_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), PCB_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::SetLastPath(), GERBVIEW_FRAME::SetPageSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PCB_EDIT_FRAME::TestStandalone(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDIT_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ReannotateBoard()

bool DIALOG_BOARD_REANNOTATE::ReannotateBoard ( void  )
private

Actually reannotate the board.

Returns
false if fail, true if success.

Definition at line 574 of file dialog_board_reannotate.cpp.

575{
576 std::vector<RefDesInfo> BadRefDes;
577 wxString message, badrefdes;
578 STRING_FORMATTER stringformatter;
579 RefDesChange* newref;
581
582 if( !BuildFootprintList( BadRefDes ) )
583 {
584 ShowReport( _( "Selected options resulted in errors! Change them and try again." ),
586 return false;
587 }
588
589 if( !BadRefDes.empty() )
590 {
591 message.Printf( _( "\nPCB has %d empty or invalid reference designations."
592 "\nRecommend running DRC with 'Test for parity between PCB and "
593 "schematic' checked.\n" ),
594 (int) BadRefDes.size() );
595
596 for( const RefDesInfo& mod : BadRefDes )
597 {
598 badrefdes += wxString::Format( _( "\nRefDes: %s Footprint: %s:%s at %s on PCB." ),
599 mod.RefDesString,
600 mod.FPID.GetLibNickname().wx_str(),
601 mod.FPID.GetLibItemName().wx_str(),
602 CoordTowxString( mod.x, mod.y ) );
603 }
604
605 ShowReport( message + badrefdes + wxT( "\n" ), RPT_SEVERITY_WARNING );
606 message += _( "Reannotate anyway?" );
607
608 if( !IsOK( m_frame, message ) )
609 return false;
610 }
611
612 BOARD_COMMIT commit( m_frame );
613
614 for( FOOTPRINT* footprint : m_footprints )
615 {
616 newref = GetNewRefDes( footprint );
617
618 if( nullptr == newref )
619 return false;
620
621 commit.Modify( footprint ); // Make a copy for undo
622 footprint->SetReference( newref->NewRefDes ); // Update the PCB reference
623 m_frame->GetCanvas()->GetView()->Update( footprint ); // Touch the footprint
624 }
625
626 commit.Push( wxT( "Geographic reannotation" ) );
627 return true;
628}
bool BuildFootprintList(std::vector< RefDesInfo > &aBadRefDes)
Build the footprint lists, sort it, filter for excludes, then build the change list.
RefDesChange * GetNewRefDes(FOOTPRINT *aFootprint)
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
Definition: pcb_netlist.h:213
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Implement an OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:415

References _, BuildFootprintList(), CoordTowxString(), Format(), PCB_BASE_FRAME::GetCanvas(), GetNewRefDes(), PCB_DRAW_PANEL_GAL::GetView(), IsOK(), m_footprints, m_frame, COMMIT::Modify(), netlist, RefDesChange::NewRefDes, BOARD_COMMIT::Push(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, ShowReport(), and KIGFX::PCB_VIEW::Update().

Referenced by OnApplyClick().

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 294 of file dialog_shim.cpp.

295{
296 const char* hash_key;
297
298 if( m_hash_key.size() )
299 {
300 // a special case like EDA_LIST_DIALOG, which has multiple uses.
301 hash_key = m_hash_key.c_str();
302 }
303 else
304 {
305 hash_key = typeid(*this).name();
306 }
307
308 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
309
310 if( it == class_map.end() )
311 return;
312
313 wxRect rect = it->second;
314 rect.SetSize( wxSize( 0, 0 ) );
315 class_map[ hash_key ] = rect;
316}
std::string m_hash_key
Definition: dialog_shim.h:203
static std::unordered_map< std::string, wxRect > class_map

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ RoundToGrid()

int DIALOG_BOARD_REANNOTATE::RoundToGrid ( int  aCoord,
int  aGrid 
)
private

Round an int coordinate to a suitable grid.

Definition at line 425 of file dialog_board_reannotate.cpp.

426{
427 if( 0 == aGrid )
428 aGrid = MINGRID;
429
430 int rounder;
431 rounder = aCoord % aGrid;
432 aCoord -= rounder;
433
434 if( abs( rounder ) > ( aGrid / 2 ) )
435 aCoord += ( aCoord < 0 ? -aGrid : aGrid );
436
437 return ( aCoord );
438}
#define MINGRID
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:412

References std::abs(), and MINGRID.

Referenced by BuildFootprintList().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 97 of file dialog_shim.h.

98 {
99 m_initialFocusTarget = aWindow;
100 }

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest,
KIWAY aKiway 
)
inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 of file kiway_holder.cpp.

44{
45#if defined(DEBUG)
46 // offer a trap point for debugging most any window
47 wxASSERT( aDest );
48 if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
49 {
50 int breakhere=1;
51 ignore_unused( breakhere );
52 }
53#endif
54
55 ignore_unused( aDest );
56
57 m_kiway = aKiway;
58}
const char * name
Definition: DXF_plotter.cpp:56

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 197 of file dialog_shim.cpp.

198{
199 wxDialog::SetPosition( aNewPosition );
200
201 // Now update the stored position:
202 const char* hash_key;
203
204 if( m_hash_key.size() )
205 {
206 // a special case like EDA_LIST_DIALOG, which has multiple uses.
207 hash_key = m_hash_key.c_str();
208 }
209 else
210 {
211 hash_key = typeid(*this).name();
212 }
213
214 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
215
216 if( it == class_map.end() )
217 return;
218
219 wxRect rect = it->second;
220 rect.SetPosition( aNewPosition );
221
222 class_map[ hash_key ] = rect;
223}
void SetPosition(const wxString &aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

void DIALOG_SHIM::setSizeInDU ( int  x,
int  y 
)
protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 169 of file dialog_shim.cpp.

170{
171 wxSize sz( x, y );
172 SetSize( ConvertDialogToPixels( sz ) );
173}

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ SetupStandardButtons()

void DIALOG_SHIM::SetupStandardButtons ( std::map< int, wxString >  aLabels = {})
inherited

Definition at line 709 of file dialog_shim.cpp.

710{
711 recursiveDescent( GetSizer(), aLabels );
712}
static void recursiveDescent(wxSizer *aSizer, std::map< int, wxString > &aLabels)

References recursiveDescent().

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CLEANUP_GRAPHICS::DIALOG_CLEANUP_GRAPHICS(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_DIELECTRIC_MATERIAL::DIALOG_DIELECTRIC_MATERIAL(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FILTER_SELECTION::DIALOG_FILTER_SELECTION(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PRIMITIVES_TRANSFORM::DIALOG_PAD_PRIMITIVES_TRANSFORM(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::DIALOG_PNS_DIFF_PAIR_DIMENSIONS(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::DIALOG_PNS_LENGTH_TUNING_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_SETTINGS::DIALOG_SIM_SETTINGS(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_CLEANUP_TRACKS_AND_VIAS::setupOKButtonLabel(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 226 of file dialog_shim.cpp.

227{
228 bool ret;
229 const char* hash_key;
230
231 if( m_hash_key.size() )
232 {
233 // a special case like EDA_LIST_DIALOG, which has multiple uses.
234 hash_key = m_hash_key.c_str();
235 }
236 else
237 {
238 hash_key = typeid(*this).name();
239 }
240
241 // Show or hide the window. If hiding, save current position and size.
242 // If showing, use previous position and size.
243 if( show )
244 {
245#ifndef __WINDOWS__
246 wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
247#endif
248 ret = wxDialog::Show( show );
249
250 // classname is key, returns a zeroed out default EDA_RECT if none existed before.
251 wxRect savedDialogRect = class_map[ hash_key ];
252
253 if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
254 {
256 {
257 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
258 wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
259 }
260 else
261 {
262 SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
263 std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
264 std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
265 0 );
266 }
267 }
268 else if( m_initialSize != wxDefaultSize )
269 SetSize( m_initialSize );
270
271 // Be sure that the dialog appears in a visible area
272 // (the dialog position might have been stored at the time when it was
273 // shown on another display)
274 if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
275 Centre();
276 }
277 else
278 {
279 // Save the dialog's position & size before hiding, using classname as key
280 class_map[ hash_key ] = wxRect( wxDialog::GetPosition(), wxDialog::GetSize() );
281
282#ifdef __WXMAC__
283 if ( m_eventLoop )
284 m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
285#endif
286
287 ret = wxDialog::Show( show );
288 }
289
290 return ret;
291}
bool m_useCalculatedSize
Definition: dialog_shim.h:207
wxSize m_initialSize
Definition: dialog_shim.h:225

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), DIALOG_FIND::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 437 of file dialog_shim.cpp.

438{
439 // This is an exception safe way to zero a pointer before returning.
440 // Yes, even though DismissModal() clears this first normally, this is
441 // here in case there's an exception before the dialog is dismissed.
442 struct NULLER
443 {
444 void*& m_what;
445 NULLER( void*& aPtr ) : m_what( aPtr ) {}
446 ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
447 } clear_this( (void*&) m_qmodal_loop );
448
449 // release the mouse if it's currently captured as the window having it
450 // will be disabled when this dialog is shown -- but will still keep the
451 // capture making it impossible to do anything in the modal dialog itself
452 wxWindow* win = wxWindow::GetCapture();
453 if( win )
454 win->ReleaseMouse();
455
456 // Get the optimal parent
457 wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
458
459 wxASSERT_MSG( !m_qmodal_parent_disabler, wxT( "Caller using ShowQuasiModal() twice on same "
460 "window?" ) );
461
462 // quasi-modal: disable only my "optimal" parent
464
465 // Apple in its infinite wisdom will raise a disabled window before even passing
466 // us the event, so we have no way to stop it. Instead, we must set an order on
467 // the windows so that the quasi-modal will be pushed in front of the disabled
468 // window when it is raised.
470
471 Show( true );
472
473 m_qmodal_showing = true;
474
475 WX_EVENT_LOOP event_loop;
476
477 m_qmodal_loop = &event_loop;
478
479 event_loop.Run();
480
481 m_qmodal_showing = false;
482
483 return GetReturnCode();
484}
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:46
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:65

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), PCB::IFACE::CreateWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and PCB_EDIT_FRAME::ToPlotter().

◆ ShowReport()

void DIALOG_BOARD_REANNOTATE::ShowReport ( const wxString &  aMessage,
SEVERITY  aSeverity 
)
private

Break report into strings separated by
and sent to the reporter.

Definition at line 489 of file dialog_board_reannotate.cpp.

490{
491 size_t pos = 0, prev = 0;
492
493 do
494 {
495 pos = aMessage.ToStdString().find( '\n', prev );
496 m_MessageWindow->Report( aMessage.ToStdString().substr( prev, pos - prev ), aSeverity );
497 prev = pos + 1;
498 } while( std::string::npos != pos );
499
500}
void Report(const wxString &aText, SEVERITY aSeverity, REPORTER::LOCATION aLocation=REPORTER::LOC_BODY)
Reports the string.

References DIALOG_BOARD_REANNOTATE_BASE::m_MessageWindow, and WX_HTML_REPORT_PANEL::Report().

Referenced by BuildFootprintList(), GetNewRefDes(), LogChangePlan(), LogFootprints(), MakeSampleText(), OnApplyClick(), and ReannotateBoard().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 183 of file dialog_shim.cpp.

184{
185 wxSize sz( 0, y );
186 return ConvertDialogToPixels( sz ).y;
187}

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ AnnotateLabel

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::AnnotateLabel
protectedinherited

◆ Bitmaps

◆ m_Advanced

wxPanel* DIALOG_BOARD_REANNOTATE_BASE::m_Advanced
protectedinherited

◆ m_AnnotateAll

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateAll
protectedinherited

◆ m_AnnotateBack

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateBack
protectedinherited

◆ m_AnnotateFront

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateFront
protectedinherited

◆ m_AnnotateSelection

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_AnnotateSelection
protectedinherited

◆ m_annotationScope

int DIALOG_BOARD_REANNOTATE::m_annotationScope
private

◆ m_backFootprints

std::vector<RefDesInfo> DIALOG_BOARD_REANNOTATE::m_backFootprints
private

Definition at line 197 of file dialog_board_reannotate.h.

Referenced by BuildFootprintList(), and BuildUnavailableRefsList().

◆ m_BackPrefix

◆ m_backPrefixString

wxString DIALOG_BOARD_REANNOTATE::m_backPrefixString
private

Definition at line 210 of file dialog_board_reannotate.h.

Referenced by GetParameters().

◆ m_BackPrefixText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_BackPrefixText
protectedinherited

◆ m_BackRefDesStart

wxTextCtrl* DIALOG_BOARD_REANNOTATE_BASE::m_BackRefDesStart
protectedinherited

◆ m_BottomRefDesStartText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_BottomRefDesStartText
protectedinherited

◆ m_changeArray

std::vector<RefDesChange> DIALOG_BOARD_REANNOTATE::m_changeArray
private

◆ m_Config

APP_SETTINGS_BASE* DIALOG_BOARD_REANNOTATE::m_Config
private

Definition at line 215 of file dialog_board_reannotate.h.

Referenced by DIALOG_BOARD_REANNOTATE().

◆ m_Down_Left

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Down_Left
protectedinherited

◆ m_Down_Right

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Down_Right
protectedinherited

◆ m_excludeArray

std::vector<wxString> DIALOG_BOARD_REANNOTATE::m_excludeArray
private

Definition at line 199 of file dialog_board_reannotate.h.

Referenced by BuildFootprintList(), and LogChangePlan().

◆ m_ExcludeList

wxTextCtrl* DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeList
protectedinherited

◆ m_ExcludeListText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeListText
protectedinherited

◆ m_ExcludeLocked

wxCheckBox* DIALOG_BOARD_REANNOTATE_BASE::m_ExcludeLocked
protectedinherited

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_footprints

FOOTPRINTS DIALOG_BOARD_REANNOTATE::m_footprints
private

Definition at line 192 of file dialog_board_reannotate.h.

Referenced by BuildFootprintList(), and ReannotateBoard().

◆ m_frame

PCB_EDIT_FRAME* DIALOG_BOARD_REANNOTATE::m_frame
private

◆ m_frontFootprints

std::vector<RefDesInfo> DIALOG_BOARD_REANNOTATE::m_frontFootprints
private

Definition at line 196 of file dialog_board_reannotate.h.

Referenced by BuildFootprintList(), and BuildUnavailableRefsList().

◆ m_FrontPrefix

◆ m_frontPrefixString

wxString DIALOG_BOARD_REANNOTATE::m_frontPrefixString
private

Definition at line 209 of file dialog_board_reannotate.h.

Referenced by GetParameters().

◆ m_FrontPrefixText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_FrontPrefixText
protectedinherited

◆ m_FrontRefDesStart

wxTextCtrl* DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStart
protectedinherited

◆ m_FrontRefDesStartText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_FrontRefDesStartText
protectedinherited

◆ m_GridChoice

wxChoice* DIALOG_BOARD_REANNOTATE_BASE::m_GridChoice
protectedinherited

◆ m_gridIndex

int DIALOG_BOARD_REANNOTATE::m_gridIndex
private

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 213 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 225 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

◆ m_Left_Down

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Left_Down
protectedinherited

◆ m_Left_Up

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Left_Up
protectedinherited

◆ m_locationChoice

wxChoice* DIALOG_BOARD_REANNOTATE_BASE::m_locationChoice
protectedinherited

◆ m_MessageWindow

◆ m_notebook

wxNotebook* DIALOG_BOARD_REANNOTATE_BASE::m_notebook
protectedinherited

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 215 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 217 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

◆ m_refDesTypes

std::vector<RefDesTypeStr> DIALOG_BOARD_REANNOTATE::m_refDesTypes
private

◆ m_RemoveBackPrefix

wxCheckBox* DIALOG_BOARD_REANNOTATE_BASE::m_RemoveBackPrefix
protectedinherited

◆ m_RemoveFrontPrefix

wxCheckBox* DIALOG_BOARD_REANNOTATE_BASE::m_RemoveFrontPrefix
protectedinherited

◆ m_Right_Down

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Right_Down
protectedinherited

◆ m_Right_Up

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Right_Up
protectedinherited

◆ m_scopeRadioButtons

std::vector<wxRadioButton*> DIALOG_BOARD_REANNOTATE::m_scopeRadioButtons
private

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_BOARD_REANNOTATE_BASE::m_sdbSizerOK
protectedinherited

◆ m_selection

PCB_SELECTION DIALOG_BOARD_REANNOTATE::m_selection
private

Definition at line 193 of file dialog_board_reannotate.h.

Referenced by BuildFootprintList(), and DIALOG_BOARD_REANNOTATE().

◆ m_settings

APP_SETTINGS_BASE* DIALOG_BOARD_REANNOTATE::m_settings
private

Definition at line 213 of file dialog_board_reannotate.h.

Referenced by DIALOG_BOARD_REANNOTATE(), and GetParameters().

◆ m_severity

int DIALOG_BOARD_REANNOTATE::m_severity
private

Definition at line 204 of file dialog_board_reannotate.h.

Referenced by InitValues(), and ~DIALOG_BOARD_REANNOTATE().

◆ m_sortButtons

◆ m_sortCode

int DIALOG_BOARD_REANNOTATE::m_sortCode
private

◆ m_SortGridText

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_SortGridText
protectedinherited

◆ m_sortGridx

double DIALOG_BOARD_REANNOTATE::m_sortGridx
private

◆ m_sortGridy

double DIALOG_BOARD_REANNOTATE::m_sortGridy
private

◆ m_StandardOptions

wxPanel* DIALOG_BOARD_REANNOTATE_BASE::m_StandardOptions
protectedinherited

◆ m_staticText9

wxStaticText* DIALOG_BOARD_REANNOTATE_BASE::m_staticText9
protectedinherited

◆ m_tabOrder

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::GetType(), and SIM_PLOT_FRAME::onSimFinished().

◆ m_units

◆ m_Up_Left

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Up_Left
protectedinherited

◆ m_Up_Right

wxRadioButton* DIALOG_BOARD_REANNOTATE_BASE::m_Up_Right
protectedinherited

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_validPrefixes

wxString DIALOG_BOARD_REANNOTATE::m_validPrefixes
private

Definition at line 211 of file dialog_board_reannotate.h.

◆ reannotate_down_left_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_down_left_bitmap
protectedinherited

◆ reannotate_down_right_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_down_right_bitmap
protectedinherited

◆ reannotate_left_down_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_left_down_bitmap
protectedinherited

◆ reannotate_left_up_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_left_up_bitmap
protectedinherited

◆ reannotate_right_down_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_right_down_bitmap
protectedinherited

◆ reannotate_right_up_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_right_up_bitmap
protectedinherited

◆ reannotate_up_left_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_up_left_bitmap
protectedinherited

◆ reannotate_up_right_bitmap

wxStaticBitmap* DIALOG_BOARD_REANNOTATE_BASE::reannotate_up_right_bitmap
protectedinherited

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