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