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 Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

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
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

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_staticTextTitleBlock
 
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...
 
WS_DATA_MODELm_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 36 of file dialog_page_settings.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS ( EDA_DRAW_FRAME parent,
wxSize  aMaxUserSizeMils 
)

Definition at line 77 of file dialog_page_settings.cpp.

77  :
79  m_initialized( false ),
82 {
83  m_parent = parent;
86  m_page_bitmap = NULL;
87  m_maxPageSizeMils = aMaxUserSizeMils;
89  m_customFmt = false;
91 
93  wxString serialization;
95  m_pagelayout->SetPageLayout( TO_UTF8( serialization ) );
96 
97  m_PickDate->SetValue( wxDateTime::Now() );
98 
99  if( parent->GetName() == PL_EDITOR_FRAME_NAME )
100  {
101  SetTitle( _( "Preview Settings" ) );
102  m_staticTextPaper->SetLabel( _( "Preview Paper" ) );
103  m_staticTextTitleBlock->SetLabel( _( "Preview Title Block Data" ) );
104  }
105  else
106  {
107  SetTitle( _( "Page Settings" ) );
108  m_staticTextPaper->SetLabel( _( "Paper" ) );
109  m_staticTextTitleBlock->SetLabel( _( "Title Block" ) );
110  }
111 
112  initDialog();
113 
114  GetSizer()->SetSizeHints( this );
115  Centre();
116 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
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)
#define PL_EDITOR_FRAME_NAME
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.
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
static WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL used in the application
wxBitmap * m_page_bitmap
the page layuout filename was changed
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
WS_DATA_MODEL * 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.
void SaveInString(wxString &aOutputString)
Save the description in a buffer.

References _, PROJECT::GetProjectPath(), EDA_DRAW_FRAME::GetScreen(), WS_DATA_MODEL::GetTheInstance(), 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, DIALOG_PAGES_SETTINGS_BASE::m_staticTextPaper, DIALOG_PAGES_SETTINGS_BASE::m_staticTextTitleBlock, m_tb, PL_EDITOR_FRAME_NAME, KIWAY_HOLDER::Prj(), WS_DATA_MODEL::SaveInString(), WS_DATA_MODEL::SetPageLayout(), and TO_UTF8.

◆ ~DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::~DIALOG_PAGES_SETTINGS ( )

Definition at line 119 of file dialog_page_settings.cpp.

120 {
121  delete m_page_bitmap;
122  delete m_pagelayout;
123 }
wxBitmap * m_page_bitmap
the page layuout filename was changed
WS_DATA_MODEL * 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 239 of file dialog_shim.cpp.

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

◆ EnableWksFileNamePicker()

