KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_symbol_fields_table.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2017 Oliver Walters
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#pragma once
26
28#include <sch_reference_list.h>
29#include <schematic.h>
30#include <fields_data_model.h>
31
32wxDECLARE_EVENT( EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxCommandEvent );
33
35class SCH_EDIT_FRAME;
37
38
40{
41public:
44
45 bool TransferDataToWindow() override;
46 bool TransferDataFromWindow() override;
47
48 void ShowEditTab();
49 void ShowExportTab();
50 void ShowHideColumn( int aCol, bool aShow );
51
52private:
53 void SetupColumnProperties( int aCol );
55 void AddField( const wxString& displayName, const wxString& aCanonicalName, bool show,
56 bool groupBy, bool addedByUser = false );
58
63 void LoadFieldNames();
64
65 void OnViewControlsCellChanged( wxGridEvent& aEvent ) override;
66 void OnSizeViewControlsGrid( wxSizeEvent& event ) override;
67 void OnAddField( wxCommandEvent& event ) override;
68 void OnRemoveField( wxCommandEvent& event ) override;
69 void OnRenameField( wxCommandEvent& event ) override;
70
71 void OnColSort( wxGridEvent& aEvent );
72 void OnColMove( wxGridEvent& aEvent );
73 void OnTableRangeSelected( wxGridRangeSelectEvent& aEvent );
74
75 void OnFilterText( wxCommandEvent& aEvent ) override;
76 void OnFilterMouseMoved( wxMouseEvent& event ) override;
77 void OnScope( wxCommandEvent& event ) override;
78 void OnGroupSymbolsToggled( wxCommandEvent& event ) override;
79 void OnRegroupSymbols( wxCommandEvent& aEvent ) override;
80 void OnMenu( wxCommandEvent& event ) override;
81
82 void OnTableValueChanged( wxGridEvent& event ) override;
83 void OnTableCellClick( wxGridEvent& event ) override;
84 void OnTableColSize( wxGridSizeEvent& event ) override;
85
86 void OnSidebarToggle( wxCommandEvent& event ) override;
87 void OnExport( wxCommandEvent& aEvent ) override;
88 void OnSaveAndContinue( wxCommandEvent& aEvent ) override;
89 void OnCancel( wxCommandEvent& aEvent ) override;
90 void OnOk( wxCommandEvent& aEvent ) override;
91 void OnClose( wxCloseEvent& aEvent ) override;
92
93 void OnOutputFileBrowseClicked( wxCommandEvent& event ) override;
94 void OnPageChanged( wxNotebookEvent& event ) override;
95 void OnPreviewRefresh( wxCommandEvent& event ) override;
96 void PreviewRefresh();
97
98 std::vector<BOM_PRESET> GetUserBomPresets() const;
99 void SetUserBomPresets( std::vector<BOM_PRESET>& aPresetList );
100 void ApplyBomPreset( const wxString& aPresetName );
101 void ApplyBomPreset( const BOM_PRESET& aPreset );
102
106 std::vector<BOM_FMT_PRESET> GetUserBomFmtPresets() const;
107 void SetUserBomFmtPresets( std::vector<BOM_FMT_PRESET>& aPresetList );
108 void ApplyBomFmtPreset( const wxString& aPresetName );
109 void ApplyBomFmtPreset( const BOM_FMT_PRESET& aPreset );
110
111 // Schematic listener event handlers
112 void OnSchItemsAdded( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) override;
113 void OnSchItemsRemoved( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) override;
114 void OnSchItemsChanged( SCHEMATIC& aSch, std::vector<SCH_ITEM*>& aSchItem ) override;
115 void OnSchSheetChanged( SCHEMATIC& aSch ) override;
116
119
120private:
123
126 void updateBomPresetSelection( const wxString& aName );
127 void onBomPresetChanged( wxCommandEvent& aEvent );
128 void doApplyBomPreset( const BOM_PRESET& aPreset );
130
133 void updateBomFmtPresetSelection( const wxString& aName );
134 void onBomFmtPresetChanged( wxCommandEvent& aEvent );
135 void doApplyBomFmtPreset( const BOM_FMT_PRESET& aPreset );
137
139
140private:
141 std::map<wxString, BOM_PRESET> m_bomPresets;
144 wxArrayString m_bomPresetMRU;
145
146 std::map<wxString, BOM_FMT_PRESET> m_bomFmtPresets;
149 wxArrayString m_bomFmtPresetMRU;
150
152
153 // Index in the fields list control for each MANDATORY_FIELD type
154 std::map<FIELD_T, int> m_mandatoryFieldListIndexes;
155
157
160
162
164};
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)
void OnTableColSize(wxGridSizeEvent &event) override
void OnSaveAndContinue(wxCommandEvent &aEvent) override
void OnSchItemsRemoved(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
void OnPreviewRefresh(wxCommandEvent &event) override
void OnAddField(wxCommandEvent &event) override
SCH_REFERENCE_LIST getSheetSymbolReferences(SCH_SHEET &aSheet)
void SetUserBomPresets(std::vector< BOM_PRESET > &aPresetList)
void OnSidebarToggle(wxCommandEvent &event) override
void OnOk(wxCommandEvent &aEvent) override
void OnGroupSymbolsToggled(wxCommandEvent &event) override
void OnSchItemsAdded(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
std::map< wxString, BOM_PRESET > m_bomPresets
void OnSchItemsChanged(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
void ApplyBomFmtPreset(const wxString &aPresetName)
void ShowHideColumn(int aCol, bool aShow)
VIEW_CONTROLS_GRID_DATA_MODEL * m_viewControlsDataModel
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
void updateBomPresetSelection(const wxString &aName)
void updateBomFmtPresetSelection(const wxString &aName)
void OnFilterText(wxCommandEvent &aEvent) override
std::map< FIELD_T, int > m_mandatoryFieldListIndexes
void OnRemoveField(wxCommandEvent &event) override
void OnTableCellClick(wxGridEvent &event) override
void doApplyBomFmtPreset(const BOM_FMT_PRESET &aPreset)
void OnScope(wxCommandEvent &event) override
void onBomPresetChanged(wxCommandEvent &aEvent)
void OnTableValueChanged(wxGridEvent &event) override
void OnExport(wxCommandEvent &aEvent) override
void OnClose(wxCloseEvent &aEvent) override
void OnSchSheetChanged(SCHEMATIC &aSch) override
void OnTableRangeSelected(wxGridRangeSelectEvent &aEvent)
void OnMenu(wxCommandEvent &event) override
void setScope(FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE aScope)
std::vector< BOM_FMT_PRESET > GetUserBomFmtPresets() const
void OnCancel(wxCommandEvent &aEvent) override
void OnFilterMouseMoved(wxMouseEvent &event) override
std::map< wxString, BOM_FMT_PRESET > m_bomFmtPresets
DIALOG_SYMBOL_FIELDS_TABLE(SCH_EDIT_FRAME *parent, JOB_EXPORT_SCH_BOM *aJob=nullptr)
BOM_FMT_PRESET GetCurrentBomFmtSettings()
Returns a formatting configuration corresponding to the values in the UI controls of the dialog.
void AddField(const wxString &displayName, const wxString &aCanonicalName, bool show, bool groupBy, bool addedByUser=false)
SCH_REFERENCE_LIST getSymbolReferences(SCH_SYMBOL *aSymbol, SCH_REFERENCE_LIST &aCachedRefs)
void doApplyBomPreset(const BOM_PRESET &aPreset)
void OnPageChanged(wxNotebookEvent &event) override
void SetUserBomFmtPresets(std::vector< BOM_FMT_PRESET > &aPresetList)
void OnRegroupSymbols(wxCommandEvent &aEvent) override
void OnViewControlsCellChanged(wxGridEvent &aEvent) override
std::vector< BOM_PRESET > GetUserBomPresets() const
void OnOutputFileBrowseClicked(wxCommandEvent &event) override
void LoadFieldNames()
Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in ...
void onBomFmtPresetChanged(wxCommandEvent &aEvent)
void ApplyBomPreset(const wxString &aPresetName)
void OnSizeViewControlsGrid(wxSizeEvent &event) override
void OnRenameField(wxCommandEvent &event) override
These are loaded from Eeschema settings but then overwritten by the project settings.
Holds all the data relating to one schematic.
Definition schematic.h:88
Schematic editor (Eeschema) main window.
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:47
Schematic symbol object.
Definition sch_symbol.h:75
wxDECLARE_EVENT(EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxCommandEvent)