1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/listbox.cpp
4 // Author: Robert Roebling
5 // Modified By: Ryan Norton (GtkTreeView implementation)
7 // Copyright: (c) 1998 Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // For compilers that support precompilation, includes "wx.h".
12 #include "wx/wxprec.h"
16 #include "wx/listbox.h"
19 #include "wx/dynarray.h"
23 #include "wx/settings.h"
24 #include "wx/checklst.h"
25 #include "wx/arrstr.h"
28 #include "wx/gtk/private.h"
29 #include "wx/gtk/treeentry_gtk.h"
32 #include "wx/tooltip.h"
37 #include <gdk/gdkkeysyms.h>
39 //-----------------------------------------------------------------------------
41 //-----------------------------------------------------------------------------
43 extern bool g_blockEventsOnDrag
;
44 extern bool g_blockEventsOnScroll
;
48 //-----------------------------------------------------------------------------
49 // Macro to tell which row the strings are in (1 if native checklist, 0 if not)
50 //-----------------------------------------------------------------------------
52 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
53 # define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0)
55 # define WXLISTBOX_DATACOLUMN_ARG(x) (0)
56 #endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
58 #define WXLISTBOX_DATACOLUMN WXLISTBOX_DATACOLUMN_ARG(this)
60 //-----------------------------------------------------------------------------
62 //-----------------------------------------------------------------------------
66 gtk_listbox_row_activated_callback(GtkTreeView
*treeview
,
68 GtkTreeViewColumn
*col
,
71 if (g_isIdle
) wxapp_install_idle_handler();
73 if (g_blockEventsOnDrag
) return;
74 if (g_blockEventsOnScroll
) return;
76 if (!listbox
->m_hasVMT
) return;
79 //1) This is triggered by either a double-click or a space press
80 //2) We handle both here because
81 //2a) in the case of a space/keypress we can't really know
82 // which item was pressed on because we can't get coords
84 //2b) It seems more correct
86 int sel
= gtk_tree_path_get_indices(path
)[0];
88 if(!listbox
->m_spacePressed
)
90 //Assume it was double-click
91 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
, listbox
->GetId() );
92 event
.SetEventObject( listbox
);
94 if(listbox
->IsSelected(sel
))
96 GtkTreeEntry
* entry
= listbox
->GtkGetEntry(sel
);
101 event
.SetString(wxConvUTF8
.cMB2WX(gtk_tree_entry_get_label(entry
)));
103 if ( listbox
->HasClientObjectData() )
104 event
.SetClientObject(
105 (wxClientData
*) gtk_tree_entry_get_userdata(entry
) );
106 else if ( listbox
->HasClientUntypedData() )
107 event
.SetClientData( gtk_tree_entry_get_userdata(entry
) );
108 g_object_unref (entry
);
112 wxLogSysError(wxT("Internal error - could not get entry for double-click"));
119 listbox
->GetEventHandler()->ProcessEvent( event
);
123 listbox
->m_spacePressed
= false; //don't block selection behaviour anymore
125 //Space was pressed - toggle the appropriate checkbox and the selection
126 #if wxUSE_CHECKLISTBOX //Do it for both native and non-native
127 if (listbox
->m_hasCheckBoxes
)
129 wxCheckListBox
*clb
= (wxCheckListBox
*)listbox
;
131 clb
->Check( sel
, !clb
->IsChecked(sel
) );
133 wxCommandEvent
new_event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, listbox
->GetId() );
134 new_event
.SetEventObject( listbox
);
135 new_event
.SetInt( sel
);
136 listbox
->GetEventHandler()->ProcessEvent( new_event
);
138 #endif // wxUSE_CHECKLISTBOX
140 if( (((listbox
->GetWindowStyleFlag() & wxLB_MULTIPLE
) != 0) ||
141 ((listbox
->GetWindowStyleFlag() & wxLB_EXTENDED
) != 0)) )
143 //toggle the selection + send event
144 listbox
->GtkSetSelection(sel
, !listbox
->IsSelected( sel
), false);
150 //-----------------------------------------------------------------------------
151 // "button_press_event"
152 //-----------------------------------------------------------------------------
156 gtk_listbox_button_press_callback( GtkWidget
*widget
,
157 GdkEventButton
*gdk_event
,
160 // don't need to install idle handler, its done from "event" signal
162 if (g_blockEventsOnDrag
) return FALSE
;
163 if (g_blockEventsOnScroll
) return FALSE
;
165 if (!listbox
->m_hasVMT
) return FALSE
;
167 //Just to be on the safe side - it should be unset in the activate callback
168 //but we don't want any obscure bugs if it doesn't get called somehow...
169 listbox
->m_spacePressed
= false;
171 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
172 if ((listbox
->m_hasCheckBoxes
) && (gdk_event
->x
< 15) && (gdk_event
->type
!= GDK_2BUTTON_PRESS
))
175 gtk_tree_view_get_path_at_pos(GTK_TREE_VIEW(widget
),
176 (gint
)gdk_event
->x
, (gint
)gdk_event
->y
,
177 &path
, NULL
, NULL
, NULL
);
178 int sel
= gtk_tree_path_get_indices(path
)[0];
179 gtk_tree_path_free(path
);
181 wxCheckListBox
*clb
= (wxCheckListBox
*)listbox
;
183 clb
->Check( sel
, !clb
->IsChecked(sel
) );
185 wxCommandEvent
event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
, listbox
->GetId() );
186 event
.SetEventObject( listbox
);
188 listbox
->GetEventHandler()->ProcessEvent( event
);
190 #endif // wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
196 //-----------------------------------------------------------------------------
198 //-----------------------------------------------------------------------------
202 gtk_listbox_key_press_callback( GtkWidget
*widget
,
203 GdkEventKey
*gdk_event
,
206 // don't need to install idle handler, its done from "event" signal
208 if (g_blockEventsOnDrag
) return FALSE
;
213 if ((gdk_event
->keyval
== GDK_Tab
) || (gdk_event
->keyval
== GDK_ISO_Left_Tab
))
215 wxNavigationKeyEvent new_event
;
216 /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
217 new_event
.SetDirection( (gdk_event
->keyval
== GDK_Tab
) );
218 /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
219 new_event
.SetWindowChange( (gdk_event
->state
& GDK_CONTROL_MASK
) );
220 new_event
.SetCurrentFocus( listbox
);
221 ret
= listbox
->GetEventHandler()->ProcessEvent( new_event
);
224 if ((gdk_event
->keyval
== GDK_Return
) && (!ret
))
226 // eat return in all modes (RN:WHY?)
230 // Check or uncheck item with SPACE
231 if (gdk_event
->keyval
== ' ')
233 //In the keyevent we don't know the index of the item
234 //and the activated event gets called anyway...
236 //Also, activating with the space causes the treeview to
237 //unselect all the items and then select the item in question
238 //wx's behaviour is to just toggle the item's selection state
239 //and leave the others alone
240 listbox
->m_spacePressed
= true;
247 //-----------------------------------------------------------------------------
248 // "select" and "deselect"
249 //-----------------------------------------------------------------------------
252 static gboolean
gtk_listitem_select_cb( GtkTreeSelection
* selection
,
255 gboolean is_selected
,
258 if (g_isIdle
) wxapp_install_idle_handler();
260 if (!listbox
->m_hasVMT
) return TRUE
;
261 if (g_blockEventsOnDrag
) return TRUE
;
263 if (listbox
->m_spacePressed
) return FALSE
; //see keyevent callback
264 if (listbox
->m_blockEvent
) return TRUE
;
266 // NB: wxdocs explicitly say that this event only gets sent when
267 // something is actually selected, plus the controls example
268 // assumes so and passes -1 to the dogetclientdata funcs if not
270 // OK, so basically we need to do a bit of a run-around here as
271 // 1) is_selected says whether the item(s?) are CURRENTLY selected -
272 // i.e. if is_selected is FALSE then the item is going to be
273 // selected right now!
274 // 2) However, since it is not already selected and the user
275 // will expect it to be we need to manually select it and
276 // return FALSE telling GTK we handled the selection
277 if (is_selected
) return TRUE
;
279 int nIndex
= gtk_tree_path_get_indices(path
)[0];
280 GtkTreeEntry
* entry
= listbox
->GtkGetEntry(nIndex
);
284 //Now, as mentioned above, we manually select the row that is/was going
285 //to be selected anyway by GTK
286 listbox
->m_blockEvent
= true; //if we don't block events we will lock the
287 //app due to recursion!!
289 GtkTreeSelection
* selection
=
290 gtk_tree_view_get_selection(listbox
->m_treeview
);
292 gtk_tree_model_get_iter(GTK_TREE_MODEL(listbox
->m_liststore
), &iter
, path
);
293 gtk_tree_selection_select_iter(selection
, &iter
);
295 listbox
->m_blockEvent
= false;
297 //Finally, send the wx event
298 wxCommandEvent
event(wxEVT_COMMAND_LISTBOX_SELECTED
, listbox
->GetId() );
299 event
.SetEventObject( listbox
);
301 // indicate whether this is a selection or a deselection
302 event
.SetExtraLong( 1 );
304 event
.SetInt(nIndex
);
305 event
.SetString(wxConvUTF8
.cMB2WX(gtk_tree_entry_get_label(entry
)));
307 if ( listbox
->HasClientObjectData() )
308 event
.SetClientObject(
309 (wxClientData
*) gtk_tree_entry_get_userdata(entry
)
311 else if ( listbox
->HasClientUntypedData() )
312 event
.SetClientData( gtk_tree_entry_get_userdata(entry
) );
314 listbox
->GetEventHandler()->ProcessEvent( event
);
316 g_object_unref (entry
);
317 return FALSE
; //We handled it/did it manually
320 return TRUE
; //allow selection to change
324 //-----------------------------------------------------------------------------
325 // GtkTreeEntry destruction (to destroy client data)
326 //-----------------------------------------------------------------------------
329 static void gtk_tree_entry_destroy_cb(GtkTreeEntry
* entry
,
332 if(listbox
->HasClientObjectData())
334 gpointer userdata
= gtk_tree_entry_get_userdata(entry
);
336 delete (wxClientData
*)userdata
;
341 //-----------------------------------------------------------------------------
342 // Sorting callback (standard CmpNoCase return value)
343 //-----------------------------------------------------------------------------
346 static gint
gtk_listbox_sort_callback(GtkTreeModel
*model
,
352 GtkTreeEntry
* entry2
;
354 gtk_tree_model_get(GTK_TREE_MODEL(listbox
->m_liststore
),
356 WXLISTBOX_DATACOLUMN_ARG(listbox
),
358 gtk_tree_model_get(GTK_TREE_MODEL(listbox
->m_liststore
),
360 WXLISTBOX_DATACOLUMN_ARG(listbox
),
362 wxCHECK_MSG(entry
, 0, wxT("Could not get entry"));
363 wxCHECK_MSG(entry2
, 0, wxT("Could not get entry2"));
365 //We compare collate keys here instead of calling g_utf8_collate
366 //as it is rather slow (and even the docs reccommend this)
367 int ret
= strcasecmp(gtk_tree_entry_get_collate_key(entry
),
368 gtk_tree_entry_get_collate_key(entry2
));
370 g_object_unref (entry
);
371 g_object_unref (entry2
);
377 //-----------------------------------------------------------------------------
378 // Searching callback (TRUE == not equal, FALSE == equal)
379 //-----------------------------------------------------------------------------
382 static gboolean
gtk_listbox_searchequal_callback(GtkTreeModel
* model
,
390 gtk_tree_model_get(GTK_TREE_MODEL(listbox
->m_liststore
),
392 WXLISTBOX_DATACOLUMN_ARG(listbox
),
394 wxCHECK_MSG(entry
, 0, wxT("Could not get entry"));
395 gchar
* keycollatekey
= g_utf8_collate_key(key
, -1);
397 int ret
= strcasecmp(keycollatekey
,
398 gtk_tree_entry_get_collate_key(entry
));
400 g_free(keycollatekey
);
401 g_object_unref (entry
);
407 //-----------------------------------------------------------------------------
409 //-----------------------------------------------------------------------------
411 IMPLEMENT_DYNAMIC_CLASS(wxListBox
, wxControl
)
413 // ----------------------------------------------------------------------------
415 // ----------------------------------------------------------------------------
417 void wxListBox::Init()
419 m_treeview
= (GtkTreeView
*) NULL
;
420 #if wxUSE_CHECKLISTBOX
421 m_hasCheckBoxes
= false;
422 #endif // wxUSE_CHECKLISTBOX
423 m_spacePressed
= false;
426 bool wxListBox::Create( wxWindow
*parent
, wxWindowID id
,
427 const wxPoint
&pos
, const wxSize
&size
,
428 const wxArrayString
& choices
,
429 long style
, const wxValidator
& validator
,
430 const wxString
&name
)
432 wxCArrayString
chs(choices
);
434 return Create( parent
, id
, pos
, size
, chs
.GetCount(), chs
.GetStrings(),
435 style
, validator
, name
);
438 bool wxListBox::Create( wxWindow
*parent
, wxWindowID id
,
439 const wxPoint
&pos
, const wxSize
&size
,
440 int n
, const wxString choices
[],
441 long style
, const wxValidator
& validator
,
442 const wxString
&name
)
445 m_acceptsFocus
= true;
446 m_blockEvent
= false;
448 if (!PreCreation( parent
, pos
, size
) ||
449 !CreateBase( parent
, id
, pos
, size
, style
, validator
, name
))
451 wxFAIL_MSG( wxT("wxListBox creation failed") );
455 m_widget
= gtk_scrolled_window_new( (GtkAdjustment
*) NULL
, (GtkAdjustment
*) NULL
);
456 if (style
& wxLB_ALWAYS_SB
)
458 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget
),
459 GTK_POLICY_AUTOMATIC
, GTK_POLICY_ALWAYS
);
463 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget
),
464 GTK_POLICY_AUTOMATIC
, GTK_POLICY_AUTOMATIC
);
468 GtkScrolledWindowSetBorder(m_widget
, style
);
470 m_treeview
= GTK_TREE_VIEW( gtk_tree_view_new( ) );
472 //wxListBox doesn't have a header :)
473 //NB: If enabled SetFirstItem doesn't work correctly
474 gtk_tree_view_set_headers_visible(m_treeview
, FALSE
);
476 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
478 ((wxCheckListBox
*)this)->DoCreateCheckList();
479 #endif // wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
481 // Create the data column
482 gtk_tree_view_insert_column_with_attributes(m_treeview
, -1, "",
483 gtk_cell_renderer_text_new(),
485 WXLISTBOX_DATACOLUMN
, NULL
);
487 // Now create+set the model (GtkListStore) - first argument # of columns
488 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
490 m_liststore
= gtk_list_store_new(2, G_TYPE_BOOLEAN
,
491 GTK_TYPE_TREE_ENTRY
);
494 m_liststore
= gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY
);
496 gtk_tree_view_set_model(m_treeview
, GTK_TREE_MODEL(m_liststore
));
498 g_object_unref (m_liststore
); //free on treeview destruction
500 // Disable the pop-up textctrl that enables searching - note that
501 // the docs specify that even if this disabled (which we are doing)
502 // the user can still have it through the start-interactive-search
503 // key binding...either way we want to provide a searchequal callback
504 // NB: If this is enabled a doubleclick event (activate) gets sent
505 // on a successful search
506 gtk_tree_view_set_search_column(m_treeview
, WXLISTBOX_DATACOLUMN
);
507 gtk_tree_view_set_search_equal_func(m_treeview
,
508 (GtkTreeViewSearchEqualFunc
) gtk_listbox_searchequal_callback
,
512 gtk_tree_view_set_enable_search(m_treeview
, FALSE
);
515 GtkTreeSelection
* selection
= gtk_tree_view_get_selection( m_treeview
);
516 gtk_tree_selection_set_select_function(selection
,
517 (GtkTreeSelectionFunc
)gtk_listitem_select_cb
,
518 this, NULL
); //NULL == destroycb
520 GtkSelectionMode mode
;
521 if (style
& wxLB_MULTIPLE
)
523 mode
= GTK_SELECTION_MULTIPLE
;
525 else if (style
& wxLB_EXTENDED
)
527 mode
= GTK_SELECTION_EXTENDED
;
531 // if style was 0 set single mode
532 m_windowStyle
|= wxLB_SINGLE
;
533 mode
= GTK_SELECTION_SINGLE
;
536 gtk_tree_selection_set_mode( selection
, mode
);
538 //Handle sortable stuff
539 if(style
& wxLB_SORT
)
541 //Setup sorting in ascending (wx) order
542 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore
),
543 WXLISTBOX_DATACOLUMN
,
546 //Set the sort callback
547 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore
),
548 WXLISTBOX_DATACOLUMN
,
549 (GtkTreeIterCompareFunc
) gtk_listbox_sort_callback
,
551 NULL
//"destroy notifier"
556 gtk_container_add (GTK_CONTAINER (m_widget
), GTK_WIDGET(m_treeview
) );
558 gtk_widget_show( GTK_WIDGET(m_treeview
) );
560 wxListBox::DoInsertItems(wxArrayString(n
, choices
), 0); // insert initial items
562 //treeview-specific events
563 g_signal_connect(m_treeview
, "row-activated",
564 G_CALLBACK(gtk_listbox_row_activated_callback
), this);
567 g_signal_connect (m_treeview
, "button_press_event",
568 G_CALLBACK (gtk_listbox_button_press_callback
),
570 g_signal_connect (m_treeview
, "key_press_event",
571 G_CALLBACK (gtk_listbox_key_press_callback
),
574 m_parent
->DoAddChild( this );
577 SetBestSize(size
); // need this too because this is a wxControlWithItems
582 wxListBox::~wxListBox()
589 // ----------------------------------------------------------------------------
591 // ----------------------------------------------------------------------------
593 void wxListBox::GtkInsertItems(const wxArrayString
& items
,
594 void** clientData
, unsigned int pos
)
596 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
598 InvalidateBestSize();
600 // Create and set column ids and GValues
602 unsigned int nNum
= items
.GetCount();
603 unsigned int nCurCount
= wxListBox::GetCount();
604 wxASSERT_MSG(pos
<= nCurCount
, wxT("Invalid index passed to wxListBox"));
606 GtkTreeIter
* pIter
= NULL
; // append by default
608 if (pos
!= nCurCount
)
610 gboolean res
= gtk_tree_model_iter_nth_child(
611 GTK_TREE_MODEL(m_liststore
),
612 &iter
, NULL
, //NULL = parent = get first
616 wxLogSysError(wxT("internal wxListBox error in insertion"));
623 for (unsigned int i
= 0; i
< nNum
; ++i
)
625 wxString label
= items
[i
];
627 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
630 label
.Prepend(wxCHECKLBOX_STRING
);
632 #endif // wxUSE_CHECKLISTBOX
635 GtkTreeEntry
* entry
= gtk_tree_entry_new();
636 gtk_tree_entry_set_label(entry
, wxConvUTF8
.cWX2MB(label
));
637 gtk_tree_entry_set_destroy_func(entry
,
638 (GtkTreeEntryDestroy
)gtk_tree_entry_destroy_cb
,
642 gtk_tree_entry_set_userdata(entry
, clientData
[i
]);
645 gtk_list_store_insert_before(m_liststore
, &itercur
, pIter
);
647 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
650 gtk_list_store_set(m_liststore
, &itercur
,
651 0, FALSE
, //FALSE == not toggled
656 gtk_list_store_set(m_liststore
, &itercur
,
659 g_object_unref (entry
); //liststore always refs :)
663 void wxListBox::DoInsertItems(const wxArrayString
& items
, unsigned int pos
)
665 wxCHECK_RET( IsValidInsert(pos
), wxT("invalid index in wxListBox::InsertItems") );
667 GtkInsertItems(items
, NULL
, pos
);
670 int wxListBox::DoAppend( const wxString
& item
)
672 // Call DoInsertItems
673 unsigned int nWhere
= wxListBox::GetCount();
674 wxArrayString aItems
;
676 wxListBox::DoInsertItems(aItems
, nWhere
);
680 void wxListBox::DoSetItems( const wxArrayString
& items
,
684 GtkInsertItems(items
, clientData
, 0);
687 // ----------------------------------------------------------------------------
689 // ----------------------------------------------------------------------------
691 void wxListBox::Clear()
693 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
695 InvalidateBestSize();
697 gtk_list_store_clear( m_liststore
); /* well, THAT was easy :) */
700 void wxListBox::Delete(unsigned int n
)
702 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
704 InvalidateBestSize();
707 gboolean res
= gtk_tree_model_iter_nth_child(
708 GTK_TREE_MODEL(m_liststore
),
709 &iter
, NULL
, //NULL = parent = get first
713 wxCHECK_RET( res
, wxT("wrong listbox index") );
715 //this returns false if iter is invalid (i.e. deleting item
716 //at end) but since we don't use iter, well... :)
717 gtk_list_store_remove(m_liststore
, &iter
);
720 // ----------------------------------------------------------------------------
721 // get GtkTreeEntry from position (note: you need to g_unref it if valid)
722 // ----------------------------------------------------------------------------
724 struct _GtkTreeEntry
* wxListBox::GtkGetEntry(int n
) const
727 gboolean res
= gtk_tree_model_iter_nth_child(
728 GTK_TREE_MODEL(m_liststore
),
729 &iter
, NULL
, //NULL = parent = get first
734 wxLogDebug(wxT("gtk_tree_model_iter_nth_child failed\n")
735 wxT("Passed in value was:[%i] List size:[%u]"),
736 n
, wxListBox::GetCount() );
741 GtkTreeEntry
* entry
= NULL
;
742 gtk_tree_model_get(GTK_TREE_MODEL(m_liststore
), &iter
,
743 WXLISTBOX_DATACOLUMN
, &entry
, -1);
748 // ----------------------------------------------------------------------------
750 // ----------------------------------------------------------------------------
752 void* wxListBox::DoGetItemClientData(unsigned int n
) const
754 wxCHECK_MSG( IsValid(n
), NULL
,
755 wxT("Invalid index passed to GetItemClientData") );
757 GtkTreeEntry
* entry
= GtkGetEntry(n
);
758 wxCHECK_MSG(entry
, NULL
, wxT("could not get entry"));
760 void* userdata
= gtk_tree_entry_get_userdata( entry
);
761 g_object_unref (entry
);
765 wxClientData
* wxListBox::DoGetItemClientObject(unsigned int n
) const
767 return (wxClientData
*) wxListBox::DoGetItemClientData(n
);
770 void wxListBox::DoSetItemClientData(unsigned int n
, void* clientData
)
772 wxCHECK_RET( IsValid(n
),
773 wxT("Invalid index passed to SetItemClientData") );
775 GtkTreeEntry
* entry
= GtkGetEntry(n
);
776 wxCHECK_RET(entry
, wxT("could not get entry"));
778 gtk_tree_entry_set_userdata( entry
, clientData
);
779 g_object_unref (entry
);
782 void wxListBox::DoSetItemClientObject(unsigned int n
, wxClientData
* clientData
)
784 // wxItemContainer already deletes data for us
785 wxListBox::DoSetItemClientData(n
, (void*) clientData
);
788 // ----------------------------------------------------------------------------
789 // string list access
790 // ----------------------------------------------------------------------------
792 void wxListBox::SetString(unsigned int n
, const wxString
&string
)
794 wxCHECK_RET( IsValid(n
), wxT("invalid index in wxListBox::SetString") );
795 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
797 GtkTreeEntry
* entry
= GtkGetEntry(n
);
798 wxCHECK_RET( entry
, wxT("wrong listbox index") );
800 wxString label
= string
;
802 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
804 label
.Prepend(wxCHECKLBOX_STRING
);
805 #endif // wxUSE_CHECKLISTBOX
807 // RN: This may look wierd but the problem is that the TreeView
808 // doesn't resort or update when changed above and there is no real
809 // notification function...
810 void* userdata
= gtk_tree_entry_get_userdata(entry
);
811 gtk_tree_entry_set_userdata(entry
, NULL
); //don't delete on destroy
812 g_object_unref (entry
);
814 bool bWasSelected
= wxListBox::IsSelected(n
);
815 wxListBox::Delete(n
);
817 wxArrayString aItems
;
819 GtkInsertItems(aItems
, &userdata
, n
);
821 wxListBox::GtkSetSelection(n
, true, true);
824 wxString
wxListBox::GetString(unsigned int n
) const
826 wxCHECK_MSG( m_treeview
!= NULL
, wxEmptyString
, wxT("invalid listbox") );
828 GtkTreeEntry
* entry
= GtkGetEntry(n
);
829 wxCHECK_MSG( entry
, wxEmptyString
, wxT("wrong listbox index") );
831 wxString label
= wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry
) );
833 #if wxUSE_CHECKLISTBOX && !wxUSE_NATIVEGTKCHECKLIST
834 // checklistboxes have "[±] " prepended to their lables, remove it
836 // NB: 4 below is the length of wxCHECKLBOX_STRING from wx/gtk/checklst.h
837 if ( m_hasCheckBoxes
)
839 #endif // wxUSE_CHECKLISTBOX
841 g_object_unref (entry
);
845 unsigned int wxListBox::GetCount() const
847 wxCHECK_MSG( m_treeview
!= NULL
, 0, wxT("invalid listbox") );
849 return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore
), NULL
);
852 int wxListBox::FindString( const wxString
&item
, bool bCase
) const
854 wxCHECK_MSG( m_treeview
!= NULL
, wxNOT_FOUND
, wxT("invalid listbox") );
856 //Sort of hackish - maybe there is a faster way
857 unsigned int nCount
= wxListBox::GetCount();
859 for(unsigned int i
= 0; i
< nCount
; ++i
)
861 if( item
.IsSameAs( wxListBox::GetString(i
), bCase
) )
866 // it's not an error if the string is not found -> no wxCHECK
870 // ----------------------------------------------------------------------------
872 // ----------------------------------------------------------------------------
874 int wxListBox::GetSelection() const
876 wxCHECK_MSG( m_treeview
!= NULL
, wxNOT_FOUND
, wxT("invalid listbox"));
877 wxCHECK_MSG( HasFlag(wxLB_SINGLE
), wxNOT_FOUND
,
878 wxT("must be single selection listbox"));
881 GtkTreeSelection
* selection
= gtk_tree_view_get_selection(m_treeview
);
883 // only works on single-sel
884 if (!gtk_tree_selection_get_selected(selection
, NULL
, &iter
))
888 gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore
), &iter
);
890 int sel
= gtk_tree_path_get_indices(path
)[0];
892 gtk_tree_path_free(path
);
897 int wxListBox::GetSelections( wxArrayInt
& aSelections
) const
899 wxCHECK_MSG( m_treeview
!= NULL
, wxNOT_FOUND
, wxT("invalid listbox") );
905 GtkTreeSelection
* selection
= gtk_tree_view_get_selection(m_treeview
);
907 if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore
), &iter
))
908 { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
911 if (gtk_tree_selection_iter_is_selected(selection
, &iter
))
915 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore
), &iter
));
918 return aSelections
.GetCount();
921 bool wxListBox::IsSelected( int n
) const
923 wxCHECK_MSG( m_treeview
!= NULL
, false, wxT("invalid listbox") );
925 GtkTreeSelection
* selection
= gtk_tree_view_get_selection(m_treeview
);
928 gboolean res
= gtk_tree_model_iter_nth_child(
929 GTK_TREE_MODEL(m_liststore
),
930 &iter
, NULL
, //NULL = parent = get first
933 wxCHECK_MSG( res
, false, wxT("Invalid index") );
935 return gtk_tree_selection_iter_is_selected(selection
, &iter
);
938 void wxListBox::DoSetSelection( int n
, bool select
)
940 // passing -1 to SetSelection() is documented to deselect all items
941 if ( n
== wxNOT_FOUND
)
943 // ... and not generate any events in the process
947 wxCHECK_RET( IsValid(n
), wxT("invalid index in wxListBox::SetSelection") );
949 // don't generate the selection event
950 GtkSetSelection(n
, select
, true);
953 void wxListBox::GtkDeselectAll()
955 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
957 GtkTreeSelection
* selection
= gtk_tree_view_get_selection(m_treeview
);
961 gtk_tree_selection_unselect_all(selection
);
963 m_blockEvent
= false;
966 void wxListBox::GtkSetSelection(int n
, const bool select
, const bool blockEvent
)
968 wxCHECK_RET( m_treeview
!= NULL
, wxT("invalid listbox") );
970 GtkTreeSelection
* selection
= gtk_tree_view_get_selection(m_treeview
);
973 gboolean res
= gtk_tree_model_iter_nth_child(
974 GTK_TREE_MODEL(m_liststore
),
975 &iter
, NULL
, //NULL = parent = get first
978 wxCHECK_RET( res
, wxT("Invalid index") );
980 m_blockEvent
= blockEvent
;
983 gtk_tree_selection_select_iter(selection
, &iter
);
985 gtk_tree_selection_unselect_iter(selection
, &iter
);
987 m_blockEvent
= false;
990 void wxListBox::DoSetFirstItem( int n
)
992 wxCHECK_RET( m_treeview
, wxT("invalid listbox") );
993 wxCHECK_RET( IsValid(n
), wxT("invalid index"));
995 //RN: I have no idea why this line is needed...
996 if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_treeview
))
1000 gtk_tree_model_iter_nth_child(
1001 GTK_TREE_MODEL(m_liststore
),
1003 NULL
, //NULL = parent = get first
1007 GtkTreePath
* path
= gtk_tree_model_get_path(
1008 GTK_TREE_MODEL(m_liststore
), &iter
);
1010 // Scroll to the desired cell (0.0 == topleft alignment)
1011 gtk_tree_view_scroll_to_cell(m_treeview
, path
, NULL
,
1014 gtk_tree_path_free(path
);
1017 // ----------------------------------------------------------------------------
1019 // ----------------------------------------------------------------------------
1021 int wxListBox::DoListHitTest(const wxPoint
& point
) const
1023 // gtk_tree_view_get_path_at_pos() also gets items that are not visible and
1024 // we only want visible items we need to check for it manually here
1025 if ( !GetClientRect().Contains(point
) )
1028 // need to translate from master window since it is in client coords
1030 gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview
),
1031 &binx
, &biny
, NULL
, NULL
, NULL
);
1034 if ( !gtk_tree_view_get_path_at_pos
1040 NULL
, // [out] column (always 0 here)
1041 NULL
, // [out] x-coord relative to the cell (not interested)
1042 NULL
// [out] y-coord relative to the cell
1048 int index
= gtk_tree_path_get_indices(path
)[0];
1049 gtk_tree_path_free(path
);
1054 // ----------------------------------------------------------------------------
1056 // ----------------------------------------------------------------------------
1059 void wxListBox::ApplyToolTip( GtkTooltips
*tips
, const wxChar
*tip
)
1061 // RN: Is this needed anymore?
1062 gtk_tooltips_set_tip( tips
, GTK_WIDGET( m_treeview
), wxGTK_CONV(tip
), (gchar
*) NULL
);
1064 #endif // wxUSE_TOOLTIPS
1066 GtkWidget
*wxListBox::GetConnectWidget()
1068 // the correct widget for listbox events (such as mouse clicks for example)
1069 // is m_treeview, not the parent scrolled window
1070 return GTK_WIDGET(m_treeview
);
1073 GdkWindow
*wxListBox::GTKGetWindow(wxArrayGdkWindows
& WXUNUSED(windows
)) const
1075 return gtk_tree_view_get_bin_window(m_treeview
);
1078 void wxListBox::DoApplyWidgetStyle(GtkRcStyle
*style
)
1080 if (m_hasBgCol
&& m_backgroundColour
.Ok())
1082 GdkWindow
*window
= gtk_tree_view_get_bin_window(m_treeview
);
1085 m_backgroundColour
.CalcPixel( gdk_drawable_get_colormap( window
) );
1086 gdk_window_set_background( window
, m_backgroundColour
.GetColor() );
1087 gdk_window_clear( window
);
1091 gtk_widget_modify_style( GTK_WIDGET(m_treeview
), style
);
1094 wxSize
wxListBox::DoGetBestSize() const
1096 wxCHECK_MSG(m_treeview
, wxDefaultSize
, wxT("invalid tree view"));
1098 // Start with a minimum size that's not too small
1100 GetTextExtent( wxT("X"), &cx
, &cy
);
1101 int lbWidth
= 3 * cx
;
1104 // Get the visible area of the tree view (limit to the 10th item
1105 // so that it isn't too big)
1106 unsigned int count
= GetCount();
1111 // Find the widest line
1112 for(unsigned int i
= 0; i
< count
; i
++) {
1113 wxString
str(GetString(i
));
1114 GetTextExtent(str
, &wLine
, NULL
);
1115 lbWidth
= wxMax(lbWidth
, wLine
);
1120 // And just a bit more for the checkbox if present and then some
1121 // (these are rough guesses)
1122 #if wxUSE_CHECKLISTBOX && wxUSE_NATIVEGTKCHECKLIST
1123 if ( m_hasCheckBoxes
)
1126 cy
= cy
> 25 ? cy
: 25; // rough height of checkbox
1130 // don't make the listbox too tall (limit height to around 10 items) but don't
1131 // make it too small neither
1132 lbHeight
= (cy
+4) * wxMin(wxMax(count
, 3), 10);
1135 // Add room for the scrollbar
1136 lbWidth
+= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
1138 wxSize
best(lbWidth
, lbHeight
);
1139 CacheBestSize(best
);
1145 wxListBox::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
1147 return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new
, true);
1150 #endif // wxUSE_LISTBOX