void DIALOG_PAGES_SETTINGS::EnableWksFileNamePicker ( bool  aEnable)
inline

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 399 of file dialog_shim.cpp.

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

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

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

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_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_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_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(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetCustomSizeMilsFromDialog()

void DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog ( )
private

Definition at line 719 of file dialog_page_settings.cpp.

720 {
721  double customSizeX = (double) m_customSizeX.GetValue() / IU_PER_MILS;
722  double customSizeY = (double) m_customSizeY.GetValue() / IU_PER_MILS;
723 
724  // Prepare to painless double -> int conversion.
725  customSizeX = Clamp( double( INT_MIN ), customSizeX, double( INT_MAX ) );
726  customSizeY = Clamp( double( INT_MIN ), customSizeY, double( INT_MAX ) );
727  m_layout_size = wxSize( KiROUND( customSizeX ), KiROUND( customSizeY ) );
728 }
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:139
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:115
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 653 of file dialog_page_settings.cpp.

654 {
655  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
656  const wxString paperType = m_pageFmt[idx];
657 
658  // here we assume translators will keep original paper size spellings
659  if( paperType.Contains( PAGE_INFO::Custom ) )
660  {
662 
663  if( m_layout_size.x && m_layout_size.y )
664  {
665  if( m_layout_size.x < m_layout_size.y )
666  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
667  else
668  m_orientationComboBox->SetStringSelection( _( "Landscape" ) );
669  }
670  }
671  else
672  {
673  PAGE_INFO pageInfo; // SetType() later to lookup size
674 
675  static const wxChar* papers[] = {
676  // longest common string first, since sequential search below
682  PAGE_INFO::A,
683  PAGE_INFO::B,
684  PAGE_INFO::C,
685  PAGE_INFO::D,
686  PAGE_INFO::E,
690  };
691 
692  unsigned i;
693 
694  for( i=0; i < arrayDim( papers ); ++i )
695  {
696  if( paperType.Contains( papers[i] ) )
697  {
698  pageInfo.SetType( papers[i] );
699  break;
700  }
701  }
702 
703  wxASSERT( i != arrayDim(papers) ); // dialog UI match the above list?
704 
705  m_layout_size = pageInfo.GetSizeMils();
706 
707  // swap sizes to match orientation
708  bool isPortrait = (bool) m_orientationComboBox->GetSelection();
709 
710  if( ( isPortrait && m_layout_size.x >= m_layout_size.y ) ||
711  ( !isPortrait && m_layout_size.x < m_layout_size.y ) )
712  {
714  }
715  }
716 }
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
#define _(s)
static const wxChar USLedger[]
Definition: page_info.h:77
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
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().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

◆ GetWksFileName()

const wxString DIALOG_PAGES_SETTINGS::GetWksFileName ( )
inline

Definition at line 60 of file dialog_page_settings.h.

61  {
62  return m_textCtrlFilePicker->GetValue();
63  }

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

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

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 126 of file dialog_page_settings.cpp.

127 {
128  wxString msg;
129 
130  // initialize page format choice box and page format list.
131  // The first shows translated strings, the second contains not translated strings
132  m_paperSizeComboBox->Clear();
133 
134  for( const wxString& pageFmt : pageFmts )
135  {
136  m_pageFmt.Add( pageFmt );
137  m_paperSizeComboBox->Append( wxGetTranslation( pageFmt ) );
138  }
139 
140  // initialize the page layout descr filename
142 
143 #ifdef EESCHEMA
144  // Init display value for schematic sub-sheet number
145  wxString format = m_TextSheetCount->GetLabel();
146  msg.Printf( format, m_screen->m_NumberOfScreens );
147  m_TextSheetCount->SetLabel( msg );
148 
149  format = m_TextSheetNumber->GetLabel();
150  msg.Printf( format, m_screen->m_ScreenNumber );
151  m_TextSheetNumber->SetLabel( msg );
152 #else
153  m_TextSheetCount->Show( false );
154  m_TextSheetNumber->Show( false );
155 #endif
156 
159  m_orientationComboBox->SetSelection( m_pageInfo.IsPortrait() );
160 
161  // only a click fires the "selection changed" event, so have to fabricate this check
162  wxCommandEvent dummy;
164 
165  if( m_customFmt )
166  {
169  }
170  else
171  {
174  }
175 
176  m_TextRevision->SetValue( m_tb.GetRevision() );
177  m_TextDate->SetValue( m_tb.GetDate() );
178  m_TextTitle->SetValue( m_tb.GetTitle() );
179  m_TextCompany->SetValue( m_tb.GetCompany() );
180  m_TextComment1->SetValue( m_tb.GetComment1() );
181  m_TextComment2->SetValue( m_tb.GetComment2() );
182  m_TextComment3->SetValue( m_tb.GetComment3() );
183  m_TextComment4->SetValue( m_tb.GetComment4() );
184 
185 #ifndef EESCHEMA
186  // these options have meaning only for Eeschema.
187  // disable them for other apps
188  m_RevisionExport->Show( false );
189  m_DateExport->Show( false );
190  m_TitleExport->Show( false );
191  m_CompanyExport->Show( false );
192  m_Comment1Export->Show( false );
193  m_Comment2Export->Show( false );
194  m_Comment3Export->Show( false );
195  m_Comment4Export->Show( false );
196 #endif
197 
200 
201  // Make the OK button the default.
202  m_sdbSizerOK->SetDefault();
203  m_initialized = true;
204 }
int m_ScreenNumber
Definition: base_screen.h:135
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:109
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)
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 to draw a dummy shape when a LIB_PART is not found in library.
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:136
const wxString & GetTitle() const
Definition: title_block.h:65
void OnPaperSizeChoice(wxCommandEvent &event) override
int GetWidthMils() const
Definition: page_info.h:137

