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