KiCad PCB EDA Suite
DIALOG_SYMBOL_FIELDS_TABLE Class Reference

#include <dialog_symbol_fields_table.h>

Inheritance diagram for DIALOG_SYMBOL_FIELDS_TABLE:
DIALOG_SYMBOL_FIELDS_TABLE_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG , FRAME , PANEL }
 

Public Member Functions

 DIALOG_SYMBOL_FIELDS_TABLE (SCH_EDIT_FRAME *parent)
 
virtual ~DIALOG_SYMBOL_FIELDS_TABLE ()
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
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 OnModify ()
 
void SetPosition (const wxPoint &aNewPosition)
 Force the position of the dialog to a new position. More...
 
EDA_UNITS GetUserUnits () const
 
void SetupStandardButtons (std::map< int, wxString > aLabels={})
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
bool HasKiway () const
 Safety check before asking for the Kiway reference. 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

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

wxSplitterWindow * m_splitterMainWindow
 
wxPanel * m_leftPanel
 
wxDataViewListCtrl * m_fieldsCtrl
 
wxButton * m_addFieldButton
 
wxButton * m_removeFieldButton
 
wxPanel * m_rightPanel
 
wxSearchCtrl * m_filter
 
BITMAP_BUTTONm_separator1
 
wxCheckBox * m_groupSymbolsBox
 
BITMAP_BUTTONm_separator2
 
wxBitmapButton * m_bRefresh
 
WX_GRIDm_grid
 
wxButton * m_buttonExport
 
wxButton * m_buttonApply
 
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

void AddField (const wxString &displayName, const wxString &aCanonicalName, bool defaultShow, bool defaultSortBy, bool addedByUser=false)
 
void LoadFieldNames ()
 Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in use. More...
 
void OnColSort (wxGridEvent &aEvent)
 
void OnColumnItemToggled (wxDataViewEvent &event) override
 
void OnGroupSymbolsToggled (wxCommandEvent &event) override
 
void OnRegroupSymbols (wxCommandEvent &aEvent) override
 
void OnTableValueChanged (wxGridEvent &event) override
 
void OnTableCellClick (wxGridEvent &event) override
 
void OnTableRangeSelected (wxGridRangeSelectEvent &event) override
 
void OnTableItemContextMenu (wxGridEvent &event) override
 
void OnTableColSize (wxGridSizeEvent &event) override
 
void OnSizeFieldList (wxSizeEvent &event) override
 
void OnAddField (wxCommandEvent &event) override
 
void OnRemoveField (wxCommandEvent &event) override
 
void OnExport (wxCommandEvent &aEvent) override
 
void OnSaveAndContinue (wxCommandEvent &aEvent) override
 
void OnCancel (wxCommandEvent &aEvent) override
 
void OnClose (wxCloseEvent &aEvent) override
 
void OnFilterText (wxCommandEvent &aEvent) override
 
void OnFilterMouseMoved (wxMouseEvent &event) override
 
void OnFieldsCtrlSelectionChanged (wxDataViewEvent &event) override
 
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. More...
 
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. More...
 
void OnGridEditorShown (wxGridEvent &event)
 
void OnGridEditorHidden (wxGridEvent &event)
 
 DECLARE_EVENT_TABLE ()
 

Private Attributes

SCH_EDIT_FRAMEm_parent
 
int m_showColWidth
 
int m_groupByColWidth
 
SCH_REFERENCE_LIST m_symbolsList
 
FIELDS_EDITOR_GRID_DATA_MODELm_dataModel
 
KIWAYm_kiway
 
HOLDER_TYPE m_type
 

Detailed Description

Definition at line 37 of file dialog_symbol_fields_table.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_SYMBOL_FIELDS_TABLE()

DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE ( SCH_EDIT_FRAME parent)

Definition at line 751 of file dialog_symbol_fields_table.cpp.

