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 DIALOG_EESCHEMA_PAGE_SETTINGS

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_PAGES_SETTINGS (EDA_DRAW_FRAME *aParent, double aIuPerMils, const wxSize &aMaxUserSizeMils)
 
virtual ~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 () const
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

Protected Member Functions

virtual void OnCheckboxTitleClick (wxCommandEvent &event)
 
virtual void OnOkClick (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) const
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically. More...
 
void resetSize ()
 Clear the existing dialog size and position. More...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected 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_pageBitmap
 the page layuout filename was changed More...
 
wxSize m_layout_size
 Temporary bitmap for the drawing sheet example. More...
 
wxSize m_maxPageSizeMils
 Logical drawing sheet 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...
 
DS_DATA_MODELm_drawingSheet
 Temporary title block (basic inscriptions). More...
 
double m_iuPerMils
 
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
 
wxStaticText * m_staticTextPreview
 
wxStaticLine * m_staticline31
 
wxStaticBitmap * m_PageLayoutExampleBitmap
 
wxStaticText * m_staticTextDrawingSheet
 
wxStaticLine * m_staticline4
 
wxStaticText * m_staticText30
 
wxTextCtrl * m_textCtrlFilePicker
 
wxBitmapButton * m_browseButton
 
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
 
wxStaticLine * m_staticline5
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
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
 
wxSize m_initialSize
 

Private Member Functions

virtual void onTransferDataToWindow ()
 
virtual bool onSavePageSettings ()
 
virtual bool TransferDataToWindow () override
 
virtual bool TransferDataFromWindow () 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 UpdateDrawingSheetExample ()
 
void GetPageLayoutInfoFromDialog ()
 
void GetCustomSizeMilsFromDialog ()
 
bool LocalPrjConfigChanged ()
 

Private Attributes

UNIT_BINDER m_customSizeX
 
UNIT_BINDER m_customSizeY
 

Detailed Description

DIALOG_PAGES_SETTINGS class declaration

Definition at line 34 of file dialog_page_settings.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS ( EDA_DRAW_FRAME aParent,
double  aIuPerMils,
const wxSize &  aMaxUserSizeMils 
)

Definition at line 75 of file dialog_page_settings.cpp.

76  :
77  DIALOG_PAGES_SETTINGS_BASE( aParent ),
78  m_parent( aParent ),
80  m_initialized( false ),
81  m_pageBitmap( nullptr ),
82  m_iuPerMils( aIuPerMils ),
85 {
88 
89  m_maxPageSizeMils = aMaxUserSizeMils;
91  m_customFmt = false;
93 
95  wxString serialization;
96  DS_DATA_MODEL::GetTheInstance().SaveInString( &serialization );
97  m_drawingSheet->SetPageLayout( TO_UTF8( serialization ) );
98 
99  m_PickDate->SetValue( wxDateTime::Now() );
100 
101  if( m_parent->GetName() == PL_EDITOR_FRAME_NAME )
102  {
103  SetTitle( _( "Preview Settings" ) );
104  m_staticTextPaper->SetLabel( _( "Preview Paper" ) );
105  m_staticTextTitleBlock->SetLabel( _( "Preview Title Block Data" ) );
106  }
107  else
108  {
109  SetTitle( _( "Page Settings" ) );
110  m_staticTextPaper->SetLabel( _( "Paper" ) );
111  m_staticTextTitleBlock->SetLabel( _( "Title Block" ) );
112  }
113 
114  Centre();
115 }
Handle the graphic items list to draw/plot the frame and title block.
Definition: ds_data_model.h:38
wxSize m_maxPageSizeMils
Logical drawing sheet 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
bool m_initialized
list of page sizes (not translated)
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:122
DS_DATA_MODEL * m_drawingSheet
Temporary title block (basic inscriptions).
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
#define _(s)
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
wxBitmap * m_pageBitmap
the page layuout filename was changed
void SetPageLayout(const char *aPageLayout, bool aAppend=false, const wxString &aSource=wxT("Sexpr_string"))
Populate the list from a S expr description stored in a string.
void SaveInString(wxString *aOutputString)
Save the description in a buffer.
bool m_customFmt
Temporary page info.
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References _, PROJECT::GetProjectPath(), DS_DATA_MODEL::GetTheInstance(), EDA_DRAW_FRAME::GetTitleBlock(), KiBitmap(), DIALOG_PAGES_SETTINGS_BASE::m_browseButton, m_customFmt, m_drawingSheet, m_localPrjConfigChanged, m_maxPageSizeMils, m_parent, DIALOG_PAGES_SETTINGS_BASE::m_PickDate, m_projectPath, DIALOG_PAGES_SETTINGS_BASE::m_staticTextPaper, DIALOG_PAGES_SETTINGS_BASE::m_staticTextTitleBlock, m_tb, PL_EDITOR_FRAME_NAME, KIWAY_HOLDER::Prj(), DS_DATA_MODEL::SaveInString(), DS_DATA_MODEL::SetPageLayout(), small_folder, and TO_UTF8.

◆ ~DIALOG_PAGES_SETTINGS()

DIALOG_PAGES_SETTINGS::~DIALOG_PAGES_SETTINGS ( )
virtual

Definition at line 118 of file dialog_page_settings.cpp.

119 {
120  delete m_pageBitmap;
121  delete m_drawingSheet;
122 }
DS_DATA_MODEL * m_drawingSheet
Temporary title block (basic inscriptions).
wxBitmap * m_pageBitmap
the page layuout filename was changed

References m_drawingSheet, and m_pageBitmap.

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 312 of file dialog_shim.cpp.

313 {
314  // so we can do logging of this state change:
315  return wxDialog::Enable( enable );
316 }

◆ EnableWksFileNamePicker()

void DIALOG_PAGES_SETTINGS::EnableWksFileNamePicker ( bool  aEnable)
inline

Definition at line 51 of file dialog_page_settings.h.

52  {
53  m_textCtrlFilePicker->Enable( aEnable );
54  m_browseButton->Enable( aEnable );
55  }

References DIALOG_PAGES_SETTINGS_BASE::m_browseButton, and DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker.

Referenced by PL_EDITOR_CONTROL::PageSetup().

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 473 of file dialog_shim.cpp.

474 {
475  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
476  // handle validation in the same way as other dialogs.
477  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
478  return;
479 
480  SetReturnCode( retCode );
481 
482  if( !IsQuasiModal() )
483  {
484  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
485  "wasn't called" );
486  return;
487  }
488 
489  if( m_qmodal_loop )
490  {
491  if( m_qmodal_loop->IsRunning() )
492  m_qmodal_loop->Exit( 0 );
493  else
494  m_qmodal_loop->ScheduleExit( 0 );
495 
496  m_qmodal_loop = nullptr;
497  }
498 
500  m_qmodal_parent_disabler = nullptr;
501 
502  Show( false );
503 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214

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

Referenced by NETLIST_DIALOG::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), NETLIST_DIALOG::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), 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 after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 151 of file dialog_shim.cpp.

152 {
153  // must be called from the constructor of derived classes,
154  // when all widgets are initialized, and therefore their size fixed
155 
156  // SetSizeHints fixes the minimal size of sizers in the dialog
157  // (SetSizeHints calls Fit(), so no need to call it)
158  GetSizer()->SetSizeHints( this );
159 }

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), 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_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_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_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), 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_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetCustomSizeMilsFromDialog()

void DIALOG_PAGES_SETTINGS::GetCustomSizeMilsFromDialog ( )
private

Definition at line 764 of file dialog_page_settings.cpp.

765 {
766  double customSizeX = (double) m_customSizeX.GetValue() / m_iuPerMils;
767  double customSizeY = (double) m_customSizeY.GetValue() / m_iuPerMils;
768 
769  // Prepare to painless double -> int conversion.
770  customSizeX = Clamp( double( INT_MIN ), customSizeX, double( INT_MAX ) );
771  customSizeY = Clamp( double( INT_MIN ), customSizeY, double( INT_MAX ) );
772  m_layout_size = wxSize( KiROUND( customSizeX ), KiROUND( customSizeY ) );
773 }
wxSize m_layout_size
Temporary bitmap for the drawing sheet example.
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:73
const T & Clamp(const T &lower, const T &value, const T &upper)
Limit value within the range lower <= value <= upper.
Definition: util.h:52
virtual long long int GetValue()
Return the current value in Internal Units.

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

Referenced by GetPageLayoutInfoFromDialog(), and SavePageSettings().

◆ GetPageLayoutInfoFromDialog()

void DIALOG_PAGES_SETTINGS::GetPageLayoutInfoFromDialog ( )
private

Definition at line 697 of file dialog_page_settings.cpp.

698 {
699  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
700  const wxString paperType = m_pageFmt[idx];
701 
702  // here we assume translators will keep original paper size spellings
703  if( paperType.Contains( PAGE_INFO::Custom ) )
704  {
706 
707  if( m_layout_size.x && m_layout_size.y )
708  {
709  if( m_layout_size.x < m_layout_size.y )
710  m_orientationComboBox->SetStringSelection( _( "Portrait" ) );
711  else
712  m_orientationComboBox->SetStringSelection( _( "Landscape" ) );
713  }
714  }
715  else
716  {
717  PAGE_INFO pageInfo; // SetType() later to lookup size
718 
719  static const wxChar* papers[] = {
720  // longest common string first, since sequential search below
727  PAGE_INFO::A,
728  PAGE_INFO::B,
729  PAGE_INFO::C,
730  PAGE_INFO::D,
731  PAGE_INFO::E,
735  };
736 
737  unsigned i;
738 
739  for( i=0; i < arrayDim( papers ); ++i )
740  {
741  if( paperType.Contains( papers[i] ) )
742  {
743  pageInfo.SetType( papers[i] );
744  break;
745  }
746  }
747 
748  wxASSERT( i != arrayDim(papers) ); // dialog UI match the above list?
749 
750  m_layout_size = pageInfo.GetSizeMils();
751 
752  // swap sizes to match orientation
753  bool isPortrait = (bool) m_orientationComboBox->GetSelection();
754 
755  if( ( isPortrait && m_layout_size.x >= m_layout_size.y ) ||
756  ( !isPortrait && m_layout_size.x < m_layout_size.y ) )
757  {
759  }
760  }
761 }
static const wxChar A[]
Definition: page_info.h:68
static const wxChar E[]
Definition: page_info.h:72
static const wxChar A3[]
Definition: page_info.h:64
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
Definition: page_info.cpp:119
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:77
static const wxChar D[]
Definition: page_info.h:71
wxSize m_layout_size
Temporary bitmap for the drawing sheet example.
static const wxChar USLegal[]
Definition: page_info.h:75
static const wxChar B[]
Definition: page_info.h:69
static const wxChar C[]
Definition: page_info.h:70
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
#define _(s)
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
static const wxChar A4[]
Definition: page_info.h:63
const wxSize & GetSizeMils() const
Definition: page_info.h:135
static const wxChar USLedger[]
Definition: page_info.h:76
static const wxChar A1[]
Definition: page_info.h:66
static const wxChar USLetter[]
Definition: page_info.h:74
static const wxChar A5[]
Definition: page_info.h:62
static const wxChar A2[]
Definition: page_info.h:65
static const wxChar A0[]
Definition: page_info.h:67

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 OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnComment5TextUpdated(), OnComment6TextUpdated(), OnComment7TextUpdated(), OnComment8TextUpdated(), OnComment9TextUpdated(), OnCompanyTextUpdated(), OnDateTextUpdated(), OnPageOrientationChoice(), OnPaperSizeChoice(), OnRevisionTextUpdated(), OnTitleTextUpdated(), OnUserPageSizeXTextUpdated(), OnUserPageSizeYTextUpdated(), OnWksFileSelection(), and TransferDataToWindow().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ GetWksFileName()

const wxString DIALOG_PAGES_SETTINGS::GetWksFileName ( )
inline

Definition at line 41 of file dialog_page_settings.h.

42  {
43  return m_textCtrlFilePicker->GetValue();
44  }

References DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker.

Referenced by OnWksFileSelection(), and SavePageSettings().

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 169 of file dialog_shim.cpp.

170 {
171  wxSize sz( x, 0 );
172  return ConvertDialogToPixels( sz ).x;
173 }

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

◆ IsCtrl()

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

Definition at line 124 of file dialog_shim.h.

125  {
126  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
127  !e.ShiftDown() && !e.MetaDown();
128  }

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 130 of file dialog_shim.h.

131  {
132  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
133  e.ShiftDown() && !e.MetaDown();
134  }

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Return 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 53 of file kiway_holder.h.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), 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(), SYMBOL_EDIT_FRAME::SetCurSymbol(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), BOARD_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 drawing sheet file has chnaged

Definition at line 113 of file dialog_page_settings.h.

References m_localPrjConfigChanged.

Referenced by TransferDataFromWindow().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 563 of file dialog_shim.cpp.

