KiCad PCB EDA Suite
DIALOG_PRINT_PCBNEW Class Reference
Inheritance diagram for DIALOG_PRINT_PCBNEW:
DIALOG_PRINT_GENERIC DIALOG_PRINT_GENERIC_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_PRINT_PCBNEW (PCB_BASE_EDIT_FRAME *aParent, PCBNEW_PRINTOUT_SETTINGS *aSettings)
 
 ~DIALOG_PRINT_PCBNEW ()
 
void ForcePrintBorder (bool aValue)
 Set 'print border and title block' to a requested value and hides the corresponding checkbox. More...
 
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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Protected Types

enum  { wxID_FRAME_SEL = 1000, wxID_PRINT_OPTIONS }
 

Protected Member Functions

wxSizer * getMainSizer ()
 
wxGridBagSizer * getOptionsSizer ()
 
wxStaticBox * getOptionsBox ()
 
double getScaleValue ()
 Return scale value selected in the dialog. More...
 
void setScaleValue (double aValue)
 Select a corresponding scale radio button and update custom scale value if needed. More...
 
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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

APP_SETTINGS_BASEm_config
 
PRINTOUT_SETTINGSm_settings
 
wxBoxSizer * bUpperSizer
 
wxStaticBoxSizer * sbOptionsSizer
 
wxGridBagSizer * gbOptionsSizer
 
wxStaticText * m_outputModeLabel
 
wxChoice * m_outputMode
 
wxCheckBox * m_titleBlock
 
wxRadioButton * m_scale1
 
wxRadioButton * m_scaleFit
 
wxRadioButton * m_scaleCustom
 
wxTextCtrl * m_scaleCustomText
 
wxStaticLine * m_staticline1
 
wxButton * m_buttonOption
 
wxStdDialogButtonSizer * m_sdbSizer1
 
wxButton * m_sdbSizer1OK
 
wxButton * m_sdbSizer1Apply
 
wxButton * m_sdbSizer1Cancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
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
 

Private Member Functions

PCBNEW_PRINTOUT_SETTINGSsettings () const
 
bool TransferDataToWindow () override
 
void createExtraOptions ()
 
void createLeftPanel ()
 
void onSelectAllClick (wxCommandEvent &event)
 
void onDeselectAllClick (wxCommandEvent &event)
 
void onUseThemeChecked (wxCommandEvent &event)
 
void onColorModeChanged (wxCommandEvent &event)
 
void setListBoxValue (wxCheckListBox *aList, bool aValue)
 

(Un)checks all items in a checklist box

More...
 
bool isLayerEnabled (unsigned int aLayer) const
 

Check whether a layer is enabled in a listbox

More...
 
void enableLayer (unsigned int aLayer, bool aValue)
 

Enable/disable layer in a listbox

More...
 
int setLayerSetFromList ()
 

Update layerset basing on the selected layers

More...
 
void saveSettings () override
 
wxPrintout * createPrintout (const wxString &aTitle) override
 Create a printout with a requested title. More...
 

Private Attributes

PCB_BASE_EDIT_FRAMEm_parent
 
std::pair< wxCheckListBox *, int > m_layers [PCB_LAYER_ID_COUNT]
 
wxCheckListBox * m_listTechLayers
 
wxCheckListBox * m_listCopperLayers
 
wxButton * m_buttonSelectAll
 
wxButton * m_buttonDeselectAll
 
wxCheckBox * m_checkboxNoEdge
 
wxCheckBox * m_checkboxMirror
 
wxChoice * m_drillMarksChoice
 
wxRadioBox * m_boxPagination
 
wxCheckBox * m_checkBackground
 
wxCheckBox * m_checkUseTheme
 
wxStaticText * m_lblTheme
 
wxChoice * m_colorTheme
 

Detailed Description

Definition at line 41 of file dialog_print_pcbnew.cpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
wxID_FRAME_SEL 
wxID_PRINT_OPTIONS 

Definition at line 44 of file dialog_print_generic_base.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_PRINT_PCBNEW()

DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW ( PCB_BASE_EDIT_FRAME aParent,
PCBNEW_PRINTOUT_SETTINGS aSettings 
)

Definition at line 106 of file dialog_print_pcbnew.cpp.

106  :
107  DIALOG_PRINT_GENERIC( aParent, aSettings ), m_parent( aParent )
108 {
110  memset( m_layers, 0, sizeof( m_layers ) );
111 
113  createLeftPanel();
114 
115  m_outputMode->Bind(
116  wxEVT_COMMAND_CHOICE_SELECTED, &DIALOG_PRINT_PCBNEW::onColorModeChanged, this );
117 }
std::pair< wxCheckListBox *, int > m_layers[PCB_LAYER_ID_COUNT]
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
void onColorModeChanged(wxCommandEvent &event)
PCB_BASE_EDIT_FRAME * m_parent
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
DIALOG_PRINT_GENERIC(EDA_DRAW_FRAME *aParent, PRINTOUT_SETTINGS *aSettings)
APP_SETTINGS_BASE * m_config

References createExtraOptions(), createLeftPanel(), Kiface(), KIFACE_I::KifaceSettings(), DIALOG_PRINT_GENERIC::m_config, m_layers, DIALOG_PRINT_GENERIC_BASE::m_outputMode, and onColorModeChanged().

◆ ~DIALOG_PRINT_PCBNEW()

DIALOG_PRINT_PCBNEW::~DIALOG_PRINT_PCBNEW ( )
inline

Definition at line 45 of file dialog_print_pcbnew.cpp.

45 {}

Member Function Documentation

◆ createExtraOptions()

void DIALOG_PRINT_PCBNEW::createExtraOptions ( )
private

Definition at line 193 of file dialog_print_pcbnew.cpp.

