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 }
 

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

Static Public Member Functions

static bool IsCtrl (int aChar, const wxKeyEvent &e)
 
static bool IsShiftCtrl (int aChar, const wxKeyEvent &e)
 
static void FixOSXCancelButtonIssue (wxWindow *aWindow)
 

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...
 
void ResetSize ()
 Clear the existing dialog size and position. 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
 
wxCheckBox * m_PaperExport
 
wxStaticLine * m_staticline31
 
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_staticTextCompany
 
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_staticTextComment5
 
wxTextCtrl * m_TextComment5
 
wxCheckBox * m_Comment5Export
 
wxStaticText * m_staticTextComment6
 
wxTextCtrl * m_TextComment6
 
wxCheckBox * m_Comment6Export
 
wxStaticText * m_staticTextComment7
 
wxTextCtrl * m_TextComment7
 
wxCheckBox * m_Comment7Export
 
wxStaticText * m_staticTextComment8
 
wxTextCtrl * m_TextComment8
 
wxCheckBox * m_Comment8Export
 
wxStaticText * m_staticTextComment9
 
wxTextCtrl * m_TextComment9
 
wxCheckBox * m_Comment9Export
 
wxStaticText * m_staticTextfilename
 
wxTextCtrl * m_textCtrlFilePicker
 
wxButton * m_buttonBrowse
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Private Member Functions

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 OnComment5TextUpdated (wxCommandEvent &event) override
 
void OnComment6TextUpdated (wxCommandEvent &event) override
 
void OnComment7TextUpdated (wxCommandEvent &event) override
 
void OnComment8TextUpdated (wxCommandEvent &event) override
 
void OnComment9TextUpdated (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 38 of file dialog_page_settings.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS ( EDA_DRAW_FRAME parent,
wxSize  aMaxUserSizeMils 
)

Definition at line 82 of file dialog_page_settings.cpp.

82  :
84  m_initialized( false ),
87 {
88  m_parent = parent;
92  m_maxPageSizeMils = aMaxUserSizeMils;
94  m_customFmt = false;
96 
98  wxString serialization;
100  m_pagelayout->SetPageLayout( TO_UTF8( serialization ) );
101 
102  m_PickDate->SetValue( wxDateTime::Now() );
103 
104  if( parent->GetName() == PL_EDITOR_FRAME_NAME )
105  {
106  SetTitle( _( "Preview Settings" ) );
107  m_staticTextPaper->SetLabel( _( "Preview Paper" ) );
108  m_staticTextTitleBlock->SetLabel( _( "Preview Title Block Data" ) );
109  }
110  else
111  {
112  SetTitle( _( "Page Settings" ) );
113  m_staticTextPaper->SetLabel( _( "Paper" ) );
114  m_staticTextTitleBlock->SetLabel( _( "Title Block" ) );
115  }
116 
117  initDialog();
118 
119  GetSizer()->SetSizeHints( this );
120  Centre();
121 }
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:123
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 NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
#define _(s)
Definition: 3d_actions.cpp:33
#define TO_UTF8(wxstring)
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, NULL, 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 124 of file dialog_page_settings.cpp.

125 {
126 #ifdef EESCHEMA
127  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
128  wxASSERT( cfg );
129 
130  cfg->m_PageSettings.export_paper = m_PaperExport->GetValue();
131  cfg->m_PageSettings.export_revision = m_RevisionExport->GetValue();
132  cfg->m_PageSettings.export_date = m_DateExport->GetValue();
133  cfg->m_PageSettings.export_title = m_TitleExport->GetValue();
134  cfg->m_PageSettings.export_company = m_CompanyExport->GetValue();
135  cfg->m_PageSettings.export_comment1 = m_Comment1Export->GetValue();
136  cfg->m_PageSettings.export_comment2 = m_Comment2Export->GetValue();
137  cfg->m_PageSettings.export_comment3 = m_Comment3Export->GetValue();
138  cfg->m_PageSettings.export_comment4 = m_Comment4Export->GetValue();
139  cfg->m_PageSettings.export_comment5 = m_Comment5Export->GetValue();
140  cfg->m_PageSettings.export_comment6 = m_Comment6Export->GetValue();
141  cfg->m_PageSettings.export_comment7 = m_Comment7Export->GetValue();
142  cfg->m_PageSettings.export_comment8 = m_Comment8Export->GetValue();
143  cfg->m_PageSettings.export_comment9 = m_Comment9Export->GetValue();
144 #endif
145 
146  delete m_page_bitmap;
147  delete m_pagelayout;
148 }
wxBitmap * m_page_bitmap
the page layuout filename was changed
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
WS_DATA_MODEL * m_pagelayout
Temporary title block (basic inscriptions).

References Kiface(), 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_Comment5Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment6Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment7Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment8Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment9Export, DIALOG_PAGES_SETTINGS_BASE::m_CompanyExport, DIALOG_PAGES_SETTINGS_BASE::m_DateExport, m_page_bitmap, m_pagelayout, DIALOG_PAGES_SETTINGS_BASE::m_PaperExport, DIALOG_PAGES_SETTINGS_BASE::m_RevisionExport, and DIALOG_PAGES_SETTINGS_BASE::m_TitleExport.

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 269 of file dialog_shim.cpp.

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

◆ 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( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
411  "wasn't called" );
412  return;
413  }
414 
415  if( m_qmodal_loop )
416  {
417  if( m_qmodal_loop->IsRunning() )
418  m_qmodal_loop->Exit( 0 );
419  else
420  m_qmodal_loop->ScheduleExit( 0 );
421 
423  }
424 
427 
428  Show( false );
429 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:206
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:123
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:209

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

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

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

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

