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 <dick@softplc.com>
6  * Copyright (C) 1992-2019 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_draw_frame.h>
27 #include <kicad_string.h>
28 #include <dialog_helpers.h>
29 
30 
31 // wxWidgets spends *far* too long calcuating column widths (most of it, believe it or
32 // not, in repeatedly creating/destroying a wxDC to do the measurement in).
33 // Use default column widths instead.
34 static int DEFAULT_COL_WIDTHS[] = { 200, 600 };
35 
36 
37 
38 EDA_LIST_DIALOG::EDA_LIST_DIALOG( EDA_DRAW_FRAME* aParent, const wxString& aTitle,
39  const wxArrayString& aItemHeaders,
40  const std::vector<wxArrayString>& aItemList,
41  const wxString& aSelection ) :
42  EDA_LIST_DIALOG_BASE( aParent, wxID_ANY, aTitle )
43 {
44  m_itemsList = &aItemList;
45 
46  m_filterBox->SetHint( _( "Filter" ) );
47 
48  initDialog( aItemHeaders, aSelection );
49 
50  // DIALOG_SHIM needs a unique hash_key because classname is not sufficient
51  // because so many dialogs share this same class, with different numbers of
52  // columns, different column names, and column widths.
53  m_hash_key = TO_UTF8( aTitle );
54 
55  m_sdbSizerOK->SetDefault();
56 
57  // this line fixes an issue on Linux Ubuntu using Unity (dialog not shown),
58  // and works fine on all systems
59  GetSizer()->Fit( this );
60 
61  Centre();
62 }
63 
64 
65 void EDA_LIST_DIALOG::initDialog( const wxArrayString& aItemHeaders, const wxString& aSelection )
66 {
67  for( unsigned i = 0; i < aItemHeaders.Count(); i++ )
68  {
69  m_listBox->InsertColumn( i, aItemHeaders.Item( i ),
70  wxLIST_FORMAT_LEFT, DEFAULT_COL_WIDTHS[ i ] );
71  }
72 
73  InsertItems( *m_itemsList, 0 );
74 
75  if( !aSelection.IsEmpty() )
76  {
77  long sel = m_listBox->FindItem( -1, aSelection );
78 
79  if( sel != wxNOT_FOUND )
80  {
81  m_listBox->SetItemState( sel, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
82 
83  // Set to a small size so EnsureVisible() won't be foiled by later additions.
84  // ListBox will expand to fit later.
85  m_listBox->SetSize( m_listBox->GetSize().GetX(), 100 );
86  m_listBox->EnsureVisible( sel );
87  }
88  }
89 }
90 
91 
92 void EDA_LIST_DIALOG::SetListLabel( const wxString& aLabel )
93 {
94  m_listLabel->SetLabel( aLabel );
95  m_listBox->SetSingleStyle( wxLC_NO_HEADER, true );
96 }
97 
98 
99 void EDA_LIST_DIALOG::SetOKLabel( const wxString& aLabel )
100 {
101  m_sdbSizerOK->SetLabel( aLabel );
102 }
103 
104 
105 void EDA_LIST_DIALOG::textChangeInFilterBox( wxCommandEvent& event )
106 {
107  wxString filter;
108  wxString itemName;
109 
110  filter = wxT( "*" ) + m_filterBox->GetLineText( 0 ).MakeLower() + wxT( "*" );
111 
112  m_listBox->DeleteAllItems();
113 
114  for( const wxArrayString& row : *m_itemsList )
115  {
116  itemName = row.Item( 0 );
117 
118  if( itemName.MakeLower().Matches( filter ) )
119  Append( row );
120  }
121 
122  sortList();
123 }
124 
125 
126 wxString EDA_LIST_DIALOG::GetTextSelection( int aColumn )
127 {
128  wxCHECK_MSG( unsigned( aColumn ) < unsigned( m_listBox->GetColumnCount() ), wxEmptyString,
129  wxT( "Invalid list control column." ) );
130 
131  long item = m_listBox->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
132 
133  if( item >= 0 ) // if something is selected.
134  {
135  wxListItem info;
136 
137  info.m_mask = wxLIST_MASK_TEXT;
138  info.m_itemId = item;
139  info.m_col = aColumn;
140 
141  if( m_listBox->GetItem( info ) )
142  return info.m_text;
143  }
144 
145  return wxEmptyString;
146 }
147 
148 
149 void EDA_LIST_DIALOG::Append( const wxArrayString& itemList )
150 {
151  long itemIndex = m_listBox->InsertItem( m_listBox->GetItemCount(), itemList[0] );
152 
153  m_listBox->SetItemPtrData( itemIndex, wxUIntPtr( &itemList[0] ) );
154 
155  // Adding the next columns content
156  for( unsigned i = 1; i < itemList.size(); i++ )
157  m_listBox->SetItem( itemIndex, i, itemList[i] );
158 }
159 
160 
161 void EDA_LIST_DIALOG::InsertItems( const std::vector< wxArrayString >& itemList, int position )
162 {
163  for( unsigned row = 0; row < itemList.size(); row++ )
164  {
165  wxASSERT( (int) itemList[row].GetCount() == m_listBox->GetColumnCount() );
166 
167  for( unsigned col = 0; col < itemList[row].GetCount(); col++ )
168  {
169  wxListItem info;
170  info.m_itemId = row + position;
171  info.m_col = col;
172  info.m_text = itemList[row].Item( col );
173  info.m_width = DEFAULT_COL_WIDTHS[ col ];
174  info.m_mask = wxLIST_MASK_TEXT | wxLIST_MASK_WIDTH;
175 
176  if( col == 0 )
177  {
178  info.m_data = wxUIntPtr( &itemList[row].Item( col ) );
179  info.m_mask |= wxLIST_MASK_DATA;
180 
181  m_listBox->InsertItem( info );
182  }
183  else
184  {
185  m_listBox->SetItem( info );
186  }
187  }
188  }
189 
190  sortList();
191 }
192 
193 
194 void EDA_LIST_DIALOG::onListItemActivated( wxListEvent& event )
195 {
196  EndModal( wxID_OK );
197 }
198 
199 
200 /* Sort alphabetically, case insensitive.
201  */
202 static int wxCALLBACK myCompareFunction( wxIntPtr aItem1, wxIntPtr aItem2,
203  wxIntPtr WXUNUSED( aSortData ) )
204 {
205  wxString* component1Name = (wxString*) aItem1;
206  wxString* component2Name = (wxString*) aItem2;
207 
208  return StrNumCmp( *component1Name, *component2Name, true );
209 }
210 
211 
213 {
214  m_listBox->SortItems( myCompareFunction, 0 );
215 }
void initDialog(const wxArrayString &aItemHeaders, const wxString &aSelection)
wxString GetTextSelection(int aColumn=0)
Function GetTextSelection return the selected text from aColumn in the wxListCtrl in the dialog.
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
Definition: string.cpp:409
void textChangeInFilterBox(wxCommandEvent &event) override
std::string m_hash_key
Definition: dialog_shim.h:191
void SetOKLabel(const wxString &aLabel)
EDA_LIST_DIALOG(EDA_DRAW_FRAME *aParent, const wxString &aTitle, const wxArrayString &aItemHeaders, const std::vector< wxArrayString > &aItemList, const wxString &aRefText)
Constructor:
void Append(const wxArrayString &aItemStr)
The base class for create windows for drawing purpose.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:95
static int wxCALLBACK myCompareFunction(wxIntPtr aItem1, wxIntPtr aItem2, wxIntPtr WXUNUSED(aSortData))
Helper dialog and control classes.
Class EDA_LIST_DIALOG_BASE.
const std::vector< wxArrayString > * m_itemsList
#define _(s)
Definition: 3d_actions.cpp:33
static int DEFAULT_COL_WIDTHS[]
void InsertItems(const std::vector< wxArrayString > &aItemList, int aPosition=0)
void onListItemActivated(wxListEvent &event) override
void SetListLabel(const wxString &aLabel)