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