KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_annotate.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 1992-2017 jean-pierre Charras jp.charras at wanadoo.fr
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#include <sch_edit_frame.h>
27#include <bitmaps.h>
29#include <eeschema_settings.h>
30#include <kiface_base.h>
32#include <schematic.h>
33#include <sch_commit.h>
34
35// A window name for the annotate dialog to retrieve is if not destroyed
36#define DLG_WINDOW_NAME "DialogAnnotateWindowName"
37
38
43{
44public:
45 DIALOG_ANNOTATE( SCH_EDIT_FRAME* parent, const wxString& message );
47
48 bool TransferDataToWindow() override;
49
50private:
52 void OnOptionChanged( wxCommandEvent& event ) override;
53 void OnClearAnnotationClick( wxCommandEvent& event ) override;
54 void OnCloseClick( wxCommandEvent& event ) override;
55 void OnClose( wxCloseEvent& event ) override;
56 void OnAnnotateClick( wxCommandEvent& event ) override;
57
59 {
60 if( m_rbScope_Schematic->GetValue() )
61 return ANNOTATE_ALL;
62 else if( m_rbScope_Sheet->GetValue() )
64 else
65 return ANNOTATE_SELECTION;
66 }
67
69 {
70 if( m_rbSortBy_Y_Position->GetValue() )
71 return SORT_BY_Y_POSITION;
72 else
73 return SORT_BY_X_POSITION;
74 }
75
77 {
78 if( m_rbSheetX100->GetValue() )
79 return SHEET_NUMBER_X_100;
80 else if( m_rbSheetX1000->GetValue() )
82 else
83 return INCREMENTAL_BY_REF;
84 }
85
87 {
89 }
90
91private:
93};
94
95
96DIALOG_ANNOTATE::DIALOG_ANNOTATE( SCH_EDIT_FRAME* parent, const wxString& message ) :
97 DIALOG_ANNOTATE_BASE( parent )
98{
99 SetName( DLG_WINDOW_NAME );
100 m_Parent = parent;
101
102 if( !message.IsEmpty() )
103 {
104 m_infoBar->RemoveAllButtons();
105 m_infoBar->ShowMessage( message );
106
107 m_rbScope_Schematic->SetValue( true );
108 m_rbScope_Schematic->Enable( false );
109 }
110
111 m_MessageWindow->SetLabel( _( "Annotation Messages:" ) );
112 m_MessageWindow->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
113
114 SetupStandardButtons( { { wxID_OK, _( "Annotate" ) },
115 { wxID_CANCEL, _( "Close" ) } } );
116
119
120 m_MessageWindow->MsgPanelSetMinSize( wxSize( -1, 160 ) );
121
122 Layout();
123
124 // When all widgets have the size fixed, call FinishDialogSettings
126}
127
128
130{
131 // We still save/restore to config (instead of letting DIALOG_SHIM do it) because we also
132 // allow editing of these settings in preferences.
133
134 SCHEMATIC_SETTINGS& schSettings = m_Parent->Schematic().Settings();
135 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
136
137 schSettings.m_AnnotateMethod = m_rbOptions->GetSelection();
138
139 if( m_rbScope_Schematic->IsEnabled() )
140 {
142 cfg->m_AnnotatePanel.recursive = m_checkRecursive->GetValue();
143 }
144
145 int sort = GetSortOrder();
146 int method = GetAnnotateAlgo();
147 int startNum = GetStartNumber();
148
149 if( SCH_EDIT_FRAME* schFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_parentFrame ) )
150 {
151 SCHEMATIC_SETTINGS& projSettings = schFrame->Schematic().Settings();
152 bool modified = false;
153
154 if( projSettings.m_AnnotateSortOrder != sort )
155 {
156 projSettings.m_AnnotateSortOrder = sort;
157 modified = true;
158 }
159
160 if( projSettings.m_AnnotateMethod != method )
161 {
162 projSettings.m_AnnotateMethod = method;
163 modified = true;
164 }
165
166 if( projSettings.m_AnnotateStartNum != startNum )
167 {
168 projSettings.m_AnnotateStartNum = startNum;
169 modified = true;
170 }
171
172 if( modified )
173 schFrame->OnModify();
174 }
175}
176
177
179{
180 // We still save/restore to config (instead of letting DIALOG_SHIM do it) because we also
181 // allow editing of these settings in preferences.
182 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
183
184 if( m_rbScope_Schematic->IsEnabled() )
185 {
186 switch( cfg->m_AnnotatePanel.scope )
187 {
188 default:
189 case ANNOTATE_ALL: m_rbScope_Schematic->SetValue( true ); break;
190 case ANNOTATE_CURRENT_SHEET: m_rbScope_Sheet->SetValue( true ); break;
191 case ANNOTATE_SELECTION: m_rbScope_Selection->SetValue( true ); break;
192 }
193
195 }
196
197 m_rbOptions->SetSelection( cfg->m_AnnotatePanel.options );
198
199 if( SCH_EDIT_FRAME* schFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_parentFrame ) )
200 {
201 SCHEMATIC_SETTINGS& projSettings = schFrame->Schematic().Settings();
202
203 switch( projSettings.m_AnnotateSortOrder )
204 {
205 default:
206 case SORT_BY_X_POSITION: m_rbSortBy_X_Position->SetValue( true ); break;
207 case SORT_BY_Y_POSITION: m_rbSortBy_Y_Position->SetValue( true ); break;
208 }
209
210 switch( projSettings.m_AnnotateMethod )
211 {
212 default:
213 case INCREMENTAL_BY_REF: m_rbFirstFree->SetValue( true ); break;
214 case SHEET_NUMBER_X_100: m_rbSheetX100->SetValue( true ); break;
215 case SHEET_NUMBER_X_1000: m_rbSheetX1000->SetValue( true ); break;
216 }
217
218 m_textNumberAfter->SetValue( wxString::Format( wxT( "%d" ), projSettings.m_AnnotateStartNum ) );
219 }
220
221 return true;
222}
223
224
225// This is a modeless dialog so we have to handle these ourselves.
226void DIALOG_ANNOTATE::OnCloseClick( wxCommandEvent& event )
227{
228 Close();
229}
230
231
232void DIALOG_ANNOTATE::OnClose( wxCloseEvent& event )
233{
234 Destroy();
235}
236
237
238void DIALOG_ANNOTATE::OnAnnotateClick( wxCommandEvent& event )
239{
240 SCH_COMMIT commit( m_Parent );
241
242 m_MessageWindow->Clear();
243 REPORTER& reporter = m_MessageWindow->Reporter();
244 m_MessageWindow->SetLazyUpdate( true ); // Don't update after each message
245
246 m_Parent->AnnotateSymbols( &commit, GetScope(), GetSortOrder(), GetAnnotateAlgo(), m_checkRecursive->GetValue(),
247 GetStartNumber(), m_rbOptions->GetSelection() >= 1, true, reporter );
248
249 commit.Push( _( "Annotate" ) );
250
251 m_MessageWindow->Flush( true ); // Now update to show all messages
252}
253
254
255void DIALOG_ANNOTATE::OnClearAnnotationClick( wxCommandEvent& event )
256{
257 m_MessageWindow->Clear();
258 m_Parent->DeleteAnnotation( GetScope(), m_checkRecursive->GetValue(), m_MessageWindow->Reporter() );
259
260 m_MessageWindow->Flush( true ); // Now update to show all messages
261}
262
263
264void DIALOG_ANNOTATE::OnOptionChanged( wxCommandEvent& event )
265{
266 m_sdbSizer1OK->Enable( true );
267 m_sdbSizer1OK->SetDefault();
268}
269
270
272{
273 DIALOG_ANNOTATE* dlg = static_cast<DIALOG_ANNOTATE*>( wxWindow::FindWindowByName( DLG_WINDOW_NAME ) );
274
275 if( !dlg )
276 {
277 dlg = new DIALOG_ANNOTATE( this, wxEmptyString );
278 dlg->Show( true );
279 }
280 else // The dialog is already opened, perhaps not visible
281 {
282 dlg->Show( true );
283 }
284}
285
286
287int SCH_EDIT_FRAME::ModalAnnotate( const wxString& aMessage )
288{
289 DIALOG_ANNOTATE dlg( this, aMessage );
290
291 return dlg.ShowModal();
292}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition bitmap.cpp:110
@ annotate_down_right
@ annotate_right_down
wxStaticBitmap * annotate_down_right_bitmap
wxRadioButton * m_rbSortBy_X_Position
wxRadioButton * m_rbSheetX100
DIALOG_ANNOTATE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Annotate Schematic"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxRadioButton * m_rbScope_Sheet
wxRadioButton * m_rbSheetX1000
wxStaticBitmap * annotate_right_down_bitmap
wxRadioButton * m_rbScope_Schematic
wxRadioButton * m_rbSortBy_Y_Position
WX_HTML_REPORT_PANEL * m_MessageWindow
wxRadioButton * m_rbScope_Selection
wxRadioButton * m_rbFirstFree
A dialog to set/clear reference designators of a schematic with different options.
void OnClose(wxCloseEvent &event) override
void OnClearAnnotationClick(wxCommandEvent &event) override
ANNOTATE_SCOPE_T GetScope()
bool TransferDataToWindow() override
void OnOptionChanged(wxCommandEvent &event) override
Initialize member variables.
void OnCloseClick(wxCommandEvent &event) override
void OnAnnotateClick(wxCommandEvent &event) override
SCH_EDIT_FRAME * m_Parent
DIALOG_ANNOTATE(SCH_EDIT_FRAME *parent, const wxString &message)
ANNOTATE_ORDER_T GetSortOrder()
ANNOTATE_ALGO_T GetAnnotateAlgo()
bool Show(bool show) override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
EDA_BASE_FRAME * m_parentFrame
int ShowModal() override
PANEL_ANNOTATE m_AnnotatePanel
APP_SETTINGS_BASE * KifaceSettings() const
Definition kiface_base.h:95
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
A pure virtual class used to derive REPORTER objects from.
Definition reporter.h:73
These are loaded from Eeschema settings but then overwritten by the project settings.
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
Schematic editor (Eeschema) main window.
int ModalAnnotate(const wxString &aMessage)
Run a modal version of the annotate dialog for a specific purpose.
#define DLG_WINDOW_NAME
#define _(s)
KICOMMON_API long long int ValueFromString(const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, const wxString &aTextValue, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
Convert aTextValue in aUnits to internal units used by the application.
ANNOTATE_ORDER_T
Schematic annotation order options.
@ SORT_BY_X_POSITION
Annotate by X position from left to right.
@ SORT_BY_Y_POSITION
Annotate by Y position from top to bottom.
ANNOTATE_SCOPE_T
Schematic annotation scope options.
@ ANNOTATE_SELECTION
Annotate the selection.
@ ANNOTATE_CURRENT_SHEET
Annotate the current sheet.
@ ANNOTATE_ALL
Annotate the full schematic.
ANNOTATE_ALGO_T
Schematic annotation type options.
@ SHEET_NUMBER_X_1000
Annotate using the first free reference number starting at the sheet number * 1000.
@ INCREMENTAL_BY_REF
Annotate incrementally using the first free reference number.
@ SHEET_NUMBER_X_100
Annotate using the first free reference number starting at the sheet number * 100.