KiCad PCB EDA Suite
DIALOG_PAGES_SETTINGS Class Reference

#include <dialog_page_settings.h>

Inheritance diagram for DIALOG_PAGES_SETTINGS:
DIALOG_PAGES_SETTINGS_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_PAGES_SETTINGS (EDA_DRAW_FRAME *parent, wxSize aMaxUserSizeMils)
 
 ~DIALOG_PAGES_SETTINGS ()
 
const wxString GetWksFileName ()
 
void SetWksFileName (const wxString &aFilename)
 
void EnableWksFileNamePicker (bool aEnable)
 
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...
 
VTBL_ENTRY TOOL_MANAGERGetToolManager () const
 Function GetToolManager Return the tool manager instance, if any. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

virtual void OnCheckboxTitleClick (wxCommandEvent &event)
 
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

wxStaticText * m_staticTextPaper
 
wxStaticLine * m_staticline2
 
wxStaticText * m_staticTextSize
 
wxChoice * m_paperSizeComboBox
 
wxStaticText * m_staticTextOrient
 
wxChoice * m_orientationComboBox
 
wxStaticText * m_staticTextCustSize
 
wxStaticText * m_userSizeYLabel
 
wxTextCtrl * m_userSizeYCtrl
 
wxStaticText * m_userSizeYUnits
 
wxStaticText * m_userSizeXLabel
 
wxTextCtrl * m_userSizeXCtrl
 
wxStaticText * m_userSizeXUnits
 
wxStaticText * m_staticTextPreview
 
wxStaticBitmap * m_PageLayoutExampleBitmap
 
wxStaticText * m_staticTexttbprm
 
wxStaticLine * m_staticline3
 
wxStaticText * m_TextSheetCount
 
wxStaticText * m_TextSheetNumber
 
wxStaticText * m_staticTextDate
 
wxTextCtrl * m_TextDate
 
wxButton * m_ApplyDate
 
wxDatePickerCtrl * m_PickDate
 
wxCheckBox * m_DateExport
 
wxStaticText * m_staticTextRev
 
wxTextCtrl * m_TextRevision
 
wxCheckBox * m_RevisionExport
 
wxStaticText * m_staticTextTitle
 
wxTextCtrl * m_TextTitle
 
wxCheckBox * m_TitleExport
 
wxStaticText * m_staticText13
 
wxTextCtrl * m_TextCompany
 
wxCheckBox * m_CompanyExport
 
wxStaticText * m_staticTextComment1
 
wxTextCtrl * m_TextComment1
 
wxCheckBox * m_Comment1Export
 
wxStaticText * m_staticTextComment2
 
wxTextCtrl * m_TextComment2
 
wxCheckBox * m_Comment2Export
 
wxStaticText * m_staticTextComment3
 
wxTextCtrl * m_TextComment3
 
wxCheckBox * m_Comment3Export
 
wxStaticText * m_staticTextComment4
 
wxTextCtrl * m_TextComment4
 
wxCheckBox * m_Comment4Export
 
wxStaticText * m_staticTextfilename
 
wxTextCtrl * m_textCtrlFilePicker
 
wxButton * m_buttonBrowse
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
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 initDialog ()
 
void OnOkClick (wxCommandEvent &event) override
 
void OnPaperSizeChoice (wxCommandEvent &event) override
 
void OnUserPageSizeXTextUpdated (wxCommandEvent &event) override
 
void OnUserPageSizeYTextUpdated (wxCommandEvent &event) override
 
void OnPageOrientationChoice (wxCommandEvent &event) override
 
void OnRevisionTextUpdated (wxCommandEvent &event) override
 
void OnDateTextUpdated (wxCommandEvent &event) override
 
void OnTitleTextUpdated (wxCommandEvent &event) override
 
void OnCompanyTextUpdated (wxCommandEvent &event) override
 
void OnComment1TextUpdated (wxCommandEvent &event) override
 
void OnComment2TextUpdated (wxCommandEvent &event) override
 
void OnComment3TextUpdated (wxCommandEvent &event) override
 
void OnComment4TextUpdated (wxCommandEvent &event) override
 
void OnDateApplyClick (wxCommandEvent &event) override
 
void OnWksFileSelection (wxCommandEvent &event) override
 
bool SavePageSettings ()
 
void SetCurrentPageSizeSelection (const wxString &aPaperSize)
 
void UpdatePageLayoutExample ()
 
void GetPageLayoutInfoFromDialog ()
 
void GetCustomSizeMilsFromDialog ()
 
bool LocalPrjConfigChanged ()
 

Private Attributes

EDA_DRAW_FRAMEm_parent
 
BASE_SCREENm_screen
 
wxString m_projectPath
 
wxArrayString m_pageFmt
 
bool m_initialized
 list of page sizes (not translated) More...
 
bool m_localPrjConfigChanged
 
wxBitmap * m_page_bitmap
 the page layuout filename was changed More...
 
wxSize m_layout_size
 Temporary bitmap for the page layout example. More...
 
wxSize m_maxPageSizeMils
 Logical page layout size. More...
 
PAGE_INFO m_pageInfo
 The max page size allowed by the caller frame. More...
 
bool m_customFmt
 Temporary page info. More...
 
TITLE_BLOCK m_tb
 true if the page selection is custom More...
 
WORKSHEET_LAYOUTm_pagelayout
 Temporary title block (basic inscriptions). More...
 
UNIT_BINDER m_customSizeX
 
UNIT_BINDER m_customSizeY
 

Detailed Description

DIALOG_PAGES_SETTINGS class declaration

Definition at line 34 of file dialog_page_settings.h.

Constructor & Destructor Documentation

◆ DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS ( EDA_DRAW_FRAME parent,
wxSize  aMaxUserSizeMils 
)

Definition at line 120 of file dialog_page_settings.cpp.

120  :
121  DIALOG_PAGES_SETTINGS_BASE( parent ),
122  m_initialized( false ),
125 {
126  m_parent = parent;
129  m_page_bitmap = NULL;
130  m_maxPageSizeMils = aMaxUserSizeMils;
132  m_customFmt = false;
133  m_localPrjConfigChanged = false;
134  m_pagelayout = NULL;
135 
136  m_PickDate->SetValue( wxDateTime::Now() );
137 
138  initDialog();
139 
140  GetSizer()->SetSizeHints( this );
141  Centre();
142 }
wxSize m_maxPageSizeMils
Logical page layout size.
virtual const TITLE_BLOCK & GetTitleBlock() const =0
TITLE_BLOCK m_tb
true if the page selection is custom
DIALOG_PAGES_SETTINGS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Page Settings"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
bool m_initialized
list of page sizes (not translated)
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
wxBitmap * m_page_bitmap
the page layuout filename was changed
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
WORKSHEET_LAYOUT * m_pagelayout
Temporary title block (basic inscriptions).
bool m_customFmt
Temporary page info.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.
Definition: draw_frame.h:408

References PROJECT::GetProjectPath(), EDA_DRAW_FRAME::GetScreen(), EDA_DRAW_FRAME::GetTitleBlock(), initDialog(), m_customFmt, m_localPrjConfigChanged, m_maxPageSizeMils, m_page_bitmap, m_pagelayout, m_parent, DIALOG_PAGES_SETTINGS_BASE::m_PickDate, m_projectPath, m_screen, m_tb, and KIWAY_HOLDER::Prj().

◆ ~DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::~DIALOG_PAGES_SETTINGS ( )

Definition at line 145 of file dialog_page_settings.cpp.