Definition at line 144 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), 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_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_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_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ FixOSXCancelButtonIssue()

static void DIALOG_SHIM::FixOSXCancelButtonIssue ( wxWindow *  aWindow)
staticinherited

◆ GetCustomSizeMilsFromDialog()

void DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog ( )
private

Definition at line 857 of file dialog_page_settings.cpp.

858 {
859  double customSizeX = (double) m_customSizeX.GetValue() / IU_PER_MILS;
860  double customSizeY = (double) m_customSizeY.GetValue() / IU_PER_MILS;
861 
862  // Prepare to painless double -> int conversion.
863  customSizeX = Clamp( double( INT_MIN ), customSizeX, double( INT_MAX ) );
864  customSizeY = Clamp( double( INT_MIN ), customSizeY, double( INT_MAX ) );
865  m_layout_size = wxSize( KiROUND( customSizeX ), KiROUND( customSizeY ) );
866 }
wxSize m_layout_size
Temporary bitmap for the page layout example.
#define IU_PER_MILS
Definition: plotter.cpp:138
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: util.h:46
virtual long long int GetValue()
Function GetValue Returns the current value in Internal Units.

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

791 {
792  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
793  const wxString paperType = m_pageFmt[idx];
794 
795  // here we assume translators will keep original paper size spellings
796  if( paperType.Contains( PAGE_INFO::Custom ) )
797  {
799 
800  if( m_layout_size.x && m_layout_size.y )
801  {
802  if( m_layout_size.x < m_layout_size.y )
803  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
804  else
805  m_orientationComboBox->SetStringSelection( _( "Landscape" ) );
806  }
807  }
808  else
809  {
810  PAGE_INFO pageInfo; // SetType() later to lookup size
811 
812  static const wxChar* papers[] = {
813  // longest common string first, since sequential search below
820  PAGE_INFO::A,
821  PAGE_INFO::B,
822  PAGE_INFO::C,
823  PAGE_INFO::D,
824  PAGE_INFO::E,
828  };
829 
830  unsigned i;
831 
832  for( i=0; i < arrayDim( papers ); ++i )
833  {
834  if( paperType.Contains( papers[i] ) )
835  {
836  pageInfo.SetType( papers[i] );
837  break;
838  }
839  }
840 
841  wxASSERT( i != arrayDim(papers) ); // dialog UI match the above list?
842 
843  m_layout_size = pageInfo.GetSizeMils();
844 
845  // swap sizes to match orientation
846  bool isPortrait = (bool) m_orientationComboBox->GetSelection();
847 
848  if( ( isPortrait && m_layout_size.x >= m_layout_size.y ) ||
849  ( !isPortrait && m_layout_size.x < m_layout_size.y ) )
850  {
852  }
853  }
854 }
static const wxChar A[]
Definition: page_info.h:70
static const wxChar E[]
Definition: page_info.h:74
static const wxChar A3[]
Definition: page_info.h:66
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:119
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:79
static const wxChar D[]
Definition: page_info.h:73
wxSize m_layout_size
Temporary bitmap for the page layout example.
static const wxChar USLegal[]
Definition: page_info.h:77
static const wxChar B[]
Definition: page_info.h:71
static const wxChar C[]
Definition: page_info.h:72
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
static const wxChar A4[]
Definition: page_info.h:65
const wxSize & GetSizeMils() const
Definition: page_info.h:143
static const wxChar USLedger[]
Definition: page_info.h:78
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160
static const wxChar A1[]
Definition: page_info.h:68
static const wxChar USLetter[]
Definition: page_info.h:76
#define _(s)
Definition: 3d_actions.cpp:33
static const wxChar A5[]
Definition: page_info.h:64
static const wxChar A2[]
Definition: page_info.h:67
static const wxChar A0[]
Definition: page_info.h:69

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

Referenced by initDialog(), OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnComment5TextUpdated(), OnComment6TextUpdated(), OnComment7TextUpdated(), OnComment8TextUpdated(), OnComment9TextUpdated(), 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().

◆ GetUserUnits()

◆ GetWksFileName()

const wxString DIALOG_PAGES_SETTINGS::GetWksFileName ( )
inline

Definition at line 62 of file dialog_page_settings.h.

63  {
64  return m_textCtrlFilePicker->GetValue();
65  }

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

166 {
167  wxSize sz( x, 0 );
168  return ConvertDialogToPixels( sz ).x;
169 }

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

