KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_list_dialog.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) 2007 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <eda_list_dialog.h>
27#include <eda_draw_frame.h>
28#include <string_utils.h>
29#include <macros.h>
30#include <wx/checkbox.h>
32
33// wxWidgets spends *far* too long calculating column widths (most of it, believe it or
34// not, in repeatedly creating/destroying a wxDC to do the measurement in).
35// Use default column widths instead.
36// Note, these are "standard DPI" widths
37static int DEFAULT_SINGLE_COL_WIDTH = 260;
38static int DEFAULT_COL_WIDTHS[] = { 200, 300 };
39
40
41EDA_LIST_DIALOG::EDA_LIST_DIALOG( wxWindow* aParent, const wxString& aTitle,
42 const wxArrayString& aItemHeaders,
43 const std::vector<wxArrayString>& aItemList,
44 const wxString& aPreselectText, bool aSortList ) :
45 EDA_LIST_DIALOG_BASE( aParent, wxID_ANY, aTitle ),
46 m_sortList( aSortList )
47{
48 // correct for wxfb not supporting FromDIP
49 m_listBox->SetMinSize( FromDIP( m_listBox->GetMinSize() ) );
50 m_filterBox->SetHint( _( "Filter" ) );
51
52 initDialog( aItemHeaders, aItemList, aPreselectText );
53
54 if( aItemList.size() > 16 )
55 {
56 m_listBox->SetMinSize( wxSize( m_listBox->GetMinWidth(),
57 KiROUND( m_listBox->GetMinHeight() * 1.66 ) ) );
58 }
59
60 // DIALOG_SHIM needs a unique hash_key because classname is not sufficient
61 // because so many dialogs share this same class, with different numbers of
62 // columns, different column names, and column widths.
63 m_hash_key = TO_UTF8( aTitle );
64
66
67 Layout();
68 GetSizer()->Fit( this );
69
70 Centre();
71}
72
73
74EDA_LIST_DIALOG::EDA_LIST_DIALOG( wxWindow* aParent, const wxString& aTitle, bool aSortList ) :
75 EDA_LIST_DIALOG_BASE( aParent, wxID_ANY, aTitle ),
76 m_sortList( aSortList )
77{
78 m_filterBox->SetHint( _( "Filter" ) );
79}
80
81
82void EDA_LIST_DIALOG::AddExtraCheckbox( const wxString& aLabel, bool* aValuePtr )
83{
84 wxCHECK2_MSG( aValuePtr, return, wxT( "Null pointer for checkbox value." ) );
85
86 int flags = wxBOTTOM;
87
88 if( m_ExtrasSizer->GetItemCount() > 0 )
89 flags |= wxTOP;
90
91 wxCheckBox* cb = new wxCheckBox( this, wxID_ANY, aLabel );
92 cb->SetValue( *aValuePtr );
93 m_ExtrasSizer->Add( cb, 0, flags, 5 );
94 m_extraCheckboxMap[cb] = aValuePtr;
95}
96
97
98bool EDA_LIST_DIALOG::Show( bool show )
99{
100 bool retVal = DIALOG_SHIM::Show( show );
101
102 if( show )
103 {
104 wxSizeEvent dummy;
105 onSize( dummy );
106 }
107
108 return retVal;
109}
110
111
112void EDA_LIST_DIALOG::initDialog( const wxArrayString& aItemHeaders,
113 const std::vector<wxArrayString>& aItemList,
114 const wxString& aPreselectText )
115{
116 if( aItemHeaders.Count() == 1 )
117 {
118 m_listBox->InsertColumn( 0, aItemHeaders.Item( 0 ), wxLIST_FORMAT_LEFT,
119 FromDIP( DEFAULT_SINGLE_COL_WIDTH ) );
120
121 m_listBox->SetMinClientSize( FromDIP( wxSize( DEFAULT_SINGLE_COL_WIDTH, 200 ) ) );
122 SetMinClientSize( FromDIP( wxSize( DEFAULT_COL_WIDTHS[0], 220 ) ) );
123 }
124 else if( aItemHeaders.Count() == 2 )
125 {
126 for( unsigned i = 0; i < aItemHeaders.Count(); i++ )
127 {
128 m_listBox->InsertColumn( i, aItemHeaders.Item( i ), wxLIST_FORMAT_LEFT,
129 FromDIP( DEFAULT_COL_WIDTHS[ i ] ) );
130 }
131
132 m_listBox->SetMinClientSize( FromDIP( wxSize( DEFAULT_COL_WIDTHS[0] * 3, 200 ) ) );
133 SetMinClientSize( FromDIP( wxSize( DEFAULT_COL_WIDTHS[0] * 2, 220 ) ) );
134 }
135
136 m_itemsList = aItemList;
138
139 if( !aPreselectText.IsEmpty() )
140 {
141 long sel = m_listBox->FindItem( -1, aPreselectText );
142
143 if( sel != wxNOT_FOUND )
144 {
145 m_listBox->SetItemState( sel, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
146
147 // Set to a small size so EnsureVisible() won't be foiled by later additions.
148 // ListBox will expand to fit later.
149 m_listBox->SetSize( m_listBox->GetSize().GetX(), FromDIP( 100 ) );
150 m_listBox->EnsureVisible( sel );
151 }
152 }
153}
154
155
156void EDA_LIST_DIALOG::SetListLabel( const wxString& aLabel )
157{
158 m_listLabel->SetLabel( aLabel );
159 m_listBox->SetSingleStyle( wxLC_NO_HEADER, true );
160}
161
162
163void EDA_LIST_DIALOG::SetOKLabel( const wxString& aLabel )
164{
165 m_sdbSizerOK->SetLabel( aLabel );
166}
167
168
170{
171 m_filterBox->Hide();
172}
173
174
175void EDA_LIST_DIALOG::textChangeInFilterBox( wxCommandEvent& event )
176{
177 wxString filter;
178 wxString itemName;
179
180 filter = wxT( "*" ) + m_filterBox->GetLineText( 0 ).MakeLower() + wxT( "*" );
181
182 m_listBox->DeleteAllItems();
183
184 for( const wxArrayString& row : m_itemsList )
185 {
186 itemName = row.Item( 0 );
187
188 if( itemName.MakeLower().Matches( filter ) )
189 Append( row );
190 }
191
192 sortList();
193}
194
195
197{
198 return m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
199}
200
201
203{
204 wxCHECK_MSG( unsigned( aColumn ) < unsigned( m_listBox->GetColumnCount() ), wxEmptyString,
205 wxT( "Invalid list control column." ) );
206
207 long item = m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
208 wxString text;
209
210 if( item >= 0 ) // if something is selected.
211 {
212 wxListItem info;
213
214 info.m_mask = wxLIST_MASK_TEXT;
215 info.m_itemId = item;
216 info.m_col = aColumn;
217
218 if( m_listBox->GetItem( info ) )
219 text = info.m_text;
220
223 }
224
225 return text;
226}
227
228
230{
231 for( const auto& [checkbox, valuePtr] : m_extraCheckboxMap )
232 *valuePtr = checkbox->GetValue();
233}
234
235
236void EDA_LIST_DIALOG::Append( const wxArrayString& itemList )
237{
238 long itemIndex = m_listBox->InsertItem( m_listBox->GetItemCount(), itemList[0] );
239
240 m_listBox->SetItemPtrData( itemIndex, wxUIntPtr( &itemList[0] ) );
241
242 // Adding the next columns content
243 for( unsigned i = 1; i < itemList.size(); i++ )
244 m_listBox->SetItem( itemIndex, i, itemList[i] );
245}
246
247
248void EDA_LIST_DIALOG::InsertItems( const std::vector< wxArrayString >& itemList, int position )
249{
250 for( unsigned row = 0; row < itemList.size(); row++ )
251 {
252 wxASSERT( (int) itemList[row].GetCount() == m_listBox->GetColumnCount() );
253
254 for( unsigned col = 0; col < itemList[row].GetCount(); col++ )
255 {
256 wxListItem info;
257 info.m_itemId = row + position;
258 info.m_col = col;
259 info.m_text = itemList[row].Item( col );
260 info.m_width = FromDIP( DEFAULT_COL_WIDTHS[ col ] );
261 info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_WIDTH;
262
263 if( col == 0 )
264 {
265 info.m_data = wxUIntPtr( &itemList[row].Item( col ) );
266 info.m_mask |= wxLIST_MASK_DATA;
267
268 m_listBox->InsertItem( info );
269 }
270 else
271 {
272 m_listBox->SetItem( info );
273 }
274 }
275 }
276
277 sortList();
278}
279
280
281void EDA_LIST_DIALOG::onListItemActivated( wxListEvent& event )
282{
283 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
284}
285
286
287void EDA_LIST_DIALOG::onSize( wxSizeEvent& event )
288{
289 if( m_listBox->GetColumnCount() == 1 )
290 {
291 m_listBox->SetColumnWidth( 0, m_listBox->GetClientSize().x );
292 }
293 else if( m_listBox->GetColumnCount() == 2 )
294 {
295 int first = KiROUND( m_listBox->GetClientSize().x * 0.42 );
296 m_listBox->SetColumnWidth( 0, first );
297 m_listBox->SetColumnWidth( 1, m_listBox->GetClientSize().x - first );
298 }
299
300 event.Skip();
301}
302
303
304/*
305 * Sort alphabetically, case insensitive.
306 */
307static int wxCALLBACK myCompareFunction( wxIntPtr aItem1, wxIntPtr aItem2,
308 wxIntPtr WXUNUSED( aSortData ) )
309{
310 wxString* component1Name = (wxString*) aItem1;
311 wxString* component2Name = (wxString*) aItem2;
312
313 return StrNumCmp( *component1Name, *component2Name, true );
314}
315
316
318{
319 if( m_sortList )
320 m_listBox->SortItems( myCompareFunction, 0 );
321}
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
bool Show(bool show) override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
std::string m_hash_key
EDA_LIST_DIALOG_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
void textChangeInFilterBox(wxCommandEvent &event) override
bool Show(bool show) override
void SetOKLabel(const wxString &aLabel)
void initDialog(const wxArrayString &aItemHeaders, const std::vector< wxArrayString > &aItemList, const wxString &aPreselectText)
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
void onListItemActivated(wxListEvent &event) override
void SetListLabel(const wxString &aLabel)
std::map< wxCheckBox *, bool * > m_extraCheckboxMap
virtual void onSize(wxSizeEvent &event) override
std::vector< wxArrayString > m_itemsList
void Append(const wxArrayString &aItemStr)
void AddExtraCheckbox(const wxString &aLabel, bool *aValuePtr)
Add a checkbox value to the dialog.
void GetExtraCheckboxValues()
Fills in the value pointers from the checkboxes after the dialog has run.
void InsertItems(const std::vector< wxArrayString > &aItemList, int aPosition=0)
EDA_LIST_DIALOG(wxWindow *aParent, const wxString &aTitle, const wxArrayString &aItemHeaders, const std::vector< wxArrayString > &aItemList, const wxString &aPreselectText=wxEmptyString, bool aSortList=true)
static const wxString GetPinningSymbol()
#define _(s)
static int wxCALLBACK myCompareFunction(wxIntPtr aItem1, wxIntPtr aItem2, wxIntPtr WXUNUSED(aSortData))
static int DEFAULT_SINGLE_COL_WIDTH
static int DEFAULT_COL_WIDTHS[]
This file contains miscellaneous commonly used macros and functions.
std::vector< FAB_LAYER_COLOR > dummy
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.