146 {
147  delete m_page_bitmap;
148  delete m_pagelayout;
149 }
wxBitmap * m_page_bitmap
the page layuout filename was changed
WORKSHEET_LAYOUT * m_pagelayout
Temporary title block (basic inscriptions).

References m_page_bitmap, and m_pagelayout.

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 237 of file dialog_shim.cpp.

238 {
239  // so we can do logging of this state change:
240 
241 #if 0 && defined(DEBUG)
242  const char* type_id = typeid( *this ).name();
243  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
244  fflush(0); //Needed on msys2 to immediately print the message
245 #endif
246 
247  return wxDialog::Enable( enable );
248 }

◆ EnableWksFileNamePicker()

void DIALOG_PAGES_SETTINGS::EnableWksFileNamePicker ( bool  aEnable)
inline

Definition at line 68 of file dialog_page_settings.h.

69  {
70  m_textCtrlFilePicker->Enable( aEnable );
71  m_buttonBrowse->Enable( aEnable );
72  }

References DIALOG_PAGES_SETTINGS_BASE::m_buttonBrowse, and DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker.

Referenced by EVT_MENU_RANGE().

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 397 of file dialog_shim.cpp.

398 {
399  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
400  // handle validation in the same way as other dialogs.
401  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
402  return;
403 
404  SetReturnCode( retCode );
405 
406  if( !IsQuasiModal() )
407  {
408  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
409  return;
410  }
411 
412  if( m_qmodal_loop )
413  {
414  if( m_qmodal_loop->IsRunning() )
415  m_qmodal_loop->Exit( 0 );
416  else
417  m_qmodal_loop->ScheduleExit( 0 );
418 
419  m_qmodal_loop = NULL;
420  }
421 
424 
425  Show( false );
426 }
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(), DIALOG_PRINT_GENERIC::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 136 of file dialog_shim.cpp.

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

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_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), 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_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().

◆ GetCustomSizeMilsFromDialog()

void DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog ( )
private

Definition at line 747 of file dialog_page_settings.cpp.

748 {
749  double customSizeX = (double) m_customSizeX.GetValue() / IU_PER_MILS;
750  double customSizeY = (double) m_customSizeY.GetValue() / IU_PER_MILS;
751 
752  // Prepare to painless double -> int conversion.
753  customSizeX = Clamp( double( INT_MIN ), customSizeX, double( INT_MAX ) );
754  customSizeY = Clamp( double( INT_MIN ), customSizeY, double( INT_MAX ) );
755  m_layout_size = wxSize( KiROUND( customSizeX ), KiROUND( customSizeY ) );
756 }
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: macros.h:138
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
wxSize m_layout_size
Temporary bitmap for the page layout example.
virtual int GetValue()
Function GetValue Returns the current value in Internal Units.
#define IU_PER_MILS
Definition: plotter.cpp:134

References Clamp(), UNIT_BINDER::GetValue(), IU_PER_MILS, KiROUND(), m_customSizeX, m_customSizeY, and m_layout_size.

Referenced by GetPageLayoutInfoFromDialog(), and SavePageSettings().

◆ GetPageLayoutInfoFromDialog()

void DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog ( )
private

Definition at line 681 of file dialog_page_settings.cpp.

682 {
683  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
684  const wxString paperType = m_pageFmt[idx];
685 
686  // here we assume translators will keep original paper size spellings
687  if( paperType.Contains( PAGE_INFO::Custom ) )
688  {
690 
691  if( m_layout_size.x && m_layout_size.y )
692  {
693  if( m_layout_size.x < m_layout_size.y )
694  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
695  else
696  m_orientationComboBox->SetStringSelection( _( "Landscape" ) );
697  }
698  }
699  else
700  {
701  PAGE_INFO pageInfo; // SetType() later to lookup size
702 
703  static const wxChar* papers[] = {
704  // longest common string first, since sequential search below
710  PAGE_INFO::A,
711  PAGE_INFO::B,
712  PAGE_INFO::C,
713  PAGE_INFO::D,
714  PAGE_INFO::E,
718  };
719 
720  unsigned i;
721 
722  for( i=0; i < arrayDim( papers ); ++i )
723  {
724  if( paperType.Contains( papers[i] ) )
725  {
726  pageInfo.SetType( papers[i] );
727  break;
728  }
729  }
730 
731  wxASSERT( i != arrayDim(papers) ); // dialog UI match the above list?
732 
733  m_layout_size = pageInfo.GetSizeMils();
734 
735  // swap sizes to match orientation
736  bool isPortrait = (bool) m_orientationComboBox->GetSelection();
737 
738  if( ( isPortrait && m_layout_size.x >= m_layout_size.y ) ||
739  ( !isPortrait && m_layout_size.x < m_layout_size.y ) )
740  {
742  }
743  }
744 }
static const wxChar A[]
Definition: page_info.h:69
static const wxChar E[]
Definition: page_info.h:73
static const wxChar A3[]
Definition: page_info.h:65
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:78
static const wxChar D[]
Definition: page_info.h:72
wxSize m_layout_size
Temporary bitmap for the page layout example.
static const wxChar USLegal[]
Definition: page_info.h:76
static const wxChar B[]
Definition: page_info.h:70
static const wxChar C[]
Definition: page_info.h:71
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 const wxChar A4[]
Definition: page_info.h:64
const wxSize & GetSizeMils() const
Definition: page_info.h:142
static const wxChar USLedger[]
Definition: page_info.h:77
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:107
static const wxChar A1[]
Definition: page_info.h:67
static const wxChar USLetter[]
Definition: page_info.h:75
#define max(a, b)
Definition: auxiliary.h:86
size_t i
Definition: json11.cpp:597
static const wxChar A2[]
Definition: page_info.h:66
static const wxChar A0[]
Definition: page_info.h:68

References PAGE_INFO::A, PAGE_INFO::A0, PAGE_INFO::A1, PAGE_INFO::A2, PAGE_INFO::A3, PAGE_INFO::A4, arrayDim(), PAGE_INFO::B, PAGE_INFO::C, PAGE_INFO::Custom, PAGE_INFO::D, PAGE_INFO::E, GetCustomSizeMilsFromDialog(), PAGE_INFO::GetSizeMils(), i, m_layout_size, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, max, PAGE_INFO::SetType(), PAGE_INFO::USLedger, PAGE_INFO::USLegal, and PAGE_INFO::USLetter.

Referenced by initDialog(), OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnCompanyTextUpdated(), OnDateTextUpdated(), OnPageOrientationChoice(), OnPaperSizeChoice(), OnRevisionTextUpdated(), OnTitleTextUpdated(), OnUserPageSizeXTextUpdated(), OnUserPageSizeYTextUpdated(), and OnWksFileSelection().

◆ GetToolManager()

TOOL_MANAGER * KIWAY_HOLDER::GetToolManager ( ) const
inherited

Function GetToolManager Return the tool manager instance, if any.

Definition at line 46 of file kiway_holder.cpp.

47 {
48  return nullptr;
49 }

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ GetWksFileName()

const wxString DIALOG_PAGES_SETTINGS::GetWksFileName ( )
inline

Definition at line 58 of file dialog_page_settings.h.

59  {
60  return m_textCtrlFilePicker->GetValue();
61  }

References DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker.

Referenced by OnWksFileSelection(), and SavePageSettings().

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

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

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

◆ initDialog()

void DIALOG_PAGES_SETTINGS::initDialog ( )
private