152 {
153  wxString msg;
154 
155  // initialize page format choice box and page format list.
156  // The first shows translated strings, the second contains not translated strings
157  m_paperSizeComboBox->Clear();
158 
159  for( const wxString& pageFmt : pageFmts )
160  {
161  m_pageFmt.Add( pageFmt );
162  m_paperSizeComboBox->Append( wxGetTranslation( pageFmt ) );
163  }
164 
165  // initialize the page layout descr filename
167 
168 #ifdef EESCHEMA
169  // Init display value for schematic sub-sheet number
170  wxString format = m_TextSheetCount->GetLabel();
171  msg.Printf( format, m_screen->m_NumberOfScreens );
172  m_TextSheetCount->SetLabel( msg );
173 
174  format = m_TextSheetNumber->GetLabel();
175  msg.Printf( format, m_screen->m_ScreenNumber );
176  m_TextSheetNumber->SetLabel( msg );
177 #else
178  m_TextSheetCount->Show( false );
179  m_TextSheetNumber->Show( false );
180 #endif
181 
184  m_orientationComboBox->SetSelection( m_pageInfo.IsPortrait() );
185 
186  // only a click fires the "selection changed" event, so have to fabricate this check
187  wxCommandEvent dummy;
189 
190  if( m_customFmt )
191  {
194  }
195  else
196  {
199  }
200 
201  m_TextRevision->SetValue( m_tb.GetRevision() );
202  m_TextDate->SetValue( m_tb.GetDate() );
203  m_TextTitle->SetValue( m_tb.GetTitle() );
204  m_TextCompany->SetValue( m_tb.GetCompany() );
205  m_TextComment1->SetValue( m_tb.GetComment( 0 ) );
206  m_TextComment2->SetValue( m_tb.GetComment( 1 ) );
207  m_TextComment3->SetValue( m_tb.GetComment( 2 ) );
208  m_TextComment4->SetValue( m_tb.GetComment( 3 ) );
209  m_TextComment5->SetValue( m_tb.GetComment( 4 ) );
210  m_TextComment6->SetValue( m_tb.GetComment( 5 ) );
211  m_TextComment7->SetValue( m_tb.GetComment( 6 ) );
212  m_TextComment8->SetValue( m_tb.GetComment( 7 ) );
213  m_TextComment9->SetValue( m_tb.GetComment( 8 ) );
214 
215 #ifdef EESCHEMA
216  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
217  wxASSERT( cfg );
218 
219  m_PaperExport->SetValue( cfg->m_PageSettings.export_paper );
220  m_RevisionExport->SetValue( cfg->m_PageSettings.export_revision );
221  m_DateExport->SetValue( cfg->m_PageSettings.export_date );
222  m_TitleExport->SetValue( cfg->m_PageSettings.export_title );
223  m_CompanyExport->SetValue( cfg->m_PageSettings.export_company );
224  m_Comment1Export->SetValue( cfg->m_PageSettings.export_comment1 );
225  m_Comment2Export->SetValue( cfg->m_PageSettings.export_comment2 );
226  m_Comment3Export->SetValue( cfg->m_PageSettings.export_comment3 );
227  m_Comment4Export->SetValue( cfg->m_PageSettings.export_comment4 );
228  m_Comment5Export->SetValue( cfg->m_PageSettings.export_comment5 );
229  m_Comment6Export->SetValue( cfg->m_PageSettings.export_comment6 );
230  m_Comment7Export->SetValue( cfg->m_PageSettings.export_comment7 );
231  m_Comment8Export->SetValue( cfg->m_PageSettings.export_comment8 );
232  m_Comment9Export->SetValue( cfg->m_PageSettings.export_comment9 );
233 #else
234  m_PaperExport->Show( false );
235  m_RevisionExport->Show( false );
236  m_DateExport->Show( false );
237  m_TitleExport->Show( false );
238  m_CompanyExport->Show( false );
239  m_Comment1Export->Show( false );
240  m_Comment2Export->Show( false );
241  m_Comment3Export->Show( false );
242  m_Comment4Export->Show( false );
243  m_Comment5Export->Show( false );
244  m_Comment6Export->Show( false );
245  m_Comment7Export->Show( false );
246  m_Comment8Export->Show( false );
247  m_Comment9Export->Show( false );
248 #endif
249 
252 
253  // Make the OK button the default.
254  m_sdbSizerOK->SetDefault();
255  m_initialized = true;
256 }
int m_ScreenNumber
Definition: base_screen.h:79
static int GetCustomHeightMils()
Function GetCustomHeightMils.
Definition: page_info.h:177
const wxString & GetComment(int aIdx) const
Definition: title_block.h:110
int GetHeightMils() const
Definition: page_info.h:141
TITLE_BLOCK m_tb
true if the page selection is custom
void SetWksFileName(const wxString &aFilename)
const wxString & GetType() const
Definition: page_info.h:98
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:57
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
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void SetCurrentPageSizeSelection(const wxString &aPaperSize)
const wxString & GetDate() const
Definition: title_block.h:79
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:122
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:138
static int GetCustomWidthMils()
Function GetCustomWidthMils.
Definition: page_info.h:171
bool m_customFmt
Temporary page info.
int m_NumberOfScreens
Definition: base_screen.h:80
const wxString & GetTitle() const
Definition: title_block.h:65
void OnPaperSizeChoice(wxCommandEvent &event) override
int GetWidthMils() const
Definition: page_info.h:138

References dummy(), TITLE_BLOCK::GetComment(), 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, Kiface(), 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_Comment5Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment6Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment7Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment8Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment9Export, 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_PaperExport, 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_TextComment5, DIALOG_PAGES_SETTINGS_BASE::m_TextComment6, DIALOG_PAGES_SETTINGS_BASE::m_TextComment7, DIALOG_PAGES_SETTINGS_BASE::m_TextComment8, DIALOG_PAGES_SETTINGS_BASE::m_TextComment9, 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().

◆ IsCtrl()

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

Definition at line 136 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), 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 128 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 395 of file dialog_page_settings.cpp.

