KiCad PCB EDA Suite
Loading...
Searching...
No Matches
DIALOG_BOARD_STATISTICS Class Reference

Dialog to show common board info. More...

#include <dialog_board_statistics.h>

Inheritance diagram for DIALOG_BOARD_STATISTICS:
DIALOG_BOARD_STATISTICS_BASE DIALOG_SHIM KIWAY_HOLDER

Classes

struct  FP_LINE_ITEM
 Footprint attributes (such as SMD, THT, Virtual and so on), which will be shown in the dialog. More...
 
struct  INFO_LINE_ITEM
 Type information, which will be shown in dialog. More...
 

Public Types

enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 DIALOG_BOARD_STATISTICS (PCB_EDIT_FRAME *aParentFrame)
 
 ~DIALOG_BOARD_STATISTICS ()
 Get data from the PCB board and print it to dialog.
 
bool TransferDataToWindow () override
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
 
int ShowModal () override
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal () const
 
void PrepareForModalSubDialog ()
 
void CleanupAfterModalSubDialog ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
void OnModify ()
 
void ClearModify ()
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position.
 
EDA_UNITS GetUserUnits () const
 
void SelectAllInTextCtrls (wxWindowList &children)
 
void SetupStandardButtons (std::map< int, wxString > aLabels={})
 
void LoadControlState ()
 Load persisted control values from the current project's local settings.
 
void SaveControlState ()
 Save control values and geometry to the current project's local settings.
 
void OptOut (wxWindow *aWindow)
 Opt out of control state saving.
 
void RegisterUnitBinder (UNIT_BINDER *aUnitBinder, wxWindow *aWindow)
 Register a UNIT_BINDER so that it can handle units in control-state save/restore.
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in.
 
bool HasKiway () const
 Safety check before asking for the Kiway reference.
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY.
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*.
 

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 windowSize (wxSizeEvent &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.
 
void setSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units".
 
int horizPixelsFromDU (int x) const
 Convert an integer number of dialog units to pixels, horizontally.
 
int vertPixelsFromDU (int y) const
 Convert an integer number of dialog units to pixels, vertically.
 
void resetSize ()
 Clear the existing dialog size and position.
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 
virtual void TearDownQuasiModal ()
 Override this method to perform dialog tear down actions not suitable for object dtor.
 

Protected Attributes

wxNotebook * topNotebook
 
wxPanel * m_generalPanel
 
wxStaticText * m_componentsLabel
 
wxGrid * m_gridComponents
 
wxStaticText * m_padsLabel
 
wxGrid * m_gridPads
 
wxStaticText * m_boardLabel
 
wxGrid * m_gridBoard
 
wxStaticText * m_viasLabel
 
wxGrid * m_gridVias
 
wxCheckBox * m_checkBoxSubtractHoles
 
wxCheckBox * m_checkBoxSubtractHolesFromCopper
 
wxCheckBox * m_checkBoxExcludeComponentsNoPins
 
wxPanel * m_drillsPanel
 
WX_GRIDm_gridDrills
 
wxButton * m_buttonSaveReport
 
wxStdDialogButtonSizer * m_sdbControlSizer
 
wxButton * m_sdbControlSizerCancel
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
bool m_isClosing
 
wxGUIEventLoop * m_qmodal_loop
 
bool m_qmodal_showing
 
WINDOW_DISABLERm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 
wxSize m_initialSize
 
bool m_userPositioned
 
bool m_userResized
 
std::map< wxWindow *, wxString > m_beforeEditValues
 
std::map< wxWindow *, UNIT_BINDER * > m_unitBinders
 
std::vector< UNDO_STEPm_undoStack
 
std::vector< UNDO_STEPm_redoStack
 
std::map< wxWindow *, wxVariant > m_currentValues
 
bool m_handlingUndoRedo
 

Private Member Functions

void refreshItemsTypes ()
 < Function to fill up all items types to be shown in the dialog.
 
void getDataFromPCB ()
 Apply data to dialog widgets.
 
void updateWidgets ()
 Update drills grid.
 
void updateDrillGrid ()
 Print grid to string in tabular format.
 
void printGridToStringAsTable (wxGrid *aGrid, wxString &aStr, bool aUseColLabels, bool aUseFirstColAsLabel)
 
void adjustDrillGridColumns ()
 
void checkboxClicked (wxCommandEvent &aEvent) override
 Save board statistics to a file.
 
void saveReportClicked (wxCommandEvent &aEvent) override
 
void drillGridSize (wxSizeEvent &aEvent) override
 
void drillGridSort (wxGridEvent &aEvent)
 
void OnCloseWindow (wxCloseEvent &aEvent)
 Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.
 
void OnSize (wxSizeEvent &aEvent)
 
void OnMove (wxMoveEvent &aEvent)
 
void OnButton (wxCommandEvent &aEvent)
 Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.
 
void onChildSetFocus (wxFocusEvent &aEvent)
 
void onInitDialog (wxInitDialogEvent &aEvent)
 
std::string generateKey (const wxWindow *aWin) const
 
void registerUndoRedoHandlers (wxWindowList &aChildren)
 
void recordControlChange (wxWindow *aCtrl)
 
void onCommandEvent (wxCommandEvent &aEvent)
 
void onSpinEvent (wxSpinEvent &aEvent)
 
void onSpinDoubleEvent (wxSpinDoubleEvent &aEvent)
 
void onStyledTextChanged (wxStyledTextEvent &aEvent)
 
void onGridCellChanged (wxGridEvent &aEvent)
 
void onPropertyGridChanged (wxPropertyGridEvent &aEvent)
 
void onDataViewListChanged (wxDataViewEvent &aEvent)
 
void doUndo ()
 
void doRedo ()
 
wxVariant getControlValue (wxWindow *aCtrl)
 
void setControlValue (wxWindow *aCtrl, const wxVariant &aValue)
 
 DECLARE_EVENT_TABLE ()
 

Private Attributes

PCB_EDIT_FRAMEm_frame
 
int m_boardWidth
 
int m_boardHeight
 
double m_boardArea
 
double m_frontCopperArea
 
double m_backCopperArea
 
int m_minClearanceTrackToTrack
 
int m_minTrackWidth
 
int m_minDrillSize
 
int m_boardThickness
 
bool m_hasOutline
 Show if board outline properly defined.
 
std::deque< FP_LINE_ITEMm_fpTypes
 
std::deque< INFO_LINE_ITEM< PAD_ATTRIB > > m_padTypes
 
std::deque< INFO_LINE_ITEM< PAD_PROP > > m_padFabProps
 
std::deque< INFO_LINE_ITEM< VIATYPE > > m_viaTypes
 
std::deque< DRILL_LINE_ITEMm_drillTypes
 
int m_startLayerColInitialSize
 Width of the start layer column as calculated by the wxWidgets autosizing algorithm.
 
int m_stopLayerColInitialSize
 Width of the stop layer column.
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Detailed Description

Dialog to show common board info.

Definition at line 43 of file dialog_board_statistics.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 41 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_BOARD_STATISTICS()

◆ ~DIALOG_BOARD_STATISTICS()

DIALOG_BOARD_STATISTICS::~DIALOG_BOARD_STATISTICS ( )

Get data from the PCB board and print it to dialog.

Definition at line 906 of file dialog_board_statistics.cpp.

Member Function Documentation

◆ adjustDrillGridColumns()

◆ checkboxClicked()

◆ CleanupAfterModalSubDialog()

void DIALOG_SHIM::CleanupAfterModalSubDialog ( )
inherited

Definition at line 1298 of file dialog_shim.cpp.

References m_qmodal_parent_disabler.

◆ ClearModify()

void DIALOG_SHIM::ClearModify ( )
inherited

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )
privateinherited