194 {
195  wxGridBagSizer* optionsSizer = getOptionsSizer();
196  wxStaticBox* box = getOptionsBox();
197  int rows = optionsSizer->GetEffectiveRowsCount();
198  int cols = optionsSizer->GetEffectiveColsCount();
199 
200  m_checkBackground = new wxCheckBox( sbOptionsSizer->GetStaticBox(), wxID_ANY,
201  _( "Print background color" ), wxDefaultPosition, wxDefaultSize, 0 );
202  optionsSizer->Add( m_checkBackground, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ), wxALL, 5 );
203 
204  m_checkUseTheme = new wxCheckBox( sbOptionsSizer->GetStaticBox(), wxID_ANY,
205  _( "Use a different color theme for printing" ), wxDefaultPosition, wxDefaultSize, 0 );
206  optionsSizer->Add( m_checkUseTheme, wxGBPosition( rows++, 0 ), wxGBSpan( 1, 3 ), wxALL, 5 );
207 
208  m_checkUseTheme->Bind(
209  wxEVT_COMMAND_CHECKBOX_CLICKED, &DIALOG_PRINT_PCBNEW::onUseThemeChecked, this );
210 
211  m_lblTheme = new wxStaticText( sbOptionsSizer->GetStaticBox(), wxID_ANY, _( "Color theme:" ),
212  wxDefaultPosition, wxDefaultSize, 0 );
213  m_lblTheme->Wrap( -1 );
214  optionsSizer->Add( m_lblTheme, wxGBPosition( rows, 0 ), wxGBSpan( 1, 1 ),
215  wxALIGN_CENTER_VERTICAL | wxALL, 5 );
216 
217  wxArrayString m_colorThemeChoices;
218  m_colorTheme = new wxChoice( sbOptionsSizer->GetStaticBox(), wxID_ANY, wxDefaultPosition,
219  wxDefaultSize, m_colorThemeChoices, 0 );
220  m_colorTheme->SetSelection( 0 );
221  optionsSizer->Add( m_colorTheme, wxGBPosition( rows++, 1 ), wxGBSpan( 1, 2 ), wxALL, 5 );
222 
223  // Drill marks option
224  auto drillMarksLabel = new wxStaticText( box, wxID_ANY, _( "Drill marks:" ) );
225  std::vector<wxString> drillMarkChoices =
226  { _( "No drill mark" ), _( "Small mark" ), _( "Real drill" ) };
227  m_drillMarksChoice = new wxChoice( box, wxID_ANY, wxDefaultPosition,
228  wxDefaultSize, drillMarkChoices.size(), drillMarkChoices.data(), 0 );
229  m_drillMarksChoice->SetSelection( 0 );
230 
231  // Print mirrored
232  m_checkboxMirror = new wxCheckBox( box, wxID_ANY, _( "Print mirrored" ) );
233 
234  // Pagination
235  std::vector<wxString> pagesOption = { _( "One page per layer" ), _( "All layers on single page" ) };
236  m_boxPagination = new wxRadioBox( box, wxID_ANY, _( "Pagination" ), wxDefaultPosition,
237  wxDefaultSize, pagesOption.size(), pagesOption.data(), 1, wxRA_SPECIFY_COLS );
238  m_boxPagination->SetSelection( 0 );
239 
240  // Sizer layout
241  optionsSizer->Add( drillMarksLabel, wxGBPosition( rows, 0 ), wxGBSpan( 1, 1 ),
242  wxBOTTOM | wxRIGHT | wxLEFT | wxALIGN_CENTER_VERTICAL, 5 );
243  optionsSizer->Add( m_drillMarksChoice, wxGBPosition( rows, 1 ), wxGBSpan( 1, cols - 1 ),
244  wxBOTTOM | wxRIGHT | wxLEFT, 5 );
245  optionsSizer->Add( m_checkboxMirror, wxGBPosition( rows + 1, 0 ), wxGBSpan( 1, cols ),
246  wxBOTTOM | wxRIGHT | wxLEFT, 5 );
247  optionsSizer->Add( m_boxPagination, wxGBPosition( rows + 2, 0 ), wxGBSpan( 1, cols ),
248  wxALL | wxEXPAND, 5 );
249 }
wxStaticBox * getOptionsBox()
#define _(s)
Definition: 3d_actions.cpp:33
wxGridBagSizer * getOptionsSizer()
void onUseThemeChecked(wxCommandEvent &event)

References _, DIALOG_PRINT_GENERIC::getOptionsBox(), DIALOG_PRINT_GENERIC::getOptionsSizer(), m_boxPagination, m_checkBackground, m_checkboxMirror, m_checkUseTheme, m_colorTheme, m_drillMarksChoice, m_lblTheme, onUseThemeChecked(), and DIALOG_PRINT_GENERIC_BASE::sbOptionsSizer.

Referenced by DIALOG_PRINT_PCBNEW().

◆ createLeftPanel()

void DIALOG_PRINT_PCBNEW::createLeftPanel ( )
private

Definition at line 252 of file dialog_print_pcbnew.cpp.