References 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 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), 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(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), 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(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), 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 121 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 343 of file dialog_page_settings.cpp.

344 {
345  if( m_initialized && m_TextComment1->IsModified() )
346  {
348  m_tb.SetComment1( m_TextComment1->GetValue() );
350  }
351 }
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 354 of file dialog_page_settings.cpp.

355 {
356  if( m_initialized && m_TextComment2->IsModified() )
357  {
359  m_tb.SetComment2( m_TextComment2->GetValue() );
361  }
362 }
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 365 of file dialog_page_settings.cpp.

366 {
367  if( m_initialized && m_TextComment3->IsModified() )
368  {
370  m_tb.SetComment3( m_TextComment3->GetValue() );
372  }
373 }
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 376 of file dialog_page_settings.cpp.

377 {
378  if( m_initialized && m_TextComment4->IsModified() )
379  {
381  m_tb.SetComment4( m_TextComment4->GetValue() );
383  }
384 }
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 332 of file dialog_page_settings.cpp.

333 {
334  if( m_initialized && m_TextCompany->IsModified() )
335  {
337  m_tb.SetCompany( m_TextCompany->GetValue() );
339  }
340 }
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 387 of file dialog_page_settings.cpp.

388 {
389  wxDateTime datetime = m_PickDate->GetValue();
390  wxString date =
391  // We can choose different formats. Only one must be uncommented
392  //
393  // datetime.Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
394  // datetime.Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
395  // datetime.Format( wxT("%Y-%b-%d") );
396  datetime.FormatISODate();
397 
398  m_TextDate->SetValue( date );
399 }

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 310 of file dialog_page_settings.cpp.

311 {
312  if( m_initialized && m_TextDate->IsModified() )
313  {
315  m_tb.SetDate( m_TextDate->GetValue() );
317  }
318 }
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 207 of file dialog_page_settings.cpp.

208 {
209  if( !m_customSizeX.Validate( Mils2iu( MIN_PAGE_SIZE ), Mils2iu( m_maxPageSizeMils.x ) ) )
210  return;
211 
212  if( !m_customSizeY.Validate( Mils2iu( MIN_PAGE_SIZE ), Mils2iu( m_maxPageSizeMils.y ) ) )
213  return;
214 
215  if( SavePageSettings() )
216  {
217  m_screen->SetModify();
218 
219  if( LocalPrjConfigChanged() )
220  m_parent->SaveProjectSettings( false );
221 
222  // Call the post processing (if any) after changes
224  }
225 
226  event.Skip();
227 }
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.
void SetModify()
Definition: base_screen.h:224
#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 289 of file dialog_page_settings.cpp.

290 {
291  if( m_initialized )
292  {
295  }
296 }
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 300 of file dialog_shim.cpp.

