KiCad PCB EDA Suite
DIALOG_PRINT_GENERIC Class Referenceabstract

#include <dialog_print_generic.h>

Inheritance diagram for DIALOG_PRINT_GENERIC:
DIALOG_PRINT_GENERIC_BASE DIALOG_SHIM KIWAY_HOLDER DIALOG_PRINT_GERBVIEW DIALOG_PRINT_PCBNEW

Public Member Functions

 DIALOG_PRINT_GENERIC (EDA_DRAW_FRAME *aParent, PRINTOUT_SETTINGS *aSettings)
 
virtual ~DIALOG_PRINT_GENERIC ()
 
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_T GetUserUnits () const override
 
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...
 

Protected Types

enum  { wxID_FRAME_SEL = 1000, wxID_PRINT_OPTIONS }
 

Protected Member Functions

virtual wxPrintout * createPrintout (const wxString &aTitle)=0
 Create a printout with a requested title. More...
 
virtual void saveSettings ()
 
wxSizer * getMainSizer ()
 
wxGridBagSizer * getOptionsSizer ()
 
wxStaticBox * getOptionsBox ()
 
double getScaleValue () const
 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...
 
bool TransferDataToWindow () override
 
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...
 

Protected Attributes

wxConfigBase * m_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_T 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
 

Private Member Functions

void onPageSetup (wxCommandEvent &event) override
 
void onPrintPreview (wxCommandEvent &event) override
 
void onPrintButtonClick (wxCommandEvent &event) override
 
void onCloseButton (wxCommandEvent &event) override
 
void onClose (wxCloseEvent &event) override
 
void onSetCustomScale (wxCommandEvent &event) override
 
void initPrintData ()
 

Private Attributes

wxFloatingPointValidator< double > m_scaleValidator
 

Static Private Attributes

static wxPrintData * s_PrintData = nullptr
 
static wxPageSetupDialogData * s_pageSetupData = nullptr
 

Detailed Description

Definition at line 30 of file dialog_print_generic.h.

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.

Constructor & Destructor Documentation

◆ DIALOG_PRINT_GENERIC()

DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC ( EDA_DRAW_FRAME aParent,
PRINTOUT_SETTINGS aSettings 
)

Definition at line 30 of file dialog_print_generic.cpp.

31  : DIALOG_PRINT_GENERIC_BASE( aParent ), m_config( nullptr ), m_settings( aSettings )
32 {
34  m_scaleCustomText->SetValidator( m_scaleValidator );
35 
36  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
37  // that requires us to correct the button labels here.
38  m_sdbSizer1OK->SetLabel( _( "Print" ) );
39  m_sdbSizer1Apply->SetLabel( _( "Print Preview" ) );
40  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
41  m_sdbSizer1->Layout();
42 
43  m_sdbSizer1OK->SetDefault();
44 
45 #if defined(__WXMAC__) or defined(__WXGTK__)
46  // Preview does not work well on GTK or Mac,
47  // but these platforms provide native print preview
48  m_sdbSizer1Apply->Hide();
49 #endif
50 
52  Layout();
53  initPrintData();
54 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
static constexpr double MIN_SCALE
static constexpr double MAX_SCALE
PRINTOUT_SETTINGS * m_settings
DIALOG_PRINT_GENERIC_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Print"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(410, 476), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
wxStdDialogButtonSizer * m_sdbSizer1
wxFloatingPointValidator< double > m_scaleValidator

References DIALOG_SHIM::FinishDialogSettings(), initPrintData(), DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, m_scaleValidator, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Apply, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1Cancel, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1OK, MAX_SCALE, and MIN_SCALE.

◆ ~DIALOG_PRINT_GENERIC()

DIALOG_PRINT_GENERIC::~DIALOG_PRINT_GENERIC ( )
virtual

Definition at line 57 of file dialog_print_generic.cpp.

58 {
59 }

Member Function Documentation

◆ createPrintout()

virtual wxPrintout* DIALOG_PRINT_GENERIC::createPrintout ( const wxString &  aTitle)
protectedpure virtual

Create a printout with a requested title.

Implemented in DIALOG_PRINT_GERBVIEW, and DIALOG_PRINT_PCBNEW.

Referenced by onPrintButtonClick(), and onPrintPreview().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 230 of file dialog_shim.cpp.

231 {
232  // so we can do logging of this state change:
233 
234 #if defined(DEBUG)
235  const char* type_id = typeid( *this ).name();
236  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
237  fflush(0); //Needed on msys2 to immediately print the message
238 #endif
239 
240  return wxDialog::Enable( enable );
241 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 391 of file dialog_shim.cpp.

392 {
393  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
394  // handle validation in the same way as other dialogs.
395  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
396  return;
397 
398  SetReturnCode( retCode );
399 
400  if( !IsQuasiModal() )
401  {
402  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
403  return;
404  }
405 
406  if( m_qmodal_loop )
407  {
408  if( m_qmodal_loop->IsRunning() )
409  m_qmodal_loop->Exit( 0 );
410  else
411  m_qmodal_loop->ScheduleExit( 0 );
412 
413  m_qmodal_loop = NULL;
414  }
415 
418 
419  Show( false );
420 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool IsQuasiModal()
Definition: dialog_shim.h:125
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, 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(), onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), 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 129 of file dialog_shim.cpp.

130 {
131  // must be called from the constructor of derived classes,
132  // when all widgets are initialized, and therefore their size fixed
133 
134  // SetSizeHints fixes the minimal size of sizers in the dialog
135  // (SetSizeHints calls Fit(), so no need to call it)
136  GetSizer()->SetSizeHints( this );
137 
138  // the default position, when calling the first time the dlg
139  Center();
140 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), 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_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), 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_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_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_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_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), 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_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ ForcePrintBorder()

