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-2021 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, 600 };
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 // this line fixes an issue on Linux Ubuntu using Unity (dialog not shown),
59 // and works fine on all systems
60 GetSizer()->Fit( this );
61
62 Centre();
63}
64
65
66void EDA_LIST_DIALOG::initDialog( const wxArrayString& aItemHeaders, const wxString& aSelection )
67{
68 if( aItemHeaders.Count() == 1 )
69 {
70 m_listBox->InsertColumn( 0, aItemHeaders.Item( 0 ), wxLIST_FORMAT_LEFT,
72 }
73 else
74 {
75 for( unsigned i = 0; i < aItemHeaders.Count(); i++ )
76 {
77 m_listBox->InsertColumn( i, aItemHeaders.Item( i ), wxLIST_FORMAT_LEFT,
78 DEFAULT_COL_WIDTHS[ i ] );
79 }
80 }
81
83
84 if( !aSelection.IsEmpty() )
85 {
86 long sel = m_listBox->FindItem( -1, aSelection );
87
88 if( sel != wxNOT_FOUND )
89 {
90 m_listBox->SetItemState( sel, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
91
92 // Set to a small size so EnsureVisible() won't be foiled by later additions.
93 // ListBox will expand to fit later.
94 m_listBox->SetSize( m_listBox->GetSize().GetX(), 100 );
95 m_listBox->EnsureVisible( sel );
96 }
97 }
98}
99
100
101void EDA_LIST_DIALOG::SetListLabel( const wxString& aLabel )
102{
103 m_listLabel->SetLabel( aLabel );
104 m_listBox->SetSingleStyle( wxLC_NO_HEADER, true );
105}
106
107
108void EDA_LIST_DIALOG::SetOKLabel( const wxString& aLabel )
109{
110 m_sdbSizerOK->SetLabel( aLabel );
111}
112
113
115{
116 m_filterBox->Hide();
117}
118
119
120void EDA_LIST_DIALOG::textChangeInFilterBox( wxCommandEvent& event )
121{
122 wxString filter;
123 wxString itemName;
124
125 filter = wxT( "*" ) + m_filterBox->GetLineText( 0 ).MakeLower() + wxT( "*" );
126
127 m_listBox->DeleteAllItems();
128
129 for( const wxArrayString& row : m_itemsList )
130 {
131 itemName = row.Item( 0 );
132
133 if( itemName.MakeLower().Matches( filter ) )
134 Append( row );
135 }
136
137 sortList();
138}
139
140
142{
143 return m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
144}
145
146
148{
149 wxCHECK_MSG( unsigned( aColumn ) < unsigned( m_listBox->GetColumnCount() ), wxEmptyString,
150 wxT( "Invalid list control column." ) );
151
152 long item = m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
153 wxString text;
154
155 if( item >= 0 ) // if something is selected.
156 {
157 wxListItem info;
158
159 info.m_mask = wxLIST_MASK_TEXT;
160 info.m_itemId = item;
161 info.m_col = aColumn;
162
163 if( m_listBox->GetItem( info ) )
164 text = info.m_text;
165
168 }
169
170 return text;
171}
172
173
174void EDA_LIST_DIALOG::Append( const wxArrayString& itemList )
175{
176 long itemIndex = m_listBox->InsertItem( m_listBox->GetItemCount(), itemList[0] );
177
178 m_listBox->SetItemPtrData( itemIndex, wxUIntPtr( &itemList[0] ) );
179
180 // Adding the next columns content
181 for( unsigned i = 1; i < itemList.size(); i++ )
182 m_listBox->SetItem( itemIndex, i, itemList[i] );
183}
184
185
186void EDA_LIST_DIALOG::InsertItems( const std::vector< wxArrayString >& itemList, int position )
187{
188 for( unsigned row = 0; row < itemList.size(); row++ )
189 {
190 wxASSERT( (int) itemList[row].GetCount() == m_listBox->GetColumnCount() );
191
192 for( unsigned col = 0; col < itemList[row].GetCount(); col++ )
193 {
194 wxListItem info;
195 info.m_itemId = row + position;
196 info.m_col = col;
197 info.m_text = itemList[row].Item( col );
198 info.m_width = DEFAULT_COL_WIDTHS[ col ];
199 info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_WIDTH;
200
201 if( col == 0 )
202 {
203 info.m_data = wxUIntPtr( &itemList[row].Item( col ) );
204 info.m_mask |= wxLIST_MASK_DATA;
205
206 m_listBox->InsertItem( info );
207 }
208 else
209 {
210 m_listBox->SetItem( info );
211 }
212 }
213 }
214
215 sortList();
216}
217
218
219void EDA_LIST_DIALOG::onListItemActivated( wxListEvent& event )
220{
221 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
222}
223
224
225/*
226 * Sort alphabetically, case insensitive.
227 */
228static int wxCALLBACK myCompareFunction( wxIntPtr aItem1, wxIntPtr aItem2,
229 wxIntPtr WXUNUSED( aSortData ) )
230{
231 wxString* component1Name = (wxString*) aItem1;
232 wxString* component2Name = (wxString*) aItem2;
233
234 return StrNumCmp( *component1Name, *component2Name, true );
235}
236
237
239{
240 if( m_sortList )
241 m_listBox->SortItems( myCompareFunction, 0 );
242}
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
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)
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
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.