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 {
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
117 annotate_down_right_bitmap->SetBitmap( KiBitmapBundle( BITMAPS::annotate_down_right ) );
118 annotate_right_down_bitmap->SetBitmap( KiBitmapBundle( BITMAPS::annotate_right_down ) );
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 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
135
138 cfg->m_AnnotatePanel.options = m_rbOptions->GetSelection();
139
140 if( m_rbScope_Schematic->IsEnabled() )
141 {
143 cfg->m_AnnotatePanel.recursive = m_checkRecursive->GetValue();
144 }
145
147
148 // Get the "start annotation after" value from dialog and update project settings if changed
149 int startNum = GetStartNumber();
150
151 if( SCH_EDIT_FRAME* schFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_parentFrame ) )
152 {
153 SCHEMATIC_SETTINGS& projSettings = schFrame->Schematic().Settings();
154
155 // If the user has updated the start annotation number then update the project file.
156 // We manually update the project file here in case the user has changed the value
157 // and just clicked the "Close" button on the annotation dialog.
158
159 if( projSettings.m_AnnotateStartNum != startNum )
160 {
161 projSettings.m_AnnotateStartNum = startNum;
162 schFrame->OnModify();
163 }
164 }
165}
166
167
169{
170 // We still save/restore to config (instead of letting DIALOG_SHIM do it) because we also
171 // allow editing of these settings in preferences.
172
173 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
174
175 if( m_rbScope_Schematic->IsEnabled() )
176 {
177 switch( cfg->m_AnnotatePanel.scope )
178 {
179 default:
180 case ANNOTATE_ALL: m_rbScope_Schematic->SetValue( true ); break;
181 case ANNOTATE_CURRENT_SHEET: m_rbScope_Sheet->SetValue( true ); break;
182 case ANNOTATE_SELECTION: m_rbScope_Selection->SetValue( true ); break;
183 }
184
186 }
187
188 m_rbOptions->SetSelection( cfg->m_AnnotatePanel.options );
189
190 switch( cfg->m_AnnotatePanel.sort_order )
191 {
192 default:
193 case SORT_BY_X_POSITION: m_rbSortBy_X_Position->SetValue( true ); break;
194 case SORT_BY_Y_POSITION: m_rbSortBy_Y_Position->SetValue( true ); break;
195 }
196
197 switch( cfg->m_AnnotatePanel.method )
198 {
199 default:
200 case INCREMENTAL_BY_REF: m_rbFirstFree->SetValue( true ); break;
201 case SHEET_NUMBER_X_100: m_rbSheetX100->SetValue( true ); break;
202 case SHEET_NUMBER_X_1000: m_rbSheetX1000->SetValue( true ); break;
203 }
204
205 int annotateStartNum = 0; // Default "start after" value for annotation
206
207 // See if we can get a "start after" value from the project settings
208 if( SCH_EDIT_FRAME* schFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_parentFrame ) )
209 {
210 SCHEMATIC_SETTINGS& projSettings = schFrame->Schematic().Settings();
211 annotateStartNum = projSettings.m_AnnotateStartNum;
212 }
213
214 m_textNumberAfter->SetValue( wxString::Format( wxT( "%d" ), annotateStartNum ) );
215
216 return true;
217}
218
219
220// This is a modeless dialog so we have to handle these ourselves.
221void DIALOG_ANNOTATE::OnCloseClick( wxCommandEvent& event )
222{
223 Close();
224}
225
226
227void DIALOG_ANNOTATE::OnClose( wxCloseEvent& event )
228{
229 Destroy();
230}
231
232
233void DIALOG_ANNOTATE::OnAnnotateClick( wxCommandEvent& event )
234{
235 SCH_COMMIT commit( m_Parent );
236
238 REPORTER& reporter = m_MessageWindow->Reporter();
239 m_MessageWindow->SetLazyUpdate( true ); // Don't update after each message
240
242 GetStartNumber(), m_rbOptions->GetSelection() >= 1, true, reporter );
243
244 commit.Push( _( "Annotate" ) );
245
246 m_MessageWindow->Flush( true ); // Now update to show all messages
247}
248
249
250void DIALOG_ANNOTATE::OnClearAnnotationClick( wxCommandEvent& event )
251{
254
255 m_MessageWindow->Flush( true ); // Now update to show all messages
256}
257
258
259void DIALOG_ANNOTATE::OnOptionChanged( wxCommandEvent& event )
260{
261 m_sdbSizer1OK->Enable( true );
262 m_sdbSizer1OK->SetDefault();
263}
264
265
267{
268 DIALOG_ANNOTATE* dlg = static_cast<DIALOG_ANNOTATE*>( wxWindow::FindWindowByName( DLG_WINDOW_NAME ) );
269
270 if( !dlg )
271 {
272 dlg = new DIALOG_ANNOTATE( this, wxEmptyString );
273 dlg->Show( true );
274 }
275 else // The dialog is already opened, perhaps not visible
276 {
277 dlg->Show( true );
278 }
279}
280
281
282int SCH_EDIT_FRAME::ModalAnnotate( const wxString& aMessage )
283{
284 DIALOG_ANNOTATE dlg( this, aMessage );
285
286 return dlg.ShowModal();
287}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition: bitmap.cpp:110
Class DIALOG_ANNOTATE_BASE.
wxStaticBitmap * annotate_down_right_bitmap
wxRadioButton * m_rbSortBy_X_Position
wxRadioButton * m_rbSheetX100
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
Definition: dialog_shim.h:254
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.
Definition: sch_commit.cpp:489
Schematic editor (Eeschema) main window.
void DeleteAnnotation(ANNOTATE_SCOPE_T aAnnotateScope, bool aRecursive, REPORTER &aReporter)
Clear the current symbol annotation.
Definition: annotate.cpp:61
void AnnotateSymbols(SCH_COMMIT *aCommit, ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, REPORTER &aReporter)
Annotate the symbols in the schematic that are not currently annotated.
Definition: annotate.cpp:213
int ModalAnnotate(const wxString &aMessage)
Run a modal version of the annotate dialog for a specific purpose.
void Clear()
Clears the report panel.
void SetLazyUpdate(bool aLazyUpdate)
Set the lazy update.
void SetLabel(const wxString &aLabel) override
Set the frame label.
void MsgPanelSetMinSize(const wxSize &aMinSize)
Set the min size of the area which displays html messages.
void SetFileName(const wxString &aReportFileName)
Set the report full file name to the string.
void Flush(bool aSort=false)
Force updating the HTML page, after the report is built in lazy mode If aSort = true,...
REPORTER & Reporter()
Return the reporter object that reports to this panel.
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
Definition: wx_infobar.cpp:371
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: wx_infobar.cpp:156
#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.
Definition: eda_units.cpp:689
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.