void DIALOG_PRINT_GENERIC::ForcePrintBorder ( bool  aValue)

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

Definition at line 62 of file dialog_print_generic.cpp.

63 {
64  m_titleBlock->SetValue( aValue );
65  m_titleBlock->Hide();
66 
67  if( m_config )
68  {
70  m_settings->m_titleBlock = aValue;
72  }
73 }
virtual void Save(wxConfigBase *aConfig)
Definition: printout.cpp:23
bool m_titleBlock
Print frame and title block.
Definition: printout.h:45
PRINTOUT_SETTINGS * m_settings
virtual void Load(wxConfigBase *aConfig)
Definition: printout.cpp:31

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

Referenced by FOOTPRINT_EDIT_FRAME::ToPrinter(), and GERBVIEW_FRAME::ToPrinter().

◆ getMainSizer()

wxSizer* DIALOG_PRINT_GENERIC::getMainSizer ( )
inlineprotected

◆ getOptionsBox()

wxStaticBox* DIALOG_PRINT_GENERIC::getOptionsBox ( )
inlineprotected

◆ getOptionsSizer()

wxGridBagSizer* DIALOG_PRINT_GENERIC::getOptionsSizer ( )
inlineprotected

◆ getScaleValue()

double DIALOG_PRINT_GENERIC::getScaleValue ( ) const
protected

Return scale value selected in the dialog.

Definition at line 87 of file dialog_print_generic.cpp.

88 {
89  if( m_scale1->GetValue() )
90  return 1.0;
91 
92  if( m_scaleFit->GetValue() )
93  return 0.0;
94 
95  if( m_scaleCustom->GetValue() )
96  {
97  double scale;
98 
99  wxCHECK( m_scaleCustomText->GetValue().ToDouble( &scale ), 1.0 );
100  return scale;
101  }
102 
103  wxCHECK( false, 1.0 );
104 }
const int scale

References DIALOG_PRINT_GENERIC_BASE::m_scale1, DIALOG_PRINT_GENERIC_BASE::m_scaleCustom, DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText, DIALOG_PRINT_GENERIC_BASE::m_scaleFit, and scale.

Referenced by saveSettings().

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

151 {
152  wxSize sz( x, 0 );
153  return ConvertDialogToPixels( sz ).x;
154 }

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

◆ initPrintData()

void DIALOG_PRINT_GENERIC::initPrintData ( )
private

Definition at line 265 of file dialog_print_generic.cpp.