301 {
302  if( m_firstPaintEvent )
303  {
304 #ifdef __WXMAC__
305  fixOSXCancelButtonIssue( this );
306 #endif
307 
308  selectAllInTextCtrls( GetChildren() );
309 
311  m_initialFocusTarget->SetFocus();
312  else
313  SetFocus(); // Focus the dialog itself
314 
315  m_firstPaintEvent = false;
316  }
317 
318  event.Skip();
319 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:182
bool m_firstPaintEvent
Definition: dialog_shim.h:181
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 230 of file dialog_page_settings.cpp.

231 {
232  int idx = m_paperSizeComboBox->GetSelection();
233 
234  if( idx < 0 )
235  idx = 0;
236 
237  const wxString paperType = m_pageFmt[idx];
238 
239  if( paperType.Contains( PAGE_INFO::Custom ) )
240  {
241  m_orientationComboBox->Enable( false );
242  m_customSizeX.Enable( true );
243  m_customSizeY.Enable( true );
244  m_customFmt = true;
245  }
246  else
247  {
248  m_orientationComboBox->Enable( true );
249 
250 #if 0
251  // ForcePortrait() does not exist, but could be useful.
252  // so I leave these lines, which could be seen as a todo feature
253  if( paperType.ForcePortrait() )
254  {
255  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
256  m_orientationComboBox->Enable( false );
257  }
258 #endif
259  m_customSizeX.Enable( false );
260  m_customSizeY.Enable( false );
261  m_customFmt = false;
262  }
263 
266 }
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:78
#define _(s)
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 299 of file dialog_page_settings.cpp.

300 {
301  if( m_initialized && m_TextRevision->IsModified() )
302  {
304  m_tb.SetRevision( m_TextRevision->GetValue() );
306  }
307 }
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 321 of file dialog_page_settings.cpp.

322 {
323  if( m_initialized && m_TextTitle->IsModified() )
324  {
326  m_tb.SetTitle( m_TextTitle->GetValue() );
328  }
329 }
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 269 of file dialog_page_settings.cpp.

270 {
271  if( m_initialized )
272  {
275  }
276 }
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 279 of file dialog_page_settings.cpp.

280 {
281  if( m_initialized )
282  {
285  }
286 }
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 731 of file dialog_page_settings.cpp.

732 {
733  wxFileName fn = GetWksFileName();
734  wxString name = GetWksFileName();
735  wxString path;
736 
737  if( fn.IsAbsolute() )
738  {
739  path = fn.GetPath();
740  name = fn.GetFullName();
741  }
742  else
743  {
744  path = m_projectPath;
745  }
746 
747  // Display a file picker dialog
748  wxFileDialog fileDialog( this, _( "Select Page Layout Description File" ),
750  wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
751 
752  if( fileDialog.ShowModal() != wxID_OK )
753  return;
754 
755  wxString fileName = fileDialog.GetPath();
756 
757  // Try to remove the path, if the path is the current working dir,
758  // or the dir of kicad.pro (template), and use a relative path
759  wxString shortFileName = WS_DATA_MODEL::MakeShortFileName( fileName, m_projectPath );
760 
761  // For Win/Linux/macOS compatibility, a relative path is a good idea
762  if( shortFileName != GetWksFileName() && shortFileName != fileName )
763  {
764  wxString msg = wxString::Format( _(
765  "The page layout description file name has changed.\n"
766  "Do you want to use the relative path:\n"
767  "\"%s\"\n"
768  "instead of\n"
769  "\"%s\"?" ), GetChars( shortFileName ), GetChars( fileName ) );
770 
771  if( !IsOK( this, msg ) )
772  shortFileName = fileName;
773  }
774 
775  SetWksFileName( shortFileName );
776 
777  if( m_pagelayout == NULL )
779 
780  m_pagelayout->SetPageLayout( fileName );
781 
784 }
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
wxString PageLayoutDescrFileWildcard()
void SetWksFileName(const wxString &aFilename)
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.
const wxString GetWksFileName()
static const wxString MakeShortFileName(const wxString &aFullFileName, const wxString &aProjectPath)
#define _(s)
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:101
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
WS_DATA_MODEL * m_pagelayout
Temporary title block (basic inscriptions).
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:294

References _, Format(), GetChars(), GetPageLayoutInfoFromDialog(), GetWksFileName(), IsOK(), m_pagelayout, m_projectPath, WS_DATA_MODEL::MakeShortFileName(), name, PageLayoutDescrFileWildcard(), WS_DATA_MODEL::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_holder.h:56
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(), LIB_CONTROL::AddSymbolToSchematic(), 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_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), 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(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), 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(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), 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 402 of file dialog_page_settings.cpp.

403 {
404  bool success = false;
405 
406  wxString fileName = GetWksFileName();
407 
409  {
410  wxString fullFileName = WS_DATA_MODEL::MakeFullFileName( fileName, m_projectPath );
411 
412  if( !fullFileName.IsEmpty() && !wxFileExists( fullFileName ) )
413  {
414  wxString msg;
415  msg.Printf( _( "Page layout description file \"%s\" not found." ),
416  GetChars( fullFileName ) );
417  wxMessageBox( msg );
418  return false;
419  }
420 
423  pglayout.SetPageLayout( fullFileName );
425  }
426 
427  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
428  const wxString paperType = m_pageFmt[idx];
429 
430  if( paperType.Contains( PAGE_INFO::Custom ) )
431  {
433 
434  success = m_pageInfo.SetType( PAGE_INFO::Custom );
435 
436  if( success )
437  {
440 
443  }
444  }
445  else
446  {
447  // search for longest common string first, e.g. A4 before A
448  if( paperType.Contains( PAGE_INFO::USLetter ) )
450  else if( paperType.Contains( PAGE_INFO::USLegal ) )
452  else if( paperType.Contains( PAGE_INFO::USLedger ) )
454  else if( paperType.Contains( PAGE_INFO::GERBER ) )
455  success = m_pageInfo.SetType( PAGE_INFO::GERBER );
456  else if( paperType.Contains( PAGE_INFO::A4 ) )
457  success = m_pageInfo.SetType( PAGE_INFO::A4 );
458  else if( paperType.Contains( PAGE_INFO::A3 ) )
459  success = m_pageInfo.SetType( PAGE_INFO::A3 );
460  else if( paperType.Contains( PAGE_INFO::A2 ) )
461  success = m_pageInfo.SetType( PAGE_INFO::A2 );
462  else if( paperType.Contains( PAGE_INFO::A1 ) )
463  success = m_pageInfo.SetType( PAGE_INFO::A1 );
464  else if( paperType.Contains( PAGE_INFO::A0 ) )
465  success = m_pageInfo.SetType( PAGE_INFO::A0 );
466  else if( paperType.Contains( PAGE_INFO::A ) )
467  success = m_pageInfo.SetType( PAGE_INFO::A );
468  else if( paperType.Contains( PAGE_INFO::B ) )
469  success = m_pageInfo.SetType( PAGE_INFO::B );
470  else if( paperType.Contains( PAGE_INFO::C ) )
471  success = m_pageInfo.SetType( PAGE_INFO::C );
472  else if( paperType.Contains( PAGE_INFO::D ) )
473  success = m_pageInfo.SetType( PAGE_INFO::D );
474  else if( paperType.Contains( PAGE_INFO::E ) )
475  success = m_pageInfo.SetType( PAGE_INFO::E );
476 
477  if( success )
478  {
479  int choice = m_orientationComboBox->GetSelection();
480  m_pageInfo.SetPortrait( choice != 0 );
481  }
482  }
483 
484  if( !success )
485  {
486  wxASSERT_MSG( false, _( "the translation for paper size must preserve original spellings" ) );
488  }
489 
491 
492  m_tb.SetRevision( m_TextRevision->GetValue() );
493  m_tb.SetDate( m_TextDate->GetValue() );
494  m_tb.SetCompany( m_TextCompany->GetValue() );
495  m_tb.SetTitle( m_TextTitle->GetValue() );
496  m_tb.SetComment1( m_TextComment1->GetValue() );
497  m_tb.SetComment2( m_TextComment2->GetValue() );
498  m_tb.SetComment3( m_TextComment3->GetValue() );
499  m_tb.SetComment4( m_TextComment4->GetValue() );
500 
502 
503 
504 #ifdef EESCHEMA
505  // Exports settings to other sheets if requested:
506  SCH_SCREEN* screen;
507 
508  // Build the screen list
509  SCH_SCREENS ScreenList;
510 
511  // Update title blocks for all screens
512  for( screen = ScreenList.GetFirst(); screen != NULL; screen = ScreenList.GetNext() )
513  {
514  if( screen == m_screen )
515  continue;
516 
517  TITLE_BLOCK tb2 = screen->GetTitleBlock();
518 
519  if( m_RevisionExport->IsChecked() )
520  tb2.SetRevision( m_tb.GetRevision() );
521 
522  if( m_DateExport->IsChecked() )
523  tb2.SetDate( m_tb.GetDate() );
524 
525  if( m_TitleExport->IsChecked() )
526  tb2.SetTitle( m_tb.GetTitle() );
527 
528  if( m_CompanyExport->IsChecked() )
529  tb2.SetCompany( m_tb.GetCompany() );
530 
531  if( m_Comment1Export->IsChecked() )
532  tb2.SetComment1( m_tb.GetComment1() );
533 
534  if( m_Comment2Export->IsChecked() )
535  tb2.SetComment2( m_tb.GetComment2() );
536 
537  if( m_Comment3Export->IsChecked() )
538  tb2.SetComment3( m_tb.GetComment3() );
539 
540  if( m_Comment4Export->IsChecked() )
541  tb2.SetComment4( m_tb.GetComment4() );
542 
543  screen->SetTitleBlock( tb2 );
544  }
545 
546 #endif
547 
548  return true;
549 }
void SetComment1(const wxString &aComment)
Definition: title_block.h:117
WS_DATA_MODEL handles the graphic items list to draw/plot the frame and title block.
Definition: ws_data_model.h:39
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:123
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 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 WS_DATA_MODEL & GetTheInstance()
static function: returns the instance of WS_DATA_MODEL 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:109
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:125
void SetTitle(const wxString &aTitle)
Definition: title_block.h:60
#define _(s)
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:253
static const wxChar USLedger[]
Definition: page_info.h:77
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:101
static const wxString MakeFullFileName(const wxString &aShortFileName, const wxString &aProjectPath)
Static function.
#define max(a, b)
Definition: auxiliary.h:86
const wxString & GetComment1() const
Definition: title_block.h:121
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()
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:486
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(), WS_DATA_MODEL::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, WS_DATA_MODEL::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(), WS_DATA_MODEL::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 552 of file dialog_page_settings.cpp.

553 {
554  // search all the not translated label list containing our paper type
555  for( unsigned i = 0; i < m_pageFmt.GetCount(); ++i )
556  {
557  // parse each label looking for aPaperSize within it
558  wxStringTokenizer st( m_pageFmt[i] );
559 
560  while( st.HasMoreTokens() )
561  {
562  if( st.GetNextToken() == aPaperSize )
563  {
564  m_paperSizeComboBox->SetSelection( i );
565  return;
566  }
567  }
568  }
569 }
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 118 of file dialog_shim.h.

119  {
120  m_initialFocusTarget = aWindow;
121  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:182

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_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_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 41 of file kiway_holder.cpp.

42 {
43 #if defined(DEBUG)
44  // offer a trap point for debugging most any window
45  wxASSERT( aDest );
46  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
47  {
48  int breakhere=1;
49  (void) breakhere;
50  }
51 #endif
52 
53  (void) aDest;
54 
55  m_kiway = aKiway;
56 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
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 152 of file dialog_shim.cpp.

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

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 345 of file dialog_shim.cpp.

346 {
347  // This is an exception safe way to zero a pointer before returning.
348  // Yes, even though DismissModal() clears this first normally, this is
349  // here in case there's an exception before the dialog is dismissed.
350  struct NULLER
351  {
352  void*& m_what;
353  NULLER( void*& aPtr ) : m_what( aPtr ) {}
354  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
355  } clear_this( (void*&) m_qmodal_loop );
356 
357  // release the mouse if it's currently captured as the window having it
358  // will be disabled when this dialog is shown -- but will still keep the
359  // capture making it impossible to do anything in the modal dialog itself
360  wxWindow* win = wxWindow::GetCapture();
361  if( win )
362  win->ReleaseMouse();
363 
364  // Get the optimal parent
365  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
366 
367  // Show the optimal parent
368  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
369 
370  wxASSERT_MSG( !m_qmodal_parent_disabler,
371  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
372 
373  // quasi-modal: disable only my "optimal" parent
375 
376 #ifdef __WXMAC__
377  // Apple in its infinite wisdom will raise a disabled window before even passing
378  // us the event, so we have no way to stop it. Instead, we must set an order on
379  // the windows so that the quasi-modal will be pushed in front of the disabled
380  // window when it is raised.
381  ReparentQuasiModal();
382 #endif
383  Show( true );
384 
385  m_qmodal_showing = true;
386 
387  WX_EVENT_LOOP event_loop;
388 
389  m_qmodal_loop = &event_loop;
390 
391  event_loop.Run();
392 
393  m_qmodal_showing = false;
394 
395  return GetReturnCode();
396 }
bool m_qmodal_showing
Definition: dialog_shim.h:186
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:185
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:187
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

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

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

◆ UpdatePageLayoutExample()

void DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample ( )
private

Definition at line 572 of file dialog_page_settings.cpp.

573 {
574  int lyWidth, lyHeight;
575 
576  wxSize clamped_layout_size( Clamp( MIN_PAGE_SIZE, m_layout_size.x, m_maxPageSizeMils.x ),
578 
579  double lyRatio = clamped_layout_size.x < clamped_layout_size.y ?
580  (double) clamped_layout_size.y / clamped_layout_size.x :
581  (double) clamped_layout_size.x / clamped_layout_size.y;
582 
583  if( clamped_layout_size.x < clamped_layout_size.y )
584  {
585  lyHeight = MAX_PAGE_EXAMPLE_SIZE;
586  lyWidth = KiROUND( (double) lyHeight / lyRatio );
587  }
588  else
589  {
590  lyWidth = MAX_PAGE_EXAMPLE_SIZE;
591  lyHeight = KiROUND( (double) lyWidth / lyRatio );
592  }
593 
594  if( m_page_bitmap )
595  {
596  m_PageLayoutExampleBitmap->SetBitmap( wxNullBitmap );
597  delete m_page_bitmap;
598  }
599 
600  m_page_bitmap = new wxBitmap( lyWidth + 1, lyHeight + 1 );
601 
602  if( m_page_bitmap->IsOk() )
603  {
604  double scaleW = (double) lyWidth / clamped_layout_size.x;
605  double scaleH = (double) lyHeight / clamped_layout_size.y;
606 
607  // Prepare DC.
608  wxSize example_size( lyWidth + 1, lyHeight + 1 );
609  wxMemoryDC memDC;
610  memDC.SelectObject( *m_page_bitmap );
611  memDC.SetClippingRegion( wxPoint( 0, 0 ), example_size );
612  memDC.Clear();
613  memDC.SetUserScale( scaleW, scaleH );
614 
615  // Get logical page size and margins.
616  PAGE_INFO pageDUMMY;
617 
618  // Get page type
619  int idx = m_paperSizeComboBox->GetSelection();
620 
621  if( idx < 0 )
622  idx = 0;
623 
624  wxString pageFmtName = m_pageFmt[idx].BeforeFirst( ' ' );
625  bool portrait = clamped_layout_size.x < clamped_layout_size.y;
626  pageDUMMY.SetType( pageFmtName, portrait );
627  if( m_customFmt )
628  {
629  pageDUMMY.SetWidthMils( clamped_layout_size.x );
630  pageDUMMY.SetHeightMils( clamped_layout_size.y );
631  }
632 
633  // Draw layout preview.
634  wxString emptyString;
635  GRResetPenAndBrush( &memDC );
636 
638  GRFilledRect( NULL, &memDC, 0, 0, m_layout_size.x, m_layout_size.y, WHITE, WHITE );
639  PrintPageLayout( &memDC, pageDUMMY, emptyString, emptyString, m_tb,
641 
642  memDC.SelectObject( wxNullBitmap );
645 
646  // Refresh the dialog.
647  Layout();
648  Refresh();
649  }
650 }
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:120
int m_ScreenNumber
Definition: base_screen.h:135
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:139
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:115
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:888
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.
static void SetAltInstance(WS_DATA_MODEL *aLayout=NULL)
static function: Set an alternate instance of WS_DATA_MODEL mainly used in page setting dialog
wxBitmap * m_page_bitmap
the page layuout filename was changed
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
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:239
WS_DATA_MODEL * m_pagelayout
Temporary title block (basic inscriptions).
Definition: colors.h:49
bool m_customFmt
Temporary page info.
int m_NumberOfScreens
Definition: base_screen.h:136
#define MIN_PAGE_SIZE
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39
void PrintPageLayout(wxDC *aDC, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, int aPenWidth, double aScalar, COLOR4D aColor, const wxString &aSheetLayer)
Function PrintPageLayout is a core function to print the page layout with the frame and the basic ins...

References Clamp(), 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, PrintPageLayout(), RED, Refresh(), WS_DATA_MODEL::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 166 of file dialog_shim.cpp.

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

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 49 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 181 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 182 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 46 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 47 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 45 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 48 of file dialog_page_settings.h.

Referenced by initDialog(), and SavePageSettings().

◆ m_pagelayout

WS_DATA_MODEL* DIALOG_PAGES_SETTINGS::m_pagelayout
private

Temporary title block (basic inscriptions).

Definition at line 51 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 185 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 186 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_staticTextTitle

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextTitle
protectedinherited

◆ m_staticTextTitleBlock

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextTitleBlock
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: