KiCad PCB EDA Suite
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 (C) 1992-2022 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>
31
32// wxWidgets spends *far* too long calculating column widths (most of it, believe it or
33// not, in repeatedly creating/destroying a wxDC to do the measurement in).
34// Use default column widths instead.
35static int DEFAULT_SINGLE_COL_WIDTH = 260;
36static int DEFAULT_COL_WIDTHS[] = { 200, 300 };
37
38
39EDA_LIST_DIALOG::EDA_LIST_DIALOG( wxWindow* aParent, const wxString& aTitle,
40 const wxArrayString& aItemHeaders,
41 const std::vector<wxArrayString>& aItemList,
42 const wxString& aPreselectText, bool aSortList ) :
43 EDA_LIST_DIALOG_BASE( aParent, wxID_ANY, aTitle ),
44 m_itemsList( aItemList ),
45 m_sortList( aSortList )
46{
47 m_filterBox->SetHint( _( "Filter" ) );
48
49 initDialog( aItemHeaders, aPreselectText );
50
51 // DIALOG_SHIM needs a unique hash_key because classname is not sufficient
52 // because so many dialogs share this same class, with different numbers of
53 // columns, different column names, and column widths.
54 m_hash_key = TO_UTF8( aTitle );
55
57
58 Layout();
59 GetSizer()->Fit( this );
60
61 Centre();
62}
63
64
65bool EDA_LIST_DIALOG::Show( bool show )
66{
67 bool retVal = DIALOG_SHIM::Show( show );
68
69 if( show )
70 {
71 wxSizeEvent dummy;
72 onSize( dummy );
73 }
74
75 return retVal;
76}
77
78
79void EDA_LIST_DIALOG::initDialog( const wxArrayString& aItemHeaders, const wxString& aSelection )
80{
81 if( aItemHeaders.Count() == 1 )
82 {
83 m_listBox->InsertColumn( 0, aItemHeaders.Item( 0 ), wxLIST_FORMAT_LEFT,
85
86 m_listBox->SetMinClientSize( wxSize( DEFAULT_SINGLE_COL_WIDTH, 200 ) );
87 SetMinClientSize( wxSize( DEFAULT_COL_WIDTHS[0], 220 ) );
88 }
89 else if( aItemHeaders.Count() == 2 )
90 {
91 for( unsigned i = 0; i < aItemHeaders.Count(); i++ )
92 {
93 m_listBox->InsertColumn( i, aItemHeaders.Item( i ), wxLIST_FORMAT_LEFT,
94 DEFAULT_COL_WIDTHS[ i ] );
95 }
96
97 m_listBox->SetMinClientSize( wxSize( DEFAULT_COL_WIDTHS[0] * 3, 200 ) );
98 SetMinClientSize( wxSize( DEFAULT_COL_WIDTHS[0] * 2, 220 ) );
99 }
100
102
103 if( !aSelection.IsEmpty() )
104 {
105 long sel = m_listBox->FindItem( -1, aSelection );
106
107 if( sel != wxNOT_FOUND )
108 {
109 m_listBox->SetItemState( sel, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
110
111 // Set to a small size so EnsureVisible() won't be foiled by later additions.
112 // ListBox will expand to fit later.
113 m_listBox->SetSize( m_listBox->GetSize().GetX(), 100 );
114 m_listBox->EnsureVisible( sel );
115 }
116 }
117}
118
119
120void EDA_LIST_DIALOG::SetListLabel( const wxString& aLabel )
121{
122 m_listLabel->SetLabel( aLabel );
123 m_listBox->SetSingleStyle( wxLC_NO_HEADER, true );
124}
125
126
127void EDA_LIST_DIALOG::SetOKLabel( const wxString& aLabel )
128{
129 m_sdbSizerOK->SetLabel( aLabel );
130}
131
132
134{
135 m_filterBox->Hide();
136}
137
138
139void EDA_LIST_DIALOG::textChangeInFilterBox( wxCommandEvent& event )
140{
141 wxString filter;
142 wxString itemName;
143
144 filter = wxT( "*" ) + m_filterBox->GetLineText( 0 ).MakeLower() + wxT( "*" );
145
146 m_listBox->DeleteAllItems();
147
148 for( const wxArrayString& row : m_itemsList )
149 {
150 itemName = row.Item( 0 );
151
152 if( itemName.MakeLower().Matches( filter ) )
153 Append( row );
154 }
155
156 sortList();
157}
158
159
161{
162 return m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
163}
164
165
167{
168 wxCHECK_MSG( unsigned( aColumn ) < unsigned( m_listBox->GetColumnCount() ), wxEmptyString,
169 wxT( "Invalid list control column." ) );
170
171 long item = m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
172 wxString text;
173
174 if( item >= 0 ) // if something is selected.
175 {
176 wxListItem info;
177
178 info.m_mask = wxLIST_MASK_TEXT;
179 info.m_itemId = item;
180 info.m_col = aColumn;
181
182 if( m_listBox->GetItem( info ) )
183 text = info.m_text;
184
187 }
188
189 return text;
190}
191
192
193void EDA_LIST_DIALOG::Append( const wxArrayString& itemList )
194{
195 long itemIndex = m_listBox->InsertItem( m_listBox->GetItemCount(), itemList[0] );
196
197 m_listBox->SetItemPtrData( itemIndex, wxUIntPtr( &itemList[0] ) );
198
199 // Adding the next columns content
200 for( unsigned i = 1; i < itemList.size(); i++ )
201 m_listBox->SetItem( itemIndex, i, itemList[i] );
202}
203
204
205void EDA_LIST_DIALOG::InsertItems( const std::vector< wxArrayString >& itemList, int position )
206{
207 for( unsigned row = 0; row < itemList.size(); row++ )
208 {
209 wxASSERT( (int) itemList[row].GetCount() == m_listBox->GetColumnCount() );
210
211 for( unsigned col = 0; col < itemList[row].GetCount(); col++ )
212 {
213 wxListItem info;
214 info.m_itemId = row + position;
215 info.m_col = col;
216 info.m_text = itemList[row].Item( col );
217 info.m_width = DEFAULT_COL_WIDTHS[ col ];
218 info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_WIDTH;
219
220 if( col == 0 )
221 {
222 info.m_data = wxUIntPtr( &itemList[row].Item( col ) );
223 info.m_mask |= wxLIST_MASK_DATA;
224
225 m_listBox->InsertItem( info );
226 }
227 else
228 {
229 m_listBox->SetItem( info );
230 }
231 }
232 }
233
234 sortList();
235}
236
237
238void EDA_LIST_DIALOG::onListItemActivated( wxListEvent& event )
239{
240 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
241}
242
243
244void EDA_LIST_DIALOG::onSize( wxSizeEvent& event )
245{
246 if( m_listBox->GetColumnCount() == 1 )
247 {
248 m_listBox->SetColumnWidth( 0, m_listBox->GetClientSize().x );
249 }
250 else if( m_listBox->GetColumnCount() == 2 )
251 {
252 int first = KiROUND( m_listBox->GetClientSize().x * 0.42 );
253 m_listBox->SetColumnWidth( 0, first );
254 m_listBox->SetColumnWidth( 1, m_listBox->GetClientSize().x - first );
255 }
256
257 event.Skip();
258}
259
260
261/*
262 * Sort alphabetically, case insensitive.
263 */
264static int wxCALLBACK myCompareFunction( wxIntPtr aItem1, wxIntPtr aItem2,
265 wxIntPtr WXUNUSED( aSortData ) )
266{
267 wxString* component1Name = (wxString*) aItem1;
268 wxString* component2Name = (wxString*) aItem2;
269
270 return StrNumCmp( *component1Name, *component2Name, true );
271}
272
273
275{
276 if( m_sortList )
277 m_listBox->SortItems( myCompareFunction, 0 );
278}
bool Show(bool show) override
void SetupStandardButtons(std::map< int, wxString > aLabels={})
std::string m_hash_key
Definition: dialog_shim.h:203
Class EDA_LIST_DIALOG_BASE.
void textChangeInFilterBox(wxCommandEvent &event) override
bool Show(bool show) override
void SetOKLabel(const wxString &aLabel)
void initDialog(const wxArrayString &aItemHeaders, const wxString &aSelection)
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)
virtual void onSize(wxSizeEvent &event) override
std::vector< wxArrayString > m_itemsList
void Append(const wxArrayString &aItemStr)
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.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
std::vector< FAB_LAYER_COLOR > dummy
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:85