KiCad PCB EDA Suite
Loading...
Searching...
No Matches
grid_layer_box_helpers.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 The 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
25
26#include <wx/textctrl.h>
27
28#include <pgm_base.h>
32#include <board.h>
33#include <lset.h>
34#include <pcb_edit_frame.h>
38
39
40//-------- Custom wxGridCellRenderers --------------------------------------------------
41
42
44 m_frame( aFrame )
45{
46}
47
48
50{
51}
52
53
54void GRID_CELL_LAYER_RENDERER::Draw( wxGrid& aGrid, wxGridCellAttr& aAttr, wxDC& aDC,
55 const wxRect& aRect, int aRow, int aCol, bool isSelected )
56{
57 int value = aGrid.GetTable()->GetValueAsLong( aRow, aCol );
59
60 if( m_frame )
62 else if( FOOTPRINT_EDITOR_SETTINGS* cfg = GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( "fpedit" ) )
63 cs = ::GetColorSettings( cfg->m_ColorTheme );
64
65 wxRect rect = aRect;
66 rect.Inflate( -1 );
67
68 // erase background
69 wxGridCellRenderer::Draw( aGrid, aAttr, aDC, aRect, aRow, aCol, isSelected );
70
71 // draw the swatch
72#ifdef __WXMAC__
73 int size = 14;
74#else
75 int size = KiROUND( 14 * aDC.GetContentScaleFactor() );
76#endif
77 wxBitmap bitmap( size, size );
78
81 cs->GetColor( ToLAYER_ID( value ) ) );
82
83 aDC.DrawBitmap( bitmap, rect.GetLeft() + 4,
84 rect.GetTop() + ( rect.GetHeight() - bitmap.GetHeight() ) / 2, true );
85
86 // draw the text
87 PCB_LAYER_ID layer = ToLAYER_ID( value );
88 wxString layerName;
89
90 if( m_frame )
91 layerName = m_frame->GetBoard()->GetLayerName( layer );
92 else
93 layerName = BOARD::GetStandardLayerName( layer );
94
95 rect.SetLeft( rect.GetLeft() + bitmap.GetWidth() + 8 );
96 SetTextColoursAndFont( aGrid, aAttr, aDC, isSelected );
97 aGrid.DrawTextRectangle( aDC, layerName, rect, wxALIGN_LEFT, wxALIGN_CENTRE );
98}
99
100
101
102//-------- Custom wxGridCellEditors ----------------------------------------------------
103//
104// Note: this implementation is an adaptation of wxGridCellChoiceEditor
105
106
108 bool aShowNonActivated ) :
109 m_frame( aFrame ),
110 m_mask( aMask ),
111 m_showNonActivated( aShowNonActivated ),
112 m_value( 0 )
113{
114}
115
116
117wxGridCellEditor* GRID_CELL_LAYER_SELECTOR::Clone() const
118{
120}
121
122
123void GRID_CELL_LAYER_SELECTOR::Create( wxWindow* aParent, wxWindowID aId,
124 wxEvtHandler* aEventHandler )
125{
126 m_control = new PCB_LAYER_BOX_SELECTOR( aParent, aId, wxEmptyString,
127 wxDefaultPosition, wxDefaultSize, 0, nullptr,
128 wxCB_READONLY | wxTE_PROCESS_ENTER | wxTE_PROCESS_TAB | wxBORDER_NONE );
129
130 LayerBox()->SetLayersHotkeys( false );
134
135 wxGridCellEditor::Create(aParent, aId, aEventHandler);
136}
137
138
140{
141 if( LayerBox()->GetLayerSelection() != UNDEFINED_LAYER )
142 {
143 PCB_LAYER_ID layer = ToLAYER_ID( LayerBox()->GetLayerSelection() );
144
145 if( m_frame )
146 return m_frame->GetBoard()->GetLayerName( layer );
147 else
148 return BOARD::GetStandardLayerName( layer );
149 }
150
151 return wxEmptyString;
152}
153
154
155void GRID_CELL_LAYER_SELECTOR::SetSize( const wxRect& aRect )
156{
157 wxRect rect( aRect );
158 rect.Inflate( -1 );
159
160#if !defined( __WXMSW__ ) && !defined( __WXGTK__ )
161 // Only implemented in generic wxBitmapComboBox; MSW and GTK use native controls
162 LayerBox()->SetButtonPosition( 0, 0, wxRIGHT, 0 );
163#endif
164
165#if defined( __WXMAC__ )
166 rect.Inflate( 3 ); // no FOCUS_RING, even on Mac
167#endif
168
169 LayerBox()->SetSize( rect, wxSIZE_ALLOW_MINUS_ONE );
170}
171
172
173void GRID_CELL_LAYER_SELECTOR::BeginEdit( int aRow, int aCol, wxGrid* aGrid )
174{
175 auto* evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );
176
177 // Don't immediately end if we get a kill focus event within BeginEdit
178 evtHandler->SetInSetFocus( true );
179
180 // These event handlers are needed to properly dismiss the editor when the popup is closed
181 m_control->Bind(wxEVT_COMBOBOX_DROPDOWN, &GRID_CELL_LAYER_SELECTOR::onComboDropDown, this);
182 m_control->Bind(wxEVT_COMBOBOX_CLOSEUP, &GRID_CELL_LAYER_SELECTOR::onComboCloseUp, this);
183
184 m_value = aGrid->GetTable()->GetValueAsLong( aRow, aCol );
185
186 // Footprints are defined in a global context and may contain layers not enabled
187 // on the current board. Check and display all layers if so.
190
192 LayerBox()->Resync();
194 LayerBox()->SetFocus();
195
196#ifdef __WXOSX_COCOA__
197 // This is a work around for the combobox being simply dismissed when a
198 // choice is made in it under OS X. The bug is almost certainly due to a
199 // problem in focus events generation logic but it's not obvious to fix and
200 // for now this at least allows one to use wxGrid.
201 if( !LayerBox()->IsPopupShown() )
202 LayerBox()->Popup();
203#endif
204
205 // When dropping down the menu, a kill focus event
206 // happens after this point, so we can't reset the flag yet.
207#if !defined(__WXGTK__)
208 evtHandler->SetInSetFocus( false );
209#endif
210}
211
212
213bool GRID_CELL_LAYER_SELECTOR::EndEdit( int , int , const wxGrid* , const wxString& ,
214 wxString *newval )
215{
216 const int value = LayerBox()->GetLayerSelection();
217
218 if ( value == m_value )
219 return false;
220
221 m_value = value;
222
223 if ( newval )
224 *newval = GetValue();
225
226 return true;
227}
228
229
230void GRID_CELL_LAYER_SELECTOR::ApplyEdit( int aRow, int aCol, wxGrid* aGrid )
231{
232 aGrid->GetTable()->SetValueAsLong( aRow, aCol, (long) m_value );
233}
234
235
237{
239}
240
241
242void GRID_CELL_LAYER_SELECTOR::onComboDropDown( wxCommandEvent& aEvent )
243{
244 // On other platforms this is done in BeginEdit()
245#if defined(__WXGTK__)
246 auto evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );
247
248 // Once the combobox is dropped, reset the flag to allow the focus-loss handler
249 // to function and close the editor.
250 evtHandler->SetInSetFocus( false );
251#endif
252}
253
254
255void GRID_CELL_LAYER_SELECTOR::onComboCloseUp( wxCommandEvent& aEvent )
256{
257 auto evtHandler = static_cast<wxGridCellEditorEvtHandler*>( m_control->GetEventHandler() );
258
259 // Forward the combobox close up event to the cell event handler as a focus kill event
260 // so that the grid editor is dismissed when the combox closes, otherwise it leaves the
261 // dropdown arrow visible in the cell.
262 wxFocusEvent event( wxEVT_KILL_FOCUS, m_control->GetId() );
263 event.SetEventObject( m_control );
264 evtHandler->ProcessEvent( event );
265}
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:839
bool IsLayerEnabled(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:933
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:680
Color settings are a bit different than most of the settings objects in that there can be more than o...
COLOR4D GetColor(int aLayer) const
void Draw(wxGrid &aGrid, wxGridCellAttr &aAttr, wxDC &aDC, const wxRect &aRect, int aRow, int aCol, bool isSelected) override
GRID_CELL_LAYER_RENDERER(PCB_BASE_FRAME *aFrame)
bool EndEdit(int, int, const wxGrid *, const wxString &, wxString *newval) override
wxGridCellEditor * Clone() const override
GRID_CELL_LAYER_SELECTOR(PCB_BASE_FRAME *aFrame, const LSET &forbiddenLayers, bool aShowNonActivated=false)
void onComboCloseUp(wxCommandEvent &aEvent)
void onComboDropDown(wxCommandEvent &aEvent)
PCB_LAYER_BOX_SELECTOR * LayerBox() const
void ApplyEdit(int aRow, int aCol, wxGrid *aGrid) override
void BeginEdit(int aRow, int aCol, wxGrid *aGrid) override
void Create(wxWindow *aParent, wxWindowID aId, wxEvtHandler *aEventHandler) override
wxString GetValue() const override
void SetSize(const wxRect &aRect) override
int SetLayerSelection(int layer)
static void DrawColorSwatch(wxBitmap &aLayerbmp, const COLOR4D &aBackground, const COLOR4D &aColor)
bool SetLayersHotkeys(bool value)
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
BOARD * GetBoard() const
virtual COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
Class to display a pcb layer list in a wxBitmapComboBox.
void SetBoardFrame(PCB_BASE_FRAME *aFrame)
void ShowNonActivatedLayers(bool aShow)
void SetNotAllowedLayerSet(const LSET &aMask)
@ LAYER_PCB_BACKGROUND
PCB background color.
Definition: layer_ids.h:280
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
PCB_LAYER_ID ToLAYER_ID(int aLayer)
Definition: lset.cpp:744
see class PGM_BASE
#define DEFAULT_THEME
COLOR_SETTINGS * GetColorSettings(const wxString &aName)