253 {
254  wxStaticBoxSizer* sbLayersSizer = new wxStaticBoxSizer( new wxStaticBox( this,
255  wxID_ANY, _( "Included Layers" ) ), wxVERTICAL );
256 
257  // Copper layer list
258  auto copperLabel = new wxStaticText( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Copper layers:" ) );
259  m_listCopperLayers = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
260 
261  wxBoxSizer* sizerLeft = new wxBoxSizer( wxVERTICAL );
262  sizerLeft->Add( copperLabel, 0, wxRIGHT | wxLEFT, 5 );
263  sizerLeft->Add( m_listCopperLayers, 1, wxEXPAND | wxBOTTOM | wxRIGHT | wxLEFT, 5 );
264 
265 
266  // Technical layer list
267  auto technicalLabel = new wxStaticText( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Technical layers:" ) );
268  m_listTechLayers = new wxCheckListBox( sbLayersSizer->GetStaticBox(), wxID_ANY );
269 
270  wxBoxSizer* sizerRight = new wxBoxSizer( wxVERTICAL );
271  sizerRight->Add( technicalLabel, 0, wxRIGHT | wxLEFT, 5 );
272  sizerRight->Add( m_listTechLayers, 1, wxEXPAND | wxBOTTOM | wxRIGHT | wxLEFT, 5 );
273 
274 
275  // Layer list layout
276  wxBoxSizer* bLayerListsSizer = new wxBoxSizer( wxHORIZONTAL );
277  bLayerListsSizer->Add( sizerLeft, 1, wxEXPAND, 5 );
278  bLayerListsSizer->Add( sizerRight, 1, wxEXPAND, 5 );
279 
280 
281  // Select/Unselect all buttons
282  m_buttonSelectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Select all" ) );
283  m_buttonDeselectAll = new wxButton( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Deselect all" ) );
284 
285  m_buttonSelectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
286  wxCommandEventHandler( DIALOG_PRINT_PCBNEW::onSelectAllClick ), NULL, this );
287  m_buttonDeselectAll->Connect( wxEVT_COMMAND_BUTTON_CLICKED,
288  wxCommandEventHandler( DIALOG_PRINT_PCBNEW::onDeselectAllClick ), NULL, this );
289 
290  wxBoxSizer* buttonSizer = new wxBoxSizer( wxHORIZONTAL );
291  buttonSizer->Add( m_buttonSelectAll, 1, wxALL, 5 );
292  buttonSizer->Add( m_buttonDeselectAll, 1, wxALL, 5 );
293 
294 
295  // Exclude Edge.Pcb layer checkbox
296  m_checkboxNoEdge = new wxCheckBox( sbLayersSizer->GetStaticBox(), wxID_ANY, _( "Exclude PCB edge layer" ) );
297  m_checkboxNoEdge->SetToolTip( _("Exclude contents of Edges_Pcb layer from all other layers") );
298 
299  // Static box sizer layout
300  sbLayersSizer->Add( bLayerListsSizer, 1, wxALL | wxEXPAND, 5 );
301  sbLayersSizer->Add( buttonSizer, 0, wxALL | wxEXPAND, 5 );
302  sbLayersSizer->Add( m_checkboxNoEdge, 0, wxALL | wxEXPAND, 5 );
303 
304  getMainSizer()->Insert( 0, sbLayersSizer, 1, wxEXPAND );
305 }
void onDeselectAllClick(wxCommandEvent &event)
wxCheckListBox * m_listCopperLayers
void onSelectAllClick(wxCommandEvent &event)
#define NULL
wxCheckListBox * m_listTechLayers
#define _(s)
Definition: 3d_actions.cpp:33

References _, DIALOG_PRINT_GENERIC::getMainSizer(), m_buttonDeselectAll, m_buttonSelectAll, m_checkboxNoEdge, m_listCopperLayers, m_listTechLayers, NULL, onDeselectAllClick(), and onSelectAllClick().

Referenced by DIALOG_PRINT_PCBNEW().

◆ createPrintout()

wxPrintout* DIALOG_PRINT_PCBNEW::createPrintout ( const wxString &  aTitle)
inlineoverrideprivatevirtual

Create a printout with a requested title.

Implements DIALOG_PRINT_GENERIC.

Definition at line 79 of file dialog_print_pcbnew.cpp.

80  {
81  return new PCBNEW_PRINTOUT( m_parent->GetBoard(), *settings(),
82  m_parent->GetCanvas()->GetView(), aTitle );
83  }
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PCB_BASE_EDIT_FRAME * m_parent
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
PCBNEW_PRINTOUT_SETTINGS * settings() const
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), m_parent, and settings().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 264 of file dialog_shim.cpp.

265 {
266  // so we can do logging of this state change:
267 
268 #if 0 && defined(DEBUG)
269  const char* type_id = typeid( *this ).name();
270  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
271  fflush(0); //Needed on msys2 to immediately print the message
272 #endif
273 
274  return wxDialog::Enable( enable );
275 }

◆ enableLayer()

void DIALOG_PRINT_PCBNEW::enableLayer ( unsigned int  aLayer,
bool  aValue 
)
private

Enable/disable layer in a listbox

Definition at line 361 of file dialog_print_pcbnew.cpp.

362 {
363  wxCHECK( aLayer < arrayDim( m_layers ), /* void */ );
364  const auto& layerInfo = m_layers[aLayer];
365  layerInfo.first->Check( layerInfo.second, aValue );
366 }
std::pair< wxCheckListBox *, int > m_layers[PCB_LAYER_ID_COUNT]
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160

References arrayDim(), and m_layers.

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 421 of file dialog_shim.cpp.

422 {
423  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
424  // handle validation in the same way as other dialogs.
425  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
426  return;
427 
428  SetReturnCode( retCode );
429 
430  if( !IsQuasiModal() )
431  {
432  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
433  "wasn't called" );
434  return;
435  }
436 
437  if( m_qmodal_loop )
438  {
439  if( m_qmodal_loop->IsRunning() )
440  m_qmodal_loop->Exit( 0 );
441  else
442  m_qmodal_loop->ScheduleExit( 0 );
443 
445  }
446 
449 
450  Show( false );
451 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:124
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ 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, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 139 of file dialog_shim.cpp.

140 {
141  // must be called from the constructor of derived classes,
142  // when all widgets are initialized, and therefore their size fixed
143 
144  // SetSizeHints fixes the minimal size of sizers in the dialog
145  // (SetSizeHints calls Fit(), so no need to call it)
146  GetSizer()->SetSizeHints( this );
147 
148  // the default position, when calling the first time the dlg
149  Center();
150 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), 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_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), 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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), 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_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_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ ForcePrintBorder()

void DIALOG_PRINT_GENERIC::ForcePrintBorder ( bool  aValue)
inherited

