KiCad PCB EDA Suite
Loading...
Searching...
No Matches
fields_grid_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) 2018-2022 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef FIELDS_GRID_TABLE_H
25#define FIELDS_GRID_TABLE_H
26
27#include <sch_validators.h>
28#include <wx/grid.h>
29#include <sch_symbol.h>
30#include <grid_tricks.h>
31#include <validators.h>
32
33class SCH_BASE_FRAME;
34class DIALOG_SHIM;
35class SCH_LABEL_BASE;
36
37
39{
40public:
42 std::function<void( wxCommandEvent& )> aAddHandler ) :
43 GRID_TRICKS( aGrid, std::move( aAddHandler ) ),
44 m_dlg( aDialog )
45 {}
46
47protected:
48 virtual void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override;
49 virtual void doPopupSelection( wxCommandEvent& event ) override;
51};
52
53
55{
71
72 FDC_COUNT // keep as last
73};
74
75
76template <class T>
77class FIELDS_GRID_TABLE : public wxGridTableBase, public std::vector<T>
78{
79public:
80 FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_BASE_FRAME* aFrame, WX_GRID* aGrid,
81 LIB_SYMBOL* aSymbol );
82 FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_EDIT_FRAME* aFrame, WX_GRID* aGrid,
83 SCH_SYMBOL* aSymbol );
84 FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_EDIT_FRAME* aFrame, WX_GRID* aGrid,
85 SCH_SHEET* aSheet );
86 FIELDS_GRID_TABLE( DIALOG_SHIM* aDialog, SCH_EDIT_FRAME* aFrame, WX_GRID* aGrid,
87 SCH_LABEL_BASE* aLabel );
89
90 int GetNumberRows() override { return (int) this->size(); }
91 int GetNumberCols() override { return FDC_COUNT; }
92
93 wxString GetColLabelValue( int aCol ) override;
94
95 bool IsEmptyCell( int row, int col ) override
96 {
97 return false; // don't allow adjacent cell overflow, even if we are actually empty
98 }
99
100 bool CanGetValueAs( int aRow, int aCol, const wxString& aTypeName ) override;
101 bool CanSetValueAs( int aRow, int aCol, const wxString& aTypeName ) override;
102 wxGridCellAttr* GetAttr( int row, int col, wxGridCellAttr::wxAttrKind kind ) override;
103
104 wxString GetValue( int aRow, int aCol ) override;
105 bool GetValueAsBool( int aRow, int aCol ) override;
106
107 void SetValue( int aRow, int aCol, const wxString& aValue ) override;
108 void SetValueAsBool( int aRow, int aCol, bool aValue ) override;
109
110 wxString StringFromBool( bool aValue ) const;
111 bool BoolFromString( wxString aValue ) const;
112
113protected:
114 void initGrid( WX_GRID* aGrid );
115
116 void onUnitsChanged( wxCommandEvent& aEvent );
117
118private:
126 wxString m_curdir;
127
134
135 wxGridCellAttr* m_readOnlyAttr;
136 wxGridCellAttr* m_fieldNameAttr;
137 wxGridCellAttr* m_referenceAttr;
138 wxGridCellAttr* m_valueAttr;
139 wxGridCellAttr* m_footprintAttr;
140 wxGridCellAttr* m_urlAttr;
141 wxGridCellAttr* m_nonUrlAttr;
142 wxGridCellAttr* m_filepathAttr;
143 wxGridCellAttr* m_boolAttr;
144 wxGridCellAttr* m_vAlignAttr;
145 wxGridCellAttr* m_hAlignAttr;
146 wxGridCellAttr* m_orientationAttr;
147 wxGridCellAttr* m_netclassAttr;
148 wxGridCellAttr* m_fontAttr;
149 wxGridCellAttr* m_colorAttr;
150
151 std::unique_ptr<NUMERIC_EVALUATOR> m_eval;
152 std::map< std::pair<int, int>, wxString > m_evalOriginal;
153};
154
155
156#endif // FIELDS_GRID_TABLE_H
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:83
wxString GetValue(int aRow, int aCol) override
wxGridCellAttr * m_nonUrlAttr
wxGridCellAttr * m_readOnlyAttr
wxGridCellAttr * m_vAlignAttr
bool CanSetValueAs(int aRow, int aCol, const wxString &aTypeName) override
wxGridCellAttr * m_netclassAttr
int GetNumberCols() override
bool GetValueAsBool(int aRow, int aCol) override
void onUnitsChanged(wxCommandEvent &aEvent)
FIELD_VALIDATOR m_referenceValidator
wxGridCellAttr * m_boolAttr
DIALOG_SHIM * m_dialog
wxString GetColLabelValue(int aCol) override
wxGridCellAttr * m_footprintAttr
FIELD_VALIDATOR m_filepathValidator
wxGridCellAttr * m_filepathAttr
std::unique_ptr< NUMERIC_EVALUATOR > m_eval
wxGridCellAttr * m_orientationAttr
void SetValue(int aRow, int aCol, const wxString &aValue) override
wxGridCellAttr * m_fontAttr
SCH_BASE_FRAME * m_frame
FIELD_VALIDATOR m_nonUrlValidator
wxGridCellAttr * m_referenceAttr
wxGridCellAttr * m_colorAttr
bool CanGetValueAs(int aRow, int aCol, const wxString &aTypeName) override
FIELD_VALIDATOR m_urlValidator
bool IsEmptyCell(int row, int col) override
wxGridCellAttr * GetAttr(int row, int col, wxGridCellAttr::wxAttrKind kind) override
wxString StringFromBool(bool aValue) const
std::map< std::pair< int, int >, wxString > m_evalOriginal
wxGridCellAttr * m_urlAttr
void SetValueAsBool(int aRow, int aCol, bool aValue) override
int GetNumberRows() override
bool BoolFromString(wxString aValue) const
wxGridCellAttr * m_valueAttr
void initGrid(WX_GRID *aGrid)
wxGridCellAttr * m_fieldNameAttr
wxGridCellAttr * m_hAlignAttr
FIELD_VALIDATOR m_valueValidator
FIELD_VALIDATOR m_fieldNameValidator
virtual void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
FIELDS_GRID_TRICKS(WX_GRID *aGrid, DIALOG_SHIM *aDialog, std::function< void(wxCommandEvent &)> aAddHandler)
virtual void doPopupSelection(wxCommandEvent &event) override
A text control validator used for validating the text allowed in fields.
Definition: validators.h:238
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
Define a library symbol object.
Definition: lib_symbol.h:99
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Schematic editor (Eeschema) main window.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Schematic symbol object.
Definition: sch_symbol.h:109
FIELDS_DATA_COL_ORDER
@ FDC_TEXT_SIZE
@ FDC_BOLD
@ FDC_POSY
@ FDC_ITALIC
@ FDC_SHOW_NAME
@ FDC_COUNT
@ FDC_NAME
@ FDC_H_ALIGN
@ FDC_COLOR
@ FDC_SHOWN
@ FDC_ALLOW_AUTOPLACE
@ FDC_VALUE
@ FDC_POSX
@ FDC_ORIENTATION
@ FDC_V_ALIGN
@ FDC_FONT
STL namespace.
Definitions of control validators for schematic dialogs.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
Custom text control validator definitions.