266 {
267  if( !s_PrintData ) // First print
268  {
269  s_PrintData = new wxPrintData();
270 
271  if( !s_PrintData->Ok() )
272  DisplayError( this, _( "An error occurred initializing the printer information." ) );
273 
274  s_PrintData->SetQuality( wxPRINT_QUALITY_HIGH ); // Default resolution = HIGH;
275  }
276 
277  if( !s_pageSetupData )
278  {
279  const PAGE_INFO& pageInfo = m_settings->m_pageInfo;
280 
281  s_pageSetupData = new wxPageSetupDialogData( *s_PrintData );
282  s_pageSetupData->SetPaperId( pageInfo.GetPaperId() );
283  s_pageSetupData->GetPrintData().SetOrientation( pageInfo.GetWxOrientation() );
284 
285  if( pageInfo.IsCustom() )
286  {
287  if( pageInfo.IsPortrait() )
288  s_pageSetupData->SetPaperSize( wxSize( Mils2mm( pageInfo.GetWidthMils() ),
289  Mils2mm( pageInfo.GetHeightMils() ) ) );
290  else
291  s_pageSetupData->SetPaperSize( wxSize( Mils2mm( pageInfo.GetHeightMils() ),
292  Mils2mm( pageInfo.GetWidthMils() ) ) );
293  }
294 
295  *s_PrintData = s_pageSetupData->GetPrintData();
296  }
297 }
const PAGE_INFO & m_pageInfo
Definition: printout.h:48
wxPrintOrientation GetWxOrientation() const
Function GetWxOrientation.
Definition: page_info.h:127
int GetHeightMils() const
Definition: page_info.h:140
bool IsCustom() const
Function IsCustom returns true if the type is Custom.
Definition: page_info.cpp:176
wxPaperSize GetPaperId() const
Function GetPaperId.
Definition: page_info.h:134
PRINTOUT_SETTINGS * m_settings
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
static wxPrintData * s_PrintData
int Mils2mm(double x)
Convert mils to mm.
Definition: base_units.h:54
bool IsPortrait() const
Definition: page_info.h:121
static wxPageSetupDialogData * s_pageSetupData
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
int GetWidthMils() const
Definition: page_info.h:137

References DisplayError(), PAGE_INFO::GetHeightMils(), PAGE_INFO::GetPaperId(), PAGE_INFO::GetWidthMils(), PAGE_INFO::GetWxOrientation(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), PRINTOUT_SETTINGS::m_pageInfo, m_settings, Mils2mm(), s_pageSetupData, and s_PrintData.

Referenced by DIALOG_PRINT_GENERIC().

◆ IsQuasiModal()