751 :
753 m_parent( parent )
754{
755 wxSize defaultDlgSize = ConvertDialogToPixels( wxSize( 600, 300 ) );
756 int nameColWidthMargin = 44;
757
758 // Get all symbols from the list of schematic sheets
760
764
765 m_fieldsCtrl->AppendTextColumn( _( "Field" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
766 m_fieldsCtrl->AppendToggleColumn( _( "Show" ), wxDATAVIEW_CELL_ACTIVATABLE, 0,
767 wxALIGN_CENTER, 0 );
768 m_fieldsCtrl->AppendToggleColumn( _( "Group By" ), wxDATAVIEW_CELL_ACTIVATABLE, 0,
769 wxALIGN_CENTER, 0 );
770
771 // GTK asserts if the number of columns doesn't match the data, but we still don't want
772 // to display the canonical names. So we'll insert a column for them, but keep it 0 width.
773 m_fieldsCtrl->AppendTextColumn( _( "Name" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
774
775 // SetWidth( wxCOL_WIDTH_AUTOSIZE ) fails here on GTK, so we calculate the title sizes and
776 // set the column widths ourselves.
777 wxDataViewColumn* column = m_fieldsCtrl->GetColumn( SHOW_FIELD_COLUMN );
778 m_showColWidth = KIUI::GetTextSize( column->GetTitle(), m_fieldsCtrl ).x + COLUMN_MARGIN;
779 column->SetMinWidth( m_showColWidth );
780
781 column = m_fieldsCtrl->GetColumn( GROUP_BY_COLUMN );
783 column->SetMinWidth( m_groupByColWidth );
784
785 // The fact that we're a list should keep the control from reserving space for the
786 // expander buttons... but it doesn't. Fix by forcing the indent to 0.
787 m_fieldsCtrl->SetIndent( 0 );
788
789 m_filter->SetDescriptiveText( _( "Filter" ) );
790
792
793 LoadFieldNames(); // loads rows into m_fieldsCtrl and columns into m_dataModel
794
795 // Now that the fields are loaded we can set the initial location of the splitter
796 // based on the list width. Again, SetWidth( wxCOL_WIDTH_AUTOSIZE ) fails us on GTK.
797 int nameColWidth = 0;
798
799 for( int row = 0; row < m_fieldsCtrl->GetItemCount(); ++row )
800 {
801 const wxString& fieldName = m_fieldsCtrl->GetTextValue( row, DISPLAY_NAME_COLUMN );
802 nameColWidth = std::max( nameColWidth, KIUI::GetTextSize( fieldName, m_fieldsCtrl ).x );
803 }
804
805 nameColWidth += nameColWidthMargin;
806
807 int fieldsMinWidth = nameColWidth + m_groupByColWidth + m_showColWidth;
808
809 m_fieldsCtrl->GetColumn( DISPLAY_NAME_COLUMN )->SetWidth( nameColWidth );
810
811 // This is used for data only. Don't show it to the user.
812 m_fieldsCtrl->GetColumn( CANONICAL_NAME_COLUMN )->SetHidden( true );
813
814 m_splitterMainWindow->SetMinimumPaneSize( fieldsMinWidth );
815 m_splitterMainWindow->SetSashPosition( fieldsMinWidth + 40 );
816
818 m_dataModel->Sort( 0, true );
819
820 m_grid->UseNativeColHeader( true );
821 m_grid->SetTable( m_dataModel, true );
822
823 // must be done after SetTable(), which appears to re-set it
824 m_grid->SetSelectionMode( wxGrid::wxGridSelectCells );
825
826 // sync m_grid's column visibilities to Show checkboxes in m_fieldsCtrl
827 for( int i = 0; i < m_fieldsCtrl->GetItemCount(); ++i )
828 {
829 if( m_fieldsCtrl->GetToggleValue( i, 1 ) )
830 m_grid->ShowCol( i );
831 else
832 m_grid->HideCol( i );
833 }
834
835 // add Cut, Copy, and Paste to wxGrid
836 m_grid->PushEventHandler( new FIELDS_EDITOR_GRID_TRICKS( this, m_grid, m_fieldsCtrl ) );
837
838 // give a bit more room for comboboxes
839 m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
840
841 // set reference column attributes
842 wxGridCellAttr* attr = new wxGridCellAttr;
843 attr->SetReadOnly();
844 m_grid->SetColAttr( REFERENCE_FIELD, attr );
845
846 // set footprint column browse button
847 attr = new wxGridCellAttr;
848 attr->SetEditor( new GRID_CELL_FPID_EDITOR( this, wxEmptyString ) );
849 m_grid->SetColAttr( FOOTPRINT_FIELD, attr );
850
851 // set datasheet column viewer button
852 attr = new wxGridCellAttr;
853 attr->SetEditor( new GRID_CELL_URL_EDITOR( this, Prj().SchSearchS() ) );
854 m_grid->SetColAttr( DATASHEET_FIELD, attr );
855
856 // set quantities column attributes
857 attr = new wxGridCellAttr;
858 attr->SetReadOnly();
859 m_grid->SetColAttr( m_dataModel->GetColsCount() - 1, attr );
860 m_grid->SetColFormatNumber( m_dataModel->GetColsCount() - 1 );
861 m_grid->AutoSizeColumns( false );
862
863 for( int col = 0; col < m_grid->GetNumberCols(); ++col )
864 {
865 // Columns are hidden by setting their width to 0 so if we resize them they will
866 // become unhidden.
867 if( m_grid->IsColShown( col ) )
868 {
869 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
870 std::string key( m_dataModel->GetCanonicalColLabel( col ).ToUTF8() );
871
872 if( cfg->m_FieldEditorPanel.column_widths.count( key ) )
873 {
874 int width = cfg->m_FieldEditorPanel.column_widths.at( key );
875 m_grid->SetColSize( col, width );
876 }
877 else
878 {
879 int textWidth = m_dataModel->GetDataWidth( col ) + COLUMN_MARGIN;
880 int maxWidth = defaultDlgSize.x / 3;
881
882 if( col == m_grid->GetNumberCols() - 1 )
883 m_grid->SetColSize( col, Clamp( 50, textWidth, maxWidth ) );
884 else
885 m_grid->SetColSize( col, Clamp( 100, textWidth, maxWidth ) );
886 }
887 }
888 }
889
890 m_grid->SelectRow( 0 );
891 m_grid->SetGridCursor( 0, 1 );
893
895
897 SetSize( defaultDlgSize );
898 Center();
899
900 // Connect Events
901 m_grid->Connect( wxEVT_GRID_COL_SORT,
902 wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColSort ), nullptr, this );
903}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
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:106
@ small_refresh
void SetIsSeparator()
Render button as a toolbar separator.
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
DIALOG_SYMBOL_FIELDS_TABLE_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Symbol Fields Table"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxMAXIMIZE_BOX|wxRESIZE_BORDER)
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
void LoadFieldNames()
Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in ...
PANEL_FIELD_EDITOR m_FieldEditorPanel
void Sort(int aColumn, bool ascending)
void RebuildRows(wxSearchCtrl *aFilter, wxCheckBox *aGroupSymbolsBox, wxDataViewListCtrl *aFieldsCtrl)
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:86
SCHEMATIC & Schematic() const
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
Definition: wx_grid.cpp:164
#define DISPLAY_NAME_COLUMN
#define COLUMN_MARGIN
#define GROUP_BY_COLUMN
#define CANONICAL_NAME_COLUMN
#define SHOW_FIELD_COLUMN
#define _(s)
wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
Definition: ui_common.cpp:70
std::map< std::string, int > column_widths
@ DATASHEET_FIELD
name of datasheet
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
constexpr T Clamp(const T &lower, const T &value, const T &upper)
Limit value within the range lower <= value <= upper.
Definition: util.h:64

References _, CANONICAL_NAME_COLUMN, PCAD2KICAD::Center, Clamp(), COLUMN_MARGIN, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::column_widths, DATASHEET_FIELD, DISPLAY_NAME_COLUMN, DIALOG_SHIM::finishDialogSettings(), FOOTPRINT_FIELD, FIELDS_EDITOR_GRID_DATA_MODEL::GetCanonicalColLabel(), FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth(), SCHEMATIC::GetSheets(), SCH_SHEET_LIST::GetSymbols(), KIUI::GetTextSize(), GROUP_BY_COLUMN, KiBitmap(), Kiface(), KIFACE_BASE::KifaceSettings(), LoadFieldNames(), DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_bRefresh, m_dataModel, EESCHEMA_SETTINGS::m_FieldEditorPanel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_filter, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, m_groupByColWidth, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_groupSymbolsBox, m_parent, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_separator1, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_separator2, m_showColWidth, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_splitterMainWindow, m_symbolsList, OnColSort(), KIWAY_HOLDER::Prj(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), REFERENCE_FIELD, SCH_EDIT_FRAME::Schematic(), DIALOG_SHIM::SetInitialFocus(), BITMAP_BUTTON::SetIsSeparator(), WX_GRID::SetTable(), DIALOG_SHIM::SetupStandardButtons(), SHOW_FIELD_COLUMN, small_refresh, and FIELDS_EDITOR_GRID_DATA_MODEL::Sort().

◆ ~DIALOG_SYMBOL_FIELDS_TABLE()

DIALOG_SYMBOL_FIELDS_TABLE::~DIALOG_SYMBOL_FIELDS_TABLE ( )
virtual

Definition at line 906 of file dialog_symbol_fields_table.cpp.

907{
908 // Disconnect Events
909 m_grid->Disconnect( wxEVT_GRID_COL_SORT,
910 wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColSort ), nullptr,
911 this );
912
913 // Delete the GRID_TRICKS.
914 m_grid->PopEventHandler( true );
915
916 // we gave ownership of m_dataModel to the wxGrid...
917}

References DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, and OnColSort().

Member Function Documentation

◆ AddField()

void DIALOG_SYMBOL_FIELDS_TABLE::AddField ( const wxString &  displayName,
const wxString &  aCanonicalName,
bool  defaultShow,
bool  defaultSortBy,
bool  addedByUser = false 
)
private

Definition at line 991 of file dialog_symbol_fields_table.cpp.

994{
995 m_dataModel->AddColumn( aCanonicalName, addedByUser );
996
997 wxVector<wxVariant> fieldsCtrlRow;
998
999 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1000 bool show = defaultShow;
1001 bool sort_by = defaultSortBy;
1002
1003 std::string key( aCanonicalName.ToUTF8() );
1004
1005 if( cfg->m_FieldEditorPanel.fields_show.count( key ) )
1006 show = cfg->m_FieldEditorPanel.fields_show.at( key );
1007
1008 if( cfg->m_FieldEditorPanel.fields_group_by.count( key ) )
1009 sort_by = cfg->m_FieldEditorPanel.fields_group_by.at( key );
1010
1011 // Don't change these to emplace_back: some versions of wxWidgets don't support it
1012 fieldsCtrlRow.push_back( wxVariant( aDisplayName ) );
1013 fieldsCtrlRow.push_back( wxVariant( show ) );
1014 fieldsCtrlRow.push_back( wxVariant( sort_by ) );
1015 fieldsCtrlRow.push_back( wxVariant( aCanonicalName ) );
1016
1017 m_fieldsCtrl->AppendItem( fieldsCtrlRow );
1018}
void AddColumn(const wxString &aFieldName, bool aAddedByUser)
std::map< std::string, bool > fields_show
std::map< std::string, bool > fields_group_by

References FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn(), EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_group_by, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_show, Kiface(), KIFACE_BASE::KifaceSettings(), m_dataModel, EESCHEMA_SETTINGS::m_FieldEditorPanel, and DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl.

Referenced by LoadFieldNames(), and OnAddField().

◆ DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )
privateinherited

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 318 of file dialog_shim.cpp.

319{
320 // so we can do logging of this state change:
321 return wxDialog::Enable( enable );
322}

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 486 of file dialog_shim.cpp.

487{
488 // Hook up validator and transfer data from controls handling so quasi-modal dialogs
489 // handle validation in the same way as other dialogs.
490 if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
491 return;
492
493 SetReturnCode( retCode );
494
495 if( !IsQuasiModal() )
496 {
497 wxFAIL_MSG( wxT( "Either DIALOG_SHIM::EndQuasiModal was called twice, or ShowQuasiModal"
498 "wasn't called" ) );
499 return;
500 }
501
502 if( m_qmodal_loop )
503 {
504 if( m_qmodal_loop->IsRunning() )
505 m_qmodal_loop->Exit( 0 );
506 else
507 m_qmodal_loop->ScheduleExit( 0 );
508
509 m_qmodal_loop = nullptr;
510 }
511
513 m_qmodal_parent_disabler = nullptr;
514
515 Show( false );
516}
bool Show(bool show) override
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:218
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:215

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

Referenced by EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::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(), DIALOG_EXPORT_NETLIST::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 157 of file dialog_shim.cpp.

158{
159 // must be called from the constructor of derived classes,
160 // when all widgets are initialized, and therefore their size fixed
161
162 // SetSizeHints fixes the minimal size of sizers in the dialog
163 // (SetSizeHints calls Fit(), so no need to call it)
164 GetSizer()->SetSizeHints( this );
165}

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_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), 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_NETLIST::DIALOG_EXPORT_NETLIST(), 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_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), 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_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), 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_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), 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_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SIM_MODEL< T_symbol, T_field >::DIALOG_SIM_MODEL(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_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_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_CONSTRAINTS_REPORTER::FinishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_VIEW_DIALOG::NETLIST_VIEW_DIALOG(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SIM_COMMAND::onInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::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:85

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

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

64 {
65 return m_kiway != nullptr;
66 }
KIWAY * m_kiway
Definition: kiway_holder.h:84

References KIWAY_HOLDER::m_kiway.

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

176{
177 wxSize sz( x, 0 );
178 return ConvertDialogToPixels( sz ).x;
179}

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

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 134 of file dialog_shim.h.

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

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

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(), SCH_EDIT_FRAME::AskToSaveChanges(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::CanCloseSymbolFromSchematic(), SCH_EDIT_FRAME::canCloseWindow(), PCB_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), SYMBOL_EDIT_FRAME::DdAddLibrary(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), SIMULATOR_FRAME::onExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), PCB_EDIT_FRAME::OnQuit(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCH_EDITOR_CONTROL::rescueProject(), PCB_EDIT_FRAME::RunEeschema(), EE_INSPECTION_TOOL::RunSimulation(), SYMBOL_EDIT_FRAME::Save(), SYMBOL_EDIT_FRAME::saveCurrentSymbol(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_EDIT_FRAME::saveProjectSettings(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), PCB_BASE_FRAME::SelectFootprintFromLibBrowser(), PCB_BASE_FRAME::SelectLibrary(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), PCB_EDIT_FRAME::SendCrossProbeItem(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), PCB_EDIT_FRAME::SendSelectItemsToSch(), SCH_EDIT_FRAME::SetCrossProbeConnection(), SYMBOL_EDIT_FRAME::SetCurSymbol(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIMULATOR_FRAME::SIMULATOR_FRAME(), PCB_EDIT_FRAME::TestStandalone(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ LoadFieldNames()

void DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames ( )
private

Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in use.

Definition at line 1021 of file dialog_symbol_fields_table.cpp.

1022{
1023 std::set<wxString> userFieldNames;
1024
1025 for( unsigned i = 0; i < m_symbolsList.GetCount(); ++i )
1026 {
1027 SCH_SYMBOL* symbol = m_symbolsList[ i ].GetSymbol();
1028
1029 for( int j = MANDATORY_FIELDS; j < symbol->GetFieldCount(); ++j )
1030 userFieldNames.insert( symbol->GetFields()[j].GetName() );
1031 }
1032
1033 // Force References to always be shown
1034 EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1035 wxCHECK( cfg, /*void*/ );
1036
1037 cfg->m_FieldEditorPanel.fields_show["Reference"] = true;
1038
1039 AddField( _( "Reference" ), wxT( "Reference" ), true, true );
1040 AddField( _( "Value" ), wxT( "Value" ), true, true );
1041 AddField( _( "Footprint" ), wxT( "Footprint" ), true, true );
1042 AddField( _( "Datasheet" ), wxT( "Datasheet" ), true, false );
1043
1044 for( const wxString& fieldName : userFieldNames )
1045 AddField( fieldName, fieldName, true, false );
1046
1047 // Add any templateFieldNames which aren't already present in the userFieldNames
1048 for( const TEMPLATE_FIELDNAME& templateFieldname :
1050 {
1051 if( userFieldNames.count( templateFieldname.m_Name ) == 0 )
1052 AddField( templateFieldname.m_Name, templateFieldname.m_Name, false, false );
1053 }
1054}
void AddField(const wxString &displayName, const wxString &aCanonicalName, bool defaultShow, bool defaultSortBy, bool addedByUser=false)
TEMPLATES m_TemplateFieldNames
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:205
size_t GetCount() const
Schematic symbol object.
Definition: sch_symbol.h:81
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: sch_symbol.h:486
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
Definition: sch_symbol.cpp:901
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field name list for read only access.
Hold a name of a symbol's field, field value, and default visibility.
@ MANDATORY_FIELDS
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.

References _, AddField(), EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_show, SCH_REFERENCE_LIST::GetCount(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFields(), TEMPLATES::GetTemplateFieldNames(), Kiface(), KIFACE_BASE::KifaceSettings(), EESCHEMA_SETTINGS::m_FieldEditorPanel, m_parent, m_symbolsList, SCHEMATIC_SETTINGS::m_TemplateFieldNames, MANDATORY_FIELDS, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by DIALOG_SYMBOL_FIELDS_TABLE().

◆ OnAddField()

void DIALOG_SYMBOL_FIELDS_TABLE::OnAddField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1057 of file dialog_symbol_fields_table.cpp.

1058{
1059 wxTextEntryDialog dlg( this, _( "New field name:" ), _( "Add Field" ) );
1060
1061 if( dlg.ShowModal() != wxID_OK )
1062 return;
1063
1064 wxString fieldName = dlg.GetValue();
1065
1066 if( fieldName.IsEmpty() )
1067 {
1068 DisplayError( this, _( "Field must have a name." ) );
1069 return;
1070 }
1071
1072 for( int i = 0; i < m_dataModel->GetNumberCols(); ++i )
1073 {
1074 if( fieldName == m_dataModel->GetColLabelValue( i ) )
1075 {
1076 DisplayError( this, wxString::Format( _( "Field name '%s' already in use." ),
1077 fieldName ) );
1078 return;
1079 }
1080 }
1081
1082 // quantities column will become new field column, so it needs to be reset
1083 wxGridCellAttr* attr = new wxGridCellAttr;
1084 m_grid->SetColAttr( m_dataModel->GetColsCount() - 1, attr );
1085 m_grid->SetColFormatCustom( m_dataModel->GetColsCount() - 1, wxGRID_VALUE_STRING );
1086
1087 std::string key( fieldName.ToUTF8() );
1088
1089 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1090 cfg->m_FieldEditorPanel.fields_show[key] = true;
1091
1092 AddField( fieldName, fieldName, true, false, true );
1093
1094 wxGridTableMessage msg( m_dataModel, wxGRIDTABLE_NOTIFY_COLS_INSERTED,
1095 m_fieldsCtrl->GetItemCount(), 1 );
1096 m_grid->ProcessTableMessage( msg );
1097
1098 // set up attributes on the new quantities column
1099 attr = new wxGridCellAttr;
1100 attr->SetReadOnly();
1101 m_grid->SetColAttr( m_dataModel->GetColsCount() - 1, attr );
1102 m_grid->SetColFormatNumber( m_dataModel->GetColsCount() - 1 );
1103 m_grid->SetColSize( m_dataModel->GetColsCount() - 1, 50 );
1104}
wxString GetColLabelValue(int aCol) override
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:300
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References _, AddField(), DisplayError(), EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_show, Format(), FIELDS_EDITOR_GRID_DATA_MODEL::GetColLabelValue(), FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols(), Kiface(), KIFACE_BASE::KifaceSettings(), m_dataModel, EESCHEMA_SETTINGS::m_FieldEditorPanel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, and DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid.

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

533{
534 const int id = aEvent.GetId();
535
536 // If we are pressing a button to exit, we need to enable the escapeID
537 // otherwise the dialog does not process cancel
538 if( id == wxID_CANCEL )
539 SetEscapeId( wxID_ANY );
540
541 if( IsQuasiModal() )
542 {
543 if( id == GetAffirmativeId() )
544 {
545 EndQuasiModal( id );
546 }
547 else if( id == wxID_APPLY )
548 {
549 // Dialogs that provide Apply buttons should make sure data is valid before
550 // allowing a transfer, as there is no other way to indicate failure
551 // (i.e. the dialog can't refuse to close as it might with OK, because it
552 // isn't closing anyway)
553 if( Validate() )
554 {
555 ignore_unused( TransferDataFromWindow() );
556 }
557 }
558 else if( id == GetEscapeId() || (id == wxID_CANCEL && GetEscapeId() == wxID_ANY) )
559 {
560 EndQuasiModal( wxID_CANCEL );
561 }
562 else // not a standard button
563 {
564 aEvent.Skip();
565 }
566
567 return;
568 }
569
570 // This is mandatory to allow wxDialogBase::OnButton() to be called.
571 aEvent.Skip();
572}
void EndQuasiModal(int retCode)
void ignore_unused(const T &)
Definition: ignore.h:24

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnCancel()

void DIALOG_SYMBOL_FIELDS_TABLE::OnCancel ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1462 of file dialog_symbol_fields_table.cpp.

1463{
1464 Close();
1465}

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in HK_PROMPT_DIALOG, DIALOG_CHOOSE_SYMBOL, and HTML_MESSAGE_BOX.

Definition at line 575 of file dialog_shim.cpp.

576{
577 if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
578 {
579 if( m_parentFrame )
580 {
582 return;
583 }
584 }
585 // shift-return (Mac default) or Ctrl-Return (GTK) for OK
586 else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
587 {
588 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
589 return;
590 }
591 else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
592 {
593 wxWindow* currentWindow = wxWindow::FindFocus();
594 int currentIdx = -1;
595 int delta = aEvt.ShiftDown() ? -1 : 1;
596
597 auto advance =
598 [&]( int& idx )
599 {
600 // Wrap-around modulus
601 int size = (int) m_tabOrder.size();
602 idx = ( ( idx + delta ) % size + size ) % size;
603 };
604
605 for( size_t i = 0; i < m_tabOrder.size(); ++i )
606 {
607 if( m_tabOrder[i] == currentWindow )
608 {
609 currentIdx = (int) i;
610 break;
611 }
612 }
613
614 if( currentIdx >= 0 )
615 {
616 advance( currentIdx );
617
618 //todo: We don't currently have non-textentry dialog boxes but this will break if
619 // we add them.
620#ifdef __APPLE__
621 while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
622 advance( currentIdx );
623#endif
624
625 m_tabOrder[ currentIdx ]->SetFocus();
626 return;
627 }
628 }
629
630 aEvt.Skip();
631}
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:222
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:220
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(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), and DIALOG_TEXTBOX_PROPERTIES::~DIALOG_TEXTBOX_PROPERTIES().

◆ OnClose()

void DIALOG_SYMBOL_FIELDS_TABLE::OnClose ( wxCloseEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1468 of file dialog_symbol_fields_table.cpp.

1469{
1470 // This is a cancel, so commit quietly as we're going to throw the results away anyway.
1472
1473 if( m_dataModel->IsEdited() )
1474 {
1475 if( !HandleUnsavedChanges( this, _( "Save changes?" ),
1476 [&]() -> bool
1477 {
1478 return TransferDataFromWindow();
1479 } ) )
1480 {
1481 event.Veto();
1482 return;
1483 }
1484 }
1485
1486 event.Skip();
1487}
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:423
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:260

References _, WX_GRID::CommitPendingChanges(), HandleUnsavedChanges(), FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, and TransferDataFromWindow().

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

520{
521 if( IsQuasiModal() )
522 {
523 EndQuasiModal( wxID_CANCEL );
524 return;
525 }
526
527 // This is mandatory to allow wxDialogBase::OnCloseWindow() to be called.
528 aEvent.Skip();
529}

References DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnColSort()

void DIALOG_SYMBOL_FIELDS_TABLE::OnColSort ( wxGridEvent &  aEvent)
private

Definition at line 1248 of file dialog_symbol_fields_table.cpp.

1249{
1250 int sortCol = aEvent.GetCol();
1251 bool ascending;
1252
1253 // This is bonkers, but wxWidgets doesn't tell us ascending/descending in the event, and
1254 // if we ask it will give us pre-event info.
1255 if( m_grid->IsSortingBy( sortCol ) )
1256 {
1257 // same column; invert ascending
1258 ascending = !m_grid->IsSortOrderAscending();
1259 }
1260 else
1261 {
1262 // different column; start with ascending
1263 ascending = true;
1264 }
1265
1266 m_dataModel->Sort( sortCol, ascending );
1267 m_grid->ForceRefresh();
1268}

References m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, and FIELDS_EDITOR_GRID_DATA_MODEL::Sort().

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

◆ OnColumnItemToggled()

void DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled ( wxDataViewEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1189 of file dialog_symbol_fields_table.cpp.

1190{
1191 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1192 wxDataViewItem item = event.GetItem();
1193
1194 int row = m_fieldsCtrl->ItemToRow( item );
1195 int col = event.GetColumn();
1196
1197 switch ( col )
1198 {
1199 case SHOW_FIELD_COLUMN:
1200 {
1201 bool value = m_fieldsCtrl->GetToggleValue( row, col );
1202
1203 if( row == REFERENCE_FIELD && !value )
1204 {
1205 DisplayError( this, _( "The Reference column cannot be hidden." ) );
1206
1207 value = true;
1208 m_fieldsCtrl->SetToggleValue( value, row, col );
1209 }
1210
1211 std::string fieldName( m_fieldsCtrl->GetTextValue( row, CANONICAL_NAME_COLUMN ).ToUTF8() );
1212 cfg->m_FieldEditorPanel.fields_show[fieldName] = value;
1213
1214 if( value )
1215 m_grid->ShowCol( row );
1216 else
1217 m_grid->HideCol( row ); // grid's columns map to fieldsCtrl's rows
1218
1219 break;
1220 }
1221
1222 case GROUP_BY_COLUMN:
1223 {
1224 bool value = m_fieldsCtrl->GetToggleValue( row, col );
1225 std::string fieldName( m_fieldsCtrl->GetTextValue( row, CANONICAL_NAME_COLUMN ).ToUTF8() );
1226 cfg->m_FieldEditorPanel.fields_group_by[fieldName] = value;
1227
1229 m_dataModel->Sort( m_grid->GetSortingColumn(), m_grid->IsSortOrderAscending() );
1230 m_grid->ForceRefresh();
1231 break;
1232 }
1233
1234 default:
1235 break;
1236 }
1237}

References _, CANONICAL_NAME_COLUMN, DisplayError(), EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_group_by, EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::fields_show, GROUP_BY_COLUMN, Kiface(), KIFACE_BASE::KifaceSettings(), m_dataModel, EESCHEMA_SETTINGS::m_FieldEditorPanel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_filter, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_groupSymbolsBox, FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), REFERENCE_FIELD, SHOW_FIELD_COLUMN, and FIELDS_EDITOR_GRID_DATA_MODEL::Sort().

◆ OnExport()

void DIALOG_SYMBOL_FIELDS_TABLE::OnExport ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1387 of file dialog_symbol_fields_table.cpp.

1388{
1389 int last_col = m_grid->GetNumberCols() - 1;
1390
1391 if( m_dataModel->IsEdited() )
1392 if( OKOrCancelDialog( nullptr, _( "Unsaved data" ),
1393 _( "Changes are unsaved. Export unsaved data?" ), "", _( "OK" ),
1394 _( "Cancel" ) )
1395 == wxID_CANCEL )
1396 return;
1397
1398
1399 // Calculate the netlist filename
1400 wxFileName fn = m_parent->Schematic().GetFileName();
1401 fn.SetExt( CsvFileExtension );
1402
1403 wxFileDialog saveDlg( this, _( "Save as CSV" ), wxPathOnly( Prj().GetProjectFullName() ),
1404 fn.GetFullName(), CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1405
1406 if( saveDlg.ShowModal() == wxID_CANCEL )
1407 return;
1408
1409 wxFFile out( saveDlg.GetPath(), "wb" );
1410
1411 if( !out.IsOpened() )
1412 return;
1413
1414 // Find the location for the line terminator
1415 for( int col = m_grid->GetNumberCols() - 1; col >=0 ; --col )
1416 {
1417 if( m_grid->IsColShown( col ) )
1418 {
1419 last_col = col;
1420 break;
1421 }
1422 }
1423
1424 // Column names
1425 for( int col = 0; col < m_grid->GetNumberCols(); col++ )
1426 {
1427 if( !m_grid->IsColShown( col ) )
1428 continue;
1429
1430 wxString escapedValue = m_grid->GetColLabelValue( col );
1431 escapedValue.Replace( wxS( "\"" ), wxS( "\"\"" ) );
1432
1433 wxString format = col == last_col ? wxS( "\"%s\"\r\n" ) : wxS( "\"%s\"," );
1434
1435 out.Write( wxString::Format( format, escapedValue ) );
1436 }
1437
1438 // Data rows
1439 for( int row = 0; row < m_grid->GetNumberRows(); row++ )
1440 {
1441 // Don't output child rows
1442 if( m_dataModel->GetRowFlags( row ) == CHILD_ITEM )
1443 continue;
1444
1445 for( int col = 0; col < m_grid->GetNumberCols(); col++ )
1446 {
1447 if( !m_grid->IsColShown( col ) )
1448 continue;
1449
1450 // Get the unanottated version of the field, e.g. no "> " or "v " by
1451 wxString escapedValue = m_dataModel->GetRawValue( row, col );
1452 escapedValue.Replace( wxS( "\"" ), wxS( "\"\"" ) );
1453
1454 wxString format = col == last_col ? wxS( "\"%s\"\r\n" ) : wxS( "\"%s\"," );
1455
1456 out.Write( wxString::Format( format, escapedValue ) );
1457 }
1458 }
1459}
wxString GetRawValue(int aRow, int aCol)
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:199
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
Definition: confirm.cpp:273
const std::string CsvFileExtension
wxString CsvFileWildcard()

References _, CHILD_ITEM, CsvFileExtension, CsvFileWildcard(), Format(), SCHEMATIC::GetFileName(), FIELDS_EDITOR_GRID_DATA_MODEL::GetRawValue(), FIELDS_EDITOR_GRID_DATA_MODEL::GetRowFlags(), FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, m_parent, OKOrCancelDialog(), KIWAY_HOLDER::Prj(), and SCH_EDIT_FRAME::Schematic().

◆ OnFieldsCtrlSelectionChanged()

void DIALOG_SYMBOL_FIELDS_TABLE::OnFieldsCtrlSelectionChanged ( wxDataViewEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1179 of file dialog_symbol_fields_table.cpp.

1180{
1181 int row = m_fieldsCtrl->GetSelectedRow();
1182
1183 if( row >= MANDATORY_FIELDS )
1184 m_removeFieldButton->Enable( true );
1185 else
1186 m_removeFieldButton->Enable( false );
1187}

References DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_removeFieldButton, and MANDATORY_FIELDS.

◆ OnFilterMouseMoved()

void DIALOG_SYMBOL_FIELDS_TABLE::OnFilterMouseMoved ( wxMouseEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1164 of file dialog_symbol_fields_table.cpp.

1165{
1166 wxPoint pos = aEvent.GetPosition();
1167 wxRect ctrlRect = m_filter->GetScreenRect();
1168 int buttonWidth = ctrlRect.GetHeight(); // Presume buttons are square
1169
1170 if( m_filter->IsSearchButtonVisible() && pos.x < buttonWidth )
1171 SetCursor( wxCURSOR_ARROW );
1172 else if( m_filter->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
1173 SetCursor( wxCURSOR_ARROW );
1174 else
1175 SetCursor( wxCURSOR_IBEAM );
1176}

References DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_filter.

◆ OnFilterText()

void DIALOG_SYMBOL_FIELDS_TABLE::OnFilterText ( wxCommandEvent &  aEvent)
overrideprivatevirtual

◆ OnGridEditorHidden()

void DIALOG_SHIM::OnGridEditorHidden ( wxGridEvent &  event)
privateinherited

Definition at line 641 of file dialog_shim.cpp.

642{
643 SetEscapeId( wxID_ANY );
644 event.Skip();
645}

◆ OnGridEditorShown()

void DIALOG_SHIM::OnGridEditorShown ( wxGridEvent &  event)
privateinherited

Definition at line 634 of file dialog_shim.cpp.

635{
636 SetEscapeId( wxID_NONE );
637 event.Skip();
638}

◆ OnGroupSymbolsToggled()

void DIALOG_SYMBOL_FIELDS_TABLE::OnGroupSymbolsToggled ( wxCommandEvent &  event)
overrideprivatevirtual

◆ OnModify()

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 386 of file dialog_shim.cpp.

387{
389 {
391
392 selectAllInTextCtrls( GetChildren() );
393
396 else
397 KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
398
399 m_firstPaintEvent = false;
400 }
401
402 event.Skip();
403}
bool m_firstPaintEvent
Definition: dialog_shim.h:212
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:213
static void selectAllInTextCtrls(wxWindowList &children)
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnRegroupSymbols()

void DIALOG_SYMBOL_FIELDS_TABLE::OnRegroupSymbols ( wxCommandEvent &  aEvent)
overrideprivatevirtual

◆ OnRemoveField()

void DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1107 of file dialog_symbol_fields_table.cpp.

1108{
1109 int col = -1;
1110 int row = m_fieldsCtrl->GetSelectedRow();
1111
1112 // Should never occur: "Remove Field..." button should be disabled if invalid selection
1113 // via OnFieldsCtrlSelectionChanged()
1114 wxCHECK_RET( row != -1, wxS( "Some user defined field must be selected first" ) );
1115 wxCHECK_RET( row >= MANDATORY_FIELDS, wxS( "Mandatory fields cannot be removed" ) );
1116
1117 wxString fieldName = m_fieldsCtrl->GetTextValue( row, 0 );
1118
1119 wxString confirm_msg = wxString::Format( _( "Are you sure you want to remove the field '%s'?" ),
1120 fieldName );
1121
1122 if( !IsOK( this, confirm_msg ) )
1123 return;
1124
1125 for( int i = 0; i < m_dataModel->GetNumberCols(); ++i )
1126 {
1127 if( fieldName == m_dataModel->GetColLabelValue( i ) )
1128 col = i;
1129 }
1130
1131 m_fieldsCtrl->DeleteItem( row );
1132 m_dataModel->RemoveColumn( col );
1133
1134 // Make selection and update the state of "Remove field..." button via OnFieldsCtrlSelectionChanged()
1135 // Safe to decrement row index because we always have mandatory fields
1136 m_fieldsCtrl->SelectRow( --row );
1137
1138 if( row < MANDATORY_FIELDS )
1139 m_removeFieldButton->Enable( false );
1140
1141 wxGridTableMessage msg( m_dataModel, wxGRIDTABLE_NOTIFY_COLS_DELETED,
1142 m_fieldsCtrl->GetItemCount(), 1 );
1143
1144 m_grid->ProcessTableMessage( msg );
1145
1146 // set up attributes on the new quantities column
1147 wxGridCellAttr* attr = new wxGridCellAttr;
1148 attr->SetReadOnly();
1149
1150 m_grid->SetColAttr( m_dataModel->GetColsCount() - 1, attr );
1151 m_grid->SetColFormatNumber( m_dataModel->GetColsCount() - 1 );
1152 m_grid->SetColSize( m_dataModel->GetColsCount() - 1, 50 );
1153}
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:380

References _, Format(), FIELDS_EDITOR_GRID_DATA_MODEL::GetColLabelValue(), FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols(), IsOK(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_removeFieldButton, MANDATORY_FIELDS, and FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn().

◆ OnSaveAndContinue()

void DIALOG_SYMBOL_FIELDS_TABLE::OnSaveAndContinue ( wxCommandEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1380 of file dialog_symbol_fields_table.cpp.

1381{
1384}
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.

References m_parent, SCH_EDIT_FRAME::SaveProject(), and TransferDataFromWindow().

◆ OnSizeFieldList()

void DIALOG_SYMBOL_FIELDS_TABLE::OnSizeFieldList ( wxSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1356 of file dialog_symbol_fields_table.cpp.

1357{
1358 int nameColWidth = KIPLATFORM::UI::GetUnobscuredSize( m_fieldsCtrl ).x;
1359 nameColWidth -= m_showColWidth + m_groupByColWidth;
1360#ifdef __WXMAC__
1361 // TODO: something in wxWidgets 3.1.x pads checkbox columns with extra space. (It used to
1362 // also be that the width of the column would get set too wide (to 30), but that's patched in
1363 // our local wxWidgets fork.)
1364 nameColWidth -= 30;
1365#endif
1366
1367 // GTK loses its head and messes these up when resizing the splitter bar:
1368 m_fieldsCtrl->GetColumn( SHOW_FIELD_COLUMN )->SetWidth( m_showColWidth );
1369 m_fieldsCtrl->GetColumn( GROUP_BY_COLUMN )->SetWidth( m_groupByColWidth );
1370
1371 m_fieldsCtrl->GetColumn( CANONICAL_NAME_COLUMN )->SetHidden( true );
1372 m_fieldsCtrl->GetColumn( DISPLAY_NAME_COLUMN )->SetWidth( nameColWidth );
1373
1374 m_fieldsCtrl->Refresh(); // To refresh checkboxes on Windows.
1375
1376 event.Skip();
1377}
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: gtk/ui.cpp:133

References CANONICAL_NAME_COLUMN, DISPLAY_NAME_COLUMN, KIPLATFORM::UI::GetUnobscuredSize(), GROUP_BY_COLUMN, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl, m_groupByColWidth, m_showColWidth, and SHOW_FIELD_COLUMN.

◆ OnTableCellClick()

void DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick ( wxGridEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1298 of file dialog_symbol_fields_table.cpp.

1299{
1300 if( event.GetCol() == REFERENCE_FIELD )
1301 {
1302 m_grid->ClearSelection();
1303 m_grid->SetGridCursor( event.GetRow(), event.GetCol() );
1304
1305 m_dataModel->ExpandCollapseRow( event.GetRow() );
1306 }
1307 else
1308 {
1309 event.Skip();
1310 }
1311}

References FIELDS_EDITOR_GRID_DATA_MODEL::ExpandCollapseRow(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, and REFERENCE_FIELD.

◆ OnTableColSize()

void DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize ( wxGridSizeEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1277 of file dialog_symbol_fields_table.cpp.

1278{
1279 EESCHEMA_SETTINGS* cfg = static_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1280 int col = aEvent.GetRowOrCol();
1281 std::string key( m_dataModel->GetCanonicalColLabel( col ).ToUTF8() );
1282
1283 if( m_grid->GetColSize( col ) )
1284 cfg->m_FieldEditorPanel.column_widths[ key ] = m_grid->GetColSize( col );
1285
1286 aEvent.Skip();
1287}

References EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::column_widths, FIELDS_EDITOR_GRID_DATA_MODEL::GetCanonicalColLabel(), Kiface(), KIFACE_BASE::KifaceSettings(), m_dataModel, EESCHEMA_SETTINGS::m_FieldEditorPanel, and DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid.

◆ OnTableItemContextMenu()

void DIALOG_SYMBOL_FIELDS_TABLE::OnTableItemContextMenu ( wxGridEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1348 of file dialog_symbol_fields_table.cpp.

1349{
1350 // TODO: Option to select footprint if FOOTPRINT column selected
1351
1352 event.Skip();
1353}

◆ OnTableRangeSelected()

void DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected ( wxGridRangeSelectEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1313 of file dialog_symbol_fields_table.cpp.

1314{
1315 wxGridCellCoordsArray selectedCells = m_grid->GetSelectedCells();
1316
1317 if( selectedCells.GetCount() == 1 )
1318 {
1319 int row = selectedCells[0].GetRow();
1320 int flag = m_dataModel->GetRowFlags( row );
1321 std::vector<SCH_REFERENCE> refs = m_dataModel->GetRowReferences( row );
1322
1323 // Focus Eeschema view on the symbol selected in the dialog
1324 // TODO: Highlight or select more than one unit
1325 if( ( flag == GROUP_SINGLETON || flag == CHILD_ITEM ) && refs.size() >= 1 )
1326 {
1328
1329 std::sort( refs.begin(), refs.end(),
1330 []( const SCH_REFERENCE& a, const SCH_REFERENCE& b )
1331 {
1332 return a.GetUnit() < b.GetUnit();
1333 } );
1334
1335 // search and highlight the symbol found by its full path.
1336 // It allows select of not yet annotated or duplicaded symbols
1337 wxString symbol_path = refs[0].GetFullPath();
1338 // wxString reference = refs[0].GetRef() + refs[0].GetRefNumber(); // Not used
1339 editor->FindSymbolAndItem( &symbol_path, nullptr, true, HIGHLIGHT_SYMBOL, wxEmptyString );
1340 }
1341
1342 return;
1343 }
1344
1345 event.Skip();
1346}
std::vector< SCH_REFERENCE > GetRowReferences(int aRow) const
Handle actions specific to the schematic editor.
A helper to define a symbol's reference designator in a schematic.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
@ HIGHLIGHT_SYMBOL

References CHILD_ITEM, editor, flag, FIELDS_EDITOR_GRID_DATA_MODEL::GetRowFlags(), FIELDS_EDITOR_GRID_DATA_MODEL::GetRowReferences(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), GROUP_SINGLETON, HIGHLIGHT_SYMBOL, m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, and m_parent.

◆ OnTableValueChanged()

void DIALOG_SYMBOL_FIELDS_TABLE::OnTableValueChanged ( wxGridEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_SYMBOL_FIELDS_TABLE_BASE.

Definition at line 1271 of file dialog_symbol_fields_table.cpp.

1272{
1273 m_grid->ForceRefresh();
1274}

References DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid.

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

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), SYMBOL_VIEWER_FRAME::ClickOnLibList(), KICAD_MANAGER_FRAME::CloseProject(), 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_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), 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_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_FIELDS_TABLE(), 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(), SCH_EDIT_FRAME::doAutoSave(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::GetLastPath(), 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_NAVIGATE_TOOL::HypertextCommand(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FIELDS_GRID_TABLE< T >::initGrid(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SIMULATOR_FRAME::initWorkbook(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SYMBOL_VIEWER_FRAME::loadAllLibraries(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), SCH_EDIT_FRAME::LoadProject(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SIMULATOR_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME::LoadWorkbook(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::onBoardLoaded(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), OnExport(), 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(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), DIALOG_TEXT_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_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(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), SCH_EDIT_FRAME::PrintPage(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), SCH_EDIT_FRAME::RefreshOperatingPointDisplay(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), PCB_EDIT_FRAME::RunEeschema(), 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::SaveProjectLocalSettings(), SCH_EDIT_FRAME::saveProjectSettings(), PCB_EDIT_FRAME::saveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_EDIT_FRAME::saveSchematicFile(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME::SaveWorkbook(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), PCB_BASE_EDIT_FRAME::selectLibTable(), SCH_BASE_FRAME::SelectSymLibTable(), PCB_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::SetLastPath(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER_FRAME::takeScreenshot(), PCB_EDIT_FRAME::TestStandalone(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), SCH_EDIT_FRAME::updateAutoSaveFile(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SCH_EDIT_FRAME::updateTitle(), SIMULATOR_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIMULATOR_FRAME::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), 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 293 of file dialog_shim.cpp.

294{
295 const char* hash_key;
296
297 if( m_hash_key.size() )
298 {
299 // a special case like EDA_LIST_DIALOG, which has multiple uses.
300 hash_key = m_hash_key.c_str();
301 }
302 else
303 {
304 hash_key = typeid(*this).name();
305 }
306
307 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
308
309 if( it == class_map.end() )
310 return;
311
312 wxRect rect = it->second;
313 rect.SetSize( wxSize( 0, 0 ) );
314 class_map[ hash_key ] = rect;
315}
std::string m_hash_key
Definition: dialog_shim.h:203
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().

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

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), 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_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), 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_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), 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_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE(), 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_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_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(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::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}
const char * name
Definition: DXF_plotter.cpp:56

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

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIMULATOR_FRAME::SIMULATOR_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 196 of file dialog_shim.cpp.

197{
198 wxDialog::SetPosition( aNewPosition );
199
200 // Now update the stored position:
201 const char* hash_key;
202
203 if( m_hash_key.size() )
204 {
205 // a special case like EDA_LIST_DIALOG, which has multiple uses.
206 hash_key = m_hash_key.c_str();
207 }
208 else
209 {
210 hash_key = typeid(*this).name();
211 }
212
213 std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
214
215 if( it == class_map.end() )
216 return;
217
218 wxRect rect = it->second;
219 rect.SetPosition( aNewPosition );
220
221 class_map[ hash_key ] = rect;
222}
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 168 of file dialog_shim.cpp.

169{
170 wxSize sz( x, y );
171 SetSize( ConvertDialogToPixels( sz ) );
172}

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

709{
710 recursiveDescent( GetSizer(), aLabels );
711}
static void recursiveDescent(wxSizer *aSizer, std::map< int, wxString > &aLabels)

References recursiveDescent().

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), 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_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_DIELECTRIC_MATERIAL::DIALOG_DIELECTRIC_MATERIAL(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), 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_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), 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_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), 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_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), 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_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), 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_PRIMITIVES_TRANSFORM::DIALOG_PAD_PRIMITIVES_TRANSFORM(), 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_PNS_DIFF_PAIR_DIMENSIONS::DIALOG_PNS_DIFF_PAIR_DIMENSIONS(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::DIALOG_PNS_LENGTH_TUNING_SETTINGS(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), 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_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), 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_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_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_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(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), 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(), DIALOG_CLEANUP_TRACKS_AND_VIAS::setupOKButtonLabel(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 225 of file dialog_shim.cpp.

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

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

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), FOOTPRINT_EDITOR_CONTROL::CrossProbe(), EE_INSPECTION_TOOL::CrossProbe(), 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(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), EDA_LIST_DIALOG::Show(), DIALOG_FIND::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 436 of file dialog_shim.cpp.

437{
438 // This is an exception safe way to zero a pointer before returning.
439 // Yes, even though DismissModal() clears this first normally, this is
440 // here in case there's an exception before the dialog is dismissed.
441 struct NULLER
442 {
443 void*& m_what;
444 NULLER( void*& aPtr ) : m_what( aPtr ) {}
445 ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
446 } clear_this( (void*&) m_qmodal_loop );
447
448 // release the mouse if it's currently captured as the window having it
449 // will be disabled when this dialog is shown -- but will still keep the
450 // capture making it impossible to do anything in the modal dialog itself
451 wxWindow* win = wxWindow::GetCapture();
452 if( win )
453 win->ReleaseMouse();
454
455 // Get the optimal parent
456 wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
457
458 wxASSERT_MSG( !m_qmodal_parent_disabler, wxT( "Caller using ShowQuasiModal() twice on same "
459 "window?" ) );
460
461 // quasi-modal: disable only my "optimal" parent
463
464 // Apple in its infinite wisdom will raise a disabled window before even passing
465 // us the event, so we have no way to stop it. Instead, we must set an order on
466 // the windows so that the quasi-modal will be pushed in front of the disabled
467 // window when it is raised.
469
470 Show( true );
471
472 m_qmodal_showing = true;
473
474 WX_EVENT_LOOP event_loop;
475
476 m_qmodal_loop = &event_loop;
477
478 event_loop.Run();
479
480 m_qmodal_showing = false;
481
482 return GetReturnCode();
483}
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:46
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
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(), MICROWAVE_TOOL::createFootprint(), PCB::IFACE::CreateKiWindow(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), SIMULATOR_CONTROL::EditUserDefinedSignals(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), 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::ShowExchangeFootprintsDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and PCB_EDIT_FRAME::ToPlotter().

◆ TransferDataFromWindow()

bool DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow ( )
override

Definition at line 968 of file dialog_symbol_fields_table.cpp.

969{
971 return false;
972
973 if( !wxDialog::TransferDataFromWindow() )
974 return false;
975
976 SCH_SHEET_PATH currentSheet = m_parent->GetCurrentSheet();
977
979
980 // Reset the view to where we left the user
981 m_parent->SetCurrentSheet( currentSheet );
983 m_parent->Refresh();
984
986
987 return true;
988}
void SyncView()
Mark all items for refresh.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
SCH_SHEET_PATH & GetCurrentSheet() const
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...

References FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), WX_GRID::CommitPendingChanges(), SCH_EDIT_FRAME::GetCurrentSheet(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, m_parent, SCH_EDIT_FRAME::OnModify(), SCH_EDIT_FRAME::SetCurrentSheet(), and SCH_BASE_FRAME::SyncView().

Referenced by OnClose(), and OnSaveAndContinue().

◆ TransferDataToWindow()

bool DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow ( )
override

Definition at line 920 of file dialog_symbol_fields_table.cpp.

921{
922 if( !wxDialog::TransferDataFromWindow() )
923 return false;
924
926 EE_SELECTION_TOOL* selectionTool = toolMgr->GetTool<EE_SELECTION_TOOL>();
927 EE_SELECTION& selection = selectionTool->GetSelection();
928 SCH_SYMBOL* symbol = nullptr;
929
930 if( selection.GetSize() == 1 )
931 {
932 EDA_ITEM* item = selection.Front();
933
934 if( item->Type() == SCH_SYMBOL_T )
935 symbol = (SCH_SYMBOL*) item;
936 else if( item->GetParent() && item->GetParent()->Type() == SCH_SYMBOL_T )
937 symbol = (SCH_SYMBOL*) item->GetParent();
938 }
939
940 if( symbol )
941 {
942 for( int row = 0; row < m_dataModel->GetNumberRows(); ++row )
943 {
944 std::vector<SCH_REFERENCE> references = m_dataModel->GetRowReferences( row );
945 bool found = false;
946
947 for( const SCH_REFERENCE& ref : references )
948 {
949 if( ref.GetSymbol() == symbol )
950 {
951 found = true;
952 break;
953 }
954 }
955
956 if( found )
957 {
958 m_grid->GoToCell( row, 1 );
959 break;
960 }
961 }
962 }
963
964 return true;
965}
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
EDA_ITEM * GetParent() const
Definition: eda_item.h:99
EE_SELECTION & GetSelection()
Master controller class:
Definition: tool_manager.h:55
@ SCH_SYMBOL_T
Definition: typeinfo.h:156

References FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberRows(), EDA_ITEM::GetParent(), FIELDS_EDITOR_GRID_DATA_MODEL::GetRowReferences(), EE_SELECTION_TOOL::GetSelection(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), m_dataModel, DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid, m_parent, SCH_SYMBOL_T, and EDA_ITEM::Type().

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

183{
184 wxSize sz( 0, y );
185 return ConvertDialogToPixels( sz ).y;
186}

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ m_addFieldButton

wxButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_addFieldButton
protectedinherited

◆ m_bRefresh

wxBitmapButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_bRefresh
protectedinherited

◆ m_buttonApply

wxButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_buttonApply
protectedinherited

◆ m_buttonExport

wxButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_buttonExport
protectedinherited

◆ m_dataModel

◆ m_fieldsCtrl

◆ m_filter

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 212 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_grid

◆ m_groupByColWidth

int DIALOG_SYMBOL_FIELDS_TABLE::m_groupByColWidth
private

Definition at line 80 of file dialog_symbol_fields_table.h.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE(), and OnSizeFieldList().

◆ m_groupSymbolsBox

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 213 of file dialog_shim.h.

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

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 225 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_kiway

KIWAY* KIWAY_HOLDER::m_kiway
privateinherited

◆ m_leftPanel

wxPanel* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_leftPanel
protectedinherited

◆ m_parent

◆ m_parentFrame

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_removeFieldButton

◆ m_rightPanel

wxPanel* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_rightPanel
protectedinherited

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_sdbSizerOK
protectedinherited

◆ m_separator1

BITMAP_BUTTON* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_separator1
protectedinherited

◆ m_separator2

BITMAP_BUTTON* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_separator2
protectedinherited

◆ m_showColWidth

int DIALOG_SYMBOL_FIELDS_TABLE::m_showColWidth
private

Definition at line 79 of file dialog_symbol_fields_table.h.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE(), and OnSizeFieldList().

◆ m_splitterMainWindow

wxSplitterWindow* DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_splitterMainWindow
protectedinherited

◆ m_symbolsList

SCH_REFERENCE_LIST DIALOG_SYMBOL_FIELDS_TABLE::m_symbolsList
private

Definition at line 82 of file dialog_symbol_fields_table.h.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE(), and LoadFieldNames().

◆ m_tabOrder

◆ m_type

HOLDER_TYPE KIWAY_HOLDER::m_type
privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::GetType().

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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