Definition at line 152 of file dialog_page_settings.cpp.

153 {
154  wxString msg;
155 
156  // initialize page format choice box and page format list.
157  // The first shows translated strings, the second contains not translated strings
158  m_paperSizeComboBox->Clear();
159 
160  for( unsigned ii = 0; ii < arrayDim(pageFmts); ii++ )
161  {
162  m_pageFmt.Add( pageFmts[ii] );
163  m_paperSizeComboBox->Append( wxGetTranslation( pageFmts[ii] ) );
164  }
165 
166  // initialize the page layout descr filename
168 
169 #ifdef EESCHEMA
170  // Init display value for schematic sub-sheet number
171  wxString format = m_TextSheetCount->GetLabel();
172  msg.Printf( format, m_screen->m_NumberOfScreens );
173  m_TextSheetCount->SetLabel( msg );
174 
175  format = m_TextSheetNumber->GetLabel();
176  msg.Printf( format, m_screen->m_ScreenNumber );
177  m_TextSheetNumber->SetLabel( msg );
178 #else
179  m_TextSheetCount->Show( false );
180  m_TextSheetNumber->Show( false );
181 #endif
182 
185  m_orientationComboBox->SetSelection( m_pageInfo.IsPortrait() );
186 
187  // only a click fires the "selection changed" event, so have to fabricate this check
188  wxCommandEvent dummy;
190 
191  if( m_customFmt )
192  {
195  }
196  else
197  {
200  }
201 
202  m_TextRevision->SetValue( m_tb.GetRevision() );
203  m_TextDate->SetValue( m_tb.GetDate() );
204  m_TextTitle->SetValue( m_tb.GetTitle() );
205  m_TextCompany->SetValue( m_tb.GetCompany() );
206  m_TextComment1->SetValue( m_tb.GetComment1() );
207  m_TextComment2->SetValue( m_tb.GetComment2() );
208  m_TextComment3->SetValue( m_tb.GetComment3() );
209  m_TextComment4->SetValue( m_tb.GetComment4() );
210 
211 #ifndef EESCHEMA
212  // these options have meaning only for Eeschema.
213  // disable them for other apps
214  m_RevisionExport->Show( false );
215  m_DateExport->Show( false );
216  m_TitleExport->Show( false );
217  m_CompanyExport->Show( false );
218  m_Comment1Export->Show( false );
219  m_Comment2Export->Show( false );
220  m_Comment3Export->Show( false );
221  m_Comment4Export->Show( false );
222 #endif
223 
226 
227  // Make the OK button the default.
228  m_sdbSizerOK->SetDefault();
229  m_initialized = true;
230 }
int m_ScreenNumber
Definition: base_screen.h:216
static int GetCustomHeightMils()
Function GetCustomHeightMils.
Definition: page_info.h:176
int GetHeightMils() const
Definition: page_info.h:140
TITLE_BLOCK m_tb
true if the page selection is custom
void SetWksFileName(const wxString &aFilename)
const wxString & GetComment4() const
Definition: title_block.h:124
const wxString & GetType() const
Definition: page_info.h:97
bool m_initialized
list of page sizes (not translated)
static wxString m_PageLayoutDescrFileName
the name of the page layout descr file, or emty to used the default pagelayout
Definition: base_screen.h:180
virtual const PAGE_INFO & GetPageSettings() const =0
const wxString & GetRevision() const
Definition: title_block.h:89
const wxString & GetCompany() const
Definition: title_block.h:99
const wxString & GetComment3() const
Definition: title_block.h:123
void SetCurrentPageSizeSelection(const wxString &aPaperSize)
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:107
const wxString & GetDate() const
Definition: title_block.h:79
const wxString & GetComment2() const
Definition: title_block.h:122
PAGE_INFO m_pageInfo
The max page size allowed by the caller frame.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
bool IsPortrait() const
Definition: page_info.h:121
const wxString & GetComment1() const
Definition: title_block.h:121
static const wxString pageFmts[]
virtual void SetValue(int aValue)
Function SetValue Sets new value (in Internal Units) for the text field, taking care of units convers...
#define IU_PER_MILS
Definition: plotter.cpp:134
static int GetCustomWidthMils()
Function GetCustomWidthMils.
Definition: page_info.h:170
bool m_customFmt
Temporary page info.
int m_NumberOfScreens
Definition: base_screen.h:217
const wxString & GetTitle() const
Definition: title_block.h:65
void OnPaperSizeChoice(wxCommandEvent &event) override
int GetWidthMils() const
Definition: page_info.h:137

References arrayDim(), dummy(), TITLE_BLOCK::GetComment1(), TITLE_BLOCK::GetComment2(), TITLE_BLOCK::GetComment3(), TITLE_BLOCK::GetComment4(), TITLE_BLOCK::GetCompany(), PAGE_INFO::GetCustomHeightMils(), PAGE_INFO::GetCustomWidthMils(), TITLE_BLOCK::GetDate(), PAGE_INFO::GetHeightMils(), GetPageLayoutInfoFromDialog(), EDA_DRAW_FRAME::GetPageSettings(), TITLE_BLOCK::GetRevision(), TITLE_BLOCK::GetTitle(), PAGE_INFO::GetType(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsPortrait(), IU_PER_MILS, DIALOG_PAGES_SETTINGS_BASE::m_Comment1Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment2Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment3Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment4Export, DIALOG_PAGES_SETTINGS_BASE::m_CompanyExport, m_customFmt, m_customSizeX, m_customSizeY, DIALOG_PAGES_SETTINGS_BASE::m_DateExport, m_initialized, BASE_SCREEN::m_NumberOfScreens, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, m_pageInfo, BASE_SCREEN::m_PageLayoutDescrFileName, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, DIALOG_PAGES_SETTINGS_BASE::m_RevisionExport, m_screen, BASE_SCREEN::m_ScreenNumber, DIALOG_PAGES_SETTINGS_BASE::m_sdbSizerOK, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment1, DIALOG_PAGES_SETTINGS_BASE::m_TextComment2, DIALOG_PAGES_SETTINGS_BASE::m_TextComment3, DIALOG_PAGES_SETTINGS_BASE::m_TextComment4, DIALOG_PAGES_SETTINGS_BASE::m_TextCompany, DIALOG_PAGES_SETTINGS_BASE::m_TextDate, DIALOG_PAGES_SETTINGS_BASE::m_TextRevision, DIALOG_PAGES_SETTINGS_BASE::m_TextSheetCount, DIALOG_PAGES_SETTINGS_BASE::m_TextSheetNumber, DIALOG_PAGES_SETTINGS_BASE::m_TextTitle, DIALOG_PAGES_SETTINGS_BASE::m_TitleExport, OnPaperSizeChoice(), pageFmts, SetCurrentPageSizeSelection(), UNIT_BINDER::SetValue(), SetWksFileName(), and UpdatePageLayoutExample().

Referenced by DIALOG_PAGES_SETTINGS().

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

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), 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(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), 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::InitSheet(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), 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::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::OnUpdatePCB(), 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::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), 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().

◆ LocalPrjConfigChanged()

bool DIALOG_PAGES_SETTINGS::LocalPrjConfigChanged ( )
inlineprivate
Returns
true if the local prj config is chande i.e. if the page layout descr file has chnaged

Definition at line 119 of file dialog_page_settings.h.

References m_localPrjConfigChanged.

Referenced by OnOkClick().

◆ OnCheckboxTitleClick()

