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

A mix in class which holds the location of a wxWindow's KIWAY. More...

#include <kiway_holder.h>

Inheritance diagram for KIWAY_HOLDER:
DIALOG_SHIM EDA_BASE_FRAME FOOTPRINT_PREVIEW_PANEL CONVERT_SETTINGS_DIALOG DIALOG_ANNOTATE_BASE DIALOG_ASSIGN_NETCLASS_BASE DIALOG_BOARD_REANNOTATE_BASE DIALOG_BOARD_STATISTICS_BASE DIALOG_BOM_BASE DIALOG_BOOK_REPORTER_BASE DIALOG_CHANGE_SYMBOLS_BASE DIALOG_CLEANUP_GRAPHICS_BASE DIALOG_CLEANUP_TRACKS_AND_VIAS_BASE DIALOG_COLOR_PICKER_BASE DIALOG_CONFIGURE_PATHS_BASE DIALOG_CONFIG_EQUFILES_BASE DIALOG_COPPER_LAYER_PAIR_SELECTION_BASE DIALOG_COPPER_ZONE_BASE DIALOG_COPYFILES_JOB_SETTINGS_BASE DIALOG_CREATE_ARRAY_BASE DIALOG_DATABASE_LIB_SETTINGS_BASE DIALOG_DESIGN_BLOCK_PROPERTIES_BASE DIALOG_DESTINATION_BASE DIALOG_DIELECTRIC_MATERIAL_BASE DIALOG_DIMENSION_PROPERTIES_BASE DIALOG_DISPLAY_HTML_TEXT_BASE DIALOG_DRAW_LAYERS_SETTINGS_BASE DIALOG_DRC_BASE DIALOG_EDIT_LIBRARY_TABLES DIALOG_EDIT_SYMBOLS_LIBID_BASE DIALOG_ENUM_PADS_BASE DIALOG_ERC_BASE DIALOG_EXCHANGE_FOOTPRINTS_BASE DIALOG_EXECUTECOMMAND_JOB_SETTINGS_BASE DIALOG_EXPORT_2581_BASE DIALOG_EXPORT_3D_IMAGE DIALOG_EXPORT_IDF3_BASE DIALOG_EXPORT_NETLIST_BASE DIALOG_EXPORT_ODBPP_BASE DIALOG_EXPORT_STEP_BASE DIALOG_EXPORT_STEP_PROCESS_BASE DIALOG_EXPORT_VRML_BASE DIALOG_FIELD_PROPERTIES_BASE DIALOG_FILTER_SELECTION_BASE DIALOG_FIND_BASE DIALOG_FOOTPRINT_ASSOCIATIONS_BASE DIALOG_FOOTPRINT_CHECKER_BASE DIALOG_FOOTPRINT_PROPERTIES_BASE DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR_BASE DIALOG_FOOTPRINT_WIZARD_LIST_BASE DIALOG_FOOTPRINT_WIZARD_LOG DIALOG_FP_CONFLICT_ASSIGNMENT_SELECTOR_BASE DIALOG_FP_EDIT_PAD_TABLE DIALOG_GENCAD_EXPORT_OPTIONS DIALOG_GENDRILL_BASE DIALOG_GENERATE_DATABASE_CONNECTION DIALOG_GENERATORS_BASE DIALOG_GEN_FOOTPRINT_POSITION_BASE DIALOG_GET_FOOTPRINT_BY_NAME_BASE DIALOG_GIT_AUTH DIALOG_GIT_COMMIT DIALOG_GIT_REPOSITORY_BASE DIALOG_GIT_SWITCH DIALOG_GLOBAL_DELETION_BASE DIALOG_GLOBAL_EDIT_TEARDROPS_BASE DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS_BASE DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS_BASE DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS_BASE DIALOG_GLOBAL_LIB_TABLE_CONFIG_BASE DIALOG_GRID_SETTINGS_BASE DIALOG_GROUP_PROPERTIES_BASE DIALOG_HTML_REPORTER DIALOG_IBIS_PARSER_REPORTER_BASE DIALOG_IMAGE_PROPERTIES_BASE DIALOG_IMPORTED_LAYERS_BASE DIALOG_IMPORT_CHOOSE_PROJECT_BASE DIALOG_IMPORT_GFX_SCH_BASE DIALOG_IMPORT_GRAPHICS_BASE DIALOG_IMPORT_NETLIST_BASE DIALOG_IMPORT_SETTINGS_BASE DIALOG_INCREMENT_ANNOTATIONS_BASE DIALOG_INSPECTOR_BASE DIALOG_JOBSET_RUN_LOG_BASE DIALOG_JUNCTION_PROPS_BASE DIALOG_LABEL_PROPERTIES_BASE DIALOG_LAYER_SELECTION_BASE DIALOG_LIB_EDIT_PIN_TABLE_BASE DIALOG_LIB_FIELDS_TABLE_BASE DIALOG_LIB_NEW_SYMBOL_BASE DIALOG_LIB_SYMBOL_PROPERTIES_BASE DIALOG_LINE_PROPERTIES_BASE DIALOG_LIST_HOTKEYS DIALOG_MANAGE_REPOSITORIES_BASE DIALOG_MAP_GERBER_LAYERS_TO_PCB_BASE DIALOG_MIGRATE_BUSES_BASE DIALOG_MIGRATE_SETTINGS_BASE DIALOG_MOVE_EXACT_BASE DIALOG_MULTICHANNEL_GENERATE_RULE_AREAS_BASE DIALOG_MULTICHANNEL_REPEAT_LAYOUT_BASE DIALOG_NEW_DATAITEM_BASE DIALOG_NONCOPPER_ZONES_PROPERTIES_BASE DIALOG_OUTSET_ITEMS_BASE DIALOG_PAD_PROPERTIES_BASE DIALOG_PAGES_SETTINGS_BASE DIALOG_PASTE_SPECIAL_BASE DIALOG_PCM_BASE DIALOG_PIN_PROPERTIES_BASE DIALOG_PLOT_BASE DIALOG_PLOT_SCHEMATIC_BASE DIALOG_PLUGIN_OPTIONS_BASE DIALOG_PNS_DIFF_PAIR_DIMENSIONS_BASE DIALOG_PNS_SETTINGS_BASE DIALOG_POSITION_RELATIVE_BASE DIALOG_PRINT_BASE DIALOG_PRINT_GENERIC_BASE DIALOG_PUSH_PAD_PROPERTIES_BASE DIALOG_RC_JOB_BASE DIALOG_REFERENCE_IMAGE_PROPERTIES_BASE DIALOG_REGULATOR_FORM_BASE DIALOG_RENDER_JOB_BASE DIALOG_RESCUE_EACH_BASE DIALOG_RULE_AREA_PROPERTIES_BASE DIALOG_SCH_FIND_BASE DIALOG_SCH_IMPORT_SETTINGS_BASE DIALOG_SELECT_3D_MODEL_BASE DIALOG_SET_OFFSET_BASE DIALOG_SHAPE_PROPERTIES_BASE DIALOG_SHAPE_PROPERTIES_BASE DIALOG_SHEET_PIN_PROPERTIES_BASE DIALOG_SHEET_PROPERTIES_BASE DIALOG_SIM_COMMAND_BASE DIALOG_SIM_FORMAT_VALUE_BASE DIALOG_SIM_MODEL_BASE DIALOG_SWAP_LAYERS_BASE DIALOG_SYMBOL_CHOOSER DIALOG_SYMBOL_FIELDS_TABLE_BASE DIALOG_SYMBOL_PROPERTIES_BASE DIALOG_SYMBOL_REMAP_BASE DIALOG_SYNC_SHEET_PINS_BASE DIALOG_TABLECELL_PROPERTIES_BASE DIALOG_TABLECELL_PROPERTIES_BASE DIALOG_TABLE_PROPERTIES_BASE DIALOG_TABLE_PROPERTIES_BASE DIALOG_TARGET_PROPERTIES_BASE DIALOG_TEMPLATE_SELECTOR_BASE DIALOG_TEXTBOX_PROPERTIES_BASE DIALOG_TEXT_PROPERTIES_BASE DIALOG_TEXT_PROPERTIES_BASE DIALOG_TRACK_VIA_PROPERTIES_BASE DIALOG_TRACK_VIA_SIZE_BASE DIALOG_TUNING_PATTERN_PROPERTIES_BASE DIALOG_UNUSED_PAD_LAYERS_BASE DIALOG_UPDATE_CHECK_PROMPT_BASE DIALOG_UPDATE_FROM_PCB_BASE DIALOG_UPDATE_NOTICE_BASE DIALOG_UPDATE_PCB_BASE DIALOG_UPDATE_SYMBOL_FIELDS_BASE DIALOG_USER_DEFINED_SIGNALS_BASE DIALOG_WIRE_BUS_PROPERTIES_BASE DIALOG_ZONE_MANAGER_BASE EDA_LIST_DIALOG_BASE EDA_REORDERABLE_LIST_DIALOG_BASE EDA_VIEW_SWITCHER_BASE GIT_PROGRESS HK_PROMPT_DIALOG MWAVE_POLYGONAL_SHAPE_DLG NETLIST_DIALOG_ADD_GENERATOR_BASE NETLIST_VIEW_DIALOG PAGED_DIALOG PRODUCE_PCB_BASE SELECT_LAYER_DIALOG WX_MULTI_ENTRY_DIALOG WX_PT_ENTRY_DIALOG_BASE WX_TEXT_ENTRY_DIALOG_BASE WX_UNIT_ENTRY_DIALOG_BASE KICAD_MANAGER_FRAME KIWAY_PLAYER

Public Types

enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 KIWAY_HOLDER (KIWAY *aKiway, HOLDER_TYPE aType)
 
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*.
 

Private Attributes

KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Detailed Description

A mix in class which holds the location of a wxWindow's KIWAY.

It allows calls to Kiway() and SetKiway().

Definition at line 38 of file kiway_holder.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 41 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ KIWAY_HOLDER()

KIWAY_HOLDER::KIWAY_HOLDER ( KIWAY * aKiway,
HOLDER_TYPE aType )
inline

Member Function Documentation

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inline

◆ HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const
inline

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

◆ Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const
inline

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

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

◆ SetKiway()

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

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

Member Data Documentation

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
private

Definition at line 86 of file kiway_holder.h.

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

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
private

Definition at line 87 of file kiway_holder.h.

Referenced by GetType(), and KIWAY_HOLDER().


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