564 {
565  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
566  {
567  if( m_parentFrame )
568  {
570  return;
571  }
572  }
573  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
574  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
575  {
576  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
577  return;
578  }
579  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
580  {
581  wxWindow* currentWindow = wxWindow::FindFocus();
582  int currentIdx = -1;
583  int delta = aEvt.ShiftDown() ? -1 : 1;
584 
585  auto advance = [&]( int& idx )
586  {
587  // Wrap-around modulus
588  int size = m_tabOrder.size();
589  idx = ( ( idx + delta ) % size + size ) % size;
590  };
591 
592  for( size_t i = 0; i < m_tabOrder.size(); ++i )
593  {
594  if( m_tabOrder[i] == currentWindow )
595  {
596  currentIdx = (int) i;
597  break;
598  }
599  }
600 
601  if( currentIdx >= 0 )
602  {
603  advance( currentIdx );
604 
605  //todo: We don't currently have non-textentry dialog boxes but this will break if
606  // we add them.
607 #ifdef __APPLE__
608  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
609  advance( currentIdx );
610 #endif
611 
612  m_tabOrder[ currentIdx ]->SetFocus();
613  return;
614  }
615  }
616 
617  aEvt.Skip();
618 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:218
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:216
virtual void ToggleUserUnits()
constexpr int delta

References delta, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES().

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

347 {
348  if( m_initialized && m_TextComment1->IsModified() )
349  {
351  m_tb.SetComment( 0, m_TextComment1->GetValue() );
353  }
354 }
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:101

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

◆ OnComment2TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment2TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 357 of file dialog_page_settings.cpp.

358 {
359  if( m_initialized && m_TextComment2->IsModified() )
360  {
362  m_tb.SetComment( 1, m_TextComment2->GetValue() );
364  }
365 }
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:101

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

◆ OnComment3TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment3TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 368 of file dialog_page_settings.cpp.

369 {
370  if( m_initialized && m_TextComment3->IsModified() )
371  {
373  m_tb.SetComment( 2, m_TextComment3->GetValue() );
375  }
376 }
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:101

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

◆ OnComment4TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment4TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 379 of file dialog_page_settings.cpp.

380 {
381  if( m_initialized && m_TextComment4->IsModified() )
382  {
384  m_tb.SetComment( 3, m_TextComment4->GetValue() );
386  }
387 }
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:101

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

◆ OnComment5TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment5TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 390 of file dialog_page_settings.cpp.

391 {
392  if( m_initialized && m_TextComment5->IsModified() )
393  {
395  m_tb.SetComment( 4, m_TextComment5->GetValue() );
397  }
398 }
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:101

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

◆ OnComment6TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment6TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 401 of file dialog_page_settings.cpp.

402 {
403  if( m_initialized && m_TextComment6->IsModified() )
404  {
406  m_tb.SetComment( 5, m_TextComment6->GetValue() );
408  }
409 }
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:101

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

◆ OnComment7TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment7TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 412 of file dialog_page_settings.cpp.

413 {
414  if( m_initialized && m_TextComment7->IsModified() )
415  {
417  m_tb.SetComment( 6, m_TextComment7->GetValue() );
419  }
420 }
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:101

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

◆ OnComment8TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment8TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 423 of file dialog_page_settings.cpp.

424 {
425  if( m_initialized && m_TextComment8->IsModified() )
426  {
428  m_tb.SetComment( 7, m_TextComment8->GetValue() );
430  }
431 }
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:101

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

◆ OnComment9TextUpdated()

void DIALOG_PAGES_SETTINGS::OnComment9TextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 434 of file dialog_page_settings.cpp.

435 {
436  if( m_initialized && m_TextComment9->IsModified() )
437  {
439  m_tb.SetComment( 8, m_TextComment9->GetValue() );
441  }
442 }
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:101

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

◆ OnCompanyTextUpdated()

void DIALOG_PAGES_SETTINGS::OnCompanyTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 335 of file dialog_page_settings.cpp.

336 {
337  if( m_initialized && m_TextCompany->IsModified() )
338  {
340  m_tb.SetCompany( m_TextCompany->GetValue() );
342  }
343 }
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:91

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

◆ OnDateApplyClick()

void DIALOG_PAGES_SETTINGS::OnDateApplyClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 445 of file dialog_page_settings.cpp.

446 {
447  wxDateTime datetime = m_PickDate->GetValue();
448  wxString date =
449  // We can choose different formats. Should probably be kept in sync with CURRENT_DATE
450  // formatting in TITLE_BLOCK.
451  //
452  // datetime.Format( wxLocale::GetInfo( wxLOCALE_SHORT_DATE_FMT ) );
453  // datetime.Format( wxLocale::GetInfo( wxLOCALE_LONG_DATE_FMT ) );
454  // datetime.Format( wxT("%Y-%b-%d") );
455  datetime.FormatISODate();
456 
457  m_TextDate->SetValue( date );
458 }

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

314 {
315  if( m_initialized && m_TextDate->IsModified() )
316  {
318  m_tb.SetDate( m_TextDate->GetValue() );
320  }
321 }
TITLE_BLOCK m_tb
true if the page selection is custom
void SetDate(const wxString &aDate)
Set the date field, and defaults to the current time and date.
Definition: title_block.h:71
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 UpdateDrawingSheetExample().

◆ OnOkClick()

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

◆ OnPageOrientationChoice()

void DIALOG_PAGES_SETTINGS::OnPageOrientationChoice ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 292 of file dialog_page_settings.cpp.

293 {
294  if( m_initialized )
295  {
298  }
299 }
bool m_initialized
list of page sizes (not translated)

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 380 of file dialog_shim.cpp.

381 {
382  if( m_firstPaintEvent )
383  {
385 
386  selectAllInTextCtrls( GetChildren() );
387 
390  else
391  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
392 
393  m_firstPaintEvent = false;
394  }
395 
396  event.Skip();
397 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209
bool m_firstPaintEvent
Definition: dialog_shim.h:208
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
static void selectAllInTextCtrls(wxWindowList &children)

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

238 {
239  int idx = m_paperSizeComboBox->GetSelection();
240 
241  if( idx < 0 )
242  idx = 0;
243 
244  const wxString paperType = m_pageFmt[idx];
245 
246  if( paperType.Contains( PAGE_INFO::Custom ) )
247  {
248  m_staticTextOrient->Enable( false );
249  m_orientationComboBox->Enable( false );
250 
251  m_staticTextCustSize->Enable( true );
252  m_customSizeX.Enable( true );
253  m_customSizeY.Enable( true );
254  m_customFmt = true;
255  }
256  else
257  {
258  m_staticTextOrient->Enable( true );
259  m_orientationComboBox->Enable( true );
260 
261  m_staticTextCustSize->Enable( false );
262  m_customSizeX.Enable( false );
263  m_customSizeY.Enable( false );
264  m_customFmt = false;
265  }
266 
269 }
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:77
bool m_customFmt
Temporary page info.
void Enable(bool aEnable)
Enable/disable 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, DIALOG_PAGES_SETTINGS_BASE::m_staticTextCustSize, DIALOG_PAGES_SETTINGS_BASE::m_staticTextOrient, and UpdateDrawingSheetExample().

Referenced by TransferDataToWindow().

◆ OnRevisionTextUpdated()

void DIALOG_PAGES_SETTINGS::OnRevisionTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 302 of file dialog_page_settings.cpp.

303 {
304  if( m_initialized && m_TextRevision->IsModified() )
305  {
307  m_tb.SetRevision( m_TextRevision->GetValue() );
309  }
310 }
void SetRevision(const wxString &aRevision)
Definition: title_block.h:81
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 UpdateDrawingSheetExample().

◆ onSavePageSettings()

virtual bool DIALOG_PAGES_SETTINGS::onSavePageSettings ( )
inlineprivatevirtual

Reimplemented in DIALOG_EESCHEMA_PAGE_SETTINGS.

Definition at line 60 of file dialog_page_settings.h.

61  {
62  // default just return true savepagesettings to succeed
63  return true;
64  }

Referenced by SavePageSettings().

◆ OnTitleTextUpdated()

void DIALOG_PAGES_SETTINGS::OnTitleTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 324 of file dialog_page_settings.cpp.

325 {
326  if( m_initialized && m_TextTitle->IsModified() )
327  {
329  m_tb.SetTitle( m_TextTitle->GetValue() );
331  }
332 }
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:58

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

◆ onTransferDataToWindow()

virtual void DIALOG_PAGES_SETTINGS::onTransferDataToWindow ( )
inlineprivatevirtual

Reimplemented in DIALOG_EESCHEMA_PAGE_SETTINGS.

Definition at line 58 of file dialog_page_settings.h.

58 {}

Referenced by TransferDataToWindow().

◆ OnUserPageSizeXTextUpdated()

void DIALOG_PAGES_SETTINGS::OnUserPageSizeXTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 272 of file dialog_page_settings.cpp.

273 {
274  if( m_initialized )
275  {
278  }
279 }
bool m_initialized
list of page sizes (not translated)

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

◆ OnUserPageSizeYTextUpdated()

void DIALOG_PAGES_SETTINGS::OnUserPageSizeYTextUpdated ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 282 of file dialog_page_settings.cpp.

283 {
284  if( m_initialized )
285  {
288  }
289 }
bool m_initialized
list of page sizes (not translated)

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

◆ OnWksFileSelection()

void DIALOG_PAGES_SETTINGS::OnWksFileSelection ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_PAGES_SETTINGS_BASE.

Definition at line 776 of file dialog_page_settings.cpp.

777 {
778  wxFileName fn = GetWksFileName();
779  wxString name = GetWksFileName();
780  wxString path;
781 
782  if( fn.IsAbsolute() )
783  {
784  path = fn.GetPath();
785  name = fn.GetFullName();
786  }
787  else
788  {
790  }
791 
792  // Display a file picker dialog
793  wxFileDialog fileDialog( this, _( "Select Drawing Sheet File" ), path, name,
794  DrawingSheetFileWildcard(), wxFD_DEFAULT_STYLE|wxFD_FILE_MUST_EXIST );
795 
796  if( fileDialog.ShowModal() != wxID_OK )
797  return;
798 
799  wxString fileName = fileDialog.GetPath();
800  wxString shortFileName;
801 
802  // Try to use a project-relative path first:
803  if( !m_projectPath.IsEmpty() && fileName.StartsWith( m_projectPath ) )
804  {
805  fn = wxFileName( fileName );
806  fn.MakeRelativeTo( m_projectPath );
807  shortFileName = fn.GetFullPath();
808  }
809  else
810  {
811  // Failing that see if we can shorten it with env vars:
812  shortFileName = NormalizePath( fileName, &Pgm().GetLocalEnvVariables(), nullptr );
813  }
814 
815  std::unique_ptr<DS_DATA_MODEL> ws = std::make_unique<DS_DATA_MODEL>();
816 
817  if( ws->LoadDrawingSheet( fileName ) )
818  {
819  delete m_drawingSheet;
820 
821  m_drawingSheet = ws.release();
822 
823  SetWksFileName( shortFileName );
824 
827  }
828 }
void SetWksFileName(const wxString &aFilename)
const wxString GetWksFileName()
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
DS_DATA_MODEL * m_drawingSheet
Temporary title block (basic inscriptions).
#define _(s)
const char * name
Definition: DXF_plotter.cpp:56
wxString DrawingSheetFileWildcard()
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:69

References _, DrawingSheetFileWildcard(), GetPageLayoutInfoFromDialog(), GetWksFileName(), m_drawingSheet, m_projectPath, name, NormalizePath(), path, Pgm(), SetWksFileName(), and UpdateDrawingSheetExample().

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

37 {
38  return Kiway().Prj();
39 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:190

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), DIALOG_EXPORT_SVG::ExportSVGFile(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_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(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIM_PLOT_FRAME::getDefaultFilename(), SIM_PLOT_FRAME::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIM_PLOT_FRAME::loadWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::OnPageChange(), DIALOG_BOARD_SETUP::OnPageChange(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_TEXT_AND_LABEL_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDXF(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), SCH_BASE_FRAME::saveSymbolLibTables(), SIM_PLOT_FRAME::saveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SCH_EDIT_FRAME::updateAutoSaveFile(), UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), 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 287 of file dialog_shim.cpp.

288 {
289  const char* hash_key;
290 
291  if( m_hash_key.size() )
292  {
293  // a special case like EDA_LIST_DIALOG, which has multiple uses.
294  hash_key = m_hash_key.c_str();
295  }
296  else
297  {
298  hash_key = typeid(*this).name();
299  }
300 
301  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
302 
303  if( it == class_map.end() )
304  return;
305 
306  wxRect rect = it->second;
307  rect.SetSize( wxSize( 0, 0 ) );
308  class_map[ hash_key ] = rect;
309 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SavePageSettings()

bool DIALOG_PAGES_SETTINGS::SavePageSettings ( )
private

Definition at line 461 of file dialog_page_settings.cpp.

462 {
463  bool success = false;
464 
465  wxString fileName = GetWksFileName();
466 
467  if( fileName != BASE_SCREEN::m_DrawingSheetFileName )
468  {
469  wxString fullFileName = DS_DATA_MODEL::ResolvePath( fileName, m_projectPath );
470 
471  if( !fullFileName.IsEmpty() && !wxFileExists( fullFileName ) )
472  {
473  wxString msg;
474  msg.Printf( _( "Drawing sheet file '%s' not found." ), fullFileName );
475  wxMessageBox( msg );
476  return false;
477  }
478 
482  }
483 
484  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
485  const wxString paperType = m_pageFmt[idx];
486 
487  if( paperType.Contains( PAGE_INFO::Custom ) )
488  {
490 
491  success = m_pageInfo.SetType( PAGE_INFO::Custom );
492 
493  if( success )
494  {
497 
500  }
501  }
502  else
503  {
504  // search for longest common string first, e.g. A4 before A
505  if( paperType.Contains( PAGE_INFO::USLetter ) )
507  else if( paperType.Contains( PAGE_INFO::USLegal ) )
509  else if( paperType.Contains( PAGE_INFO::USLedger ) )
511  else if( paperType.Contains( PAGE_INFO::GERBER ) )
512  success = m_pageInfo.SetType( PAGE_INFO::GERBER );
513  else if( paperType.Contains( PAGE_INFO::A5 ) )
514  success = m_pageInfo.SetType( PAGE_INFO::A5 );
515  else if( paperType.Contains( PAGE_INFO::A4 ) )
516  success = m_pageInfo.SetType( PAGE_INFO::A4 );
517  else if( paperType.Contains( PAGE_INFO::A3 ) )
518  success = m_pageInfo.SetType( PAGE_INFO::A3 );
519  else if( paperType.Contains( PAGE_INFO::A2 ) )
520  success = m_pageInfo.SetType( PAGE_INFO::A2 );
521  else if( paperType.Contains( PAGE_INFO::A1 ) )
522  success = m_pageInfo.SetType( PAGE_INFO::A1 );
523  else if( paperType.Contains( PAGE_INFO::A0 ) )
524  success = m_pageInfo.SetType( PAGE_INFO::A0 );
525  else if( paperType.Contains( PAGE_INFO::A ) )
526  success = m_pageInfo.SetType( PAGE_INFO::A );
527  else if( paperType.Contains( PAGE_INFO::B ) )
528  success = m_pageInfo.SetType( PAGE_INFO::B );
529  else if( paperType.Contains( PAGE_INFO::C ) )
530  success = m_pageInfo.SetType( PAGE_INFO::C );
531  else if( paperType.Contains( PAGE_INFO::D ) )
532  success = m_pageInfo.SetType( PAGE_INFO::D );
533  else if( paperType.Contains( PAGE_INFO::E ) )
534  success = m_pageInfo.SetType( PAGE_INFO::E );
535 
536  if( success )
537  {
538  int choice = m_orientationComboBox->GetSelection();
539  m_pageInfo.SetPortrait( choice != 0 );
540  }
541  }
542 
543  if( !success )
544  {
545  wxASSERT_MSG( false,
546  _( "the translation for paper size must preserve original spellings" ) );
548  }
549 
551 
552  m_tb.SetRevision( m_TextRevision->GetValue() );
553  m_tb.SetDate( m_TextDate->GetValue() );
554  m_tb.SetCompany( m_TextCompany->GetValue() );
555  m_tb.SetTitle( m_TextTitle->GetValue() );
556  m_tb.SetComment( 0, m_TextComment1->GetValue() );
557  m_tb.SetComment( 1, m_TextComment2->GetValue() );
558  m_tb.SetComment( 2, m_TextComment3->GetValue() );
559  m_tb.SetComment( 3, m_TextComment4->GetValue() );
560  m_tb.SetComment( 4, m_TextComment5->GetValue() );
561  m_tb.SetComment( 5, m_TextComment6->GetValue() );
562  m_tb.SetComment( 6, m_TextComment7->GetValue() );
563  m_tb.SetComment( 7, m_TextComment8->GetValue() );
564  m_tb.SetComment( 8, m_TextComment9->GetValue() );
565 
567 
568  return onSavePageSettings();
569 }
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)=0
static const wxChar A[]
Definition: page_info.h:68
virtual void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)=0
void SetRevision(const wxString &aRevision)
Definition: title_block.h:81
static const wxChar E[]
Definition: page_info.h:72
static const wxChar GERBER[]
Definition: page_info.h:73
TITLE_BLOCK m_tb
true if the page selection is custom
static const wxChar A3[]
Definition: page_info.h:64
static void SetCustomWidthMils(int aWidthInMils)
Set the width of Custom page in mils for any custom page constructed or made via SetType() after maki...
Definition: page_info.cpp:231
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
Definition: page_info.cpp:119
void SetDate(const wxString &aDate)
Set the date field, and defaults to the current time and date.
Definition: title_block.h:71
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:77
static const wxChar D[]
Definition: page_info.h:71
const wxString GetWksFileName()
wxSize m_layout_size
Temporary bitmap for the drawing sheet example.
static const wxString ResolvePath(const wxString &aPath, const wxString &aProjectPath)
Resolve a path which might be project-relative or contain env variable references.
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
static const wxChar USLegal[]
Definition: page_info.h:75
virtual bool onSavePageSettings()
static const wxChar B[]
Definition: page_info.h:69
void SetComment(int aIdx, const wxString &aComment)
Definition: title_block.h:101
static const wxChar C[]
Definition: page_info.h:70
void SetCompany(const wxString &aCompany)
Definition: title_block.h:91
#define _(s)
static const wxChar A4[]
Definition: page_info.h:63
void SetTitle(const wxString &aTitle)
Definition: title_block.h:58
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
static const wxChar USLedger[]
Definition: page_info.h:76
static const wxChar A1[]
Definition: page_info.h:66
static const wxChar USLetter[]
Definition: page_info.h:74
PAGE_INFO m_pageInfo
The max page size allowed by the caller frame.
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:243
static const wxChar A5[]
Definition: page_info.h:62
bool LoadDrawingSheet(const wxString &aFullFileName=wxEmptyString, bool Append=false)
Populates the list with a custom layout or the default layout if no custom layout is available.
static const wxChar A2[]
Definition: page_info.h:65
void SetPortrait(bool aIsPortrait)
Rotate the paper page 90 degrees.
Definition: page_info.cpp:186
static void SetCustomHeightMils(int aHeightInMils)
Set the height of Custom page in mils for any custom page constructed or made via SetType() after mak...
Definition: page_info.cpp:237
static const wxChar A0[]
Definition: page_info.h:67

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, GetCustomSizeMilsFromDialog(), DS_DATA_MODEL::GetTheInstance(), GetWksFileName(), DS_DATA_MODEL::LoadDrawingSheet(), BASE_SCREEN::m_DrawingSheetFileName, m_layout_size, m_localPrjConfigChanged, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, m_pageInfo, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, m_projectPath, 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, onSavePageSettings(), DS_DATA_MODEL::ResolvePath(), TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), PAGE_INFO::SetCustomHeightMils(), PAGE_INFO::SetCustomWidthMils(), TITLE_BLOCK::SetDate(), PAGE_INFO::SetHeightMils(), 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 TransferDataFromWindow().

◆ SetCurrentPageSizeSelection()

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

Definition at line 572 of file dialog_page_settings.cpp.

573 {
574  // search all the not translated label list containing our paper type
575  for( unsigned i = 0; i < m_pageFmt.GetCount(); ++i )
576  {
577  // parse each label looking for aPaperSize within it
578  wxStringTokenizer st( m_pageFmt[i] );
579 
580  while( st.HasMoreTokens() )
581  {
582  if( st.GetNextToken() == aPaperSize )
583  {
584  m_paperSizeComboBox->SetSelection( i );
585  return;
586  }
587  }
588  }
589 }

References m_pageFmt, and DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox.

Referenced by TransferDataToWindow().

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

98  {
99  m_initialFocusTarget = aWindow;
100  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_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_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), 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_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_AND_LABEL_PROPERTIES::DIALOG_TEXT_AND_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::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(), SYMBOL_EDIT_FRAME::saveSymbolAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
aKiwayis often from a parent window or from KIFACE::CreateWindow().

Definition at line 43 of file kiway_holder.cpp.

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

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 190 of file dialog_shim.cpp.

191 {
192  wxDialog::SetPosition( aNewPosition );
193 
194  // Now update the stored position:
195  const char* hash_key;
196 
197  if( m_hash_key.size() )
198  {
199  // a special case like EDA_LIST_DIALOG, which has multiple uses.
200  hash_key = m_hash_key.c_str();
201  }
202  else
203  {
204  hash_key = typeid(*this).name();
205  }
206 
207  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
208 
209  if( it == class_map.end() )
210  return;
211 
212  wxRect rect = it->second;
213  rect.SetPosition( aNewPosition );
214 
215  class_map[ hash_key ] = rect;
216 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map
void SetPosition(const wxString &aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)

References class_map, DIALOG_SHIM::m_hash_key, and PCAD2KICAD::SetPosition().

Referenced by PCB_BASE_FRAME::SelectOneLayer().

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

163 {
164  wxSize sz( x, y );
165  SetSize( ConvertDialogToPixels( sz ) );
166 }

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

220 {
221  bool ret;
222  const char* hash_key;
223 
224  if( m_hash_key.size() )
225  {
226  // a special case like EDA_LIST_DIALOG, which has multiple uses.
227  hash_key = m_hash_key.c_str();
228  }
229  else
230  {
231  hash_key = typeid(*this).name();
232  }
233 
234  // Show or hide the window. If hiding, save current position and size.
235  // If showing, use previous position and size.
236  if( show )
237  {
238 #ifndef __WINDOWS__
239  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
240 #endif
241  ret = wxDialog::Show( show );
242 
243  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
244  wxRect savedDialogRect = class_map[ hash_key ];
245 
246  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
247  {
248  if( m_useCalculatedSize )
249  {
250  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
251  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
252  }
253  else
254  {
255  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
256  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
257  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
258  0 );
259  }
260  }
261  else if( m_initialSize != wxDefaultSize )
262  SetSize( m_initialSize );
263 
264  // Be sure that the dialog appears in a visible area
265  // (the dialog position might have been stored at the time when it was
266  // shown on another display)
267  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
268  Centre();
269  }
270  else
271  {
272  // Save the dialog's position & size before hiding, using classname as key
273  class_map[ hash_key ] = wxRect( wxDialog::GetPosition(), wxDialog::GetSize() );
274 
275 #ifdef __WXMAC__
276  if ( m_eventLoop )
277  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
278 #endif
279 
280  ret = wxDialog::Show( show );
281  }
282 
283  return ret;
284 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map
bool m_useCalculatedSize
Definition: dialog_shim.h:203
wxSize m_initialSize
Definition: dialog_shim.h:221

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), DRC_TOOL::CrossProbe(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 423 of file dialog_shim.cpp.

424 {
425  // This is an exception safe way to zero a pointer before returning.
426  // Yes, even though DismissModal() clears this first normally, this is
427  // here in case there's an exception before the dialog is dismissed.
428  struct NULLER
429  {
430  void*& m_what;
431  NULLER( void*& aPtr ) : m_what( aPtr ) {}
432  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
433  } clear_this( (void*&) m_qmodal_loop );
434 
435  // release the mouse if it's currently captured as the window having it
436  // will be disabled when this dialog is shown -- but will still keep the
437  // capture making it impossible to do anything in the modal dialog itself
438  wxWindow* win = wxWindow::GetCapture();
439  if( win )
440  win->ReleaseMouse();
441 
442  // Get the optimal parent
443  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
444 
445  wxASSERT_MSG( !m_qmodal_parent_disabler,
446  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
447 
448  // quasi-modal: disable only my "optimal" parent
450 
451  // Apple in its infinite wisdom will raise a disabled window before even passing
452  // us the event, so we have no way to stop it. Instead, we must set an order on
453  // the windows so that the quasi-modal will be pushed in front of the disabled
454  // window when it is raised.
456 
457  Show( true );
458 
459  m_qmodal_showing = true;
460 
461  WX_EVENT_LOOP event_loop;
462 
463  m_qmodal_loop = &event_loop;
464 
465  event_loop.Run();
466 
467  m_qmodal_showing = false;
468 
469  return GetReturnCode();
470 }
bool m_qmodal_showing
Definition: dialog_shim.h:213
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:44
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:65

References 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 SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ TransferDataFromWindow()

bool DIALOG_PAGES_SETTINGS::TransferDataFromWindow ( )
overrideprivatevirtual

Definition at line 208 of file dialog_page_settings.cpp.

209 {
210  int idx = std::max( m_paperSizeComboBox->GetSelection(), 0 );
211  const wxString paperType = m_pageFmt[idx];
212 
213  if( paperType.Contains( PAGE_INFO::Custom ) )
214  {
216  return false;
217 
219  return false;
220  }
221 
222  if( SavePageSettings() )
223  {
225 
226  if( LocalPrjConfigChanged() )
228 
229  // Call the post processing (if any) after changes
231  }
232 
233  return true;
234 }
wxSize m_maxPageSizeMils
Logical drawing sheet size.
virtual void SaveProjectSettings()
Save changes to the project settings to the project (.pro) file.
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:77
#define MIN_PAGE_SIZE_MILS
Min and max page sizes for clamping, in mils.
Definition: page_info.h:39
void SetContentModified(bool aModified=true)
Definition: base_screen.h:59
virtual void OnPageSettingsChange()
Called when modifying the page settings.
virtual bool Validate(double aMin, double aMax, EDA_UNITS aUnits=EDA_UNITS::UNSCALED)
Validate the control against the given range, informing the user of any errors found.

References PAGE_INFO::Custom, LocalPrjConfigChanged(), m_customSizeX, m_customSizeY, m_maxPageSizeMils, m_pageFmt, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, m_screen, MILS, MIN_PAGE_SIZE_MILS, EDA_DRAW_FRAME::OnPageSettingsChange(), SavePageSettings(), EDA_BASE_FRAME::SaveProjectSettings(), BASE_SCREEN::SetContentModified(), and UNIT_BINDER::Validate().

◆ TransferDataToWindow()

bool DIALOG_PAGES_SETTINGS::TransferDataToWindow ( )
overrideprivatevirtual

Definition at line 125 of file dialog_page_settings.cpp.

126 {
127  wxString msg;
128 
129  // initialize page format choice box and page format list.
130  // The first shows translated strings, the second contains not translated strings
131  m_paperSizeComboBox->Clear();
132 
133  for( const wxString& pageFmt : pageFmts )
134  {
135  m_pageFmt.Add( pageFmt );
136  m_paperSizeComboBox->Append( wxGetTranslation( pageFmt ) );
137  }
138 
139  // initialize the drawing sheet filename
141 
144  m_orientationComboBox->SetSelection( m_pageInfo.IsPortrait() );
145 
146  // only a click fires the "selection changed" event, so have to fabricate this check
147  wxCommandEvent dummy;
149 
150  if( m_customFmt )
151  {
154  }
155  else
156  {
159  }
160 
161  m_TextRevision->SetValue( m_tb.GetRevision() );
162  m_TextDate->SetValue( m_tb.GetDate() );
163  m_TextTitle->SetValue( m_tb.GetTitle() );
164  m_TextCompany->SetValue( m_tb.GetCompany() );
165  m_TextComment1->SetValue( m_tb.GetComment( 0 ) );
166  m_TextComment2->SetValue( m_tb.GetComment( 1 ) );
167  m_TextComment3->SetValue( m_tb.GetComment( 2 ) );
168  m_TextComment4->SetValue( m_tb.GetComment( 3 ) );
169  m_TextComment5->SetValue( m_tb.GetComment( 4 ) );
170  m_TextComment6->SetValue( m_tb.GetComment( 5 ) );
171  m_TextComment7->SetValue( m_tb.GetComment( 6 ) );
172  m_TextComment8->SetValue( m_tb.GetComment( 7 ) );
173  m_TextComment9->SetValue( m_tb.GetComment( 8 ) );
174 
175  // The default is to disable aall these fields for the "generic" dialog
176  m_TextSheetCount->Show( false );
177  m_TextSheetNumber->Show( false );
178  m_PaperExport->Show( false );
179  m_RevisionExport->Show( false );
180  m_DateExport->Show( false );
181  m_TitleExport->Show( false );
182  m_CompanyExport->Show( false );
183  m_Comment1Export->Show( false );
184  m_Comment2Export->Show( false );
185  m_Comment3Export->Show( false );
186  m_Comment4Export->Show( false );
187  m_Comment5Export->Show( false );
188  m_Comment6Export->Show( false );
189  m_Comment7Export->Show( false );
190  m_Comment8Export->Show( false );
191  m_Comment9Export->Show( false );
192 
194 
197 
198  GetSizer()->SetSizeHints( this );
199 
200  // Make the OK button the default.
201  m_sdbSizerOK->SetDefault();
202  m_initialized = true;
203 
204  return true;
205 }
virtual void onTransferDataToWindow()
static int GetCustomHeightMils()
Definition: page_info.h:165
const wxString & GetComment(int aIdx) const
Definition: title_block.h:107
int GetHeightMils() const
Definition: page_info.h:133
TITLE_BLOCK m_tb
true if the page selection is custom
void SetWksFileName(const wxString &aFilename)
const wxString & GetType() const
Definition: page_info.h:94
bool m_initialized
list of page sizes (not translated)
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
virtual const PAGE_INFO & GetPageSettings() const =0
const wxString & GetRevision() const
Definition: title_block.h:86
const wxString & GetCompany() const
Definition: title_block.h:96
void SetCurrentPageSizeSelection(const wxString &aPaperSize)
const wxString & GetDate() const
Definition: title_block.h:76
PAGE_INFO m_pageInfo
The max page size allowed by the caller frame.
bool IsPortrait() const
Definition: page_info.h:117
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85
static const wxString pageFmts[]
virtual void SetValue(int aValue)
Set new value (in Internal Units) for the text field, taking care of units conversion.
static int GetCustomWidthMils()
Definition: page_info.h:160
bool m_customFmt
Temporary page info.
const wxString & GetTitle() const
Definition: title_block.h:63
void OnPaperSizeChoice(wxCommandEvent &event) override
int GetWidthMils() const
Definition: page_info.h:130

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(), 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, BASE_SCREEN::m_DrawingSheetFileName, m_initialized, m_iuPerMils, DIALOG_PAGES_SETTINGS_BASE::m_orientationComboBox, m_pageFmt, m_pageInfo, DIALOG_PAGES_SETTINGS_BASE::m_PaperExport, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, DIALOG_PAGES_SETTINGS_BASE::m_RevisionExport, 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(), onTransferDataToWindow(), pageFmts, SetCurrentPageSizeSelection(), UNIT_BINDER::SetValue(), SetWksFileName(), and UpdateDrawingSheetExample().

◆ UpdateDrawingSheetExample()

void DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample ( )
private

Definition at line 592 of file dialog_page_settings.cpp.

593 {
594  int lyWidth, lyHeight;
595 
596  wxSize clamped_layout_size( Clamp( MIN_PAGE_SIZE_MILS, m_layout_size.x, m_maxPageSizeMils.x ),
598 
599  double lyRatio = clamped_layout_size.x < clamped_layout_size.y ?
600  (double) clamped_layout_size.y / clamped_layout_size.x :
601  (double) clamped_layout_size.x / clamped_layout_size.y;
602 
603  if( clamped_layout_size.x < clamped_layout_size.y )
604  {
605  lyHeight = MAX_PAGE_EXAMPLE_SIZE;
606  lyWidth = KiROUND( (double) lyHeight / lyRatio );
607  }
608  else
609  {
610  lyWidth = MAX_PAGE_EXAMPLE_SIZE;
611  lyHeight = KiROUND( (double) lyWidth / lyRatio );
612  }
613 
614  if( m_pageBitmap )
615  {
616  m_PageLayoutExampleBitmap->SetBitmap( wxNullBitmap );
617  delete m_pageBitmap;
618  }
619 
620  m_pageBitmap = new wxBitmap( lyWidth + 1, lyHeight + 1 );
621 
622  if( m_pageBitmap->IsOk() )
623  {
624  double scaleW = (double) lyWidth / clamped_layout_size.x;
625  double scaleH = (double) lyHeight / clamped_layout_size.y;
626  double scale = std::min( scaleW, scaleH );
627 
628  // Prepare DC.
629  wxSize example_size( lyWidth + 1, lyHeight + 1 );
630  wxMemoryDC memDC;
631  memDC.SelectObject( *m_pageBitmap );
632  memDC.SetClippingRegion( wxPoint( 0, 0 ), example_size );
633  memDC.Clear();
634  memDC.SetUserScale( scale, scale );
635 
636  // Get logical page size and margins.
637  PAGE_INFO pageDUMMY;
638 
639  // Get page type
640  int idx = m_paperSizeComboBox->GetSelection();
641 
642  if( idx < 0 )
643  idx = 0;
644 
645  wxString pageFmtName = m_pageFmt[idx].BeforeFirst( ' ' );
646  bool portrait = clamped_layout_size.x < clamped_layout_size.y;
647  pageDUMMY.SetType( pageFmtName, portrait );
648 
649  if( m_customFmt )
650  {
651  pageDUMMY.SetWidthMils( clamped_layout_size.x );
652  pageDUMMY.SetHeightMils( clamped_layout_size.y );
653  }
654 
655  // Draw layout preview.
656  KIGFX::DS_RENDER_SETTINGS renderSettings;
657  COLOR_SETTINGS* colorSettings = m_parent->GetColorSettings();
658  COLOR4D bgColor = m_parent->GetDrawBgColor();
659  wxString emptyString;
660 
662  {
663  GRResetPenAndBrush( &memDC );
664  renderSettings.SetDefaultPenWidth( 1 );
665  renderSettings.LoadColors( colorSettings );
666  renderSettings.SetPrintDC( &memDC );
667 
668  if( m_parent->IsType( FRAME_SCH )
672  {
674  renderSettings.SetLayerColor( LAYER_DRAWINGSHEET, color );
675  }
676 
677  GRFilledRect( nullptr, &memDC, 0, 0, m_layout_size.x, m_layout_size.y, bgColor,
678  bgColor );
679 
680  PrintDrawingSheet( &renderSettings, pageDUMMY, emptyString, emptyString, m_tb,
682  wxEmptyString, m_screen->GetVirtualPageNumber() == 1 );
683 
684  memDC.SelectObject( wxNullBitmap );
686  }
687 
689 
690  // Refresh the dialog.
691  Layout();
692  Refresh();
693  }
694 }
void GRResetPenAndBrush(wxDC *DC)
Definition: gr_basic.cpp:111
wxSize m_maxPageSizeMils
Logical drawing sheet size.
void GRFilledRect(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, const COLOR4D &Color, const COLOR4D &BgColor)
Definition: gr_basic.cpp:811
TITLE_BLOCK m_tb
true if the page selection is custom
int color
Definition: DXF_plotter.cpp:57
int GetVirtualPageNumber() const
Definition: base_screen.h:75
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Set the name of the page type and also the sizes and margins commonly associated with that type name.
Definition: page_info.cpp:119
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
int GetPageCount() const
Definition: base_screen.h:72
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 drawing sheet example.
const wxString & GetPageNumber() const
Definition: base_screen.cpp:71
Store page-layout-specific render settings.
Definition: ds_painter.h:46
DS_DATA_MODEL * m_drawingSheet
Temporary title block (basic inscriptions).
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:53
void PrintDrawingSheet(const RENDER_SETTINGS *aSettings, const PAGE_INFO &aPageInfo, const wxString &aFullSheetName, const wxString &aFileName, const TITLE_BLOCK &aTitleBlock, int aSheetCount, const wxString &aPageNumber, double aMils2Iu, const PROJECT *aProject, const wxString &aSheetLayer, bool aIsFirstPage)
Print the border and title block.
static void SetAltInstance(DS_DATA_MODEL *aLayout=nullptr)
Set an alternate instance of DS_DATA_MODEL.
void SetLayerColor(int aLayer, const COLOR4D &aColor)
Change the color used to draw a layer.
drawingsheet frame and titleblock
Definition: layer_ids.h:213
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:257
wxBitmap * m_pageBitmap
the page layuout filename was changed
const int scale
bool IsType(FRAME_T aType) const
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:73
const T & Clamp(const T &lower, const T &value, const T &upper)
Limit value within the range lower <= value <= upper.
Definition: util.h:52
bool m_customFmt
Temporary page info.
Color settings are a bit different than most of the settings objects in that there can be more than o...
virtual COLOR4D GetDrawBgColor() const
virtual COLOR_SETTINGS * GetColorSettings() const
Returns a pointer to the active color theme settings.
void SetDefaultPenWidth(int aWidth)
void LoadColors(const COLOR_SETTINGS *aSettings) override
Definition: ds_painter.cpp:57
void SetPrintDC(wxDC *aDC)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

References Clamp(), color, emptyString, FRAME_SCH, FRAME_SCH_SYMBOL_EDITOR, FRAME_SCH_VIEWER, FRAME_SCH_VIEWER_MODAL, EDA_DRAW_FRAME::GetColorSettings(), EDA_DRAW_FRAME::GetDrawBgColor(), KIGFX::RENDER_SETTINGS::GetLayerColor(), BASE_SCREEN::GetPageCount(), BASE_SCREEN::GetPageNumber(), BASE_SCREEN::GetVirtualPageNumber(), GRFilledRect(), GRResetPenAndBrush(), EDA_BASE_FRAME::IsType(), KiROUND(), LAYER_DRAWINGSHEET, LAYER_SCHEMATIC_DRAWINGSHEET, KIGFX::DS_RENDER_SETTINGS::LoadColors(), m_customFmt, m_drawingSheet, m_layout_size, m_maxPageSizeMils, m_pageBitmap, m_pageFmt, DIALOG_PAGES_SETTINGS_BASE::m_PageLayoutExampleBitmap, DIALOG_PAGES_SETTINGS_BASE::m_paperSizeComboBox, m_parent, m_screen, m_tb, MAX_PAGE_EXAMPLE_SIZE, MIN_PAGE_SIZE_MILS, PrintDrawingSheet(), KIWAY_HOLDER::Prj(), Refresh(), scale, DS_DATA_MODEL::SetAltInstance(), KIGFX::RENDER_SETTINGS::SetDefaultPenWidth(), PAGE_INFO::SetHeightMils(), KIGFX::RENDER_SETTINGS::SetLayerColor(), KIGFX::RENDER_SETTINGS::SetPrintDC(), PAGE_INFO::SetType(), and PAGE_INFO::SetWidthMils().

Referenced by OnComment1TextUpdated(), OnComment2TextUpdated(), OnComment3TextUpdated(), OnComment4TextUpdated(), OnComment5TextUpdated(), OnComment6TextUpdated(), OnComment7TextUpdated(), OnComment8TextUpdated(), OnComment9TextUpdated(), OnCompanyTextUpdated(), OnDateTextUpdated(), OnPageOrientationChoice(), OnPaperSizeChoice(), OnRevisionTextUpdated(), OnTitleTextUpdated(), OnUserPageSizeXTextUpdated(), OnUserPageSizeYTextUpdated(), OnWksFileSelection(), and TransferDataToWindow().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 176 of file dialog_shim.cpp.

177 {
178  wxSize sz( 0, y );
179  return ConvertDialogToPixels( sz ).y;
180 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_ApplyDate

wxButton* DIALOG_PAGES_SETTINGS_BASE::m_ApplyDate
protectedinherited

◆ m_browseButton

wxBitmapButton* DIALOG_PAGES_SETTINGS_BASE::m_browseButton
protectedinherited

◆ m_Comment1Export

◆ m_Comment2Export

◆ m_Comment3Export

◆ m_Comment4Export

◆ m_Comment5Export

◆ m_Comment6Export

◆ m_Comment7Export

◆ m_Comment8Export

◆ m_Comment9Export

◆ m_CompanyExport

◆ m_customFmt

bool DIALOG_PAGES_SETTINGS::m_customFmt
protected

Temporary page info.

Definition at line 126 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), OnPaperSizeChoice(), TransferDataToWindow(), and UpdateDrawingSheetExample().

◆ m_customSizeX

UNIT_BINDER DIALOG_PAGES_SETTINGS::m_customSizeX
private

◆ m_customSizeY

UNIT_BINDER DIALOG_PAGES_SETTINGS::m_customSizeY
private

◆ m_DateExport

◆ m_drawingSheet

DS_DATA_MODEL* DIALOG_PAGES_SETTINGS::m_drawingSheet
protected

Temporary title block (basic inscriptions).

Definition at line 128 of file dialog_page_settings.h.

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

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 209 of file dialog_shim.h.

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

◆ m_initialized

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 221 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_iuPerMils

double DIALOG_PAGES_SETTINGS::m_iuPerMils
protected

Definition at line 130 of file dialog_page_settings.h.

Referenced by GetCustomSizeMilsFromDialog(), and TransferDataToWindow().

◆ m_layout_size

wxSize DIALOG_PAGES_SETTINGS::m_layout_size
protected

Temporary bitmap for the drawing sheet example.

Definition at line 123 of file dialog_page_settings.h.

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

◆ m_localPrjConfigChanged

bool DIALOG_PAGES_SETTINGS::m_localPrjConfigChanged
protected

◆ m_maxPageSizeMils

wxSize DIALOG_PAGES_SETTINGS::m_maxPageSizeMils
protected

Logical drawing sheet size.

Definition at line 124 of file dialog_page_settings.h.

Referenced by DIALOG_PAGES_SETTINGS(), TransferDataFromWindow(), and UpdateDrawingSheetExample().

◆ m_orientationComboBox

◆ m_pageBitmap

wxBitmap* DIALOG_PAGES_SETTINGS::m_pageBitmap
protected

the page layuout filename was changed

Definition at line 122 of file dialog_page_settings.h.

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

◆ m_pageFmt

◆ m_pageInfo

PAGE_INFO DIALOG_PAGES_SETTINGS::m_pageInfo
protected

The max page size allowed by the caller frame.

Definition at line 125 of file dialog_page_settings.h.

Referenced by DIALOG_EESCHEMA_PAGE_SETTINGS::onSavePageSettings(), SavePageSettings(), and TransferDataToWindow().

◆ m_PageLayoutExampleBitmap

wxStaticBitmap* DIALOG_PAGES_SETTINGS_BASE::m_PageLayoutExampleBitmap
protectedinherited

◆ m_PaperExport

◆ m_paperSizeComboBox

◆ m_parent

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_PickDate

wxDatePickerCtrl* DIALOG_PAGES_SETTINGS_BASE::m_PickDate
protectedinherited

◆ m_projectPath

wxString DIALOG_PAGES_SETTINGS::m_projectPath
protected

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_RevisionExport

◆ m_screen

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

wxStaticLine* DIALOG_PAGES_SETTINGS_BASE::m_staticline4
protectedinherited

◆ m_staticline5

wxStaticLine* DIALOG_PAGES_SETTINGS_BASE::m_staticline5
protectedinherited

◆ m_staticText30

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

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

◆ m_TextComment2

◆ m_TextComment3

◆ m_TextComment4

◆ m_TextComment5

◆ m_TextComment6

◆ m_TextComment7

◆ m_TextComment8

◆ m_TextComment9

◆ m_TextCompany

◆ m_textCtrlFilePicker

wxTextCtrl* DIALOG_PAGES_SETTINGS_BASE::m_textCtrlFilePicker
protectedinherited

◆ m_TextDate

◆ m_TextRevision

◆ m_TextSheetCount

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_TextSheetCount
protectedinherited

◆ m_TextSheetNumber

wxStaticText* DIALOG_PAGES_SETTINGS_BASE::m_TextSheetNumber
protectedinherited

◆ m_TextTitle

◆ m_TitleExport

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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