virtual void DIALOG_PAGES_SETTINGS_BASE::OnCheckboxTitleClick ( wxCommandEvent &  event)
inlineprotectedvirtualinherited

◆ OnComment1TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment1TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 369 of file dialog_page_settings.cpp.

370 {
371  if( m_initialized && m_TextComment1->IsModified() )
372  {
374  m_tb.SetComment1( m_TextComment1->GetValue() );
376  }
377 }
void SetComment1(const wxString &aComment)
Definition: title_block.h:117
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment1, TITLE_BLOCK::SetComment1(), and UpdatePageLayoutExample().

◆ OnComment2TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment2TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 380 of file dialog_page_settings.cpp.

381 {
382  if( m_initialized && m_TextComment2->IsModified() )
383  {
385  m_tb.SetComment2( m_TextComment2->GetValue() );
387  }
388 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment2(const wxString &aComment)
Definition: title_block.h:118

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment2, TITLE_BLOCK::SetComment2(), and UpdatePageLayoutExample().

◆ OnComment3TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment3TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 391 of file dialog_page_settings.cpp.

392 {
393  if( m_initialized && m_TextComment3->IsModified() )
394  {
396  m_tb.SetComment3( m_TextComment3->GetValue() );
398  }
399 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment3(const wxString &aComment)
Definition: title_block.h:119

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment3, TITLE_BLOCK::SetComment3(), and UpdatePageLayoutExample().

◆ OnComment4TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment4TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 402 of file dialog_page_settings.cpp.

403 {
404  if( m_initialized && m_TextComment4->IsModified() )
405  {
407  m_tb.SetComment4( m_TextComment4->GetValue() );
409  }
410 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment4(const wxString &aComment)
Definition: title_block.h:120

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment4, TITLE_BLOCK::SetComment4(), and UpdatePageLayoutExample().

◆ OnCompanyTextUpdated()

void DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 358 of file dialog_page_settings.cpp.

359 {
360  if( m_initialized && m_TextCompany->IsModified() )
361  {
363  m_tb.SetCompany( m_TextCompany->GetValue() );
365  }
366 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetCompany(const wxString &aCompany)
Definition: title_block.h:94

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextCompany, TITLE_BLOCK::SetCompany(), and UpdatePageLayoutExample().

◆ OnDateApplyClick()

void DIALOG_PAGES_SETTINGS::OnDateApplyClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 413 of file dialog_page_settings.cpp.

414 {
415  wxDateTime datetime = m_PickDate->GetValue();
416  wxString date =
417  // We can choose different formats. Only one must be uncommented
418  //
419  // datetime.Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
420  // datetime.Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
421  // datetime.Format( wxT("%Y-%b-%d") );
422  datetime.FormatISODate();
423 
424  m_TextDate->SetValue( date );
425 }

References DIALOG_PAGES_SETTINGS_BASE::m_PickDate, and DIALOG_PAGES_SETTINGS_BASE::m_TextDate.

◆ OnDateTextUpdated()

void DIALOG_PAGES_SETTINGS::OnDateTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 336 of file dialog_page_settings.cpp.

337 {
338  if( m_initialized && m_TextDate->IsModified() )
339  {
341  m_tb.SetDate( m_TextDate->GetValue() );
343  }
344 }
TITLE_BLOCK m_tb
true if the page selection is custom
void SetDate(const wxString &aDate)
Function SetDate sets the date field, and defaults to the current time and date.
Definition: title_block.h:74
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextDate, TITLE_BLOCK::SetDate(), and UpdatePageLayoutExample().

◆ OnOkClick()

void DIALOG_PAGES_SETTINGS::OnOkClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 233 of file dialog_page_settings.cpp.

234 {
235  if( !m_customSizeX.Validate( Mils2iu( MIN_PAGE_SIZE ), Mils2iu( m_maxPageSizeMils.x ) ) )
236  return;
237 
238  if( !m_customSizeY.Validate( Mils2iu( MIN_PAGE_SIZE ), Mils2iu( m_maxPageSizeMils.y ) ) )
239  return;
240 
241  if( SavePageSettings() )
242  {
243  m_screen->SetModify();
244 
245  if( LocalPrjConfigChanged() )
246  m_parent->SaveProjectSettings( false );
247 
248  // Call the post processing (if any) after changes
250  }
251 
252  event.Skip();
253 }
wxSize m_maxPageSizeMils
Logical page layout size.
virtual bool Validate(int aMin, int aMax, bool setFocusOnError=true)
Function Validate Validates the control against the given range, informing the user of any errors fou...
virtual void SaveProjectSettings(bool aAskForSave)
Save changes to the project settings to the project (.pro) file.
virtual void OnPageSettingsChange()
Called when modifying the page settings.
Definition: draw_frame.h:760
void SetModify()
Definition: base_screen.h:324
#define MIN_PAGE_SIZE
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39

References LocalPrjConfigChanged(), m_customSizeX, m_customSizeY, m_maxPageSizeMils, m_parent, m_screen, MIN_PAGE_SIZE, EDA_DRAW_FRAME::OnPageSettingsChange(), SavePageSettings(), EDA_BASE_FRAME::SaveProjectSettings(), BASE_SCREEN::SetModify(), and UNIT_BINDER::Validate().

◆ OnPageOrientationChoice()

void DIALOG_PAGES_SETTINGS::OnPageOrientationChoice ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 315 of file dialog_page_settings.cpp.

316 {
317  if( m_initialized )
318  {
321  }
322 }
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, and UpdatePageLayoutExample().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 298 of file dialog_shim.cpp.

299 {
300  if( m_firstPaintEvent )
301  {
302 #ifdef __WXMAC__
303  fixOSXCancelButtonIssue( this );
304 #endif
305 
306  selectAllInTextCtrls( GetChildren() );
307 
309  m_initialFocusTarget->SetFocus();
310  else
311  SetFocus(); // Focus the dialog itself
312 
313  m_firstPaintEvent = false;
314  }
315 
316  event.Skip();
317 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180
bool m_firstPaintEvent
Definition: dialog_shim.h:179
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnPaperSizeChoice()

void DIALOG_PAGES_SETTINGS::OnPaperSizeChoice ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 256 of file dialog_page_settings.cpp.

257 {
258  int idx = m_paperSizeComboBox->GetSelection();
259 
260  if( idx < 0 )
261  idx = 0;
262 
263  const wxString paperType = m_pageFmt[idx];
264 
265  if( paperType.Contains( PAGE_INFO::Custom ) )
266  {
267  m_orientationComboBox->Enable( false );
268  m_customSizeX.Enable( true );
269  m_customSizeY.Enable( true );
270  m_customFmt = true;
271  }
272  else
273  {
274  m_orientationComboBox->Enable( true );
275 
276 #if 0
277  // ForcePortrait() does not exist, but could be useful.
278  // so I leave these lines, which could be seen as a todo feature
279  if( paperType.ForcePortrait() )
280  {
281  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
282  m_orientationComboBox->Enable( false );
283  }
284 #endif
285  m_customSizeX.Enable( false );
286  m_customSizeY.Enable( false );
287  m_customFmt = false;
288  }
289 
292 }
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:78
bool m_customFmt
Temporary page info.
void Enable(bool aEnable)
Function Enable Enables/diasables the label, widget and units label.

References PAGE_INFO::Custom, UNIT_BINDER::Enable(), GetPageLayoutInfoFromDialog(), m_customFmt, m_customSizeX, m_customSizeY, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, and UpdatePageLayoutExample().

Referenced by initDialog().

◆ OnRevisionTextUpdated()

void DIALOG_PAGES_SETTINGS::OnRevisionTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 325 of file dialog_page_settings.cpp.

326 {
327  if( m_initialized && m_TextRevision->IsModified() )
328  {
330  m_tb.SetRevision( m_TextRevision->GetValue() );
332  }
333 }
void SetRevision(const wxString &aRevision)
Definition: title_block.h:84
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextRevision, TITLE_BLOCK::SetRevision(), and UpdatePageLayoutExample().

◆ OnTitleTextUpdated()

void DIALOG_PAGES_SETTINGS::OnTitleTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 347 of file dialog_page_settings.cpp.

348 {
349  if( m_initialized && m_TextTitle->IsModified() )
350  {
352  m_tb.SetTitle( m_TextTitle->GetValue() );
354  }
355 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetTitle(const wxString &aTitle)
Definition: title_block.h:60

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextTitle, TITLE_BLOCK::SetTitle(), and UpdatePageLayoutExample().

◆ OnUserPageSizeXTextUpdated()

void DIALOG_PAGES_SETTINGS::OnUserPageSizeXTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 295 of file dialog_page_settings.cpp.

296 {
297  if( m_initialized )
298  {
301  }
302 }
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, and UpdatePageLayoutExample().

◆ OnUserPageSizeYTextUpdated()

void DIALOG_PAGES_SETTINGS::OnUserPageSizeYTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 305 of file dialog_page_settings.cpp.

306 {
307  if( m_initialized )
308  {
311  }
312 }
bool m_initialized
list of page sizes (not translated)

References GetPageLayoutInfoFromDialog(), m_initialized, and UpdatePageLayoutExample().

◆ OnWksFileSelection()

void DIALOG_PAGES_SETTINGS::OnWksFileSelection ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 759 of file dialog_page_settings.cpp.

760 {
761  wxFileName fn = GetWksFileName();
762  wxString name = GetWksFileName();
763  wxString path;
764 
765  if( fn.IsAbsolute() )
766  {
767  path = fn.GetPath();
768  name = fn.GetFullName();
769  }
770  else
771  {
772  path = m_projectPath;
773  }
774 
775  // Display a file picker dialog
776  wxFileDialog fileDialog( this, _( "Select Page Layout Description File" ),
778  wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
779 
780  if( fileDialog.ShowModal() != wxID_OK )
781  return;
782 
783  wxString fileName = fileDialog.GetPath();
784 
785  // Try to remove the path, if the path is the current working dir,
786  // or the dir of kicad.pro (template), and use a relative path
787  wxString shortFileName = WORKSHEET_LAYOUT::MakeShortFileName( fileName, m_projectPath );
788 
789  // For Win/Linux/macOS compatibility, a relative path is a good idea
790  if( shortFileName != GetWksFileName() && shortFileName != fileName )
791  {
792  wxString msg = wxString::Format( _(
793  "The page layout description file name has changed.\n"
794  "Do you want to use the relative path:\n"
795  "\"%s\"\n"
796  "instead of\n"
797  "\"%s\"?" ), GetChars( shortFileName ), GetChars( fileName ) );
798 
799  if( !IsOK( this, msg ) )
800  shortFileName = fileName;
801  }
802 
803  SetWksFileName( shortFileName );
804 
805  if( m_pagelayout == NULL )
807 
808  m_pagelayout->SetPageLayout( fileName );
809 
812 }
wxString PageLayoutDescrFileWildcard()
void SetWksFileName(const wxString &aFilename)
const wxString GetWksFileName()
WORKSHEET_LAYOUT handles the graphic items list to draw/plot the title block and other items (page re...
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
const char * name
Definition: DXF_plotter.cpp:61
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
static const wxString MakeShortFileName(const wxString &aFullFileName, const wxString &aProjectPath)
WORKSHEET_LAYOUT * m_pagelayout
Temporary title block (basic inscriptions).
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:294
void SetPageLayout(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout, or the default layout, if no custom layout available.

References Format(), GetChars(), GetPageLayoutInfoFromDialog(), GetWksFileName(), IsOK(), m_pagelayout, m_projectPath, WORKSHEET_LAYOUT::MakeShortFileName(), name, PageLayoutDescrFileWildcard(), WORKSHEET_LAYOUT::SetPageLayout(), SetWksFileName(), and UpdatePageLayoutExample().

◆ 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:61
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163

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_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), PCB_EDIT_FRAME::doAutoSave(), SCH_DRAWING_TOOLS::doPlaceComponent(), 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::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(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), 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(), 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(), 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_EDITOR_CONTROL::Paste(), 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::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(), 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().

◆ SavePageSettings()

bool DIALOG_PAGES_SETTINGS::SavePageSettings ( )
private

Definition at line 428 of file dialog_page_settings.cpp.

429 {
430  bool success = false;
431 
432  wxString fileName = GetWksFileName();
433 
435  {
436  wxString fullFileName = WORKSHEET_LAYOUT::MakeFullFileName( fileName, m_projectPath );
437 
438  if( !fullFileName.IsEmpty() && !wxFileExists( fullFileName ) )
439  {
440  wxString msg;
441  msg.Printf( _( "Page layout description file \"%s\" not found." ),
442  GetChars( fullFileName ) );
443  wxMessageBox( msg );
444  return false;
445  }
446 
449  pglayout.SetPageLayout( fullFileName );
451  }
452 
453  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
454  const wxString paperType = m_pageFmt[idx];
455 
456  if( paperType.Contains( PAGE_INFO::Custom ) )
457  {
459 
460  success = m_pageInfo.SetType( PAGE_INFO::Custom );
461 
462  if( success )
463  {
466 
469  }
470  }
471  else
472  {
473  // search for longest common string first, e.g. A4 before A
474  if( paperType.Contains( PAGE_INFO::USLetter ) )
476  else if( paperType.Contains( PAGE_INFO::USLegal ) )
478  else if( paperType.Contains( PAGE_INFO::USLedger ) )
480  else if( paperType.Contains( PAGE_INFO::GERBER ) )
481  success = m_pageInfo.SetType( PAGE_INFO::GERBER );
482  else if( paperType.Contains( PAGE_INFO::A4 ) )
483  success = m_pageInfo.SetType( PAGE_INFO::A4 );
484  else if( paperType.Contains( PAGE_INFO::A3 ) )
485  success = m_pageInfo.SetType( PAGE_INFO::A3 );
486  else if( paperType.Contains( PAGE_INFO::A2 ) )
487  success = m_pageInfo.SetType( PAGE_INFO::A2 );
488  else if( paperType.Contains( PAGE_INFO::A1 ) )
489  success = m_pageInfo.SetType( PAGE_INFO::A1 );
490  else if( paperType.Contains( PAGE_INFO::A0 ) )
491  success = m_pageInfo.SetType( PAGE_INFO::A0 );
492  else if( paperType.Contains( PAGE_INFO::A ) )
493  success = m_pageInfo.SetType( PAGE_INFO::A );
494  else if( paperType.Contains( PAGE_INFO::B ) )
495  success = m_pageInfo.SetType( PAGE_INFO::B );
496  else if( paperType.Contains( PAGE_INFO::C ) )
497  success = m_pageInfo.SetType( PAGE_INFO::C );
498  else if( paperType.Contains( PAGE_INFO::D ) )
499  success = m_pageInfo.SetType( PAGE_INFO::D );
500  else if( paperType.Contains( PAGE_INFO::E ) )
501  success = m_pageInfo.SetType( PAGE_INFO::E );
502 
503  if( success )
504  {
505  int choice = m_orientationComboBox->GetSelection();
506  m_pageInfo.SetPortrait( choice != 0 );
507  }
508  }
509 
510  if( !success )
511  {
512  wxASSERT_MSG( false, _( "the translation for paper size must preserve original spellings" ) );
514  }
515 
517 
518  m_tb.SetRevision( m_TextRevision->GetValue() );
519  m_tb.SetDate( m_TextDate->GetValue() );
520  m_tb.SetCompany( m_TextCompany->GetValue() );
521  m_tb.SetTitle( m_TextTitle->GetValue() );
522  m_tb.SetComment1( m_TextComment1->GetValue() );
523  m_tb.SetComment2( m_TextComment2->GetValue() );
524  m_tb.SetComment3( m_TextComment3->GetValue() );
525  m_tb.SetComment4( m_TextComment4->GetValue() );
526 
528 
529 
530 #ifdef EESCHEMA
531  // Exports settings to other sheets if requested:
532  SCH_SCREEN* screen;
533 
534  // Build the screen list
535  SCH_SCREENS ScreenList;
536 
537  // Update title blocks for all screens
538  for( screen = ScreenList.GetFirst(); screen != NULL; screen = ScreenList.GetNext() )
539  {
540  if( screen == m_screen )
541  continue;
542 
543  TITLE_BLOCK tb2 = screen->GetTitleBlock();
544 
545  if( m_RevisionExport->IsChecked() )
546  tb2.SetRevision( m_tb.GetRevision() );
547 
548  if( m_DateExport->IsChecked() )
549  tb2.SetDate( m_tb.GetDate() );
550 
551  if( m_TitleExport->IsChecked() )
552  tb2.SetTitle( m_tb.GetTitle() );
553 
554  if( m_CompanyExport->IsChecked() )
555  tb2.SetCompany( m_tb.GetCompany() );
556 
557  if( m_Comment1Export->IsChecked() )
558  tb2.SetComment1( m_tb.GetComment1() );
559 
560  if( m_Comment2Export->IsChecked() )
561  tb2.SetComment2( m_tb.GetComment2() );
562 
563  if( m_Comment3Export->IsChecked() )
564  tb2.SetComment3( m_tb.GetComment3() );
565 
566  if( m_Comment4Export->IsChecked() )
567  tb2.SetComment4( m_tb.GetComment4() );
568 
569  screen->SetTitleBlock( tb2 );
570  }
571 
572 #endif
573 
574  return true;
575 }
void SetComment1(const wxString &aComment)
Definition: title_block.h:117
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)=0
static const wxChar A[]
Definition: page_info.h:69
SCH_SCREEN * GetNext()
virtual void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)=0
void SetRevision(const wxString &aRevision)
Definition: title_block.h:84
static const wxChar E[]
Definition: page_info.h:73
static const wxChar GERBER[]
Definition: page_info.h:74
TITLE_BLOCK m_tb
true if the page selection is custom
static const wxChar A3[]
Definition: page_info.h:65
static void SetCustomWidthMils(int aWidthInMils)
Function SetCustomWidthMils sets the width of Custom page in mils, for any custom page constructed or...
Definition: page_info.cpp:227
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
const wxString & GetComment4() const
Definition: title_block.h:124
void SetDate(const wxString &aDate)
Function SetDate sets the date field, and defaults to the current time and date.
Definition: title_block.h:74
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:129
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:78
static const wxChar D[]
Definition: page_info.h:72
const wxString GetWksFileName()
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
wxSize m_layout_size
Temporary bitmap for the page layout example.
void SetComment4(const wxString &aComment)
Definition: title_block.h:120
static WORKSHEET_LAYOUT & GetTheInstance()
static function: returns the instance of WORKSHEET_LAYOUT used in the application
static wxString m_PageLayoutDescrFileName
the name of the page layout descr file, or emty to used the default pagelayout
Definition: base_screen.h:180
static const wxChar USLegal[]
Definition: page_info.h:76
static const wxChar B[]
Definition: page_info.h:70
static const wxChar C[]
Definition: page_info.h:71
const wxString & GetRevision() const
Definition: title_block.h:89
const wxString & GetCompany() const
Definition: title_block.h:99
const wxString & GetComment3() const
Definition: title_block.h:123
void SetCompany(const wxString &aCompany)
Definition: title_block.h:94
static const wxChar A4[]
Definition: page_info.h:64
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: sch_screen.h:131
void SetTitle(const wxString &aTitle)
Definition: title_block.h:60
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:253
static const wxChar USLedger[]
Definition: page_info.h:77
WORKSHEET_LAYOUT handles the graphic items list to draw/plot the title block and other items (page re...
static const wxChar A1[]
Definition: page_info.h:67
const wxString & GetDate() const
Definition: title_block.h:79
const wxString & GetComment2() const
Definition: title_block.h:122
static const wxChar USLetter[]
Definition: page_info.h:75
void SetComment2(const wxString &aComment)
Definition: title_block.h:118
PAGE_INFO m_pageInfo
The max page size allowed by the caller frame.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
#define max(a, b)
Definition: auxiliary.h:86
const wxString & GetComment1() const
Definition: title_block.h:121
static const wxString MakeFullFileName(const wxString &aShortFileName, const wxString &aProjectPath)
Static function.
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:239
static const wxChar A2[]
Definition: page_info.h:66
const wxString & GetTitle() const
Definition: title_block.h:65
SCH_SCREEN * GetFirst()
Definition: sch_screen.cpp:996
void SetComment3(const wxString &aComment)
Definition: title_block.h:119
void SetPortrait(bool aIsPortrait)
Function SetPortrait will rotate the paper page 90 degrees.
Definition: page_info.cpp:182
static void SetCustomHeightMils(int aHeightInMils)
Function SetCustomHeightMils sets the height of Custom page in mils, for any custom page constructed ...
Definition: page_info.cpp:233
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:493
void SetPageLayout(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout, or the default layout, if no custom layout available.
static const wxChar A0[]
Definition: page_info.h:68

References PAGE_INFO::A, PAGE_INFO::A0, PAGE_INFO::A1, PAGE_INFO::A2, PAGE_INFO::A3, PAGE_INFO::A4, PAGE_INFO::B, PAGE_INFO::C, PAGE_INFO::Custom, PAGE_INFO::D, PAGE_INFO::E, PAGE_INFO::GERBER, GetChars(), TITLE_BLOCK::GetComment1(), TITLE_BLOCK::GetComment2(), TITLE_BLOCK::GetComment3(), TITLE_BLOCK::GetComment4(), TITLE_BLOCK::GetCompany(), GetCustomSizeMilsFromDialog(), TITLE_BLOCK::GetDate(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), TITLE_BLOCK::GetRevision(), WORKSHEET_LAYOUT::GetTheInstance(), TITLE_BLOCK::GetTitle(), SCH_SCREEN::GetTitleBlock(), GetWksFileName(), DIALOG_PAGES_SETTINGS_BASE::m_Comment1Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment2Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment3Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment4Export, DIALOG_PAGES_SETTINGS_BASE::m_CompanyExport, DIALOG_PAGES_SETTINGS_BASE::m_DateExport, m_layout_size, m_localPrjConfigChanged, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, m_pageInfo, BASE_SCREEN::m_PageLayoutDescrFileName, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, m_projectPath, DIALOG_PAGES_SETTINGS_BASE::m_RevisionExport, m_screen, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment1, DIALOG_PAGES_SETTINGS_BASE::m_TextComment2, DIALOG_PAGES_SETTINGS_BASE::m_TextComment3, DIALOG_PAGES_SETTINGS_BASE::m_TextComment4, DIALOG_PAGES_SETTINGS_BASE::m_TextCompany, DIALOG_PAGES_SETTINGS_BASE::m_TextDate, DIALOG_PAGES_SETTINGS_BASE::m_TextRevision, DIALOG_PAGES_SETTINGS_BASE::m_TextTitle, DIALOG_PAGES_SETTINGS_BASE::m_TitleExport, WORKSHEET_LAYOUT::MakeFullFileName(), max, TITLE_BLOCK::SetComment1(), TITLE_BLOCK::SetComment2(), TITLE_BLOCK::SetComment3(), TITLE_BLOCK::SetComment4(), TITLE_BLOCK::SetCompany(), PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), TITLE_BLOCK::SetDate(), PAGE_INFO::SetHeightMils(), WORKSHEET_LAYOUT::SetPageLayout(), EDA_DRAW_FRAME::SetPageSettings(), PAGE_INFO::SetPortrait(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), SCH_SCREEN::SetTitleBlock(), EDA_DRAW_FRAME::SetTitleBlock(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMils(), PAGE_INFO::USLedger, PAGE_INFO::USLegal, and PAGE_INFO::USLetter.

Referenced by OnOkClick().

◆ SetCurrentPageSizeSelection()

void DIALOG_PAGES_SETTINGS::SetCurrentPageSizeSelection ( const wxString &  aPaperSize)
private

Definition at line 578 of file dialog_page_settings.cpp.

579 {
580  // search all the not translated label list containing our paper type
581  for( unsigned i = 0; i < m_pageFmt.GetCount(); ++i )
582  {
583  // parse each label looking for aPaperSize within it
584  wxStringTokenizer st( m_pageFmt[i] );
585 
586  while( st.HasMoreTokens() )
587  {
588  if( st.GetNextToken() == aPaperSize )
589  {
590  m_paperSizeComboBox->SetSelection( i );
591  return;
592  }
593  }
594  }
595 }
size_t i
Definition: json11.cpp:597

References i, m_pageFmt, and DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox.

Referenced by initDialog().

◆ 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_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_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 53 of file kiway_holder.cpp.

54 {
55 #if defined(DEBUG)
56  // offer a trap point for debugging most any window
57  wxASSERT( aDest );
58  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
59  {
60  int breakhere=1;
61  (void) breakhere;
62  }
63 #endif
64 
65  (void) aDest;
66 
67  m_kiway = aKiway;
68 }
KIWAY * m_kiway
Definition: kiway_player.h:101
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().

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

151 {
152  wxSize sz( x, y );
153  SetSize( ConvertDialogToPixels( sz ) );
154 }

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().

◆ SetWksFileName()

void DIALOG_PAGES_SETTINGS::SetWksFileName ( const wxString &  aFilename)
inline

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 178 of file dialog_shim.cpp.

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

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

◆ UpdatePageLayoutExample()

void DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample ( )
private

Definition at line 598 of file dialog_page_settings.cpp.

599 {
600  int lyWidth, lyHeight;
601 
602  wxSize clamped_layout_size( Clamp( MIN_PAGE_SIZE, m_layout_size.x, m_maxPageSizeMils.x ),
604 
605  double lyRatio = clamped_layout_size.x < clamped_layout_size.y ?
606  (double) clamped_layout_size.y / clamped_layout_size.x :
607  (double) clamped_layout_size.x / clamped_layout_size.y;
608 
609  if( clamped_layout_size.x < clamped_layout_size.y )
610  {
611  lyHeight = MAX_PAGE_EXAMPLE_SIZE;
612  lyWidth = KiROUND( (double) lyHeight / lyRatio );
613  }
614  else
615  {
616  lyWidth = MAX_PAGE_EXAMPLE_SIZE;
617  lyHeight = KiROUND( (double) lyWidth / lyRatio );
618  }
619 
620  if( m_page_bitmap )
621  {
622  m_PageLayoutExampleBitmap->SetBitmap( wxNullBitmap );
623  delete m_page_bitmap;
624  }
625 
626  m_page_bitmap = new wxBitmap( lyWidth + 1, lyHeight + 1 );
627 
628  if( m_page_bitmap->IsOk() )
629  {
630  double scaleW = (double) lyWidth / clamped_layout_size.x;
631  double scaleH = (double) lyHeight / clamped_layout_size.y;
632 
633  // Prepare DC.
634  wxSize example_size( lyWidth + 1, lyHeight + 1 );
635  wxMemoryDC memDC;
636  memDC.SelectObject( *m_page_bitmap );
637  memDC.SetClippingRegion( wxPoint( 0, 0 ), example_size );
638  memDC.Clear();
639  memDC.SetUserScale( scaleW, scaleH );
640 
641  // Get logical page size and margins.
642  PAGE_INFO pageDUMMY;
643 
644  // Get page type
645  int idx = m_paperSizeComboBox->GetSelection();
646 
647  if( idx < 0 )
648  idx = 0;
649 
650  wxString pageFmtName = m_pageFmt[idx].BeforeFirst( ' ' );
651  bool portrait = clamped_layout_size.x < clamped_layout_size.y;
652  pageDUMMY.SetType( pageFmtName, portrait );
653  if( m_customFmt )
654  {
655  pageDUMMY.SetWidthMils( clamped_layout_size.x );
656  pageDUMMY.SetHeightMils( clamped_layout_size.y );
657  }
658 
659  // Draw layout preview.
660  wxString emptyString;
661  GRResetPenAndBrush( &memDC );
662 
664  GRFilledRect( NULL, &memDC, 0, 0, m_layout_size.x, m_layout_size.y, WHITE, WHITE );
665  DrawPageLayout( &memDC, NULL, pageDUMMY,
666  emptyString, emptyString,
668  m_screen->m_ScreenNumber, 1, 1, DARKGRAY, RED );
669 
670  memDC.SelectObject( wxNullBitmap );
673 
674  // Refresh the dialog.
675  Layout();
676  Refresh();
677  }
678 }
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:123
int m_ScreenNumber
Definition: base_screen.h:216
wxSize m_maxPageSizeMils
Logical page layout size.
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: macros.h:138
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:118
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:1043
TITLE_BLOCK m_tb
true if the page selection is custom
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
#define MAX_PAGE_EXAMPLE_SIZE
wxSize m_layout_size
Temporary bitmap for the page layout example.
wxBitmap * m_page_bitmap
the page layuout filename was changed
void DrawPageLayout(wxDC *aDC, EDA_RECT *aClipBox, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, int aPenWidth, double aScalar, COLOR4D aColor, COLOR4D aAltColor, const wxString &aSheetLayer)
Function DrawPageLayout is a core function to draw the page layout with the frame and the basic inscr...
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
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
Definition: colors.h:60
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:253
WORKSHEET_LAYOUT * m_pagelayout
Temporary title block (basic inscriptions).
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:239
Definition: colors.h:49
bool m_customFmt
Temporary page info.
int m_NumberOfScreens
Definition: base_screen.h:217
#define MIN_PAGE_SIZE
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39
static void SetAltInstance(WORKSHEET_LAYOUT *aLayout=NULL)
static function: Set an alternate instance of WORKSHEET_LAYOUT mainly used in page setting dialog

References Clamp(), DARKGRAY, DrawPageLayout(), GRFilledRect(), GRResetPenAndBrush(), KiROUND(), m_customFmt, m_layout_size, m_maxPageSizeMils, BASE_SCREEN::m_NumberOfScreens, m_page_bitmap, m_pageFmt, m_pagelayout, DIALOG_PAGES_SETTINGS_BASE::m_PageLayoutExampleBitmap, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_screen, BASE_SCREEN::m_ScreenNumber, m_tb, MAX_PAGE_EXAMPLE_SIZE, MIN_PAGE_SIZE, RED, Refresh(), WORKSHEET_LAYOUT::SetAltInstance(), PAGE_INFO::SetHeightMils(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMils(), and WHITE.

Referenced by initDialog(), OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnCompanyTextUpdated(), OnDateTextUpdated(), OnPageOrientationChoice(), OnPaperSizeChoice(), OnRevisionTextUpdated(), OnTitleTextUpdated(), OnUserPageSizeXTextUpdated(), OnUserPageSizeYTextUpdated(), and OnWksFileSelection().

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

165 {
166  wxSize sz( 0, y );
167  return ConvertDialogToPixels( sz ).y;
168 }

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

Member Data Documentation

◆ m_ApplyDate

wxButton* DIALOG_PAGES_SETTINGS_BASE::m_ApplyDate
protectedinherited

◆ m_buttonBrowse

wxButton* DIALOG_PAGES_SETTINGS_BASE::m_buttonBrowse
protectedinherited

◆ m_Comment1Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment1Export
protectedinherited

◆ m_Comment2Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment2Export
protectedinherited

◆ m_Comment3Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment3Export
protectedinherited

◆ m_Comment4Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment4Export
protectedinherited

◆ m_CompanyExport

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_CompanyExport
protectedinherited

◆ m_customFmt

bool DIALOG_PAGES_SETTINGS::m_customFmt
private

Temporary page info.

Definition at line 47 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), initDialog(), OnPaperSizeChoice(), and UpdatePageLayoutExample().

◆ m_customSizeX

UNIT_BINDER DIALOG_PAGES_SETTINGS::m_customSizeX
private

◆ m_customSizeY

UNIT_BINDER DIALOG_PAGES_SETTINGS::m_customSizeY
private

◆ m_DateExport

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_DateExport
protectedinherited

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

◆ m_layout_size

wxSize DIALOG_PAGES_SETTINGS::m_layout_size
private

Temporary bitmap for the page layout example.

Definition at line 44 of file dialog_page_settings.h.

Referenced by GetCustomSizeMilsFromDialog(), GetPageLayoutInfoFromDialog(), SavePageSettings(), and UpdatePageLayoutExample().

◆ m_localPrjConfigChanged

bool DIALOG_PAGES_SETTINGS::m_localPrjConfigChanged
private

◆ m_maxPageSizeMils

wxSize DIALOG_PAGES_SETTINGS::m_maxPageSizeMils
private

Logical page layout size.

Definition at line 45 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), OnOkClick(), and UpdatePageLayoutExample().

◆ m_orientationComboBox

◆ m_page_bitmap

wxBitmap* DIALOG_PAGES_SETTINGS::m_page_bitmap
private

the page layuout filename was changed

Definition at line 43 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), UpdatePageLayoutExample(), and ~DIALOG_PAGES_SETTINGS().

◆ m_pageFmt

wxArrayString DIALOG_PAGES_SETTINGS::m_pageFmt
private

◆ m_pageInfo

PAGE_INFO DIALOG_PAGES_SETTINGS::m_pageInfo
private

The max page size allowed by the caller frame.

Definition at line 46 of file dialog_page_settings.h.

Referenced by initDialog(), and SavePageSettings().

◆ m_pagelayout

WORKSHEET_LAYOUT* DIALOG_PAGES_SETTINGS::m_pagelayout
private

Temporary title block (basic inscriptions).

Definition at line 49 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), OnWksFileSelection(), UpdatePageLayoutExample(), and ~DIALOG_PAGES_SETTINGS().

◆ m_PageLayoutExampleBitmap

wxStaticBitmap* DIALOG_PAGES_SETTINGS_BASE::m_PageLayoutExampleBitmap
protectedinherited

◆ m_paperSizeComboBox

◆ m_parent

EDA_DRAW_FRAME* DIALOG_PAGES_SETTINGS::m_parent
private

◆ m_PickDate

wxDatePickerCtrl* DIALOG_PAGES_SETTINGS_BASE::m_PickDate
protectedinherited

◆ m_projectPath

wxString DIALOG_PAGES_SETTINGS::m_projectPath
private

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

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_RevisionExport
protectedinherited

◆ m_screen

BASE_SCREEN* DIALOG_PAGES_SETTINGS::m_screen
private

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_PAGES_SETTINGS_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_PAGES_SETTINGS_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_PAGES_SETTINGS_BASE::m_sdbSizerOK
protectedinherited

◆ m_staticline2

wxStaticLine* DIALOG_PAGES_SETTINGS_BASE::m_staticline2
protectedinherited

◆ m_staticline3

wxStaticLine* DIALOG_PAGES_SETTINGS_BASE::m_staticline3
protectedinherited

◆ m_staticText13

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticText13
protectedinherited

◆ m_staticTextComment1

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment1
protectedinherited

◆ m_staticTextComment2

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment2
protectedinherited

◆ m_staticTextComment3

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment3
protectedinherited

◆ m_staticTextComment4

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment4
protectedinherited

◆ m_staticTextCustSize

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextCustSize
protectedinherited

◆ m_staticTextDate

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextDate
protectedinherited

◆ m_staticTextfilename

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextfilename
protectedinherited

◆ m_staticTextOrient

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextOrient
protectedinherited

◆ m_staticTextPaper

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextPaper
protectedinherited

◆ m_staticTextPreview

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextPreview
protectedinherited

◆ m_staticTextRev

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextRev
protectedinherited

◆ m_staticTextSize

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextSize
protectedinherited

◆ m_staticTexttbprm

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTexttbprm
protectedinherited

◆ m_staticTextTitle

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextTitle
protectedinherited

◆ m_tb

◆ m_TextComment1

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment1
protectedinherited

◆ m_TextComment2

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment2
protectedinherited

◆ m_TextComment3

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment3
protectedinherited

◆ m_TextComment4

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment4
protectedinherited

◆ m_TextCompany

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextCompany
protectedinherited

◆ m_textCtrlFilePicker

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker
protectedinherited

◆ m_TextDate

◆ m_TextRevision

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextRevision
protectedinherited

◆ m_TextSheetCount

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_TextSheetCount
protectedinherited

◆ m_TextSheetNumber

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_TextSheetNumber
protectedinherited

◆ m_TextTitle

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextTitle
protectedinherited

◆ m_TitleExport

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_TitleExport
protectedinherited

◆ m_units

◆ m_userSizeXCtrl

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_userSizeXCtrl
protectedinherited

◆ m_userSizeXLabel

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_userSizeXLabel
protectedinherited

◆ m_userSizeXUnits

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_userSizeXUnits
protectedinherited

◆ m_userSizeYCtrl

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_userSizeYCtrl
protectedinherited

◆ m_userSizeYLabel

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_userSizeYLabel
protectedinherited

◆ m_userSizeYUnits

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_userSizeYUnits
protectedinherited

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