KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_board_setup.h
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 The KiCad Developers, see AUTHORS.txt for contributors.
5
*
6
* This program is free software: you can redistribute it and/or modify it
7
* under the terms of the GNU General Public License as published by the
8
* Free Software Foundation, either version 3 of the License, or (at your
9
* option) any later version.
10
*
11
* This program is distributed in the hope that it will be useful, but
12
* WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
* General Public License for more details.
15
*
16
* You should have received a copy of the GNU General Public License
17
* along with this program. If not, see <https://www.gnu.org/licenses/>.
18
*/
19
20
21
#pragma once
22
23
#include <memory>
24
#include <
widgets/paged_dialog.h
>
25
#include "
panel_setup_formatting.h
"
26
27
class
BOARD
;
28
class
BOARD_DESIGN_SETTINGS
;
29
class
PCB_EDIT_FRAME
;
30
class
DRC_RULE_DOCUMENT
;
31
class
PANEL_SETUP_CONSTRAINTS
;
32
class
PANEL_SETUP_CONSTRAINT_RULES
;
33
class
PANEL_SETUP_LAYERS
;
34
class
PANEL_SETUP_DEFAULTS
;
35
class
PANEL_SETUP_NETCLASSES
;
36
class
PANEL_SETUP_RULES
;
37
class
PANEL_SETUP_TRACKS_AND_VIAS
;
38
class
PANEL_SETUP_MASK_AND_PASTE
;
39
class
PANEL_SETUP_ZONES
;
40
class
PANEL_SETUP_BOARD_STACKUP
;
41
class
PANEL_SETUP_BOARD_FINISH
;
42
class
PANEL_SETUP_SEVERITIES
;
43
class
PANEL_TEXT_VARIABLES
;
44
class
PANEL_SETUP_TUNING_PROFILES
;
45
46
47
class
DIALOG_BOARD_SETUP
:
public
PAGED_DIALOG
48
{
49
public
:
50
DIALOG_BOARD_SETUP
(
PCB_EDIT_FRAME
* aFrame, wxWindow* aWindow =
nullptr
);
51
~DIALOG_BOARD_SETUP
();
52
53
protected
:
54
// event handlers
55
void
onPageChanged
( wxBookCtrlEvent& aEvent )
override
;
56
void
onAuxiliaryAction
( wxCommandEvent& aEvent )
override
;
57
void
onCancelButton
( wxCommandEvent& aEvent );
58
void
onCloseWindow
( wxCloseEvent& aEvent );
59
60
void
refreshRulePage
(
size_t
aPage );
61
63
void
refreshStagedPages
(
const
wxString& aGroup );
64
void
forEachOpenRulePage
(
const
std::function<
void
(
PANEL_SETUP_CONSTRAINT_RULES
* )>& aAction );
65
66
bool
TransferDataFromWindow
()
override
;
67
68
PCB_EDIT_FRAME
*
m_frame
;
69
PANEL_SETUP_LAYERS
*
m_layers
;
70
PANEL_SETUP_BOARD_FINISH
*
m_boardFinish
;
71
PANEL_SETUP_BOARD_STACKUP
*
m_physicalStackup
;
72
PANEL_SETUP_ZONES
*
m_zones
;
73
PANEL_SETUP_TUNING_PROFILES
*
m_tuningProfiles
;
74
PANEL_SETUP_NETCLASSES
*
m_netClasses
;
75
76
private
:
77
bool
canDiscardChanges
();
78
79
size_t
m_currentPage
;
// the current page index
80
size_t
m_layersPage
;
81
size_t
m_physicalStackupPage
;
82
size_t
m_boardFinishPage
;
83
size_t
m_defaultsPage
;
84
size_t
m_formattingPage
;
85
size_t
m_drillChartPage
;
86
size_t
m_customRulesPage
;
87
size_t
m_tracksAndViasPage
;
88
size_t
m_viaStacksPage
;
89
size_t
m_zonesPage
;
90
size_t
m_teardropsPage
;
91
size_t
m_tuningPatternsPage
;
92
size_t
m_netclassesPage
;
93
size_t
m_componentClassesPage
;
94
size_t
m_severitiesPage
;
95
size_t
m_embeddedFilesPage
;
96
size_t
m_tuningProfilesPage
;
97
bool
m_initComplete
;
98
99
std::unique_ptr<DRC_RULE_DOCUMENT>
m_ruleDocument
;
100
103
std::unique_ptr<BOARD_DESIGN_SETTINGS>
m_stagedSettings
;
104
};
BOARD_DESIGN_SETTINGS
Container for design settings for a BOARD object.
Definition
board_design_settings.h:201
BOARD
Information pertinent to a Pcbnew printed circuit board.
Definition
board.h:411
DIALOG_BOARD_SETUP::m_embeddedFilesPage
size_t m_embeddedFilesPage
Definition
dialog_board_setup.h:95
DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP
DIALOG_BOARD_SETUP(PCB_EDIT_FRAME *aFrame, wxWindow *aWindow=nullptr)
Definition
dialog_board_setup.cpp:69
DIALOG_BOARD_SETUP::canDiscardChanges
bool canDiscardChanges()
Definition
dialog_board_setup.cpp:373
DIALOG_BOARD_SETUP::m_tracksAndViasPage
size_t m_tracksAndViasPage
Definition
dialog_board_setup.h:87
DIALOG_BOARD_SETUP::forEachOpenRulePage
void forEachOpenRulePage(const std::function< void(PANEL_SETUP_CONSTRAINT_RULES *)> &aAction)
Definition
dialog_board_setup.cpp:551
DIALOG_BOARD_SETUP::m_boardFinishPage
size_t m_boardFinishPage
Definition
dialog_board_setup.h:82
DIALOG_BOARD_SETUP::m_ruleDocument
std::unique_ptr< DRC_RULE_DOCUMENT > m_ruleDocument
Definition
dialog_board_setup.h:99
DIALOG_BOARD_SETUP::m_viaStacksPage
size_t m_viaStacksPage
Definition
dialog_board_setup.h:88
DIALOG_BOARD_SETUP::m_frame
PCB_EDIT_FRAME * m_frame
Definition
dialog_board_setup.h:68
DIALOG_BOARD_SETUP::onCancelButton
void onCancelButton(wxCommandEvent &aEvent)
Definition
dialog_board_setup.cpp:385
DIALOG_BOARD_SETUP::m_drillChartPage
size_t m_drillChartPage
Definition
dialog_board_setup.h:85
DIALOG_BOARD_SETUP::m_currentPage
size_t m_currentPage
Definition
dialog_board_setup.h:79
DIALOG_BOARD_SETUP::m_physicalStackupPage
size_t m_physicalStackupPage
Definition
dialog_board_setup.h:81
DIALOG_BOARD_SETUP::m_layersPage
size_t m_layersPage
Definition
dialog_board_setup.h:80
DIALOG_BOARD_SETUP::m_tuningProfiles
PANEL_SETUP_TUNING_PROFILES * m_tuningProfiles
Definition
dialog_board_setup.h:73
DIALOG_BOARD_SETUP::m_stagedSettings
std::unique_ptr< BOARD_DESIGN_SETTINGS > m_stagedSettings
The constraint, mask and rule pages edit one value from several pages, so they share this copy,...
Definition
dialog_board_setup.h:103
DIALOG_BOARD_SETUP::onAuxiliaryAction
void onAuxiliaryAction(wxCommandEvent &aEvent) override
Definition
dialog_board_setup.cpp:602
DIALOG_BOARD_SETUP::m_tuningPatternsPage
size_t m_tuningPatternsPage
Definition
dialog_board_setup.h:91
DIALOG_BOARD_SETUP::m_netclassesPage
size_t m_netclassesPage
Definition
dialog_board_setup.h:92
DIALOG_BOARD_SETUP::m_physicalStackup
PANEL_SETUP_BOARD_STACKUP * m_physicalStackup
Definition
dialog_board_setup.h:71
DIALOG_BOARD_SETUP::m_formattingPage
size_t m_formattingPage
Definition
dialog_board_setup.h:84
DIALOG_BOARD_SETUP::m_zones
PANEL_SETUP_ZONES * m_zones
Definition
dialog_board_setup.h:72
DIALOG_BOARD_SETUP::refreshStagedPages
void refreshStagedPages(const wxString &aGroup)
Reads the staged settings back into the open pages of one Import Settings group.
Definition
dialog_board_setup.cpp:561
DIALOG_BOARD_SETUP::~DIALOG_BOARD_SETUP
~DIALOG_BOARD_SETUP()
Definition
dialog_board_setup.cpp:351
DIALOG_BOARD_SETUP::m_boardFinish
PANEL_SETUP_BOARD_FINISH * m_boardFinish
Definition
dialog_board_setup.h:70
DIALOG_BOARD_SETUP::m_defaultsPage
size_t m_defaultsPage
Definition
dialog_board_setup.h:83
DIALOG_BOARD_SETUP::m_layers
PANEL_SETUP_LAYERS * m_layers
Definition
dialog_board_setup.h:69
DIALOG_BOARD_SETUP::m_initComplete
bool m_initComplete
Definition
dialog_board_setup.h:97
DIALOG_BOARD_SETUP::m_tuningProfilesPage
size_t m_tuningProfilesPage
Definition
dialog_board_setup.h:96
DIALOG_BOARD_SETUP::TransferDataFromWindow
bool TransferDataFromWindow() override
Definition
dialog_board_setup.cpp:404
DIALOG_BOARD_SETUP::m_teardropsPage
size_t m_teardropsPage
Definition
dialog_board_setup.h:90
DIALOG_BOARD_SETUP::m_customRulesPage
size_t m_customRulesPage
Definition
dialog_board_setup.h:86
DIALOG_BOARD_SETUP::m_componentClassesPage
size_t m_componentClassesPage
Definition
dialog_board_setup.h:93
DIALOG_BOARD_SETUP::m_zonesPage
size_t m_zonesPage
Definition
dialog_board_setup.h:89
DIALOG_BOARD_SETUP::onPageChanged
void onPageChanged(wxBookCtrlEvent &aEvent) override
Definition
dialog_board_setup.cpp:473
DIALOG_BOARD_SETUP::m_netClasses
PANEL_SETUP_NETCLASSES * m_netClasses
Definition
dialog_board_setup.h:74
DIALOG_BOARD_SETUP::m_severitiesPage
size_t m_severitiesPage
Definition
dialog_board_setup.h:94
DIALOG_BOARD_SETUP::onCloseWindow
void onCloseWindow(wxCloseEvent &aEvent)
Definition
dialog_board_setup.cpp:392
DIALOG_BOARD_SETUP::refreshRulePage
void refreshRulePage(size_t aPage)
Definition
dialog_board_setup.cpp:587
DRC_RULE_DOCUMENT
The custom rules of one board, held in memory while Board Setup is open.
Definition
drc_rule_document.h:42
PAGED_DIALOG::PAGED_DIALOG
PAGED_DIALOG(wxWindow *aParent, const wxString &aTitle, bool aShowReset, bool aShowOpenFolder, const wxString &aAuxiliaryAction=wxEmptyString, const wxSize &aInitialSize=wxDefaultSize)
Definition
paged_dialog.cpp:49
PANEL_SETUP_BOARD_FINISH
Definition
panel_board_finish.h:34
PANEL_SETUP_BOARD_STACKUP
Definition
panel_board_stackup.h:93
PANEL_SETUP_CONSTRAINTS
Definition
panel_setup_constraints.h:41
PANEL_SETUP_CONSTRAINT_RULES
Definition
panel_setup_constraint_rules.h:104
PANEL_SETUP_DEFAULTS
Definition
panel_setup_defaults.h:34
PANEL_SETUP_LAYERS
Definition
panel_setup_layers.h:54
PANEL_SETUP_MASK_AND_PASTE
Definition
panel_setup_mask_and_paste.h:34
PANEL_SETUP_NETCLASSES
Definition
panel_setup_netclasses.h:36
PANEL_SETUP_RULES
Definition
panel_setup_rules.h:37
PANEL_SETUP_SEVERITIES
Definition
panel_setup_severities.h:34
PANEL_SETUP_TRACKS_AND_VIAS
Definition
panel_setup_tracks_and_vias.h:36
PANEL_SETUP_TUNING_PROFILES
Definition
panel_setup_tuning_profiles.h:33
PANEL_SETUP_ZONES
Definition
panel_setup_zones.h:34
PANEL_TEXT_VARIABLES
Definition
panel_text_variables.h:32
PCB_EDIT_FRAME
The main frame for Pcbnew.
Definition
pcb_edit_frame.h:86
paged_dialog.h
panel_setup_formatting.h
src
pcbnew
dialogs
dialog_board_setup.h
Generated on Tue Nov 17 2026 00:06:19 for KiCad PCB EDA Suite by
1.13.2