◆ doRedo()

void DIALOG_SHIM::doRedo ( )
privateinherited

◆ doUndo()

void DIALOG_SHIM::doUndo ( )
privateinherited

◆ drillGridSize()

void DIALOG_BOARD_STATISTICS::drillGridSize ( wxSizeEvent & aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_BOARD_STATISTICS_BASE.

Definition at line 888 of file dialog_board_statistics.cpp.

References adjustDrillGridColumns().

◆ drillGridSort()

void DIALOG_BOARD_STATISTICS::drillGridSort ( wxGridEvent & aEvent)
private

◆ Enable()

bool DIALOG_SHIM::Enable ( bool enable)
overrideinherited

Definition at line 431 of file dialog_shim.cpp.

◆ EndQuasiModal()

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

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BOOK_REPORTER::DIALOG_BOOK_REPORTER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DATABASE_LIB_SETTINGS::DIALOG_DATABASE_LIB_SETTINGS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRAW_LAYERS_SETTINGS::DIALOG_DRAW_LAYERS_SETTINGS(), 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_EXECUTECOMMAND_JOB_SETTINGS::DIALOG_EXECUTECOMMAND_JOB_SETTINGS(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_VRML::DIALOG_EXPORT_VRML(), 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_FP_EDIT_PAD_TABLE::DIALOG_FP_EDIT_PAD_TABLE(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GIT_REPOSITORY::DIALOG_GIT_REPOSITORY(), DIALOG_GIT_SWITCH::DIALOG_GIT_SWITCH(), DIALOG_GLOBAL_EDIT_TEARDROPS::DIALOG_GLOBAL_EDIT_TEARDROPS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), 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_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_CHOOSE_PROJECT::DIALOG_IMPORT_CHOOSE_PROJECT(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JOBSET_RUN_LOG::DIALOG_JOBSET_RUN_LOG(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MAP_LAYERS::DIALOG_MAP_LAYERS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::DIALOG_MULTICHANNEL_REPEAT_LAYOUT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT::DIALOG_PRINT(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SET_OFFSET::DIALOG_SET_OFFSET(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_SYNC_SHEET_PINS::DIALOG_SYNC_SHEET_PINS(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_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_USER_DEFINED_SIGNALS::DIALOG_USER_DEFINED_SIGNALS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PAGED_DIALOG::finishInitialization(), DIALOG_PASTE_SPECIAL::HideClearNets(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), NETLIST_VIEW_DIALOG::NETLIST_VIEW_DIALOG(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SIM_COMMAND::onInitDlg(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), DIALOG_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataToWindow(), WX_MULTI_ENTRY_DIALOG::WX_MULTI_ENTRY_DIALOG(), and WX_PT_ENTRY_DIALOG::WX_PT_ENTRY_DIALOG().

◆ generateKey()

std::string DIALOG_SHIM::generateKey ( const wxWindow * aWin) const
privateinherited

Definition at line 438 of file dialog_shim.cpp.

References makeKey().

Referenced by LoadControlState(), and SaveControlState().

◆ getControlValue()

wxVariant DIALOG_SHIM::getControlValue ( wxWindow * aCtrl)
privateinherited

Definition at line 962 of file dialog_shim.cpp.

References grid.

Referenced by recordControlChange(), and registerUndoRedoHandlers().

◆ getDataFromPCB()

void DIALOG_BOARD_STATISTICS::getDataFromPCB ( )
private

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

◆ GetUserUnits()

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inlineinherited

Safety check before asking for the Kiway reference.

Returns
true if kiway is non-null

Definition at line 65 of file kiway_holder.h.

References m_kiway.

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

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

Referenced by DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), and DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

◆ IsCtrl()

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

Definition at line 127 of file dialog_shim.h.

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 133 of file dialog_shim.h.

◆ 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 55 of file kiway_holder.h.

References m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), IMPORT_PROJ_HELPER::addLocalLibraries(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLibrariesList(), KICAD_MANAGER_FRAME::CloseProject(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), KIWAY_PLAYER::Destroy(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), PCB_CALCULATOR_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), EDA_3D_CANVAS::OnLeftDown(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), Prj(), SCH_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), BOARD_EDITOR_CONTROL::ShowEeschema(), CVPCB_CONTROL::ShowFootprintViewer(), showFrame(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ LoadControlState()

void DIALOG_SHIM::LoadControlState ( )
inherited

Load persisted control values from the current project's local settings.

Controls may opt out by setting the boolean window property "persist" to false. Dialog geometry is stored under the special key "__geometry".

Definition at line 579 of file dialog_shim.cpp.

References generateKey(), PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_dialogControlValues, m_hash_key, m_unitBinders, Pgm(), and PROPERTY_HOLDER::SafeCast().

Referenced by onInitDialog().

◆ OnButton()

void DIALOG_SHIM::OnButton ( wxCommandEvent & aEvent)
privateinherited

Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 1354 of file dialog_shim.cpp.

References EndQuasiModal(), ignore_unused(), and IsQuasiModal().

Referenced by DIALOG_SHIM(), and ~DIALOG_SHIM().

◆ OnCharHook()

◆ onChildSetFocus()

void DIALOG_SHIM::onChildSetFocus ( wxFocusEvent & aEvent)
privateinherited

Definition at line 1392 of file dialog_shim.cpp.

References m_beforeEditValues, and m_isClosing.

Referenced by SelectAllInTextCtrls(), and ~DIALOG_SHIM().

◆ OnCloseWindow()

void DIALOG_SHIM::OnCloseWindow ( wxCloseEvent & aEvent)
privateinherited

Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 1338 of file dialog_shim.cpp.

References APP_MONITOR::AddNavigationBreadcrumb(), EndQuasiModal(), and IsQuasiModal().

Referenced by DIALOG_SHIM(), and ~DIALOG_SHIM().

◆ onCommandEvent()

void DIALOG_SHIM::onCommandEvent ( wxCommandEvent & aEvent)
privateinherited

Definition at line 902 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ onDataViewListChanged()

void DIALOG_SHIM::onDataViewListChanged ( wxDataViewEvent & aEvent)
privateinherited

Definition at line 954 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ onGridCellChanged()

void DIALOG_SHIM::onGridCellChanged ( wxGridEvent & aEvent)
privateinherited

Definition at line 938 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ onInitDialog()

void DIALOG_SHIM::onInitDialog ( wxInitDialogEvent & aEvent)
privateinherited

Definition at line 261 of file dialog_shim.cpp.

References LoadControlState().

Referenced by DIALOG_SHIM(), and ~DIALOG_SHIM().

◆ OnModify()

void DIALOG_SHIM::OnModify ( )
inherited

Definition at line 1196 of file dialog_shim.cpp.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddBodyStyle(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_LIB_FIELDS_TABLE::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onAddGroup(), DIALOG_LIB_SYMBOL_PROPERTIES::OnBodyStyleMoveDown(), DIALOG_LIB_SYMBOL_PROPERTIES::OnBodyStyleMoveUp(), DIALOG_FOOTPRINT_PROPERTIES::OnCheckBox(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnCheckBox(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCheckBox(), DIALOG_SYMBOL_PROPERTIES::OnCheckBox(), DIALOG_FOOTPRINT_PROPERTIES::OnChoice(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnChoice(), DIALOG_FOOTPRINT_PROPERTIES::OnCombobox(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCombobox(), DIALOG_PAD_PROPERTIES::onCornerRadiusChange(), DIALOG_PAD_PROPERTIES::onCornerSizePercentChange(), DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteBodyStyle(), DIALOG_FOOTPRINT_PROPERTIES::OnDeleteField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnDeleteField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_PAD_PROPERTIES::OnDrillShapeSelected(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnGridCellChanged(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onLayerGridRowAddUserLayer(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onLayerGridRowDelete(), DIALOG_PAD_PROPERTIES::onModify(), DIALOG_PAD_PROPERTIES::onModify(), DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveDown(), DIALOG_SYMBOL_PROPERTIES::OnMoveDown(), DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveUp(), DIALOG_SYMBOL_PROPERTIES::OnMoveUp(), DIALOG_PAD_PROPERTIES::OnPadShapeSelection(), DIALOG_SYMBOL_PROPERTIES::OnPinTableCellEdited(), DIALOG_LIB_SYMBOL_PROPERTIES::onPowerCheckBox(), DIALOG_LIB_FIELDS_TABLE::OnRemoveField(), DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onRemoveGroup(), DIALOG_LIB_FIELDS_TABLE::OnRenameField(), DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField(), DIALOG_PAD_PROPERTIES::OnSetCopperLayers(), DIALOG_PAD_PROPERTIES::OnSetLayers(), DIALOG_LIB_SYMBOL_PROPERTIES::OnSymbolNameText(), DIALOG_LIB_FIELDS_TABLE::OnTableValueChanged(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableValueChanged(), DIALOG_FOOTPRINT_PROPERTIES::OnText(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnText(), DIALOG_LIB_SYMBOL_PROPERTIES::OnText(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), DIALOG_LIB_SYMBOL_PROPERTIES::OnUnitSpinCtrl(), DIALOG_LIB_SYMBOL_PROPERTIES::OnUnitSpinCtrlEnter(), DIALOG_LIB_SYMBOL_PROPERTIES::OnUnitSpinCtrlKillFocus(), DIALOG_PAD_PROPERTIES::OnValuesChanged(), DIALOG_LIB_FIELDS_TABLE::OnViewControlsCellChanged(), DIALOG_SYMBOL_FIELDS_TABLE::OnViewControlsCellChanged(), DIALOG_PAD_PROPERTIES::PadOrientEvent(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), DIALOG_LIB_FIELDS_TABLE::ShowHideColumn(), and DIALOG_SYMBOL_FIELDS_TABLE::ShowHideColumn().

◆ OnMove()

void DIALOG_SHIM::OnMove ( wxMoveEvent & aEvent)
privateinherited

Definition at line 424 of file dialog_shim.cpp.

References m_userPositioned.

Referenced by DIALOG_SHIM(), and ~DIALOG_SHIM().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent & event)
inherited

◆ onPropertyGridChanged()

void DIALOG_SHIM::onPropertyGridChanged ( wxPropertyGridEvent & aEvent)
privateinherited

Definition at line 946 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ OnSize()

void DIALOG_SHIM::OnSize ( wxSizeEvent & aEvent)
privateinherited

Definition at line 417 of file dialog_shim.cpp.

References m_userResized.

Referenced by DIALOG_SHIM(), and ~DIALOG_SHIM().

◆ onSpinDoubleEvent()

void DIALOG_SHIM::onSpinDoubleEvent ( wxSpinDoubleEvent & aEvent)
privateinherited

Definition at line 920 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ onSpinEvent()

void DIALOG_SHIM::onSpinEvent ( wxSpinEvent & aEvent)
privateinherited

Definition at line 911 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ onStyledTextChanged()

void DIALOG_SHIM::onStyledTextChanged ( wxStyledTextEvent & aEvent)
privateinherited

Definition at line 929 of file dialog_shim.cpp.

References m_handlingUndoRedo, and recordControlChange().

Referenced by registerUndoRedoHandlers(), and ~DIALOG_SHIM().

◆ OptOut()

void DIALOG_SHIM::OptOut ( wxWindow * aWindow)
inherited

◆ PrepareForModalSubDialog()

void DIALOG_SHIM::PrepareForModalSubDialog ( )
inherited

Definition at line 1291 of file dialog_shim.cpp.

References m_qmodal_parent_disabler.

◆ printGridToStringAsTable()

void DIALOG_BOARD_STATISTICS::printGridToStringAsTable ( wxGrid * aGrid,
wxString & aStr,
bool aUseColLabels,
bool aUseFirstColAsLabel )
private

Definition at line 632 of file dialog_board_statistics.cpp.

Referenced by saveReportClicked().

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

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

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_FRAME::CreateNewFootprint(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), 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_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), EDA_3D_VIEWER_FRAME::getExportFileName(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), API_HANDLER_PCB::handleRevertDocument(), FIELDS_GRID_TABLE::initGrid(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), SIMULATOR_FRAME::LoadSimulator(), EDA_BASE_FRAME::LoadWindowState(), EDA_3D_VIEWER_FRAME::NewDisplay(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), DIALOG_EXPORT_2581::onBrowseClicked(), DIALOG_EXPORT_ODBPP::onBrowseClicked(), DIALOG_EXPORT_STEP::onBrowseClicked(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowseClicked(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_EXPORT_STEP::onExportButton(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DIALOG_GENDRILL::onGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT::onOpenOutputDirectory(), DIALOG_GEN_FOOTPRINT_POSITION::onOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::onOutputDirectoryBrowseClicked(), DIALOG_PLOT::onOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_DRC::OnSaveReport(), DIALOG_ERC::OnSaveReport(), SCH_BASE_FRAME::OnSymChange(), PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), KICAD_MANAGER_FRAME::ProjectChanged(), CVPCB_MAINFRAME::readNetListAndFpFiles(), EDA_3D_VIEWER_FRAME::ReloadRequest(), SIMULATOR_FRAME::ReloadSimulator(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::setFPWatcher(), GERBVIEW_FRAME::SetPageSettings(), SCH_BASE_FRAME::setSymWatcher(), DIALOG_LIB_FIELDS_TABLE::SetupColumnProperties(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), BOARD_EDITOR_CONTROL::ShowEeschema(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataToWindow(), KICAD_MANAGER_FRAME::UnarchiveFiles(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SIMULATOR_FRAME::UpdateTitle(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ recordControlChange()

void DIALOG_SHIM::recordControlChange ( wxWindow * aCtrl)
privateinherited

◆ refreshItemsTypes()

void DIALOG_BOARD_STATISTICS::refreshItemsTypes ( )
private

◆ registerUndoRedoHandlers()

void DIALOG_SHIM::registerUndoRedoHandlers ( wxWindowList & aChildren)
privateinherited

◆ RegisterUnitBinder()

void DIALOG_SHIM::RegisterUnitBinder ( UNIT_BINDER * aUnitBinder,
wxWindow * aWindow )
inherited

Register a UNIT_BINDER so that it can handle units in control-state save/restore.

Parameters
aUnitBinder
aWindowthe control window

Definition at line 728 of file dialog_shim.cpp.

References m_unitBinders.

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

References m_hash_key, and Pgm().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), and DIALOG_PAD_PROPERTIES::updatePadSizeControls().

◆ SaveControlState()

void DIALOG_SHIM::SaveControlState ( )
inherited

Save control values and geometry to the current project's local settings.

Definition at line 480 of file dialog_shim.cpp.

References generateKey(), PGM_BASE::GetCommonSettings(), COMMON_SETTINGS::m_dialogControlValues, m_hash_key, m_unitBinders, Pgm(), and PROPERTY_HOLDER::SafeCast().

Referenced by Show().

◆ saveReportClicked()

◆ SelectAllInTextCtrls()

void DIALOG_SHIM::SelectAllInTextCtrls ( wxWindowList & children)
inherited

◆ setControlValue()

void DIALOG_SHIM::setControlValue ( wxWindow * aCtrl,
const wxVariant & aValue )
privateinherited

Definition at line 1052 of file dialog_shim.cpp.

References grid.

Referenced by doRedo(), and doUndo().

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

References m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX_SCH::DIALOG_IMPORT_GFX_SCH(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLUGIN_OPTIONS::DIALOG_PLUGIN_OPTIONS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SET_OFFSET::DIALOG_SET_OFFSET(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TUNING_PATTERN_PROPERTIES::DIALOG_TUNING_PATTERN_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), SCH_EDITOR_CONTROL::IncrementAnnotations(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), DIALOG_LABEL_PROPERTIES::onMultiLabelCheck(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataToWindow(), WX_PT_ENTRY_DIALOG::WX_PT_ENTRY_DIALOG(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_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::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), DIALOG_SHIM::DIALOG_SHIM(), InvokePcbLibTableEditor(), and InvokeSchEditSymbolLibTable().

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

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

Referenced by HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ SetupStandardButtons()

void DIALOG_SHIM::SetupStandardButtons ( std::map< int, wxString > aLabels = {})
inherited

Definition at line 1618 of file dialog_shim.cpp.

References recursiveDescent().

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BOOK_REPORTER::DIALOG_BOOK_REPORTER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_GRAPHICS::DIALOG_CLEANUP_GRAPHICS(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_COPYFILES_JOB_SETTINGS::DIALOG_COPYFILES_JOB_SETTINGS(), DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_DATABASE_LIB_SETTINGS::DIALOG_DATABASE_LIB_SETTINGS(), DIALOG_DESIGN_BLOCK_PROPERTIES::DIALOG_DESIGN_BLOCK_PROPERTIES(), DIALOG_DESTINATION::DIALOG_DESTINATION(), DIALOG_DIELECTRIC_MATERIAL::DIALOG_DIELECTRIC_MATERIAL(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRAW_LAYERS_SETTINGS::DIALOG_DRAW_LAYERS_SETTINGS(), DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXECUTECOMMAND_JOB_SETTINGS::DIALOG_EXECUTECOMMAND_JOB_SETTINGS(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_2581::DIALOG_EXPORT_2581(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_ODBPP::DIALOG_EXPORT_ODBPP(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_VRML::DIALOG_EXPORT_VRML(), DIALOG_FILTER_SELECTION::DIALOG_FILTER_SELECTION(), 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_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GENERATE_DATABASE_CONNECTION::DIALOG_GENERATE_DATABASE_CONNECTION(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GIT_COMMIT::DIALOG_GIT_COMMIT(), DIALOG_GIT_REPOSITORY::DIALOG_GIT_REPOSITORY(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), DIALOG_GLOBAL_EDIT_TEARDROPS::DIALOG_GLOBAL_EDIT_TEARDROPS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), 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_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_CHOOSE_PROJECT::DIALOG_IMPORT_CHOOSE_PROJECT(), DIALOG_IMPORT_GFX_SCH::DIALOG_IMPORT_GFX_SCH(), DIALOG_IMPORT_GRAPHICS::DIALOG_IMPORT_GRAPHICS(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_JOBSET_RUN_LOG::DIALOG_JOBSET_RUN_LOG(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_MAP_LAYERS::DIALOG_MAP_LAYERS(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS::DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS(), DIALOG_MULTICHANNEL_REPEAT_LAYOUT::DIALOG_MULTICHANNEL_REPEAT_LAYOUT(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_OUTSET_ITEMS::DIALOG_OUTSET_ITEMS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PLUGIN_OPTIONS::DIALOG_PLUGIN_OPTIONS(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::DIALOG_PNS_DIFF_PAIR_DIMENSIONS(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT::DIALOG_PRINT(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_RC_JOB::DIALOG_RC_JOB(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RENDER_JOB::DIALOG_RENDER_JOB(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SET_OFFSET::DIALOG_SET_OFFSET(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_COMMAND::DIALOG_SIM_COMMAND(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TABLE_PROPERTIES::DIALOG_TABLE_PROPERTIES(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TABLECELL_PROPERTIES::DIALOG_TABLECELL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_TUNING_PATTERN_PROPERTIES::DIALOG_TUNING_PATTERN_PROPERTIES(), 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_USER_DEFINED_SIGNALS::DIALOG_USER_DEFINED_SIGNALS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_REORDERABLE_LIST_DIALOG::EDA_REORDERABLE_LIST_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), PAGED_DIALOG::PAGED_DIALOG(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SAVE_SYMBOL_AS_DIALOG::SAVE_SYMBOL_AS_DIALOG(), DIALOG_CLEANUP_TRACKS_AND_VIAS::setupOKButtonLabel(), WX_MULTI_ENTRY_DIALOG::WX_MULTI_ENTRY_DIALOG(), WX_PT_ENTRY_DIALOG::WX_PT_ENTRY_DIALOG(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ Show()

◆ ShowModal()

int DIALOG_SHIM::ShowModal ( )
overrideinherited

Definition at line 1209 of file dialog_shim.cpp.

References KIPLATFORM::UI::ReparentModal().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), PANEL_SETUP_LAYERS::addUserDefinedLayer(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), GRID_CELL_COLOR_SELECTOR::BeginEdit(), SCH_INSPECTION_TOOL::CheckSymbol(), FOOTPRINT_EDITOR_CONTROL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupGraphics(), GLOBAL_EDIT_TOOL::CleanupTracksAndVias(), COMMON_CONTROL::ConfigurePaths(), DIALOG_PLOT::CreateDrillFile(), CONVERT_TOOL::CreateLines(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), ROUTER_TOOL::CustomTrackWidthDialog(), FOOTPRINT_LIST::DisplayErrors(), PANEL_DESIGN_BLOCK_CHOOSER::displayErrors(), DisplayHotkeyList(), CURSORS_GRID_TRICKS::doPopupSelection(), LIB_FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), MEASUREMENTS_GRID_TRICKS::doPopupSelection(), SIGNALS_GRID_TRICKS::doPopupSelection(), ROUTER_TOOL::DpDimensionsDialog(), SIMULATOR_FRAME::EditAnalysis(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SCH_EDIT_FRAME::EditSheetProperties(), FOOTPRINT_EDITOR_CONTROL::EditTextAndGraphics(), GLOBAL_EDIT_TOOL::EditTextAndGraphics(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), EESCHEMA_JOBS_HANDLER::EESCHEMA_JOBS_HANDLER(), VIA_SIZE_MENU::eventHandler(), BOARD_EDITOR_CONTROL::ExportGenCAD(), BOARD_EDITOR_CONTROL::ExportIDF(), EDA_3D_CONTROLLER::ExportImage(), BOARD_EDITOR_CONTROL::ExportSTEP(), GERBVIEW_CONTROL::ExportToPcbnew(), BOARD_EDITOR_CONTROL::ExportVRML(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::filterSelection(), BOARD_EDITOR_CONTROL::GenerateDrillFiles(), BOARD_EDITOR_CONTROL::GenerateODBPPFiles(), BOARD_EDITOR_CONTROL::GeneratePosFile(), BOARD_EDITOR_CONTROL::GenIPC2581File(), GetChamferParams(), GetDogboneParams(), GetFootprintFromBoardByReference(), COLOR_SWATCH::GetNewSwatchColor(), GetRadiusParams(), GetSequentialPadNumberingParams(), GLOBAL_EDIT_TOOL::GlobalDeletions(), SCH_EDIT_TOOL::GlobalEdit(), COMMON_TOOLS::GridOrigin(), EDIT_TOOL::HealShapes(), SCH_EDIT_FRAME::importFile(), SCH_DRAWING_TOOLS::ImportGraphics(), SYMBOL_EDITOR_DRAWING_TOOLS::ImportGraphics(), SCH_EDITOR_CONTROL::IncrementAnnotations(), PCB_EDIT_FRAME::InstallNetlistFrame(), InvokeDialogNetList(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeRuleAreaEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_VIEWER_FRAME::loadAllLibraries(), GERBVIEW_FRAME::LoadGerberJobFile(), PCB::IFACE::loadGlobalLibTable(), SCH::IFACE::loadGlobalLibTable(), GERBVIEW_FRAME::LoadListOfGerberAndDrillFiles(), GERBVIEW_FRAME::LoadZipArchiveFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SCH_EDIT_FRAME::ModalAnnotate(), EDIT_TOOL::MoveExact(), PCB_POINT_EDITOR::movePoint(), SIMULATOR_CONTROL::NewAnalysisTab(), KICAD_MANAGER_CONTROL::NewFromRepository(), KICAD_MANAGER_CONTROL::NewProject(), PANEL_JOBSET::OnAddDestinationClick(), PANEL_SETUP_BOARD_STACKUP::onAddDielectricLayer(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), PANEL_GRID_SETTINGS::OnAddGrid(), PCB_NET_INSPECTOR_PANEL::onAddGroup(), PANEL_JOBSET::OnAddJobClick(), PCB_NET_INSPECTOR_PANEL::onAddNet(), PANEL_REGULATOR::OnAddRegulator(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged(), PANEL_SETUP_BOARD_STACKUP::onColorSelected(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter(), PANEL_GRID_SETTINGS::onEditGrid(), PANEL_REGULATOR::OnEditRegulator(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_ERC::OnERCItemRClick(), DIALOG_EXPORT_STEP::onExportButton(), PROJECT_TREE_PANE::onGitCommit(), PROJECT_TREE_PANE::onGitInitializeProject(), PROJECT_TREE_PANE::onGitSwitchBranch(), LIB_TREE::onHeaderContextMenu(), PROPERTIES_FRAME::onHelp(), PANEL_DESTINATION::OnLastStatusClick(), APPEARANCE_CONTROLS::onLayerPresetChanged(), APPEARANCE_CONTROLS_3D::onLayerPresetChanged(), DIALOG_PCM::OnManageRepositoriesClicked(), PANEL_SETUP_BOARD_STACKUP::onMaterialChange(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), PANEL_DESTINATION::OnProperties(), PANEL_SETUP_BOARD_STACKUP::onRemoveDielectricLayer(), PCB_NET_INSPECTOR_PANEL::onRenameSelectedNet(), PANEL_FP_LIB_TABLE::onReset(), PANEL_SYM_LIB_TABLE::onReset(), PANEL_PCBNEW_ACTION_PLUGINS::OnShowErrorsButtonClick(), DIALOG_FOOTPRINT_WIZARD_LIST::onShowTrace(), APPEARANCE_CONTROLS::onViewportChanged(), APPEARANCE_CONTROLS_3D::onViewportChanged(), PANEL_JOBSET::OpenJobOptionsForListItem(), PCB_EDIT_FRAME::OpenProjectFiles(), DESIGN_BLOCK_GRID_TRICKS::optionsEditor(), FP_GRID_TRICKS::optionsEditor(), SYMBOL_GRID_TRICKS::optionsEditor(), CONVERT_TOOL::OutsetItems(), DIALOG_PAD_PROPERTIES::padValuesOK(), BOARD_EDITOR_CONTROL::PageSettings(), PL_EDITOR_CONTROL::PageSetup(), SCH_EDITOR_CONTROL::PageSetup(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), SCH_BASE_FRAME::PickSymbolFromLibrary(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceTuningPattern(), SCH_EDITOR_CONTROL::Plot(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SYMBOL_LIBRARY_MANAGER::Preload(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDITOR_CONTROL::Print(), HK_PROMPT_DIALOG::PromptForKey(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), GERBVIEW_FRAME::Read_EXCELLON_File(), GERBVIEW_FRAME::Read_GERBER_File(), CVPCB_MAINFRAME::readNetListAndFpFiles(), GLOBAL_EDIT_TOOL::RemoveUnusedPads(), MULTICHANNEL_TOOL::repeatLayout(), DIALOG_IMPORT_CHOOSE_PROJECT::RunModal(), DIALOG_MAP_LAYERS::RunModal(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetToDesignBlock(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), PROJECT_SCH::SchLibs(), ROUTER_TOOL::SelectCopperLayerPair(), FOOTPRINT_EDIT_FRAME::SelectFootprintFromBoard(), FOOTPRINT_WIZARD_FRAME::SelectFootprintWizard(), PCB_BASE_EDIT_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibrary(), PCB_BASE_FRAME::SelectOneLayer(), GERBVIEW_FRAME::SelectPCBLayer(), GERBVIEW_FRAME::SetLayerDrawPrms(), ROUTER_TOOL::SettingsDialog(), BOARD_INSPECTION_TOOL::ShowBoardStatistics(), PL_EDITOR_FRAME::ShowDesignInspector(), CVPCB_CONTROL::ShowEquFileTable(), BOARD_INSPECTION_TOOL::ShowFootprintLinks(), SYMBOL_EDITOR_CONTROL::ShowLibraryTable(), SIMULATOR_CONTROL::ShowNetlist(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), BOARD_REANNOTATE_TOOL::ShowReannotateDialog(), PCB_BASE_EDIT_FRAME::ShowReferenceImagePropertiesDialog(), SYMBOL_LIB_TABLE_ROW::ShowSettingsDialog(), PCB_EDIT_FRAME::ShowTargetOptionsDialog(), EDIT_TOOL::SimplifyPolygons(), SCH_DRAWING_TOOLS::SingleClickPlace(), GLOBAL_EDIT_TOOL::SwapLayers(), DIALOG_IMPORT_GFX_SCH::TransferDataFromWindow(), DIALOG_IMPORT_GRAPHICS::TransferDataFromWindow(), EDA_3D_VIEWER_FRAME::TryBefore(), PCB_BASE_EDIT_FRAME::TryBefore(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::UpdateFromPCB(), BOARD_EDITOR_CONTROL::UpdatePCBFromSchematic(), SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields(), DIALOG_SHAPE_PROPERTIES::Validate(), and PANEL_PREVIEW_3D_MODEL::View3DSettings().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 1247 of file dialog_shim.cpp.

References m_qmodal_loop, m_qmodal_parent_disabler, m_qmodal_showing, KIPLATFORM::UI::ReparentModal(), and Show().

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), DIALOG_SELECT_3DMODEL::Cfg3DPaths(), SCH_EDIT_TOOL::ChangeSymbols(), MICROWAVE_TOOL::createFootprint(), PCB::IFACE::CreateKiWindow(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::DrawTable(), SCH_DRAWING_TOOLS::DrawTable(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), FOOTPRINT_EDIT_FRAME::editFootprintProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), PCB_EDIT_TABLE_TOOL::EditTable(), SCH_EDIT_TABLE_TOOL::EditTable(), GLOBAL_EDIT_TOOL::EditTeardrops(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), SIMULATOR_CONTROL::EditUserDefinedSignals(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), BOARD_EDITOR_CONTROL::GenerateGerbers(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), PANEL_JOBSET::OpenJobOptionsForListItem(), SCH_EDIT_FRAME::OpenProjectFiles(), PAD_TOOL::PadTable(), DRAWING_TOOL::PlaceText(), BOARD_EDITOR_CONTROL::Plot(), EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and GLOBAL_EDIT_TOOL::ZonesManager().

◆ TearDownQuasiModal()

virtual void DIALOG_SHIM::TearDownQuasiModal ( )
inlineprotectedvirtualinherited

Override this method to perform dialog tear down actions not suitable for object dtor.

Warning
This only gets called for dialogs that are shown in the quasimodal mode. If you need to perform tear down actions in modal or modeless dialogs, create a close window event handler.

Definition at line 215 of file dialog_shim.h.

Referenced by EndQuasiModal().

◆ TransferDataToWindow()

◆ updateDrillGrid()

◆ updateWidgets()

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

Referenced by DIALOG_LIB_FIELDS_TABLE::DIALOG_LIB_FIELDS_TABLE(), and DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

◆ windowSize()

virtual void DIALOG_BOARD_STATISTICS_BASE::windowSize ( wxSizeEvent & event)
inlineprotectedvirtualinherited

Member Data Documentation

◆ m_backCopperArea

double DIALOG_BOARD_STATISTICS::m_backCopperArea
private

◆ m_beforeEditValues

std::map<wxWindow*, wxString> DIALOG_SHIM::m_beforeEditValues
protectedinherited

Definition at line 285 of file dialog_shim.h.

Referenced by OnCharHook(), onChildSetFocus(), and SelectAllInTextCtrls().

◆ m_boardArea

double DIALOG_BOARD_STATISTICS::m_boardArea
private

◆ m_boardHeight

int DIALOG_BOARD_STATISTICS::m_boardHeight
private

◆ m_boardLabel

wxStaticText* DIALOG_BOARD_STATISTICS_BASE::m_boardLabel
protectedinherited

◆ m_boardThickness

int DIALOG_BOARD_STATISTICS::m_boardThickness
private

◆ m_boardWidth

int DIALOG_BOARD_STATISTICS::m_boardWidth
private

◆ m_buttonSaveReport

wxButton* DIALOG_BOARD_STATISTICS_BASE::m_buttonSaveReport
protectedinherited

◆ m_checkBoxExcludeComponentsNoPins

wxCheckBox* DIALOG_BOARD_STATISTICS_BASE::m_checkBoxExcludeComponentsNoPins
protectedinherited

◆ m_checkBoxSubtractHoles

◆ m_checkBoxSubtractHolesFromCopper

wxCheckBox* DIALOG_BOARD_STATISTICS_BASE::m_checkBoxSubtractHolesFromCopper
protectedinherited

◆ m_componentsLabel

wxStaticText* DIALOG_BOARD_STATISTICS_BASE::m_componentsLabel
protectedinherited

◆ m_currentValues

std::map<wxWindow*, wxVariant> DIALOG_SHIM::m_currentValues
protectedinherited

Definition at line 297 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), recordControlChange(), and registerUndoRedoHandlers().

◆ m_drillsPanel

wxPanel* DIALOG_BOARD_STATISTICS_BASE::m_drillsPanel
protectedinherited

◆ m_drillTypes

std::deque<DRILL_LINE_ITEM> DIALOG_BOARD_STATISTICS::m_drillTypes
private

Definition at line 140 of file dialog_board_statistics.h.

Referenced by drillGridSort(), getDataFromPCB(), and updateDrillGrid().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 266 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), and OnPaint().

◆ m_fpTypes

std::deque<FP_LINE_ITEM> DIALOG_BOARD_STATISTICS::m_fpTypes
private

◆ m_frame

PCB_EDIT_FRAME* DIALOG_BOARD_STATISTICS::m_frame
private

◆ m_frontCopperArea

double DIALOG_BOARD_STATISTICS::m_frontCopperArea
private

◆ m_generalPanel

wxPanel* DIALOG_BOARD_STATISTICS_BASE::m_generalPanel
protectedinherited

Definition at line 44 of file dialog_board_statistics_base.h.

Referenced by DIALOG_BOARD_STATISTICS_BASE().

◆ m_gridBoard

wxGrid* DIALOG_BOARD_STATISTICS_BASE::m_gridBoard
protectedinherited

◆ m_gridComponents

◆ m_gridDrills

◆ m_gridPads

◆ m_gridVias

◆ m_handlingUndoRedo

bool DIALOG_SHIM::m_handlingUndoRedo
protectedinherited

◆ m_hash_key

◆ m_hasOutline

bool DIALOG_BOARD_STATISTICS::m_hasOutline
private

Show if board outline properly defined.

Definition at line 134 of file dialog_board_statistics.h.

Referenced by DIALOG_BOARD_STATISTICS(), getDataFromPCB(), saveReportClicked(), and updateWidgets().

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 280 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), and Show().

◆ m_isClosing

bool DIALOG_SHIM::m_isClosing
protectedinherited

Definition at line 268 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), onChildSetFocus(), and ~DIALOG_SHIM().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

Definition at line 86 of file kiway_holder.h.

Referenced by HasKiway(), Kiway(), KIWAY_HOLDER(), and SetKiway().

◆ m_minClearanceTrackToTrack

int DIALOG_BOARD_STATISTICS::m_minClearanceTrackToTrack
private

◆ m_minDrillSize

int DIALOG_BOARD_STATISTICS::m_minDrillSize
private

◆ m_minTrackWidth

int DIALOG_BOARD_STATISTICS::m_minTrackWidth
private

◆ m_padFabProps

std::deque<INFO_LINE_ITEM<PAD_PROP> > DIALOG_BOARD_STATISTICS::m_padFabProps
private

Definition at line 138 of file dialog_board_statistics.h.

Referenced by getDataFromPCB(), refreshItemsTypes(), and updateWidgets().

◆ m_padsLabel

wxStaticText* DIALOG_BOARD_STATISTICS_BASE::m_padsLabel
protectedinherited

◆ m_padTypes

std::deque<INFO_LINE_ITEM<PAD_ATTRIB> > DIALOG_BOARD_STATISTICS::m_padTypes
private

◆ m_parentFrame

◆ m_qmodal_loop

wxGUIEventLoop* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 270 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), EndQuasiModal(), and ShowQuasiModal().

◆ m_qmodal_parent_disabler

WINDOW_DISABLER* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 272 of file dialog_shim.h.

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

◆ m_redoStack

std::vector<UNDO_STEP> DIALOG_SHIM::m_redoStack
protectedinherited

Definition at line 296 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), and recordControlChange().

◆ m_sdbControlSizer

wxStdDialogButtonSizer* DIALOG_BOARD_STATISTICS_BASE::m_sdbControlSizer
protectedinherited

Definition at line 59 of file dialog_board_statistics_base.h.

Referenced by DIALOG_BOARD_STATISTICS_BASE().

◆ m_sdbControlSizerCancel

wxButton* DIALOG_BOARD_STATISTICS_BASE::m_sdbControlSizerCancel
protectedinherited

◆ m_startLayerColInitialSize

int DIALOG_BOARD_STATISTICS::m_startLayerColInitialSize
private

Width of the start layer column as calculated by the wxWidgets autosizing algorithm.

Definition at line 142 of file dialog_board_statistics.h.

Referenced by adjustDrillGridColumns(), DIALOG_BOARD_STATISTICS(), and TransferDataToWindow().

◆ m_stopLayerColInitialSize

int DIALOG_BOARD_STATISTICS::m_stopLayerColInitialSize
private

Width of the stop layer column.

Definition at line 144 of file dialog_board_statistics.h.

Referenced by adjustDrillGridColumns(), DIALOG_BOARD_STATISTICS(), and TransferDataToWindow().

◆ m_tabOrder

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 87 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().

◆ m_undoStack

std::vector<UNDO_STEP> DIALOG_SHIM::m_undoStack
protectedinherited

Definition at line 295 of file dialog_shim.h.

Referenced by doRedo(), doUndo(), and recordControlChange().

◆ m_unitBinders

std::map<wxWindow*, UNIT_BINDER*> DIALOG_SHIM::m_unitBinders
protectedinherited

Definition at line 286 of file dialog_shim.h.

Referenced by LoadControlState(), RegisterUnitBinder(), and SaveControlState().

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_userPositioned

bool DIALOG_SHIM::m_userPositioned
protectedinherited

Definition at line 281 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), OnMove(), and Show().

◆ m_userResized

bool DIALOG_SHIM::m_userResized
protectedinherited

Definition at line 282 of file dialog_shim.h.

Referenced by DIALOG_SHIM(), OnSize(), and Show().

◆ m_viasLabel

wxStaticText* DIALOG_BOARD_STATISTICS_BASE::m_viasLabel
protectedinherited

◆ m_viaTypes

std::deque<INFO_LINE_ITEM<VIATYPE> > DIALOG_BOARD_STATISTICS::m_viaTypes
private

◆ topNotebook

wxNotebook* DIALOG_BOARD_STATISTICS_BASE::topNotebook
protectedinherited

Definition at line 43 of file dialog_board_statistics_base.h.

Referenced by DIALOG_BOARD_STATISTICS_BASE().


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