KiCad PCB EDA Suite
wx_grid.cpp
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 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 #include <wx/tokenzr.h>
25 #include <wx/dc.h>
26 #include <wx/wx.h>
27 #include "wx_grid.h"
28 
29 #include <algorithm>
30 
31 
32 #define MIN_GRIDCELL_MARGIN 3
33 
34 
35 WX_GRID::WX_GRID( wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size,
36  long style, const wxString& name ) :
37  wxGrid( parent, id, pos, size, style, name ),
38  m_weOwnTable( false )
39 {}
40 
41 
43 {
44  if( m_weOwnTable )
45  DestroyTable( GetTable() );
46 }
47 
48 
49 void WX_GRID::SetColLabelSize( int aHeight )
50 {
51  if( aHeight == 0 )
52  {
53  wxGrid::SetColLabelSize( 0 );
54  return;
55  }
56 
57  // correct wxFormBuilder height for large fonts
58  wxFont guiFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
59  int minHeight = guiFont.GetPixelSize().y + 2 * MIN_GRIDCELL_MARGIN;
60 
61  wxGrid::SetColLabelSize( std::max( aHeight, minHeight ) );
62 }
63 
64 
65 void WX_GRID::SetTable( wxGridTableBase* aTable, bool aTakeOwnership )
66 {
67  // wxGrid::SetTable() messes up the column widths from wxFormBuilder so we have to save
68  // and restore them.
69  int numberCols = GetNumberCols();
70  int* formBuilderColWidths = new int[numberCols];
71 
72  for( int i = 0; i < numberCols; ++i )
73  formBuilderColWidths[ i ] = GetColSize( i );
74 
75  wxGrid::SetTable( aTable );
76  // wxGrid::SetTable() may change the number of columns, so prevent out-of-bounds access
77  // to formBuilderColWidths
78  numberCols = std::min( numberCols, GetNumberCols() );
79 
80  for( int i = 0; i < numberCols; ++i )
81  {
82  // correct wxFormBuilder width for large fonts and/or long translations
83  int headingWidth = GetTextExtent( GetColLabelValue( i ) ).x + 2 * MIN_GRIDCELL_MARGIN;
84 
85  SetColSize( i, std::max( formBuilderColWidths[ i ], headingWidth ) );
86  }
87 
88  delete[] formBuilderColWidths;
89 
90  Connect( wxEVT_GRID_COL_MOVE, wxGridEventHandler( WX_GRID::onGridColMove ), NULL, this );
91 
92  m_weOwnTable = aTakeOwnership;
93 }
94 
95 
96 void WX_GRID::DestroyTable( wxGridTableBase* aTable )
97 {
98  // wxGrid's destructor will crash trying to look up the cell attr if the edit control
99  // is left open. Normally it's closed in Validate(), but not if the user hit Cancel.
100  CommitPendingChanges( true /* quiet mode */ );
101 
102  Disconnect( wxEVT_GRID_COL_MOVE, wxGridEventHandler( WX_GRID::onGridColMove ), NULL, this );
103 
104  wxGrid::SetTable( nullptr );
105  delete aTable;
106 }
107 
108 
110 {
111  wxString shownColumns;
112 
113  for( int i = 0; i < GetNumberCols(); ++i )
114  {
115  if( IsColShown( i ) )
116  {
117  if( shownColumns.Length() )
118  shownColumns << wxT( " " );
119  shownColumns << i;
120  }
121  }
122 
123  return shownColumns;
124 }
125 
126 
127 void WX_GRID::ShowHideColumns( const wxString& shownColumns )
128 {
129  for( int i = 0; i < GetNumberCols(); ++i )
130  HideCol( i );
131 
132  wxStringTokenizer shownTokens( shownColumns );
133 
134  while( shownTokens.HasMoreTokens() )
135  {
136  long colNumber;
137  shownTokens.GetNextToken().ToLong( &colNumber );
138 
139  if( colNumber >= 0 && colNumber < GetNumberCols() )
140  ShowCol( colNumber );
141  }
142 }
143 
144 
145 // An re-implementation of wxGrid::DrawColLabel which left-aligns the first column when
146 // there are no row labels.
147 void WX_GRID::DrawColLabel( wxDC& dc, int col )
148 {
149  if( GetColWidth( col ) <= 0 || m_colLabelHeight <= 0 )
150  return;
151 
152  int colLeft = GetColLeft( col );
153 
154  wxRect rect( colLeft, 0, GetColWidth( col ), m_colLabelHeight );
155  static wxGridColumnHeaderRendererDefault rend;
156 
157  // It is reported that we need to erase the background to avoid display
158  // artefacts, see #12055.
159  // wxWidgets renamed this variable between 3.1.2 and 3.1.3 ...
160 #if wxCHECK_VERSION( 3, 1, 3 )
161  wxDCBrushChanger setBrush( dc, m_colLabelWin->GetBackgroundColour() );
162 #else
163  wxDCBrushChanger setBrush( dc, m_colWindow->GetBackgroundColour() );
164 #endif
165  dc.DrawRectangle(rect);
166 
167  rend.DrawBorder( *this, dc, rect );
168 
169  int hAlign, vAlign;
170  GetColLabelAlignment( &hAlign, &vAlign );
171  const int orient = GetColLabelTextOrientation();
172 
173  if( col == 0 && GetRowLabelSize() == 0 )
174  hAlign = wxALIGN_LEFT;
175 
176  rend.DrawLabel( *this, dc, GetColLabelValue( col ), rect, hAlign, vAlign, orient );
177 }
178 
179 
180 bool WX_GRID::CommitPendingChanges( bool aQuietMode )
181 {
182  if( !IsCellEditControlEnabled() )
183  return true;
184 
185  if( !aQuietMode && SendEvent( wxEVT_GRID_EDITOR_HIDDEN ) == -1 )
186  return false;
187 
188  HideCellEditControl();
189 
190  // do it after HideCellEditControl()
191  m_cellEditCtrlEnabled = false;
192 
193  int row = m_currentCellCoords.GetRow();
194  int col = m_currentCellCoords.GetCol();
195 
196  wxString oldval = GetCellValue( row, col );
197  wxString newval;
198 
199  wxGridCellAttr* attr = GetCellAttr( row, col );
200  wxGridCellEditor* editor = attr->GetEditor( this, row, col );
201 
202  bool changed = editor->EndEdit( row, col, this, oldval, &newval );
203 
204  editor->DecRef();
205  attr->DecRef();
206 
207  if( changed )
208  {
209  if( !aQuietMode && SendEvent(wxEVT_GRID_CELL_CHANGING, newval) == -1 )
210  return false;
211 
212  editor->ApplyEdit(row, col, this);
213 
214  // for compatibility reasons dating back to wx 2.8 when this event
215  // was called wxEVT_GRID_CELL_CHANGE and wxEVT_GRID_CELL_CHANGING
216  // didn't exist we allow vetoing this one too
217  if( !aQuietMode && SendEvent( wxEVT_GRID_CELL_CHANGED, oldval ) == -1 )
218  {
219  // Event has been vetoed, set the data back.
220  SetCellValue( row, col, oldval );
221  return false;
222  }
223  }
224 
225  return true;
226 }
227 
228 
229 void WX_GRID::onGridColMove( wxGridEvent& aEvent )
230 {
231  // wxWidgets won't move an open editor, so better just to close it
232  CommitPendingChanges( true );
233 }
234 
235 
236 int WX_GRID::GetVisibleWidth( int aCol, bool aHeader, bool aContents, bool aKeep )
237 {
238  int size = 0;
239 
240  if( aCol < 0 )
241  {
242  if( aKeep )
243  size = GetRowLabelSize();
244 
245  // The 1.1 scale factor is due to the fact row labels use a bold font, bigger than the normal font
246  // TODO: use a better way to evaluate the text size, for bold font
247  for( int row = 0; aContents && row < GetNumberRows(); row++ )
248  size = std::max( size, int( GetTextExtent( GetRowLabelValue( row ) + "M" ).x * 1.1 ) );
249  }
250  else
251  {
252  if( aKeep )
253  size = GetColSize( aCol );
254 
255  // 'M' is generally the widest character, so we buffer the column width by default to ensure
256  // we don't write a continuous line of text at the column header
257  if( aHeader )
258  {
260  // The 1.1 scale factor is due to the fact headers use a bold font, bigger than the normal font
261  size = std::max( size, int( GetTextExtent( GetColLabelValue( aCol ) + "M" ).x * 1.1 ) );
262  }
263 
264  for( int row = 0; aContents && row < GetNumberRows(); row++ )
265  {
266  // If we have text, get the size. Otherwise, use a placeholder for the checkbox
267  if( GetTable()->CanGetValueAs( row, aCol, wxGRID_VALUE_STRING ) )
268  size = std::max( size, GetTextExtent( GetCellValue( row, aCol ) + "M" ).x );
269  else
270  size = std::max( size, GetTextExtent( "MM" ).x );
271  }
272  }
273 
274  return size;
275 }
276 
277 
279 {
280  // The 1.1 scale factor is due to the fact row labels use a bold font, bigger than
281  // the normal font
282  // TODO: use a better way to evaluate the text size, for bold font
283  int line_height = int( GetTextExtent( "Mj" ).y * 1.1 ) + 3;
284  int row_height = GetColLabelSize();
285 
286  // Headers can be multiline. Fix the Column Label Height to show the full header
287  // However GetTextExtent does not work on multiline strings,
288  // and do not return the full text height (only the height of one line)
289  for( int col = 0; col < GetNumberCols(); col++ )
290  {
291  int nl_count = GetColLabelValue( col ).Freq( '\n' );
292 
293  if( nl_count )
294  {
295  // Col Label height must be able to show nl_count+1 lines
296  if( row_height < line_height * ( nl_count+1 ) )
297  row_height += line_height * nl_count;
298  }
299  }
300 
301  SetColLabelSize( row_height );
302 }
bool m_weOwnTable
Definition: wx_grid.h:106
void DrawColLabel(wxDC &dc, int col) override
Definition: wx_grid.cpp:147
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:35
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:127
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:65
#define MIN_GRIDCELL_MARGIN
Definition: wx_grid.cpp:32
int GetVisibleWidth(int aCol, bool aHeader=true, bool aContents=false, bool aKeep=true)
Calculates the specified column based on the actual size of the text on screen.
Definition: wx_grid.cpp:236
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:96
#define NULL
void onGridColMove(wxGridEvent &aEvent)
Definition: wx_grid.cpp:229
void EnsureColLabelsVisible()
Ensure the height of the row displaying the column labels is enough, even if labels are multiline tex...
Definition: wx_grid.cpp:278
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:180
~WX_GRID() override
Definition: wx_grid.cpp:42
wxString GetShownColumns()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:109
const char * name
Definition: DXF_plotter.cpp:59
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:49