KiCad PCB EDA Suite
wx_grid.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-2023 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 3
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 KICAD_WX_GRID_H
25#define KICAD_WX_GRID_H
26
27#include <memory>
28#include <vector>
29#include <memory>
30#include <wx/event.h>
31#include <wx/grid.h>
32#include <wx/version.h>
33#include <units_provider.h>
35
36
37class WX_GRID : public wxGrid
38{
39public:
40 // Constructor has to be wxFormBuilder-compatible
41 WX_GRID( wxWindow *parent, wxWindowID id,
42 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
43 long style = wxWANTS_CHARS, const wxString& name = wxGridNameStr );
44
45 ~WX_GRID() override;
46
52 void SetColLabelSize( int aHeight ); // Yes, we're hiding a non-virtual method
53
58 void SetLabelFont( const wxFont& aFont ); // Yes, we're hiding a non-virtual method
59
64 wxString GetShownColumns();
65
69 void ShowHideColumns( const wxString& shownColumns );
70
75 void SetTable( wxGridTableBase* table, bool aTakeOwnership = false );
76
81 void DestroyTable( wxGridTableBase* aTable );
82
88 bool CommitPendingChanges( bool aQuietMode = false );
89
94 void SetUnitsProvider( UNITS_PROVIDER* aProvider, int aCol = 0 );
95
96 void SetAutoEvalCols( const std::vector<int>& aCols ) { m_autoEvalCols = aCols; }
97
102 int GetUnitValue( int aRow, int aCol );
103
107 void SetUnitValue( int aRow, int aCol, int aValue );
108
118 int GetVisibleWidth( int aCol, bool aHeader = true, bool aContents = true, bool aKeep = false );
119
125
132 void ShowEditorOnMouseUp() { m_waitForSlowClick = true; }
133
140 {
141 if( GetNumberRows() )
142 DeleteRows( 0, GetNumberRows() );
143 }
144
145protected:
150 void DrawColLabel( wxDC& dc, int col ) override;
151
155 void DrawRowLabel( wxDC& dc, int row ) override;
156
160 void DrawCornerLabel( wxDC& dc ) override;
161
162 void onGridColMove( wxGridEvent& aEvent );
163 void onGridCellSelect( wxGridEvent& aEvent );
164 void onCellEditorShown( wxGridEvent& aEvent );
165 void onCellEditorHidden( wxGridEvent& aEvent );
166
167
168#if wxCHECK_VERSION( 3, 1, 3 )
169 void onDPIChanged(wxDPIChangedEvent& event);
170#endif
171
172protected:
174
175 std::map<int, UNITS_PROVIDER*> m_unitsProviders;
176 std::unique_ptr<NUMERIC_EVALUATOR> m_eval;
177 std::vector<int> m_autoEvalCols;
178
179 std::map< std::pair<int, int>, std::pair<wxString, wxString> > m_evalBeforeAfter;
180};
181
182#endif //KICAD_WX_GRID_H
const char * name
Definition: DXF_plotter.cpp:56
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=true, bool aKeep=false)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:520
void onGridCellSelect(wxGridEvent &aEvent)
Definition: wx_grid.cpp:197
~WX_GRID() override
Definition: wx_grid.cpp:120
void SetLabelFont(const wxFont &aFont)
Hide wxGrid's SetLabelFont() because for some reason on MSW it's a one-shot and subsequent calls to i...
Definition: wx_grid.cpp:158
bool m_weOwnTable
Definition: wx_grid.h:173
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:295
std::map< int, UNITS_PROVIDER * > m_unitsProviders
Definition: wx_grid.h:175
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
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:262
void SetColLabelSize(int aHeight)
Hide wxGrid's SetColLabelSize() method with one which makes sure the size is tall enough for the syst...
Definition: wx_grid.cpp:144
void SetUnitValue(int aRow, int aCol, int aValue)
Set a unitized cell's value.
Definition: wx_grid.cpp:502
WX_GRID(wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxWANTS_CHARS, const wxString &name=wxGridNameStr)
Definition: wx_grid.cpp:97
int GetUnitValue(int aRow, int aCol)
Apply standard KiCad unit and eval services to a numeric cell.
Definition: wx_grid.cpp:481
std::vector< int > m_autoEvalCols
Definition: wx_grid.h:177
std::map< std::pair< int, int >, std::pair< wxString, wxString > > m_evalBeforeAfter
Definition: wx_grid.h:179
void DrawCornerLabel(wxDC &dc) override
A re-implementation of wxGrid::DrawCornerLabel which draws flat borders.
Definition: wx_grid.cpp:313
void onCellEditorHidden(wxGridEvent &aEvent)
Definition: wx_grid.cpp:225
void ShowEditorOnMouseUp()
WxWidgets has a bunch of bugs in its handling of wxGrid mouse events which close cell editors right a...
Definition: wx_grid.h:132
void onGridColMove(wxGridEvent &aEvent)
Definition: wx_grid.cpp:513
void onCellEditorShown(wxGridEvent &aEvent)
Definition: wx_grid.cpp:210
void EnsureColLabelsVisible()
Ensure the height of the row displaying the column labels is enough, even if labels are multiline tex...
Definition: wx_grid.cpp:560
void DrawRowLabel(wxDC &dc, int row) override
A re-implementation of wxGrid::DrawRowLabel which draws flat borders.
Definition: wx_grid.cpp:385
void SetAutoEvalCols(const std::vector< int > &aCols)
Definition: wx_grid.h:96
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:276
void SetUnitsProvider(UNITS_PROVIDER *aProvider, int aCol=0)
Set a UNITS_PROVIDER to enable use of unit- and eval-based Getters.
Definition: wx_grid.cpp:472
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
Definition: wx_grid.h:139
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:423
std::unique_ptr< NUMERIC_EVALUATOR > m_eval
Definition: wx_grid.h:176
void DrawColLabel(wxDC &dc, int col) override
A re-implementation of wxGrid::DrawColLabel which left-aligns the first column and draws flat borders...
Definition: wx_grid.cpp:340