◆ 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 60 of file kiway_player.h.

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:94

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), SCH_EDIT_FRAME::doUpdatePcb(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::KiwayMailIn(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), 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(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ onClose()

void DIALOG_PRINT_GENERIC::onClose ( wxCloseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 250 of file dialog_print_generic.cpp.

251 {
252  saveSettings();
253  event.Skip();
254 }

References saveSettings().

◆ onCloseButton()

void DIALOG_PRINT_GENERIC::onCloseButton ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 236 of file dialog_print_generic.cpp.

237 {
238  saveSettings();
239 
240  if( IsQuasiModal() )
241  EndQuasiModal( wxID_CANCEL );
242 
243  if( IsModal() )
244  EndModal( wxID_CANCEL );
245 
246  Close();
247 }
bool IsQuasiModal()
Definition: dialog_shim.h:125
void EndQuasiModal(int retCode)

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

◆ onPageSetup()

void DIALOG_PRINT_GENERIC::onPageSetup ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 152 of file dialog_print_generic.cpp.

153 {
154  wxPageSetupDialog pageSetupDialog( this, s_pageSetupData );
155  pageSetupDialog.ShowModal();
156 
157  (*s_PrintData) = pageSetupDialog.GetPageSetupDialogData().GetPrintData();
158  (*s_pageSetupData) = pageSetupDialog.GetPageSetupDialogData();
159 }
static wxPageSetupDialogData * s_pageSetupData

References s_pageSetupData.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 293 of file dialog_shim.cpp.

294 {
295  if( m_firstPaintEvent )
296  {
297 #ifdef __WXMAC__
298  fixOSXCancelButtonIssue( this );
299  selectAllInTextCtrls( GetChildren() );
300 #endif
301 
303  m_initialFocusTarget->SetFocus();
304  else
305  SetFocus(); // Focus the dialog itself
306 
307  m_firstPaintEvent = false;
308  }
309 
310  event.Skip();
311 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179

References DIALOG_SHIM::m_firstPaintEvent, and DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ onPrintButtonClick()

void DIALOG_PRINT_GENERIC::onPrintButtonClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 203 of file dialog_print_generic.cpp.

204 {
205  m_settings->m_pageCount = 0; // it needs to be set by a derived dialog
206  saveSettings();
207 
208  if( m_settings->m_pageCount == 0 )
209  {
210  DisplayError( this, _( "Nothing to print" ) );
211  return;
212  }
213 
214  wxPrintDialogData printDialogData( *s_PrintData );
215  printDialogData.SetMaxPage( m_settings->m_pageCount );
216 
217  wxPrinter printer( &printDialogData );
218  auto printout = std::unique_ptr<wxPrintout>( createPrintout( _( "Print" ) ) );
219 
220  // Disable 'Print' button to prevent issuing another print
221  // command before the previous one is finished (causes problems on Windows)
222  ENABLER printBtnDisable( *m_sdbSizer1OK, false );
223 
224  if( !printer.Print( this, printout.get(), true ) )
225  {
226  if( wxPrinter::GetLastError() == wxPRINTER_ERROR )
227  DisplayError( this, _( "There was a problem printing." ) );
228  }
229  else
230  {
231  *s_PrintData = printer.GetPrintDialogData().GetPrintData();
232  }
233 }
PRINTOUT_SETTINGS * m_settings
static wxPrintData * s_PrintData
int m_pageCount
Number of pages to print.
Definition: printout.h:47
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
Simple class to automatically enable/disable widgets.
Definition: enabler.h:29
virtual wxPrintout * createPrintout(const wxString &aTitle)=0
Create a printout with a requested title.

References createPrintout(), DisplayError(), PRINTOUT_SETTINGS::m_pageCount, DIALOG_PRINT_GENERIC_BASE::m_sdbSizer1OK, m_settings, s_PrintData, and saveSettings().

◆ onPrintPreview()

void DIALOG_PRINT_GENERIC::onPrintPreview ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 162 of file dialog_print_generic.cpp.

163 {
164  m_settings->m_pageCount = 0; // it needs to be set by a derived dialog
165  saveSettings();
166 
167  if( m_settings->m_pageCount == 0 )
168  {
169  DisplayError( this, _( "Nothing to print" ) );
170  return;
171  }
172 
173  // Pass two printout objects: for preview, and possible printing.
174  wxString title = _( "Print Preview" );
175  wxPrintPreview* preview =
176  new wxPrintPreview( createPrintout( title ), createPrintout( title ), s_PrintData );
177 
178  preview->SetZoom( 100 );
179 
180  wxPreviewFrame* frame = new wxPreviewFrame( preview, this, title, m_parent->GetPosition(),
181  m_parent->GetSize() );
182  frame->SetMinSize( wxSize( 550, 350 ) );
183  frame->Center();
184 
185  // On wxGTK, set the flag wxTOPLEVEL_EX_DIALOG is mandatory, if we want
186  // close the frame using the X box in caption, when the preview frame is run
187  // from a dialog
188  frame->SetExtraStyle( frame->GetExtraStyle() | wxTOPLEVEL_EX_DIALOG );
189 
190  // We use here wxPreviewFrame_WindowModal option to make the wxPrintPreview frame
191  // modal for its caller only.
192  // An other reason is the fact when closing the frame without this option,
193  // all top level frames are reenabled.
194  // With this option, only the parent is reenabled.
195  // Reenabling all top level frames should be made by the parent dialog.
196  frame->InitializeWithModality( wxPreviewFrame_WindowModal );
197 
198  frame->Raise(); // Needed on Ubuntu/Unity to display the frame
199  frame->Show( true );
200 }
PRINTOUT_SETTINGS * m_settings
static wxPrintData * s_PrintData
int m_pageCount
Number of pages to print.
Definition: printout.h:47
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:243
virtual wxPrintout * createPrintout(const wxString &aTitle)=0
Create a printout with a requested title.

References createPrintout(), DisplayError(), PRINTOUT_SETTINGS::m_pageCount, m_settings, s_PrintData, and saveSettings().

◆ onSetCustomScale()

void DIALOG_PRINT_GENERIC::onSetCustomScale ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PRINT_GENERIC_BASE.

Definition at line 257 of file dialog_print_generic.cpp.

258 {
259  // Select 'custom scale' radio button when user types in a value in the
260  // custom scale text box
261  m_scaleCustom->SetValue( true );
262 }

References DIALOG_PRINT_GENERIC_BASE::m_scaleCustom.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), 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_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doUpdatePcb(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), 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_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), 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(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), 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().

◆ saveSettings()

void DIALOG_PRINT_GENERIC::saveSettings ( )
protectedvirtual

Reimplemented in DIALOG_PRINT_GERBVIEW, and DIALOG_PRINT_PCBNEW.

Definition at line 76 of file dialog_print_generic.cpp.

77 {
79  m_settings->m_titleBlock = m_titleBlock->GetValue();
80  m_settings->m_blackWhite = m_outputMode->GetSelection();
81 
82  if( m_config )
84 }
double getScaleValue() const
Return scale value selected in the dialog.
virtual void Save(wxConfigBase *aConfig)
Definition: printout.cpp:23
double m_scale
Printing scale.
Definition: printout.h:44
bool m_titleBlock
Print frame and title block.
Definition: printout.h:45
PRINTOUT_SETTINGS * m_settings
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:46

References getScaleValue(), PRINTOUT_SETTINGS::m_blackWhite, m_config, DIALOG_PRINT_GENERIC_BASE::m_outputMode, PRINTOUT_SETTINGS::m_scale, m_settings, PRINTOUT_SETTINGS::m_titleBlock, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, and PRINTOUT_SETTINGS::Save().

Referenced by onClose(), onCloseButton(), onPrintButtonClick(), onPrintPreview(), DIALOG_PRINT_PCBNEW::saveSettings(), and DIALOG_PRINT_GERBVIEW::saveSettings().

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

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

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_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), 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_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_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), 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_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::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 47 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ setScaleValue()

void DIALOG_PRINT_GENERIC::setScaleValue ( double  aValue)
protected

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 107 of file dialog_print_generic.cpp.

108 {
109  wxASSERT( aValue >= 0.0 );
110 
111  if( aValue == 0.0 ) // fit to page
112  {
113  m_scaleFit->SetValue( true );
114  }
115  else if( aValue == 1.0 )
116  {
117  m_scale1->SetValue( true );
118  }
119  else
120  {
121  if( aValue > MAX_SCALE )
122  {
123  DisplayInfoMessage( nullptr, _( "Warning: Scale option set to a very large value" ) );
124  }
125  else if( aValue < MIN_SCALE )
126  {
127  DisplayInfoMessage( nullptr, _( "Warning: Scale option set to a very small value" ) );
128  }
129 
130  m_scaleCustom->SetValue( true );
131  m_scaleCustomText->SetValue( wxString::Format( wxT( "%f" ), aValue ) );
132  }
133 }
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
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:275

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, and MIN_SCALE.

Referenced by 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 143 of file dialog_shim.cpp.

144 {
145  wxSize sz( x, y );
146  SetSize( ConvertDialogToPixels( sz ) );
147 }

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 171 of file dialog_shim.cpp.

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

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, and max.

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_SCH_FIND::OnCancel(), SCH_EDIT_FRAME::OnFindItems(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 337 of file dialog_shim.cpp.

338 {
339  // This is an exception safe way to zero a pointer before returning.
340  // Yes, even though DismissModal() clears this first normally, this is
341  // here in case there's an exception before the dialog is dismissed.
342  struct NULLER
343  {
344  void*& m_what;
345  NULLER( void*& aPtr ) : m_what( aPtr ) {}
346  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
347  } clear_this( (void*&) m_qmodal_loop );
348 
349  // release the mouse if it's currently captured as the window having it
350  // will be disabled when this dialog is shown -- but will still keep the
351  // capture making it impossible to do anything in the modal dialog itself
352  wxWindow* win = wxWindow::GetCapture();
353  if( win )
354  win->ReleaseMouse();
355 
356  // Get the optimal parent
357  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
358 
359  // Show the optimal parent
360  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
361 
362  wxASSERT_MSG( !m_qmodal_parent_disabler,
363  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
364 
365  // quasi-modal: disable only my "optimal" parent
367 
368 #ifdef __WXMAC__
369  // Apple in its infinite wisdom will raise a disabled window before even passing
370  // us the event, so we have no way to stop it. Instead, we must set an order on
371  // the windows so that the quasi-modal will be pushed in front of the disabled
372  // window when it is raised.
373  ReparentQuasiModal();
374 #endif
375  Show( true );
376 
377  m_qmodal_showing = true;
378 
379  WX_EVENT_LOOP event_loop;
380 
381  m_qmodal_loop = &event_loop;
382 
383  event_loop.Run();
384 
385  m_qmodal_showing = false;
386 
387  return GetReturnCode();
388 }
bool m_qmodal_showing
Definition: dialog_shim.h:184
#define WX_EVENT_LOOP
Definition: kiway_player.h:100
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:183
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:185
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:34
#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 SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), SCH_EDIT_FRAME::InstallHierarchyFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), LIB_EDIT_FRAME::OnEditComponentProperties(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectComponentFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ TransferDataToWindow()

bool DIALOG_PRINT_GENERIC::TransferDataToWindow ( )
overrideprotected

Definition at line 136 of file dialog_print_generic.cpp.

137 {
138  if( !wxDialog::TransferDataToWindow() )
139  return false;
140 
141  if( m_config )
143 
145  m_titleBlock->SetValue( m_settings->m_titleBlock );
146  m_outputMode->SetSelection( m_settings->m_blackWhite ? 1 : 0 );
147 
148  return true;
149 }
double m_scale
Printing scale.
Definition: printout.h:44
void setScaleValue(double aValue)
Select a corresponding scale radio button and update custom scale value if needed.
bool m_titleBlock
Print frame and title block.
Definition: printout.h:45
PRINTOUT_SETTINGS * m_settings
virtual void Load(wxConfigBase *aConfig)
Definition: printout.cpp:31
bool m_blackWhite
Print in B&W or Color.
Definition: printout.h:46

References PRINTOUT_SETTINGS::Load(), PRINTOUT_SETTINGS::m_blackWhite, m_config, DIALOG_PRINT_GENERIC_BASE::m_outputMode, PRINTOUT_SETTINGS::m_scale, m_settings, PRINTOUT_SETTINGS::m_titleBlock, DIALOG_PRINT_GENERIC_BASE::m_titleBlock, and setScaleValue().

Referenced by DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and DIALOG_PRINT_GERBVIEW::TransferDataToWindow().

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

158 {
159  wxSize sz( 0, y );
160  return ConvertDialogToPixels( sz ).y;
161 }

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

Member Data Documentation

◆ bUpperSizer

wxBoxSizer* DIALOG_PRINT_GENERIC_BASE::bUpperSizer
protectedinherited

◆ gbOptionsSizer

wxGridBagSizer* DIALOG_PRINT_GENERIC_BASE::gbOptionsSizer
protectedinherited

◆ m_buttonOption

wxButton* DIALOG_PRINT_GENERIC_BASE::m_buttonOption
protectedinherited

◆ m_config

wxConfigBase* DIALOG_PRINT_GENERIC::m_config
protected

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_outputMode

wxChoice* DIALOG_PRINT_GENERIC_BASE::m_outputMode
protectedinherited

◆ m_outputModeLabel

wxStaticText* DIALOG_PRINT_GENERIC_BASE::m_outputModeLabel
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 183 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 184 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

wxTextCtrl* DIALOG_PRINT_GENERIC_BASE::m_scaleCustomText
protectedinherited

◆ m_scaleFit

wxRadioButton* DIALOG_PRINT_GENERIC_BASE::m_scaleFit
protectedinherited

◆ m_scaleValidator

wxFloatingPointValidator<double> DIALOG_PRINT_GENERIC::m_scaleValidator
private

Definition at line 98 of file dialog_print_generic.h.

Referenced by DIALOG_PRINT_GENERIC().

◆ 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_titleBlock

wxCheckBox* DIALOG_PRINT_GENERIC_BASE::m_titleBlock
protectedinherited

◆ m_units

◆ s_pageSetupData

wxPageSetupDialogData * DIALOG_PRINT_GENERIC::s_pageSetupData = nullptr
staticprivate

Definition at line 101 of file dialog_print_generic.h.

Referenced by initPrintData(), and onPageSetup().

◆ s_PrintData

wxPrintData * DIALOG_PRINT_GENERIC::s_PrintData = nullptr
staticprivate

Definition at line 100 of file dialog_print_generic.h.

Referenced by initPrintData(), onPrintButtonClick(), and onPrintPreview().

◆ sbOptionsSizer

wxStaticBoxSizer* DIALOG_PRINT_GENERIC_BASE::sbOptionsSizer
protectedinherited

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