Set 'print border and title block' to a requested value and hides the corresponding checkbox.

Definition at line 64 of file dialog_print_generic.cpp.

65 {
66  m_titleBlock->SetValue( aValue );
67  m_titleBlock->Hide();
68 
69  if( m_config )
70  {
72  m_settings->m_titleBlock = aValue;
74  }
75 }
virtual void Save(APP_SETTINGS_BASE *aConfig)
Definition: printout.cpp:24
virtual void Load(APP_SETTINGS_BASE *aConfig)
Definition: printout.cpp:32
bool m_titleBlock
Print frame and title block.
Definition: printout.h:52
PRINTOUT_SETTINGS * m_settings
APP_SETTINGS_BASE * m_config

References PRINTOUT_SETTINGS::Load(), DIALOG_PRINT_GENERIC::m_config, DIALOG_PRINT_GENERIC::m_settings, PRINTOUT_SETTINGS::m_titleBlock, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, and PRINTOUT_SETTINGS::Save().

◆ getMainSizer()

wxSizer* DIALOG_PRINT_GENERIC::getMainSizer ( )
inlineprotectedinherited

◆ getOptionsBox()

wxStaticBox* DIALOG_PRINT_GENERIC::getOptionsBox ( )
inlineprotectedinherited

Definition at line 59 of file dialog_print_generic.h.

60  {
61  return sbOptionsSizer->GetStaticBox();
62  }

References DIALOG_PRINT_GENERIC_BASE::sbOptionsSizer.

Referenced by createExtraOptions(), and DIALOG_PRINT_GERBVIEW::createExtraOptions().

◆ getOptionsSizer()

wxGridBagSizer* DIALOG_PRINT_GENERIC::getOptionsSizer ( )
inlineprotectedinherited

◆ getScaleValue()

double DIALOG_PRINT_GENERIC::getScaleValue ( )
protectedinherited

Return scale value selected in the dialog.

if this value is outside limits, it will be clamped

Definition at line 89 of file dialog_print_generic.cpp.

90 {
91  if( m_scale1->GetValue() )
92  return 1.0;
93 
94  if( m_scaleFit->GetValue() )
95  return 0.0;
96 
97  if( m_scaleCustom->GetValue() )
98  {
99  double scale = 1.0;;
100 
101  if( !m_scaleCustomText->GetValue().ToDouble( &scale ) )
102  {
103  DisplayInfoMessage( nullptr, _( "Warning: Bad scale number" ) );
104  scale = 1.0;
105  }
106 
107  if( scale > MAX_SCALE )
108  {
109  scale = MAX_SCALE;
110  setScaleValue( scale );
111  DisplayInfoMessage( nullptr,
112  wxString::Format( _( "Warning: Scale option set to a very large value.\n"
113  " Clamped to %f" ), scale ) );
114  }
115  else if( scale < MIN_SCALE )
116  {
117  scale = MIN_SCALE;
118  setScaleValue( scale );
119  DisplayInfoMessage( nullptr,
120  wxString::Format( _( "Warning: Scale option set to a very small value.\n"
121  " Clamped to %f" ), scale ) );
122  }
123  return scale;
124  }
125 
126  wxCHECK( false, 1.0 );
127 }
static constexpr double MIN_SCALE
void setScaleValue(double aValue)
Select a corresponding scale radio button and update custom scale value if needed.
static constexpr double MAX_SCALE
const int scale
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267

References _, DisplayInfoMessage(), Format(), DIALOG_PRINT_GENERIC_BASE::m_scale1, DIALOG_PRINT_GENERIC_BASE::m_scaleCustom, DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, DIALOG_PRINT_GENERIC_BASE::m_scaleFit, MAX_SCALE, MIN_SCALE, scale, and DIALOG_PRINT_GENERIC::setScaleValue().

Referenced by DIALOG_PRINT_GENERIC::saveSettings().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 160 of file dialog_shim.cpp.

161 {
162  wxSize sz( x, 0 );
163  return ConvertDialogToPixels( sz ).x;
164 }

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

◆ IsCtrl()

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

Definition at line 137 of file dialog_shim.h.

138  {
139  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
140  !e.ShiftDown() && !e.MetaDown();
141  }

Referenced by DIALOG_LABEL_EDITOR::OnCharHook(), and DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ isLayerEnabled()

bool DIALOG_PRINT_PCBNEW::isLayerEnabled ( unsigned int  aLayer) const
private

Check whether a layer is enabled in a listbox

Definition at line 349 of file dialog_print_pcbnew.cpp.

350 {
351  wxCHECK( aLayer < arrayDim( m_layers ), false );
352  const auto& layerInfo = m_layers[aLayer];
353 
354  if( layerInfo.first )
355  return layerInfo.first->IsChecked( layerInfo.second );
356 
357  return false;
358 }
std::pair< wxCheckListBox *, int > m_layers[PCB_LAYER_ID_COUNT]
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160

References arrayDim(), and m_layers.

Referenced by setLayerSetFromList().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 143 of file dialog_shim.h.

144  {
145  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
146  e.ShiftDown() && !e.MetaDown();
147  }

Referenced by DIALOG_LABEL_EDITOR::OnCharHook(), and DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns 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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ onColorModeChanged()

void DIALOG_PRINT_PCBNEW::onColorModeChanged ( wxCommandEvent &  event)
private

Definition at line 329 of file dialog_print_pcbnew.cpp.

330 {
332 
333  m_settings->m_blackWhite = m_outputMode->GetSelection();
334 
339 }
bool use_theme
If false, display color theme will be used.
Definition: app_settings.h:102
PCBNEW_SETTINGS * GetPcbNewSettings()
PCB_BASE_EDIT_FRAME * m_parent
PRINTOUT_SETTINGS * m_settings
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:53

