KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 <bitset>
31#include <wx/event.h>
32#include <wx/grid.h>
33#include <wx/version.h>
34#include <units_provider.h>
36
37
38class WX_GRID : public wxGrid
39{
40public:
41 // Constructor has to be wxFormBuilder-compatible
42 WX_GRID( wxWindow *parent, wxWindowID id,
43 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
44 long style = wxWANTS_CHARS, const wxString& name = wxGridNameStr );
45
46 ~WX_GRID() override;
47
53 void SetColLabelSize( int aHeight ); // Yes, we're hiding a non-virtual method
54
59 void SetLabelFont( const wxFont& aFont ); // Yes, we're hiding a non-virtual method
60
65 wxString GetShownColumnsAsString();
66 std::bitset<64> GetShownColumns();
67
71 void ShowHideColumns( const wxString& shownColumns );
72
76 void ShowHideColumns( const std::bitset<64>& aShownColumns );
77
82 void SetTable( wxGridTableBase* table, bool aTakeOwnership = false );
83
88 void DestroyTable( wxGridTableBase* aTable );
89
95 bool CommitPendingChanges( bool aQuietMode = false );
97
102 void SetUnitsProvider( UNITS_PROVIDER* aProvider, int aCol = 0 );
103
104 void SetAutoEvalCols( const std::vector<int>& aCols ) { m_autoEvalCols = aCols; }
105
110 int GetUnitValue( int aRow, int aCol );
111
115 void SetUnitValue( int aRow, int aCol, int aValue );
116
126 int GetVisibleWidth( int aCol, bool aHeader = true, bool aContents = true, bool aKeep = false );
127
133
140 void ShowEditorOnMouseUp() { m_waitForSlowClick = true; }
141
148 {
149 if( GetNumberRows() )
150 DeleteRows( 0, GetNumberRows() );
151 }
152
153protected:
158 void DrawColLabel( wxDC& dc, int col ) override;
159
163 void DrawRowLabel( wxDC& dc, int row ) override;
164
168 void DrawCornerLabel( wxDC& dc ) override;
169
170 void onGridColMove( wxGridEvent& aEvent );
171 void onGridCellSelect( wxGridEvent& aEvent );
172 void onCellEditorShown( wxGridEvent& aEvent );
173 void onCellEditorHidden( wxGridEvent& aEvent );
174
175 void onDPIChanged(wxDPIChangedEvent& event);
176
177protected:
179
180 std::map<int, UNITS_PROVIDER*> m_unitsProviders;
181 std::unique_ptr<NUMERIC_EVALUATOR> m_eval;
182 std::vector<int> m_autoEvalCols;
183
184 std::map< std::pair<int, int>, std::pair<wxString, wxString> > m_evalBeforeAfter;
185};
186
187#endif //KICAD_WX_GRID_H
const char * name
Definition: DXF_plotter.cpp:57
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:559
void onGridCellSelect(wxGridEvent &aEvent)
Definition: wx_grid.cpp:189
~WX_GRID() override
Definition: wx_grid.cpp:117
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:150
bool m_weOwnTable
Definition: wx_grid.h:178
void onDPIChanged(wxDPIChangedEvent &event)
Definition: wx_grid.cpp:126
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:312
std::map< int, UNITS_PROVIDER * > m_unitsProviders
Definition: wx_grid.h:180
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:156
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:268
bool CancelPendingChanges()
Definition: wx_grid.cpp:434
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:136
void SetUnitValue(int aRow, int aCol, int aValue)
Set a unitized cell's value.
Definition: wx_grid.cpp:541
int GetUnitValue(int aRow, int aCol)
Apply standard KiCad unit and eval services to a numeric cell.
Definition: wx_grid.cpp:520
std::vector< int > m_autoEvalCols
Definition: wx_grid.h:182
std::map< std::pair< int, int >, std::pair< wxString, wxString > > m_evalBeforeAfter
Definition: wx_grid.h:184
void DrawCornerLabel(wxDC &dc) override
A re-implementation of wxGrid::DrawCornerLabel which draws flat borders.
Definition: wx_grid.cpp:342
void onCellEditorHidden(wxGridEvent &aEvent)
Definition: wx_grid.cpp:231
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:140
void onGridColMove(wxGridEvent &aEvent)
Definition: wx_grid.cpp:552
void onCellEditorShown(wxGridEvent &aEvent)
Definition: wx_grid.cpp:216
void EnsureColLabelsVisible()
Ensure the height of the row displaying the column labels is enough, even if labels are multiline tex...
Definition: wx_grid.cpp:599
wxString GetShownColumnsAsString()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:282
void DrawRowLabel(wxDC &dc, int row) override
A re-implementation of wxGrid::DrawRowLabel which draws flat borders.
Definition: wx_grid.cpp:402
std::bitset< 64 > GetShownColumns()
Definition: wx_grid.cpp:301
void SetAutoEvalCols(const std::vector< int > &aCols)
Definition: wx_grid.h:104
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:511
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
Definition: wx_grid.h:147
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:462
std::unique_ptr< NUMERIC_EVALUATOR > m_eval
Definition: wx_grid.h:181
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:363