396 {
397  if( m_initialized && m_TextComment1->IsModified() )
398  {
400  m_tb.SetComment( 0, m_TextComment1->GetValue() );
402  }
403 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

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

◆ OnComment2TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment2TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 406 of file dialog_page_settings.cpp.

407 {
408  if( m_initialized && m_TextComment2->IsModified() )
409  {
411  m_tb.SetComment( 1, m_TextComment2->GetValue() );
413  }
414 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

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

◆ OnComment3TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment3TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 417 of file dialog_page_settings.cpp.

418 {
419  if( m_initialized && m_TextComment3->IsModified() )
420  {
422  m_tb.SetComment( 2, m_TextComment3->GetValue() );
424  }
425 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

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

◆ OnComment4TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment4TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 428 of file dialog_page_settings.cpp.

429 {
430  if( m_initialized && m_TextComment4->IsModified() )
431  {
433  m_tb.SetComment( 3, m_TextComment4->GetValue() );
435  }
436 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

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

◆ OnComment5TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment5TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 439 of file dialog_page_settings.cpp.

440 {
441  if( m_initialized && m_TextComment5->IsModified() )
442  {
444  m_tb.SetComment( 4, m_TextComment5->GetValue() );
446  }
447 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment5, TITLE_BLOCK::SetComment(), and UpdatePageLayoutExample().

◆ OnComment6TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment6TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 450 of file dialog_page_settings.cpp.

451 {
452  if( m_initialized && m_TextComment6->IsModified() )
453  {
455  m_tb.SetComment( 5, m_TextComment6->GetValue() );
457  }
458 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment6, TITLE_BLOCK::SetComment(), and UpdatePageLayoutExample().

◆ OnComment7TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment7TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 461 of file dialog_page_settings.cpp.

462 {
463  if( m_initialized && m_TextComment7->IsModified() )
464  {
466  m_tb.SetComment( 6, m_TextComment7->GetValue() );
468  }
469 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment7, TITLE_BLOCK::SetComment(), and UpdatePageLayoutExample().

◆ OnComment8TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment8TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 472 of file dialog_page_settings.cpp.

473 {
474  if( m_initialized && m_TextComment8->IsModified() )
475  {
477  m_tb.SetComment( 7, m_TextComment8->GetValue() );
479  }
480 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment8, TITLE_BLOCK::SetComment(), and UpdatePageLayoutExample().

◆ OnComment9TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment9TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 483 of file dialog_page_settings.cpp.

484 {
485  if( m_initialized && m_TextComment9->IsModified() )
486  {
488  m_tb.SetComment( 8, m_TextComment9->GetValue() );
490  }
491 }
TITLE_BLOCK m_tb
true if the page selection is custom
bool m_initialized
list of page sizes (not translated)
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104

References GetPageLayoutInfoFromDialog(), m_initialized, m_tb, DIALOG_PAGES_SETTINGS_BASE::m_TextComment9, TITLE_BLOCK::SetComment(), and UpdatePageLayoutExample().

◆ OnCompanyTextUpdated()

void DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 384 of file dialog_page_settings.cpp.

385 {
386  if( m_initialized && m_TextCompany->IsModified() )
387  {
389  m_tb.SetCompany( m_TextCompany->GetValue() );
391  }
392 }
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 494 of file dialog_page_settings.cpp.

495 {
496  wxDateTime datetime = m_PickDate->GetValue();
497  wxString date =
498  // We can choose different formats. Only one must be uncommented
499  //
500  // datetime.Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
501  // datetime.Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
502  // datetime.Format( wxT("%Y-%b-%d") );
503  datetime.FormatISODate();
504 
505  m_TextDate->SetValue( date );
506 }

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

363 {
364  if( m_initialized && m_TextDate->IsModified() )
365  {
367  m_tb.SetDate( m_TextDate->GetValue() );
369  }
370 }
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 259 of file dialog_page_settings.cpp.

260 {
262  return;
263 
265  return;
266 
267  if( SavePageSettings() )
268  {
269  m_screen->SetModify();
270 
271  if( LocalPrjConfigChanged() )
273 
274  // Call the post processing (if any) after changes
276  }
277 
278  event.Skip();
279 }
wxSize m_maxPageSizeMils
Logical page layout size.
virtual void SaveProjectSettings()
Save changes to the project settings to the project (.pro) file.
#define MIN_PAGE_SIZE_MILS
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39
virtual bool Validate(double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED, bool aUseMils=false)
Function Validate Validates the control against the given range, informing the user of any errors fou...
virtual void OnPageSettingsChange()
Called when modifying the page settings.
void SetModify()
Definition: base_screen.h:100

References INCHES, LocalPrjConfigChanged(), m_customSizeX, m_customSizeY, m_maxPageSizeMils, m_parent, m_screen, MIN_PAGE_SIZE_MILS, 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 341 of file dialog_page_settings.cpp.

342 {
343  if( m_initialized )
344  {
347  }
348 }
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 302 of file dialog_shim.cpp.

303 {
304  if( m_firstPaintEvent )
305  {
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:204
bool m_firstPaintEvent
Definition: dialog_shim.h:203
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:38
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), 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 282 of file dialog_page_settings.cpp.

283 {
284  int idx = m_paperSizeComboBox->GetSelection();
285 
286  if( idx < 0 )
287  idx = 0;
288 
289  const wxString paperType = m_pageFmt[idx];
290 
291  if( paperType.Contains( PAGE_INFO::Custom ) )
292  {
293  m_orientationComboBox->Enable( false );
294  m_customSizeX.Enable( true );
295  m_customSizeY.Enable( true );
296  m_customFmt = true;
297  }
298  else
299  {
300  m_orientationComboBox->Enable( true );
301 
302 #if 0
303  // ForcePortrait() does not exist, but could be useful.
304  // so I leave these lines, which could be seen as a todo feature
305  if( paperType.ForcePortrait() )
306  {
307  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
308  m_orientationComboBox->Enable( false );
309  }
310 #endif
311  m_customSizeX.Enable( false );
312  m_customSizeY.Enable( false );
313  m_customFmt = false;
314  }
315 
318 }
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:79
#define _(s)
Definition: 3d_actions.cpp:33
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 351 of file dialog_page_settings.cpp.

352 {
353  if( m_initialized && m_TextRevision->IsModified() )
354  {
356  m_tb.SetRevision( m_TextRevision->GetValue() );
358  }
359 }
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 373 of file dialog_page_settings.cpp.

374 {
375  if( m_initialized && m_TextTitle->IsModified() )
376  {
378  m_tb.SetTitle( m_TextTitle->GetValue() );
380  }
381 }
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 321 of file dialog_page_settings.cpp.

322 {
323  if( m_initialized )
324  {
327  }
328 }
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 331 of file dialog_page_settings.cpp.

332 {
333  if( m_initialized )
334  {
337  }
338 }
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 869 of file dialog_page_settings.cpp.

870 {
871  wxFileName fn = GetWksFileName();
872  wxString name = GetWksFileName();
873  wxString path;
874 
875  if( fn.IsAbsolute() )
876  {
877  path = fn.GetPath();
878  name = fn.GetFullName();
879  }
880  else
881  {
882  path = m_projectPath;
883  }
884 
885  // Display a file picker dialog
886  wxFileDialog fileDialog( this, _( "Select Page Layout Description File" ),
888  wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
889 
890  if( fileDialog.ShowModal() != wxID_OK )
891  return;
892 
893  wxString fileName = fileDialog.GetPath();
894 
895  // Try to remove the path, if the path is the current working dir,
896  // or the dir of kicad.pro (template), and use a relative path
897  wxString shortFileName = WS_DATA_MODEL::MakeShortFileName( fileName, m_projectPath );
898 
899  // For Win/Linux/macOS compatibility, a relative path is a good idea
900  if( shortFileName != GetWksFileName() && shortFileName != fileName )
901  {
902  wxString msg = wxString::Format( _(
903  "The page layout description file name has changed.\n"
904  "Do you want to use the relative path:\n"
905  "\"%s\"\n"
906  "instead of\n"
907  "\"%s\"?" ), GetChars( shortFileName ), GetChars( fileName ) );
908 
909  if( !IsOK( this, msg ) )
910  shortFileName = fileName;
911  }
912 
913  SetWksFileName( shortFileName );
914 
915  if( m_pagelayout == NULL )
917 
918  m_pagelayout->SetPageLayout( fileName );
919 
922 }
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()
#define NULL
static const wxString MakeShortFileName(const wxString &aFullFileName, const wxString &aProjectPath)
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:153
const char * name
Definition: DXF_plotter.cpp:60
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33
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:283

References _, Format(), GetChars(), GetPageLayoutInfoFromDialog(), GetWksFileName(), IsOK(), m_pagelayout, m_projectPath, WS_DATA_MODEL::MakeShortFileName(), name, NULL, 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 35 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), 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::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::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(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ ResetSize()

void DIALOG_SHIM::ResetSize ( )
protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 244 of file dialog_shim.cpp.

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

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

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ SavePageSettings()

bool DIALOG_PAGES_SETTINGS::SavePageSettings ( )
private

Definition at line 509 of file dialog_page_settings.cpp.

510 {
511  bool success = false;
512 
513  wxString fileName = GetWksFileName();
514 
516  {
517  wxString fullFileName = WS_DATA_MODEL::MakeFullFileName( fileName, m_projectPath );
518 
519  if( !fullFileName.IsEmpty() && !wxFileExists( fullFileName ) )
520  {
521  wxString msg;
522  msg.Printf( _( "Page layout description file \"%s\" not found." ),
523  GetChars( fullFileName ) );
524  wxMessageBox( msg );
525  return false;
526  }
527 
530  pglayout.SetPageLayout( fullFileName );
532  }
533 
534  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
535  const wxString paperType = m_pageFmt[idx];
536 
537  if( paperType.Contains( PAGE_INFO::Custom ) )
538  {
540 
541  success = m_pageInfo.SetType( PAGE_INFO::Custom );
542 
543  if( success )
544  {
547 
550  }
551  }
552  else
553  {
554  // search for longest common string first, e.g. A4 before A
555  if( paperType.Contains( PAGE_INFO::USLetter ) )
557  else if( paperType.Contains( PAGE_INFO::USLegal ) )
559  else if( paperType.Contains( PAGE_INFO::USLedger ) )
561  else if( paperType.Contains( PAGE_INFO::GERBER ) )
562  success = m_pageInfo.SetType( PAGE_INFO::GERBER );
563  else if( paperType.Contains( PAGE_INFO::A5 ) )
564  success = m_pageInfo.SetType( PAGE_INFO::A5 );
565  else if( paperType.Contains( PAGE_INFO::A4 ) )
566  success = m_pageInfo.SetType( PAGE_INFO::A4 );
567  else if( paperType.Contains( PAGE_INFO::A3 ) )
568  success = m_pageInfo.SetType( PAGE_INFO::A3 );
569  else if( paperType.Contains( PAGE_INFO::A2 ) )
570  success = m_pageInfo.SetType( PAGE_INFO::A2 );
571  else if( paperType.Contains( PAGE_INFO::A1 ) )
572  success = m_pageInfo.SetType( PAGE_INFO::A1 );
573  else if( paperType.Contains( PAGE_INFO::A0 ) )
574  success = m_pageInfo.SetType( PAGE_INFO::A0 );
575  else if( paperType.Contains( PAGE_INFO::A ) )
576  success = m_pageInfo.SetType( PAGE_INFO::A );
577  else if( paperType.Contains( PAGE_INFO::B ) )
578  success = m_pageInfo.SetType( PAGE_INFO::B );
579  else if( paperType.Contains( PAGE_INFO::C ) )
580  success = m_pageInfo.SetType( PAGE_INFO::C );
581  else if( paperType.Contains( PAGE_INFO::D ) )
582  success = m_pageInfo.SetType( PAGE_INFO::D );
583  else if( paperType.Contains( PAGE_INFO::E ) )
584  success = m_pageInfo.SetType( PAGE_INFO::E );
585 
586  if( success )
587  {
588  int choice = m_orientationComboBox->GetSelection();
589  m_pageInfo.SetPortrait( choice != 0 );
590  }
591  }
592 
593  if( !success )
594  {
595  wxASSERT_MSG( false, _( "the translation for paper size must preserve original spellings" ) );
597  }
598 
600 
601  m_tb.SetRevision( m_TextRevision->GetValue() );
602  m_tb.SetDate( m_TextDate->GetValue() );
603  m_tb.SetCompany( m_TextCompany->GetValue() );
604  m_tb.SetTitle( m_TextTitle->GetValue() );
605  m_tb.SetComment( 0, m_TextComment1->GetValue() );
606  m_tb.SetComment( 1, m_TextComment2->GetValue() );
607  m_tb.SetComment( 2, m_TextComment3->GetValue() );
608  m_tb.SetComment( 3, m_TextComment4->GetValue() );
609  m_tb.SetComment( 4, m_TextComment5->GetValue() );
610  m_tb.SetComment( 5, m_TextComment6->GetValue() );
611  m_tb.SetComment( 6, m_TextComment7->GetValue() );
612  m_tb.SetComment( 7, m_TextComment8->GetValue() );
613  m_tb.SetComment( 8, m_TextComment9->GetValue() );
614 
616 
617 
618 #ifdef EESCHEMA
619  wxCHECK_MSG( dynamic_cast<SCH_EDIT_FRAME*>( m_parent ), true,
620  "DIALOG_PAGES_SETTINGS::OnDateApplyClick frame is not a schematic frame!" );
621 
622  // Exports settings to other sheets if requested:
623  SCH_SCREENS ScreenList( dynamic_cast<SCH_EDIT_FRAME*>( m_parent )->Schematic().Root() );
624 
625  // Update page info and/or title blocks for all screens
626  for( SCH_SCREEN* screen = ScreenList.GetFirst(); screen; screen = ScreenList.GetNext() )
627  {
628  if( screen == m_screen )
629  continue;
630 
631  if( m_PaperExport->IsChecked() )
632  screen->SetPageSettings( m_pageInfo );
633 
634  TITLE_BLOCK tb2 = screen->GetTitleBlock();
635 
636  if( m_RevisionExport->IsChecked() )
637  tb2.SetRevision( m_tb.GetRevision() );
638 
639  if( m_DateExport->IsChecked() )
640  tb2.SetDate( m_tb.GetDate() );
641 
642  if( m_TitleExport->IsChecked() )
643  tb2.SetTitle( m_tb.GetTitle() );
644 
645  if( m_CompanyExport->IsChecked() )
646  tb2.SetCompany( m_tb.GetCompany() );
647 
648  if( m_Comment1Export->IsChecked() )
649  tb2.SetComment( 0, m_tb.GetComment( 0 ) );
650 
651  if( m_Comment2Export->IsChecked() )
652  tb2.SetComment( 1, m_tb.GetComment( 1 ) );
653 
654  if( m_Comment3Export->IsChecked() )
655  tb2.SetComment( 2, m_tb.GetComment( 2 ) );
656 
657  if( m_Comment4Export->IsChecked() )
658  tb2.SetComment( 3, m_tb.GetComment( 3 ) );
659 
660  if( m_Comment5Export->IsChecked() )
661  tb2.SetComment( 4, m_tb.GetComment( 4 ) );
662 
663  if( m_Comment6Export->IsChecked() )
664  tb2.SetComment( 5, m_tb.GetComment( 5 ) );
665 
666  if( m_Comment7Export->IsChecked() )
667  tb2.SetComment( 6, m_tb.GetComment( 6 ) );
668 
669  if( m_Comment8Export->IsChecked() )
670  tb2.SetComment( 7, m_tb.GetComment( 7 ) );
671 
672  if( m_Comment9Export->IsChecked() )
673  tb2.SetComment( 8, m_tb.GetComment( 8 ) );
674 
675  screen->SetTitleBlock( tb2 );
676  }
677 #endif
678 
679  return true;
680 }
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:70
virtual void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)=0
void SetRevision(const wxString &aRevision)
Definition: title_block.h:84
const wxString & GetComment(int aIdx) const
Definition: title_block.h:110
static const wxChar E[]
Definition: page_info.h:74
static const wxChar GERBER[]
Definition: page_info.h:75
TITLE_BLOCK m_tb
true if the page selection is custom
static const wxChar A3[]
Definition: page_info.h:66
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:231
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:119
void SetDate(const wxString &aDate)
Function SetDate sets the date field, and defaults to the current time and date.
Definition: title_block.h:74
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:79
static const wxChar D[]
Definition: page_info.h:73
const wxString GetWksFileName()
TITLE_BLOCK holds the information shown in the lower right corner of a plot, printout,...
Definition: title_block.h:40
wxSize m_layout_size
Temporary bitmap for the page layout example.
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:57
static const wxChar USLegal[]
Definition: page_info.h:77
static const wxChar B[]
Definition: page_info.h:71
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:104
static const wxChar C[]
Definition: page_info.h:72
const wxString & GetRevision() const
Definition: title_block.h:89
const wxString & GetCompany() const
Definition: title_block.h:99
void SetCompany(const wxString &aCompany)
Definition: title_block.h:94
static const wxChar A4[]
Definition: page_info.h:65
void SetTitle(const wxString &aTitle)
Definition: title_block.h:60
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
static const wxChar USLedger[]
Definition: page_info.h:78
static const wxChar A1[]
Definition: page_info.h:68
const wxString & GetDate() const
Definition: title_block.h:79
static const wxChar USLetter[]
Definition: page_info.h:76
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:153
static const wxString MakeFullFileName(const wxString &aShortFileName, const wxString &aProjectPath)
Static function.
#define _(s)
Definition: 3d_actions.cpp:33
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:243
static const wxChar A5[]
Definition: page_info.h:64
static const wxChar A2[]
Definition: page_info.h:67
const wxString & GetTitle() const
Definition: title_block.h:65
void SetPortrait(bool aIsPortrait)
Function SetPortrait will rotate the paper page 90 degrees.
Definition: page_info.cpp:186
static void SetCustomHeightMils(int aHeightInMils)
Function SetCustomHeightMils sets the height of Custom page in mils, for any custom page constructed ...
Definition: page_info.cpp:237
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:528
static const wxChar A0[]
Definition: page_info.h:69

References _, PAGE_INFO::A, PAGE_INFO::A0, PAGE_INFO::A1, PAGE_INFO::A2, PAGE_INFO::A3, PAGE_INFO::A4, PAGE_INFO::A5, PAGE_INFO::B, PAGE_INFO::C, PAGE_INFO::Custom, PAGE_INFO::D, PAGE_INFO::E, PAGE_INFO::GERBER, GetChars(), TITLE_BLOCK::GetComment(), TITLE_BLOCK::GetCompany(), GetCustomSizeMilsFromDialog(), TITLE_BLOCK::GetDate(), SCH_SCREENS::GetFirst(), SCH_SCREENS::GetNext(), TITLE_BLOCK::GetRevision(), WS_DATA_MODEL::GetTheInstance(), TITLE_BLOCK::GetTitle(), 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_Comment5Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment6Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment7Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment8Export, DIALOG_PAGES_SETTINGS_BASE::m_Comment9Export, 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_PaperExport, 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_TextComment5, DIALOG_PAGES_SETTINGS_BASE::m_TextComment6, DIALOG_PAGES_SETTINGS_BASE::m_TextComment7, DIALOG_PAGES_SETTINGS_BASE::m_TextComment8, DIALOG_PAGES_SETTINGS_BASE::m_TextComment9, 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(), TITLE_BLOCK::SetComment(), 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(), 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 683 of file dialog_page_settings.cpp.

684 {
685  // search all the not translated label list containing our paper type
686  for( unsigned i = 0; i < m_pageFmt.GetCount(); ++i )
687  {
688  // parse each label looking for aPaperSize within it
689  wxStringTokenizer st( m_pageFmt[i] );
690 
691  while( st.HasMoreTokens() )
692  {
693  if( st.GetNextToken() == aPaperSize )
694  {
695  m_paperSizeComboBox->SetSelection( i );
696  return;
697  }
698  }
699  }
700 }

References 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 114 of file dialog_shim.h.

115  {
116  m_initialFocusTarget = aWindow;
117  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), 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 158 of file dialog_shim.cpp.

159 {
160  wxSize sz( x, y );
161  SetSize( ConvertDialogToPixels( sz ) );
162 }

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

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

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 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 
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.
382 
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:208
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:206
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:209
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:40
#define DBG(x)
Definition: fctsys.h:33
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:32

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

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

◆ UpdatePageLayoutExample()

void DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample ( )
private

Definition at line 703 of file dialog_page_settings.cpp.

704 {
705  int lyWidth, lyHeight;
706 
707  wxSize clamped_layout_size( Clamp( MIN_PAGE_SIZE_MILS, m_layout_size.x, m_maxPageSizeMils.x ),
709 
710  double lyRatio = clamped_layout_size.x < clamped_layout_size.y ?
711  (double) clamped_layout_size.y / clamped_layout_size.x :
712  (double) clamped_layout_size.x / clamped_layout_size.y;
713 
714  if( clamped_layout_size.x < clamped_layout_size.y )
715  {
716  lyHeight = MAX_PAGE_EXAMPLE_SIZE;
717  lyWidth = KiROUND( (double) lyHeight / lyRatio );
718  }
719  else
720  {
721  lyWidth = MAX_PAGE_EXAMPLE_SIZE;
722  lyHeight = KiROUND( (double) lyWidth / lyRatio );
723  }
724 
725  if( m_page_bitmap )
726  {
727  m_PageLayoutExampleBitmap->SetBitmap( wxNullBitmap );
728  delete m_page_bitmap;
729  }
730 
731  m_page_bitmap = new wxBitmap( lyWidth + 1, lyHeight + 1 );
732 
733  if( m_page_bitmap->IsOk() )
734  {
735  double scaleW = (double) lyWidth / clamped_layout_size.x;
736  double scaleH = (double) lyHeight / clamped_layout_size.y;
737 
738  // Prepare DC.
739  wxSize example_size( lyWidth + 1, lyHeight + 1 );
740  wxMemoryDC memDC;
741  memDC.SelectObject( *m_page_bitmap );
742  memDC.SetClippingRegion( wxPoint( 0, 0 ), example_size );
743  memDC.Clear();
744  memDC.SetUserScale( scaleW, scaleH );
745 
746  // Get logical page size and margins.
747  PAGE_INFO pageDUMMY;
748 
749  // Get page type
750  int idx = m_paperSizeComboBox->GetSelection();
751 
752  if( idx < 0 )
753  idx = 0;
754 
755  wxString pageFmtName = m_pageFmt[idx].BeforeFirst( ' ' );
756  bool portrait = clamped_layout_size.x < clamped_layout_size.y;
757  pageDUMMY.SetType( pageFmtName, portrait );
758  if( m_customFmt )
759  {
760  pageDUMMY.SetWidthMils( clamped_layout_size.x );
761  pageDUMMY.SetHeightMils( clamped_layout_size.y );
762  }
763 
764  // Draw layout preview.
765  wxString emptyString;
766  GRResetPenAndBrush( &memDC );
767 
769  KIGFX::WS_RENDER_SETTINGS renderSettings;
770  renderSettings.SetDefaultPenWidth( 1 );
771  renderSettings.SetLayerColor( LAYER_WORKSHEET, COLOR4D( RED ) );
772  renderSettings.SetPrintDC( &memDC );
773 
774  GRFilledRect( NULL, &memDC, 0, 0, m_layout_size.x, m_layout_size.y, WHITE, WHITE );
775 
776  PrintPageLayout( &renderSettings, pageDUMMY, emptyString, emptyString, m_tb,
778 
779  memDC.SelectObject( wxNullBitmap );
782 
783  // Refresh the dialog.
784  Layout();
785  Refresh();
786  }
787 }
WS_RENDER_SETTINGS Stores page-layout-specific render settings.
Definition: ws_painter.h:47
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:122
int m_ScreenNumber
Definition: base_screen.h:79
wxSize m_maxPageSizeMils
Logical page layout size.
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:886
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:119
static const char * emptyString
#define MAX_PAGE_EXAMPLE_SIZE
#define MIN_PAGE_SIZE_MILS
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39
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
#define NULL
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
PAGE_INFO describes the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:54
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Function SetLayerColor Changes the color used to draw a layer.
Definition: color4d.h:59
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
Definition: color4d.h:48
void PrintPageLayout(RENDER_SETTINGS *aSettings, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, int aSheetCount, int aSheetNumber, double aScalar, const PROJECT *aProject, const wxString &aSheetLayer)
Function PrintPageLayout is a core function to print the page layout with the frame and the basic ins...
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:243
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
const T & Clamp(const T &lower, const T &value, const T &upper)
Function Clamp limits value within the range lower <= value <= upper.
Definition: util.h:46
WS_DATA_MODEL * m_pagelayout
Temporary title block (basic inscriptions).
bool m_customFmt
Temporary page info.
int m_NumberOfScreens
Definition: base_screen.h:80
void SetDefaultPenWidth(int aWidth)
void SetPrintDC(wxDC *aDC)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99

References Clamp(), emptyString, GRFilledRect(), GRResetPenAndBrush(), KiROUND(), LAYER_WORKSHEET, 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_MILS, NULL, PrintPageLayout(), KIWAY_HOLDER::Prj(), RED, Refresh(), WS_DATA_MODEL::SetAltInstance(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), PAGE_INFO::SetHeightMils(), KIGFX::RENDER_SETTINGS::SetLayerColor(), KIGFX::RENDER_SETTINGS::SetPrintDC(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMils(), and WHITE.

Referenced by initDialog(), OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnComment5TextUpdated(), OnComment6TextUpdated(), OnComment7TextUpdated(), OnComment8TextUpdated(), OnComment9TextUpdated(), 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 172 of file dialog_shim.cpp.

173 {
174  wxSize sz( 0, y );
175  return ConvertDialogToPixels( sz ).y;
176 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

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_Comment5Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment5Export
protectedinherited

◆ m_Comment6Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment6Export
protectedinherited

◆ m_Comment7Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment7Export
protectedinherited

◆ m_Comment8Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment8Export
protectedinherited

◆ m_Comment9Export

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_Comment9Export
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 51 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 203 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 204 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 48 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 49 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 47 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 50 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 53 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_PaperExport

wxCheckBox* DIALOG_PAGES_SETTINGS_BASE::m_PaperExport
protectedinherited

◆ m_paperSizeComboBox

◆ m_parent

EDA_DRAW_FRAME* DIALOG_PAGES_SETTINGS::m_parent
private

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 211 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ 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 206 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 208 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_staticline31

wxStaticLine* DIALOG_PAGES_SETTINGS_BASE::m_staticline31
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_staticTextComment5

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment5
protectedinherited

◆ m_staticTextComment6

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment6
protectedinherited

◆ m_staticTextComment7

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment7
protectedinherited

◆ m_staticTextComment8

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment8
protectedinherited

◆ m_staticTextComment9

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_staticTextComment9
protectedinherited

◆ m_staticTextCompany

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

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

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment5
protectedinherited

◆ m_TextComment6

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment6
protectedinherited

◆ m_TextComment7

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment7
protectedinherited

◆ m_TextComment8

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment8
protectedinherited

◆ m_TextComment9

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_TextComment9
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: