]> git.saurik.com Git - wxWidgets.git/blob - src/gtk/listbox.cpp
remove unused function GTKSetItem()
[wxWidgets.git] / src / gtk / listbox.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/listbox.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Modified By: Ryan Norton (GtkTreeView implementation)
6 // Id: $Id$
7 // Copyright: (c) 1998 Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 // For compilers that support precompilation, includes "wx.h".
12 #include "wx/wxprec.h"
13
14 #if wxUSE_LISTBOX
15
16 #include "wx/listbox.h"
17
18 #ifndef WX_PRECOMP
19 #include "wx/dynarray.h"
20 #include "wx/intl.h"
21 #include "wx/log.h"
22 #include "wx/utils.h"
23 #include "wx/settings.h"
24 #include "wx/checklst.h"
25 #include "wx/arrstr.h"
26 #endif
27
28 #if wxUSE_TOOLTIPS
29 #include "wx/tooltip.h"
30 #endif
31
32 #include <gtk/gtk.h>
33 #include "wx/gtk/private.h"
34 #include "wx/gtk/private/gtk2-compat.h"
35 #include "wx/gtk/private/object.h"
36 #include "wx/gtk/treeentry_gtk.h"
37
38 #include <gdk/gdkkeysyms.h>
39 #ifdef __WXGTK3__
40 #include <gdk/gdkkeysyms-compat.h>
41 #endif
42
43 //-----------------------------------------------------------------------------
44 // data
45 //-----------------------------------------------------------------------------
46
47 extern bool g_blockEventsOnDrag;
48 extern bool g_blockEventsOnScroll;
49
50
51
52 //-----------------------------------------------------------------------------
53 // Macro to tell which row the strings are in (1 if native checklist, 0 if not)
54 //-----------------------------------------------------------------------------
55
56 #if wxUSE_CHECKLISTBOX
57 # define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0)
58 #else
59 # define WXLISTBOX_DATACOLUMN_ARG(x) (0)
60 #endif // wxUSE_CHECKLISTBOX
61
62 #define WXLISTBOX_DATACOLUMN WXLISTBOX_DATACOLUMN_ARG(this)
63
64 // ----------------------------------------------------------------------------
65 // helper functions
66 // ----------------------------------------------------------------------------
67
68 namespace
69 {
70
71 // Return the entry for the given listbox item.
72 //
73 // Return value must be released by caller if non-NULL.
74 GtkTreeEntry *
75 GetEntry(GtkListStore *store, GtkTreeIter *iter, const wxListBox *listbox)
76 {
77 GtkTreeEntry* entry;
78 gtk_tree_model_get(GTK_TREE_MODEL(store),
79 iter,
80 WXLISTBOX_DATACOLUMN_ARG(listbox),
81 &entry,
82 -1);
83
84 return entry;
85 }
86
87 } // anonymous namespace
88
89 //-----------------------------------------------------------------------------
90 // "row-activated"
91 //-----------------------------------------------------------------------------
92
93 extern "C" {
94 static void
95 gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview),
96 GtkTreePath *path,
97 GtkTreeViewColumn * WXUNUSED(col),
98 wxListBox *listbox)
99 {
100 if (g_blockEventsOnDrag) return;
101 if (g_blockEventsOnScroll) return;
102
103 // This is triggered by either a double-click or a space press
104
105 int sel = gtk_tree_path_get_indices(path)[0];
106
107 listbox->GTKOnActivated(sel);
108 }
109 }
110
111 //-----------------------------------------------------------------------------
112 // "changed"
113 //-----------------------------------------------------------------------------
114
115 extern "C" {
116 static void
117 gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection),
118 wxListBox *listbox )
119 {
120 if (g_blockEventsOnDrag) return;
121
122 listbox->GTKOnSelectionChanged();
123 }
124
125 }
126
127 //-----------------------------------------------------------------------------
128 // "key_press_event"
129 //-----------------------------------------------------------------------------
130
131 extern "C" {
132 static gboolean
133 gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
134 GdkEventKey *gdk_event,
135 wxListBox *listbox )
136 {
137 if ((gdk_event->keyval == GDK_Return) ||
138 (gdk_event->keyval == GDK_ISO_Enter) ||
139 (gdk_event->keyval == GDK_KP_Enter))
140 {
141 int index = -1;
142 if (!listbox->HasMultipleSelection())
143 index = listbox->GetSelection();
144 else
145 {
146 wxArrayInt sels;
147 if (listbox->GetSelections( sels ) < 1)
148 return FALSE;
149 index = sels[0];
150 }
151
152 if (index != wxNOT_FOUND)
153 {
154 listbox->GTKOnActivated(index);
155
156 // wxMac and wxMSW always invoke default action
157 // if (!ret)
158 {
159 // DClick not handled -> invoke default action
160 wxWindow *tlw = wxGetTopLevelParent( listbox );
161 if (tlw)
162 {
163 GtkWindow *gtk_window = GTK_WINDOW( tlw->GetHandle() );
164 if (gtk_window)
165 gtk_window_activate_default( gtk_window );
166 }
167 }
168
169 // Always intercept, otherwise we'd get another dclick
170 // event from row_activated
171 return TRUE;
172 }
173 }
174
175 return FALSE;
176 }
177 }
178
179 //-----------------------------------------------------------------------------
180 // GtkTreeEntry destruction (to destroy client data)
181 //-----------------------------------------------------------------------------
182
183 extern "C" {
184 static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
185 wxListBox* listbox)
186 {
187 if (listbox->HasClientObjectData())
188 {
189 gpointer userdata = gtk_tree_entry_get_userdata(entry);
190 if (userdata)
191 delete (wxClientData *)userdata;
192 }
193 }
194 }
195
196 //-----------------------------------------------------------------------------
197 // Sorting callback (standard CmpNoCase return value)
198 //-----------------------------------------------------------------------------
199
200 extern "C" {
201 static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model),
202 GtkTreeIter *a,
203 GtkTreeIter *b,
204 wxListBox *listbox)
205 {
206 wxGtkObject<GtkTreeEntry> entry1(GetEntry(listbox->m_liststore, a, listbox));
207 wxCHECK_MSG(entry1, 0, wxT("Could not get first entry"));
208
209 wxGtkObject<GtkTreeEntry> entry2(GetEntry(listbox->m_liststore, b, listbox));
210 wxCHECK_MSG(entry2, 0, wxT("Could not get second entry"));
211
212 //We compare collate keys here instead of calling g_utf8_collate
213 //as it is rather slow (and even the docs recommend this)
214 return strcmp(gtk_tree_entry_get_collate_key(entry1),
215 gtk_tree_entry_get_collate_key(entry2)) >= 0;
216 }
217 }
218
219 //-----------------------------------------------------------------------------
220 // Searching callback (TRUE == not equal, FALSE == equal)
221 //-----------------------------------------------------------------------------
222
223 extern "C" {
224 static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model),
225 gint WXUNUSED(column),
226 const gchar* key,
227 GtkTreeIter* iter,
228 wxListBox* listbox)
229 {
230 wxGtkObject<GtkTreeEntry>
231 entry(GetEntry(listbox->m_liststore, iter, listbox));
232 wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
233
234 wxGtkString keycollatekey(g_utf8_collate_key(key, -1));
235
236 return strcmp(keycollatekey, gtk_tree_entry_get_collate_key(entry)) != 0;
237 }
238 }
239
240 //-----------------------------------------------------------------------------
241 // wxListBox
242 //-----------------------------------------------------------------------------
243
244 // ----------------------------------------------------------------------------
245 // construction
246 // ----------------------------------------------------------------------------
247
248 void wxListBox::Init()
249 {
250 m_treeview = NULL;
251 #if wxUSE_CHECKLISTBOX
252 m_hasCheckBoxes = false;
253 #endif // wxUSE_CHECKLISTBOX
254 }
255
256 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
257 const wxPoint &pos, const wxSize &size,
258 const wxArrayString& choices,
259 long style, const wxValidator& validator,
260 const wxString &name )
261 {
262 wxCArrayString chs(choices);
263
264 return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
265 style, validator, name );
266 }
267
268 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
269 const wxPoint &pos, const wxSize &size,
270 int n, const wxString choices[],
271 long style, const wxValidator& validator,
272 const wxString &name )
273 {
274 if (!PreCreation( parent, pos, size ) ||
275 !CreateBase( parent, id, pos, size, style, validator, name ))
276 {
277 wxFAIL_MSG( wxT("wxListBox creation failed") );
278 return false;
279 }
280
281 m_widget = gtk_scrolled_window_new( NULL, NULL );
282 g_object_ref(m_widget);
283 if (style & wxLB_ALWAYS_SB)
284 {
285 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
286 GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
287 }
288 else
289 {
290 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
291 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
292 }
293
294
295 GTKScrolledWindowSetBorder(m_widget, style);
296
297 m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
298
299 //wxListBox doesn't have a header :)
300 //NB: If enabled SetFirstItem doesn't work correctly
301 gtk_tree_view_set_headers_visible(m_treeview, FALSE);
302
303 #if wxUSE_CHECKLISTBOX
304 if(m_hasCheckBoxes)
305 ((wxCheckListBox*)this)->DoCreateCheckList();
306 #endif // wxUSE_CHECKLISTBOX
307
308 // Create the data column
309 gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "",
310 gtk_cell_renderer_text_new(),
311 "text",
312 WXLISTBOX_DATACOLUMN, NULL);
313
314 // Now create+set the model (GtkListStore) - first argument # of columns
315 #if wxUSE_CHECKLISTBOX
316 if(m_hasCheckBoxes)
317 m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN,
318 GTK_TYPE_TREE_ENTRY);
319 else
320 #endif
321 m_liststore = gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY);
322
323 gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore));
324
325 g_object_unref (m_liststore); //free on treeview destruction
326
327 // Disable the pop-up textctrl that enables searching - note that
328 // the docs specify that even if this disabled (which we are doing)
329 // the user can still have it through the start-interactive-search
330 // key binding...either way we want to provide a searchequal callback
331 // NB: If this is enabled a doubleclick event (activate) gets sent
332 // on a successful search
333 gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN);
334 gtk_tree_view_set_search_equal_func(m_treeview,
335 (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback,
336 this,
337 NULL);
338
339 gtk_tree_view_set_enable_search(m_treeview, FALSE);
340
341 GtkSelectionMode mode;
342 // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE
343 if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) )
344 {
345 mode = GTK_SELECTION_MULTIPLE;
346 }
347 else // no multi-selection flags specified
348 {
349 m_windowStyle |= wxLB_SINGLE;
350
351 // Notice that we must use BROWSE and not GTK_SELECTION_SINGLE because
352 // the latter allows to not select any items at all while a single
353 // selection listbox is supposed to always have a selection (at least
354 // once the user selected something, it might not have any initially).
355 mode = GTK_SELECTION_BROWSE;
356 }
357
358 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
359 gtk_tree_selection_set_mode( selection, mode );
360
361 // Handle sortable stuff
362 if(HasFlag(wxLB_SORT))
363 {
364 // Setup sorting in ascending (wx) order
365 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
366 WXLISTBOX_DATACOLUMN,
367 GTK_SORT_ASCENDING);
368
369 // Set the sort callback
370 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore),
371 WXLISTBOX_DATACOLUMN,
372 (GtkTreeIterCompareFunc) gtk_listbox_sort_callback,
373 this, //userdata
374 NULL //"destroy notifier"
375 );
376 }
377
378
379 gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) );
380
381 gtk_widget_show( GTK_WIDGET(m_treeview) );
382 m_focusWidget = GTK_WIDGET(m_treeview);
383
384 Append(n, choices); // insert initial items
385
386 // generate dclick events
387 g_signal_connect_after(m_treeview, "row-activated",
388 G_CALLBACK(gtk_listbox_row_activated_callback), this);
389
390 // for intercepting dclick generation by <ENTER>
391 g_signal_connect (m_treeview, "key_press_event",
392 G_CALLBACK (gtk_listbox_key_press_callback),
393 this);
394 m_parent->DoAddChild( this );
395
396 PostCreation(size);
397 SetInitialSize(size); // need this too because this is a wxControlWithItems
398
399 g_signal_connect_after (selection, "changed",
400 G_CALLBACK (gtk_listitem_changed_callback), this);
401
402 return true;
403 }
404
405 wxListBox::~wxListBox()
406 {
407 if (m_treeview)
408 {
409 GTKDisconnect(m_treeview);
410 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
411 if (selection)
412 GTKDisconnect(selection);
413 }
414
415 Clear();
416 }
417
418 void wxListBox::GTKDisableEvents()
419 {
420 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
421
422 g_signal_handlers_block_by_func(selection,
423 (gpointer) gtk_listitem_changed_callback, this);
424 }
425
426 void wxListBox::GTKEnableEvents()
427 {
428 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
429
430 g_signal_handlers_unblock_by_func(selection,
431 (gpointer) gtk_listitem_changed_callback, this);
432
433 UpdateOldSelections();
434 }
435
436
437 void wxListBox::Update()
438 {
439 wxWindow::Update();
440
441 if (m_treeview)
442 gdk_window_process_updates(gtk_widget_get_window(GTK_WIDGET(m_treeview)), true);
443 }
444
445 // ----------------------------------------------------------------------------
446 // adding items
447 // ----------------------------------------------------------------------------
448
449 int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items,
450 unsigned int pos,
451 void **clientData,
452 wxClientDataType type)
453 {
454 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
455
456 InvalidateBestSize();
457 int n = DoInsertItemsInLoop(items, pos, clientData, type);
458 UpdateOldSelections();
459 return n;
460 }
461
462 int wxListBox::DoInsertOneItem(const wxString& item, unsigned int pos)
463 {
464 GtkTreeEntry* entry = gtk_tree_entry_new();
465 gtk_tree_entry_set_label(entry, wxGTK_CONV(item));
466 gtk_tree_entry_set_destroy_func(entry, (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb, this);
467
468 #if wxUSE_CHECKLISTBOX
469 int entryCol = int(m_hasCheckBoxes);
470 #else
471 int entryCol = 0;
472 #endif
473 gtk_list_store_insert_with_values(m_liststore, NULL, pos, entryCol, entry, -1);
474 g_object_unref(entry);
475
476 return pos;
477 }
478
479 // ----------------------------------------------------------------------------
480 // deleting items
481 // ----------------------------------------------------------------------------
482
483 void wxListBox::DoClear()
484 {
485 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
486
487 GTKDisableEvents(); // just in case
488
489 InvalidateBestSize();
490
491 gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
492
493 GTKEnableEvents();
494
495 UpdateOldSelections();
496 }
497
498 void wxListBox::DoDeleteOneItem(unsigned int n)
499 {
500 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
501
502 InvalidateBestSize();
503
504 GTKDisableEvents(); // just in case
505
506 GtkTreeIter iter;
507 wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("wrong listbox index") );
508
509 // this returns false if iter is invalid (e.g. deleting item at end) but
510 // since we don't use iter, we ignore the return value
511 gtk_list_store_remove(m_liststore, &iter);
512
513 GTKEnableEvents();
514 }
515
516 // ----------------------------------------------------------------------------
517 // helper functions for working with iterators
518 // ----------------------------------------------------------------------------
519
520 bool wxListBox::GTKGetIteratorFor(unsigned pos, GtkTreeIter *iter) const
521 {
522 if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore),
523 iter, NULL, pos) )
524 {
525 wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos);
526 return false;
527 }
528
529 return true;
530 }
531
532 int wxListBox::GTKGetIndexFor(GtkTreeIter& iter) const
533 {
534 GtkTreePath *path =
535 gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter);
536
537 gint* pIntPath = gtk_tree_path_get_indices(path);
538
539 wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") );
540
541 int idx = pIntPath[0];
542
543 gtk_tree_path_free( path );
544
545 return idx;
546 }
547
548 // get GtkTreeEntry from position (note: you need to g_unref it if valid)
549 GtkTreeEntry *wxListBox::GTKGetEntry(unsigned n) const
550 {
551 GtkTreeIter iter;
552 if ( !GTKGetIteratorFor(n, &iter) )
553 return NULL;
554
555 return GetEntry(m_liststore, &iter, this);
556 }
557
558 // ----------------------------------------------------------------------------
559 // client data
560 // ----------------------------------------------------------------------------
561
562 void* wxListBox::DoGetItemClientData(unsigned int n) const
563 {
564 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
565 wxCHECK_MSG(entry, NULL, wxT("could not get entry"));
566
567 return gtk_tree_entry_get_userdata( entry );
568 }
569
570 void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
571 {
572 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
573 wxCHECK_RET(entry, wxT("could not get entry"));
574
575 gtk_tree_entry_set_userdata( entry, clientData );
576 }
577
578 // ----------------------------------------------------------------------------
579 // string list access
580 // ----------------------------------------------------------------------------
581
582 void wxListBox::SetString(unsigned int n, const wxString& label)
583 {
584 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
585
586 GtkTreeIter iter;
587 wxCHECK_RET(GTKGetIteratorFor(n, &iter), "invalid index");
588 wxGtkObject<GtkTreeEntry> entry(GetEntry(m_liststore, &iter, this));
589
590 // update the item itself
591 gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
592
593 // signal row changed
594 GtkTreeModel* tree_model = GTK_TREE_MODEL(m_liststore);
595 GtkTreePath* path = gtk_tree_model_get_path(tree_model, &iter);
596 gtk_tree_model_row_changed(tree_model, path, &iter);
597 gtk_tree_path_free(path);
598 }
599
600 wxString wxListBox::GetString(unsigned int n) const
601 {
602 wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") );
603
604 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
605 wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") );
606
607 return wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) );
608 }
609
610 unsigned int wxListBox::GetCount() const
611 {
612 wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") );
613
614 return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL);
615 }
616
617 int wxListBox::FindString( const wxString &item, bool bCase ) const
618 {
619 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
620
621 //Sort of hackish - maybe there is a faster way
622 unsigned int nCount = wxListBox::GetCount();
623
624 for(unsigned int i = 0; i < nCount; ++i)
625 {
626 if( item.IsSameAs( wxListBox::GetString(i), bCase ) )
627 return (int)i;
628 }
629
630
631 // it's not an error if the string is not found -> no wxCHECK
632 return wxNOT_FOUND;
633 }
634
635 // ----------------------------------------------------------------------------
636 // selection
637 // ----------------------------------------------------------------------------
638
639 void wxListBox::GTKOnActivated(int item)
640 {
641 SendEvent(wxEVT_LISTBOX_DCLICK, item, IsSelected(item));
642 }
643
644 void wxListBox::GTKOnSelectionChanged()
645 {
646 if ( HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED) )
647 {
648 CalcAndSendEvent();
649 }
650 else // single selection
651 {
652 const int item = GetSelection();
653 if ( DoChangeSingleSelection(item) )
654 SendEvent(wxEVT_LISTBOX, item, true);
655 }
656 }
657
658 int wxListBox::GetSelection() const
659 {
660 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox"));
661 wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND,
662 wxT("must be single selection listbox"));
663
664 GtkTreeIter iter;
665 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
666
667 // only works on single-sel
668 if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
669 return wxNOT_FOUND;
670
671 return GTKGetIndexFor(iter);
672 }
673
674 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
675 {
676 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
677
678 aSelections.Empty();
679
680 int i = 0;
681 GtkTreeIter iter;
682 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
683
684 if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter))
685 { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
686 do
687 {
688 if (gtk_tree_selection_iter_is_selected(selection, &iter))
689 aSelections.Add(i);
690
691 i++;
692 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter));
693 }
694
695 return aSelections.GetCount();
696 }
697
698 bool wxListBox::IsSelected( int n ) const
699 {
700 wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") );
701
702 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
703
704 GtkTreeIter iter;
705 wxCHECK_MSG( GTKGetIteratorFor(n, &iter), false, wxT("Invalid index") );
706
707 return gtk_tree_selection_iter_is_selected(selection, &iter) != 0;
708 }
709
710 void wxListBox::DoSetSelection( int n, bool select )
711 {
712 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
713
714 GTKDisableEvents();
715
716 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
717
718 // passing -1 to SetSelection() is documented to deselect all items
719 if ( n == wxNOT_FOUND )
720 {
721 gtk_tree_selection_unselect_all(selection);
722 GTKEnableEvents();
723 return;
724 }
725
726 wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
727
728
729 GtkTreeIter iter;
730 wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("Invalid index") );
731
732 if (select)
733 gtk_tree_selection_select_iter(selection, &iter);
734 else
735 gtk_tree_selection_unselect_iter(selection, &iter);
736
737 GtkTreePath* path = gtk_tree_model_get_path(
738 GTK_TREE_MODEL(m_liststore), &iter);
739
740 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f);
741
742 gtk_tree_path_free(path);
743
744 GTKEnableEvents();
745 }
746
747 void wxListBox::DoScrollToCell(int n, float alignY, float alignX)
748 {
749 wxCHECK_RET( m_treeview, wxT("invalid listbox") );
750 wxCHECK_RET( IsValid(n), wxT("invalid index"));
751
752 //RN: I have no idea why this line is needed...
753 if (gtk_widget_has_grab(GTK_WIDGET(m_treeview)))
754 return;
755
756 GtkTreeIter iter;
757 if ( !GTKGetIteratorFor(n, &iter) )
758 return;
759
760 GtkTreePath* path = gtk_tree_model_get_path(
761 GTK_TREE_MODEL(m_liststore), &iter);
762
763 // Scroll to the desired cell (0.0 == topleft alignment)
764 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
765 TRUE, alignY, alignX);
766
767 gtk_tree_path_free(path);
768 }
769
770 void wxListBox::DoSetFirstItem(int n)
771 {
772 DoScrollToCell(n, 0, 0);
773 }
774
775 void wxListBox::EnsureVisible(int n)
776 {
777 DoScrollToCell(n, 0.5, 0);
778 }
779
780 // ----------------------------------------------------------------------------
781 // hittest
782 // ----------------------------------------------------------------------------
783
784 int wxListBox::DoListHitTest(const wxPoint& point) const
785 {
786 // gtk_tree_view_get_path_at_pos() also gets items that are not visible and
787 // we only want visible items we need to check for it manually here
788 if ( !GetClientRect().Contains(point) )
789 return wxNOT_FOUND;
790
791 // need to translate from master window since it is in client coords
792 gint binx, biny;
793 gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview),
794 &binx, &biny, NULL, NULL);
795
796 GtkTreePath* path;
797 if ( !gtk_tree_view_get_path_at_pos
798 (
799 m_treeview,
800 point.x - binx,
801 point.y - biny,
802 &path,
803 NULL, // [out] column (always 0 here)
804 NULL, // [out] x-coord relative to the cell (not interested)
805 NULL // [out] y-coord relative to the cell
806 ) )
807 {
808 return wxNOT_FOUND;
809 }
810
811 int index = gtk_tree_path_get_indices(path)[0];
812 gtk_tree_path_free(path);
813
814 return index;
815 }
816
817 // ----------------------------------------------------------------------------
818 // helpers
819 // ----------------------------------------------------------------------------
820
821 GtkWidget *wxListBox::GetConnectWidget()
822 {
823 // the correct widget for listbox events (such as mouse clicks for example)
824 // is m_treeview, not the parent scrolled window
825 return GTK_WIDGET(m_treeview);
826 }
827
828 GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
829 {
830 return gtk_tree_view_get_bin_window(m_treeview);
831 }
832
833 void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
834 {
835 #ifdef __WXGTK3__
836 // don't know if this is even necessary, or how to do it
837 #else
838 if (m_hasBgCol && m_backgroundColour.IsOk())
839 {
840 GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
841 if (window)
842 {
843 m_backgroundColour.CalcPixel( gdk_drawable_get_colormap( window ) );
844 gdk_window_set_background( window, m_backgroundColour.GetColor() );
845 gdk_window_clear( window );
846 }
847 }
848 #endif
849
850 GTKApplyStyle(GTK_WIDGET(m_treeview), style);
851 }
852
853 wxSize wxListBox::DoGetBestSize() const
854 {
855 wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view"));
856
857 // Start with a minimum size that's not too small
858 int cx, cy;
859 GetTextExtent( wxT("X"), &cx, &cy);
860 int lbWidth = 0;
861 int lbHeight = 10;
862
863 // Find the widest string.
864 const unsigned int count = GetCount();
865 if ( count )
866 {
867 int wLine;
868 for ( unsigned int i = 0; i < count; i++ )
869 {
870 GetTextExtent(GetString(i), &wLine, NULL);
871 if ( wLine > lbWidth )
872 lbWidth = wLine;
873 }
874 }
875
876 lbWidth += 3 * cx;
877
878 // And just a bit more for the checkbox if present and then some
879 // (these are rough guesses)
880 #if wxUSE_CHECKLISTBOX
881 if ( m_hasCheckBoxes )
882 {
883 lbWidth += 35;
884 cy = cy > 25 ? cy : 25; // rough height of checkbox
885 }
886 #endif
887
888 // Add room for the scrollbar
889 lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
890
891 // Don't make the listbox too tall but don't make it too small neither
892 lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
893
894 wxSize best(lbWidth, lbHeight);
895 CacheBestSize(best);
896 return best;
897 }
898
899 // static
900 wxVisualAttributes
901 wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
902 {
903 return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new(), true);
904 }
905
906 #endif // wxUSE_LISTBOX