References PCB_BASE_FRAME::GetPcbNewSettings(), PRINTOUT_SETTINGS::m_blackWhite, m_checkBackground, m_checkUseTheme, m_colorTheme, m_lblTheme, DIALOG_PRINT_GENERIC_BASE::m_outputMode, m_parent, APP_SETTINGS_BASE::m_Printing, DIALOG_PRINT_GENERIC::m_settings, and APP_SETTINGS_BASE::PRINTING::use_theme.

Referenced by DIALOG_PRINT_PCBNEW(), and TransferDataToWindow().

◆ onDeselectAllClick()

void DIALOG_PRINT_PCBNEW::onDeselectAllClick ( wxCommandEvent &  event)
private

Definition at line 315 of file dialog_print_pcbnew.cpp.

316 {
319 }
wxCheckListBox * m_listCopperLayers
wxCheckListBox * m_listTechLayers
void setListBoxValue(wxCheckListBox *aList, bool aValue)
(Un)checks all items in a checklist box

References m_listCopperLayers, m_listTechLayers, and setListBoxValue().

Referenced by createLeftPanel().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 322 of file dialog_shim.cpp.

323 {
324  if( m_firstPaintEvent )
325  {
326 #ifdef __WXMAC__
327  fixOSXCancelButtonIssue( this );
328 #endif
329 
330  selectAllInTextCtrls( GetChildren() );
331 
333  m_initialFocusTarget->SetFocus();
334  else
335  SetFocus(); // Focus the dialog itself
336 
337  m_firstPaintEvent = false;
338  }
339 
340  event.Skip();
341 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203
bool m_firstPaintEvent
Definition: dialog_shim.h:202
static void selectAllInTextCtrls(wxWindowList &children)

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onSelectAllClick()

void DIALOG_PRINT_PCBNEW::onSelectAllClick ( wxCommandEvent &  event)
private

Definition at line 308 of file dialog_print_pcbnew.cpp.

309 {
312 }
wxCheckListBox * m_listCopperLayers
wxCheckListBox * m_listTechLayers
void setListBoxValue(wxCheckListBox *aList, bool aValue)
(Un)checks all items in a checklist box

References m_listCopperLayers, m_listTechLayers, and setListBoxValue().

Referenced by createLeftPanel().

◆ onUseThemeChecked()

void DIALOG_PRINT_PCBNEW::onUseThemeChecked ( wxCommandEvent &  event)
private

Definition at line 322 of file dialog_print_pcbnew.cpp.

323 {
324  m_lblTheme->Enable( m_checkUseTheme->GetValue() );
325  m_colorTheme->Enable( m_checkUseTheme->GetValue() );
326 }

References m_checkUseTheme, m_colorTheme, and m_lblTheme.

Referenced by createExtraOptions().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:171

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ 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 239 of file dialog_shim.cpp.

240 {
241  const char* hash_key;
242 
243  if( m_hash_key.size() )
244  {
245  // a special case like EDA_LIST_DIALOG, which has multiple uses.
246  hash_key = m_hash_key.c_str();
247  }
248  else
249  {
250  hash_key = typeid(*this).name();
251  }
252 
253  RECT_MAP::iterator it = class_map.find( hash_key );
254 
255  if( it == class_map.end() )
256  return;
257 
258  EDA_RECT rect = it->second;
259  rect.SetSize( 0, 0 );
260  class_map[ hash_key ] = rect;
261 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ saveSettings()

void DIALOG_PRINT_PCBNEW::saveSettings ( )
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC.

Definition at line 395 of file dialog_print_pcbnew.cpp.

396 {
398 
401 
402  settings()->m_pagination = m_boxPagination->GetSelection() == 0
404 
405  settings()->m_mirror = m_checkboxMirror->GetValue();
406 
408 
409  cfg->m_Printing.background = m_checkBackground->GetValue();
411  cfg->m_Printing.use_theme = m_checkUseTheme->GetValue();
412 
413  COLOR_SETTINGS* theme = static_cast<COLOR_SETTINGS*>(
414  m_colorTheme->GetClientData( m_colorTheme->GetSelection() ) );
415 
416  if( theme && m_checkUseTheme->IsChecked() )
417  {
418  cfg->m_Printing.color_theme = theme->GetFilename();
419  settings()->m_colorSettings = theme;
420  }
421  else
422  {
423  // This should always work, but in case it doesn't we fall back on default colors
424  if( auto pcbframe = dynamic_cast<PCB_BASE_EDIT_FRAME*>( m_parent ) )
425  settings()->m_colorSettings = pcbframe->GetColorSettings();
426  else
428  }
429 
431 }
bool m_background
Print background color.
Definition: printout.h:55
int setLayerSetFromList()
Update layerset basing on the selected layers
wxString color_theme
Color theme to use for printing.
Definition: app_settings.h:103
bool use_theme
If false, display color theme will be used.
Definition: app_settings.h:102
PCBNEW_SETTINGS * GetPcbNewSettings()
COLOR_SETTINGS * m_colorSettings
The color settings to be used for printing.
Definition: printout.h:59
COLOR_SETTINGS * GetColorSettings() override
Helper to retrieve the current color settings.
bool m_mirror
Print mirrored.
PCB_BASE_EDIT_FRAME * m_parent
bool background
Whether or not to print background color.
Definition: app_settings.h:99
PCBNEW_PRINTOUT_SETTINGS * settings() const
enum PCBNEW_PRINTOUT_SETTINGS::PAGINATION_T m_pagination
Pagination.
Color settings are a bit different than most of the settings objects in that there can be more than o...
std::string GetFilename() const
Definition: json_settings.h:57
enum PCBNEW_PRINTOUT_SETTINGS::DRILL_MARK_SHAPE_T m_drillMarks
Drill marks shape.

References PCBNEW_PRINTOUT_SETTINGS::ALL_LAYERS, APP_SETTINGS_BASE::PRINTING::background, APP_SETTINGS_BASE::PRINTING::color_theme, PCB_BASE_EDIT_FRAME::GetColorSettings(), JSON_SETTINGS::GetFilename(), PCB_BASE_FRAME::GetPcbNewSettings(), PCBNEW_PRINTOUT_SETTINGS::LAYER_PER_PAGE, PRINTOUT_SETTINGS::m_background, m_boxPagination, m_checkBackground, m_checkboxMirror, m_checkUseTheme, PRINTOUT_SETTINGS::m_colorSettings, m_colorTheme, PCBNEW_PRINTOUT_SETTINGS::m_drillMarks, m_drillMarksChoice, BOARD_PRINTOUT_SETTINGS::m_mirror, PCBNEW_PRINTOUT_SETTINGS::m_pagination, m_parent, APP_SETTINGS_BASE::m_Printing, DIALOG_PRINT_GENERIC::saveSettings(), setLayerSetFromList(), settings(), and APP_SETTINGS_BASE::PRINTING::use_theme.

◆ 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 115 of file dialog_shim.h.

116  {
117  m_initialFocusTarget = aWindow;
118  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::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(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ setLayerSetFromList()

int DIALOG_PRINT_PCBNEW::setLayerSetFromList ( )
private

Update layerset basing on the selected layers

Definition at line 369 of file dialog_print_pcbnew.cpp.

370 {
371  settings()->m_layerSet = LSET();
372  int& pageCount = settings()->m_pageCount;
373  pageCount = 0;
374 
375  for( unsigned int layer = 0; layer < arrayDim( m_layers ); ++layer )
376  {
377  if( isLayerEnabled( layer ) )
378  {
379  ++pageCount;
380  settings()->m_layerSet.set( layer );
381  }
382  }
383 
384  // In Pcbnew force the EDGE layer to be printed or not with the other layers
385  settings()->m_noEdgeLayer = m_checkboxNoEdge->IsChecked();
386 
387  // All layers on one page (only if there is at least one layer selected)
388  if( m_boxPagination->GetSelection() != 0 && pageCount > 0 )
389  pageCount = 1;
390 
391  return pageCount;
392 }
bool m_noEdgeLayer
Disable board outline on each page.
std::pair< wxCheckListBox *, int > m_layers[PCB_LAYER_ID_COUNT]
bool isLayerEnabled(unsigned int aLayer) const
Check whether a layer is enabled in a listbox
LSET is a set of PCB_LAYER_IDs.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160
int m_pageCount
Number of pages to print.
Definition: printout.h:54
PCBNEW_PRINTOUT_SETTINGS * settings() const
LSET m_layerSet
Layers to print.

References arrayDim(), isLayerEnabled(), m_boxPagination, m_checkboxNoEdge, m_layers, BOARD_PRINTOUT_SETTINGS::m_layerSet, PCBNEW_PRINTOUT_SETTINGS::m_noEdgeLayer, PRINTOUT_SETTINGS::m_pageCount, and settings().

Referenced by saveSettings().

◆ setListBoxValue()

void DIALOG_PRINT_PCBNEW::setListBoxValue ( wxCheckListBox *  aList,
bool  aValue 
)
private

(Un)checks all items in a checklist box

Definition at line 342 of file dialog_print_pcbnew.cpp.

343 {
344  for( unsigned int i = 0; i < aList->GetCount(); ++i )
345  aList->Check( i, aValue );
346 }

Referenced by onDeselectAllClick(), and onSelectAllClick().

◆ setScaleValue()

void DIALOG_PRINT_GENERIC::setScaleValue ( double  aValue)
protectedinherited

Select a corresponding scale radio button and update custom scale value if needed.

Parameters
aValueis the scale value to be selected (0 stands for fit-to-page).

Definition at line 130 of file dialog_print_generic.cpp.

131 {
132  wxASSERT( aValue >= 0.0 );
133 
134  if( aValue == 0.0 ) // fit to page
135  {
136  m_scaleFit->SetValue( true );
137  }
138  else if( aValue == 1.0 )
139  {
140  m_scale1->SetValue( true );
141  }
142  else
143  {
144  // Silently clamp the value (it comes from the config file).
145  if( aValue > MAX_SCALE )
146  aValue = MAX_SCALE;
147  else if( aValue < MIN_SCALE )
148  aValue = MIN_SCALE;
149 
150  m_scaleCustom->SetValue( true );
151  m_scaleCustomText->SetValue( wxString::Format( wxT( "%f" ), aValue ) );
152  }
153 }
static constexpr double MIN_SCALE
static constexpr double MAX_SCALE
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References Format(), DIALOG_PRINT_GENERIC_BASE::m_scale1, DIALOG_PRINT_GENERIC_BASE::m_scaleCustom, DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, DIALOG_PRINT_GENERIC_BASE::m_scaleFit, MAX_SCALE, and MIN_SCALE.

Referenced by DIALOG_PRINT_GENERIC::getScaleValue(), and DIALOG_PRINT_GENERIC::TransferDataToWindow().

◆ 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 153 of file dialog_shim.cpp.

154 {
155  wxSize sz( x, y );
156  SetSize( ConvertDialogToPixels( sz ) );
157 }

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

◆ settings()

PCBNEW_PRINTOUT_SETTINGS* DIALOG_PRINT_PCBNEW::settings ( ) const
inlineprivate

Definition at line 48 of file dialog_print_pcbnew.cpp.

49  {
50  wxASSERT( dynamic_cast<PCBNEW_PRINTOUT_SETTINGS*>( m_settings ) );
51  return static_cast<PCBNEW_PRINTOUT_SETTINGS*>( m_settings );
52  }
PRINTOUT_SETTINGS * m_settings

References DIALOG_PRINT_GENERIC::m_settings.

Referenced by createPrintout(), saveSettings(), setLayerSetFromList(), and TransferDataToWindow().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 180 of file dialog_shim.cpp.

181 {
182  bool ret;
183  const char* hash_key;
184 
185  if( m_hash_key.size() )
186  {
187  // a special case like EDA_LIST_DIALOG, which has multiple uses.
188  hash_key = m_hash_key.c_str();
189  }
190  else
191  {
192  hash_key = typeid(*this).name();
193  }
194 
195  // Show or hide the window. If hiding, save current position and size.
196  // If showing, use previous position and size.
197  if( show )
198  {
199 #ifndef __WINDOWS__
200  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
201 #endif
202  ret = wxDialog::Show( show );
203 
204  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
205  EDA_RECT savedDialogRect = class_map[ hash_key ];
206 
207  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
208  {
209  SetSize( savedDialogRect.GetPosition().x,
210  savedDialogRect.GetPosition().y,
211  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
212  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
213  0 );
214  }
215 
216  // Be sure that the dialog appears in a visible area
217  // (the dialog position might have been stored at the time when it was
218  // shown on another display)
219  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
220  Centre();
221  }
222  else
223  {
224  // Save the dialog's position & size before hiding, using classname as key
225  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
226 
227 #ifdef __WXMAC__
228  if ( m_eventLoop )
229  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
230 #endif
231 
232  ret = wxDialog::Show( show );
233  }
234 
235  return ret;
236 }
std::string m_hash_key
Definition: dialog_shim.h:197
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:115
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:103

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 367 of file dialog_shim.cpp.

368 {
369  // This is an exception safe way to zero a pointer before returning.
370  // Yes, even though DismissModal() clears this first normally, this is
371  // here in case there's an exception before the dialog is dismissed.
372  struct NULLER
373  {
374  void*& m_what;
375  NULLER( void*& aPtr ) : m_what( aPtr ) {}
376  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
377  } clear_this( (void*&) m_qmodal_loop );
378 
379  // release the mouse if it's currently captured as the window having it
380  // will be disabled when this dialog is shown -- but will still keep the
381  // capture making it impossible to do anything in the modal dialog itself
382  wxWindow* win = wxWindow::GetCapture();
383  if( win )
384  win->ReleaseMouse();
385 
386  // Get the optimal parent
387  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
388 
389  // Show the optimal parent
390  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
391 
392  wxASSERT_MSG( !m_qmodal_parent_disabler,
393  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
394 
395  // quasi-modal: disable only my "optimal" parent
397 
398 #ifdef __WXMAC__
399  // Apple in its infinite wisdom will raise a disabled window before even passing
400  // us the event, so we have no way to stop it. Instead, we must set an order on
401  // the windows so that the quasi-modal will be pushed in front of the disabled
402  // window when it is raised.
403  ReparentQuasiModal();
404 #endif
405  Show( true );
406 
407  m_qmodal_showing = true;
408 
409  WX_EVENT_LOOP event_loop;
410 
411  m_qmodal_loop = &event_loop;
412 
413  event_loop.Run();
414 
415  m_qmodal_showing = false;
416 
417  return GetReturnCode();
418 }
bool m_qmodal_showing
Definition: dialog_shim.h:207
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ TransferDataToWindow()

bool DIALOG_PRINT_PCBNEW::TransferDataToWindow ( )
overrideprivate

Definition at line 120 of file dialog_print_pcbnew.cpp.

121 {
123  return false;
124 
125  BOARD* board = m_parent->GetBoard();
126 
127  // Create layer list
128  for( LSEQ seq = board->GetEnabledLayers().UIOrder(); seq; ++seq )
129  {
130  PCB_LAYER_ID layer = *seq;
131  int checkIndex;
132 
133  if( IsCopperLayer( layer ) )
134  {
135  checkIndex = m_listCopperLayers->Append( board->GetLayerName( layer ) );
136  m_layers[layer] = std::make_pair( m_listCopperLayers, checkIndex );
137  }
138  else
139  {
140  checkIndex = m_listTechLayers->Append( board->GetLayerName( layer ) );
141  m_layers[layer] = std::make_pair( m_listTechLayers, checkIndex );
142  }
143 
144  m_layers[layer].first->Check( checkIndex, settings()->m_layerSet.test( layer ) );
145  }
146 
147  m_checkboxMirror->SetValue( settings()->m_mirror );
148  m_checkboxNoEdge->SetValue( settings()->m_noEdgeLayer );
149  m_titleBlock->SetValue( settings()->m_titleBlock );
150 
152 
153  m_checkBackground->SetValue( cfg->m_Printing.background );
154  m_checkUseTheme->SetValue( cfg->m_Printing.use_theme );
155 
156  m_colorTheme->Clear();
157 
158  int width = 0;
159  int height = 0;
160  int minwidth = width;
161 
162  wxString target = cfg->m_Printing.use_theme ? cfg->m_Printing.color_theme : cfg->m_ColorTheme;
163 
164  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
165  {
166  int pos = m_colorTheme->Append( settings->GetName(), static_cast<void*>( settings ) );
167 
168  if( settings->GetFilename() == target )
169  m_colorTheme->SetSelection( pos );
170 
171  m_colorTheme->GetTextExtent( settings->GetName(), &width, &height );
172  minwidth = std::max( minwidth, width );
173  }
174 
175  m_colorTheme->SetMinSize( wxSize( minwidth + 50, -1 ) );
176 
177  wxCommandEvent dummy;
179 
180  // Options to plot pads and vias holes
181  m_drillMarksChoice->SetSelection( settings()->m_drillMarks );
182 
183  // Print all layers one one page or separately
184  m_boxPagination->SetSelection( settings()->m_pagination );
185 
186  // Update the dialog layout when layers are added
187  GetSizer()->Fit( this );
188 
189  return true;
190 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer.
std::pair< wxCheckListBox *, int > m_layers[PCB_LAYER_ID_COUNT]
wxString color_theme
Color theme to use for printing.
Definition: app_settings.h:103
wxCheckListBox * m_listCopperLayers
LSET GetEnabledLayers() const
Function GetEnabledLayers is a proxy function that calls the corresponding function in m_BoardSetting...
bool use_theme
If false, display color theme will be used.
Definition: app_settings.h:102
PCBNEW_SETTINGS * GetPcbNewSettings()
PCB_LAYER_ID
A quick note on layer IDs:
void onColorModeChanged(wxCommandEvent &event)
PCB_BASE_EDIT_FRAME * m_parent
wxCheckListBox * m_listTechLayers
bool background
Whether or not to print background color.
Definition: app_settings.h:99
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
bool TransferDataToWindow() override
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:181
PCBNEW_PRINTOUT_SETTINGS * settings() const
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
Color settings are a bit different than most of the settings objects in that there can be more than o...
BOARD * GetBoard() const
LSEQ UIOrder() const
Definition: lset.cpp:837
wxString m_ColorTheme
Active color theme name.
Definition: app_settings.h:136

References APP_SETTINGS_BASE::PRINTING::background, APP_SETTINGS_BASE::PRINTING::color_theme, dummy(), PCB_BASE_FRAME::GetBoard(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), PCB_BASE_FRAME::GetPcbNewSettings(), IsCopperLayer(), m_boxPagination, m_checkBackground, m_checkboxMirror, m_checkboxNoEdge, m_checkUseTheme, m_colorTheme, APP_SETTINGS_BASE::m_ColorTheme, m_drillMarksChoice, m_layers, m_listCopperLayers, m_listTechLayers, m_parent, APP_SETTINGS_BASE::m_Printing, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, onColorModeChanged(), Pgm(), settings(), DIALOG_PRINT_GENERIC::TransferDataToWindow(), LSET::UIOrder(), and APP_SETTINGS_BASE::PRINTING::use_theme.

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 167 of file dialog_shim.cpp.

168 {
169  wxSize sz( 0, y );
170  return ConvertDialogToPixels( sz ).y;
171 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ bUpperSizer

wxBoxSizer* DIALOG_PRINT_GENERIC_BASE::bUpperSizer
protectedinherited

◆ gbOptionsSizer

wxGridBagSizer* DIALOG_PRINT_GENERIC_BASE::gbOptionsSizer
protectedinherited

◆ m_boxPagination

wxRadioBox* DIALOG_PRINT_PCBNEW::m_boxPagination
private

◆ m_buttonDeselectAll

wxButton* DIALOG_PRINT_PCBNEW::m_buttonDeselectAll
private

Definition at line 94 of file dialog_print_pcbnew.cpp.

Referenced by createLeftPanel().

◆ m_buttonOption

wxButton* DIALOG_PRINT_GENERIC_BASE::m_buttonOption
protectedinherited

◆ m_buttonSelectAll

wxButton* DIALOG_PRINT_PCBNEW::m_buttonSelectAll
private

Definition at line 93 of file dialog_print_pcbnew.cpp.

Referenced by createLeftPanel().

◆ m_checkBackground

wxCheckBox* DIALOG_PRINT_PCBNEW::m_checkBackground
private

◆ m_checkboxMirror

wxCheckBox* DIALOG_PRINT_PCBNEW::m_checkboxMirror
private

Definition at line 96 of file dialog_print_pcbnew.cpp.

Referenced by createExtraOptions(), saveSettings(), and TransferDataToWindow().

◆ m_checkboxNoEdge

wxCheckBox* DIALOG_PRINT_PCBNEW::m_checkboxNoEdge
private

◆ m_checkUseTheme

wxCheckBox* DIALOG_PRINT_PCBNEW::m_checkUseTheme
private

◆ m_colorTheme

wxChoice* DIALOG_PRINT_PCBNEW::m_colorTheme
private

◆ m_config

◆ m_drillMarksChoice

wxChoice* DIALOG_PRINT_PCBNEW::m_drillMarksChoice
private

Definition at line 97 of file dialog_print_pcbnew.cpp.

Referenced by createExtraOptions(), saveSettings(), and TransferDataToWindow().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 202 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 203 of file dialog_shim.h.

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

◆ m_layers

std::pair<wxCheckListBox*, int> DIALOG_PRINT_PCBNEW::m_layers[PCB_LAYER_ID_COUNT]
private

◆ m_lblTheme

wxStaticText* DIALOG_PRINT_PCBNEW::m_lblTheme
private

◆ m_listCopperLayers

wxCheckListBox* DIALOG_PRINT_PCBNEW::m_listCopperLayers
private

◆ m_listTechLayers

wxCheckListBox* DIALOG_PRINT_PCBNEW::m_listTechLayers
private

◆ m_outputMode

◆ m_outputModeLabel

wxStaticText* DIALOG_PRINT_GENERIC_BASE::m_outputModeLabel
protectedinherited

◆ m_parent

PCB_BASE_EDIT_FRAME* DIALOG_PRINT_PCBNEW::m_parent
private

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 210 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 205 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 207 of file dialog_shim.h.

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

◆ m_scale1

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scale1
protectedinherited

◆ m_scaleCustom

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scaleCustom
protectedinherited

◆ m_scaleCustomText

◆ m_scaleFit

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scaleFit
protectedinherited

◆ m_sdbSizer1

wxStdDialogButtonSizer* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1
protectedinherited

◆ m_sdbSizer1Apply

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Apply
protectedinherited

◆ m_sdbSizer1Cancel

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Cancel
protectedinherited

◆ m_sdbSizer1OK

wxButton* DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1OK
protectedinherited

◆ m_settings

◆ m_staticline1

wxStaticLine* DIALOG_PRINT_GENERIC_BASE::m_staticline1
protectedinherited

◆ m_tabOrder

◆ m_titleBlock

◆ m_units

◆ sbOptionsSizer

wxStaticBoxSizer* DIALOG_PRINT_GENERIC_BASE::sbOptionsSizer
protectedinherited

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