]> git.saurik.com Git - wxWidgets.git/blame - src/gtk/listbox.cpp
supporting full style mask
[wxWidgets.git] / src / gtk / listbox.cpp
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
11e62fe6 2// Name: src/gtk/listbox.cpp
c801d85f
KB
3// Purpose:
4// Author: Robert Roebling
4a46cbe8 5// Modified By: Ryan Norton (GtkTreeView implementation)
f96aa4d9
RR
6// Id: $Id$
7// Copyright: (c) 1998 Robert Roebling
65571936 8// Licence: wxWindows licence
c801d85f
KB
9/////////////////////////////////////////////////////////////////////////////
10
14f355c2
VS
11// For compilers that support precompilation, includes "wx.h".
12#include "wx/wxprec.h"
13
dcf924a3
RR
14#if wxUSE_LISTBOX
15
88a7a4e1
WS
16#include "wx/listbox.h"
17
ad9835c9
WS
18#ifndef WX_PRECOMP
19 #include "wx/dynarray.h"
88a7a4e1 20 #include "wx/intl.h"
e4db172a 21 #include "wx/log.h"
de6185e2 22 #include "wx/utils.h"
9eddec69 23 #include "wx/settings.h"
e6e83933 24 #include "wx/checklst.h"
aaa6d89a 25 #include "wx/arrstr.h"
ad9835c9
WS
26#endif
27
fab591c5 28#include "wx/gtk/private.h"
00d45d04 29#include "wx/gtk/private/object.h"
4a46cbe8 30#include "wx/gtk/treeentry_gtk.h"
291a8f20
RR
31
32#if wxUSE_TOOLTIPS
ad9835c9 33 #include "wx/tooltip.h"
291a8f20 34#endif
c801d85f 35
4a46cbe8 36#include <gtk/gtk.h>
14b44999 37
a625c5b6 38#include <gdk/gdkkeysyms.h>
14b44999
VS
39#if GTK_CHECK_VERSION(3,0,0)
40#include <gdk/gdkkeysyms-compat.h>
41#endif
83624f79 42
66bd6b93
RR
43//-----------------------------------------------------------------------------
44// data
45//-----------------------------------------------------------------------------
46
d7fa7eaa
RR
47extern bool g_blockEventsOnDrag;
48extern bool g_blockEventsOnScroll;
caaa4cfd 49
7a30ee8f 50
4a82abc8 51
c9433ea9 52//-----------------------------------------------------------------------------
4a46cbe8 53// Macro to tell which row the strings are in (1 if native checklist, 0 if not)
c9433ea9
RR
54//-----------------------------------------------------------------------------
55
470402b9 56#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
57# define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0)
58#else
59# define WXLISTBOX_DATACOLUMN_ARG(x) (0)
470402b9 60#endif // wxUSE_CHECKLISTBOX
17a1ebd1 61
4a46cbe8 62#define WXLISTBOX_DATACOLUMN WXLISTBOX_DATACOLUMN_ARG(this)
c9433ea9 63
00d45d04
VZ
64// ----------------------------------------------------------------------------
65// helper functions
66// ----------------------------------------------------------------------------
67
68namespace
69{
70
71// Return the entry for the given listbox item.
72//
73// Return value must be released by caller if non-NULL.
74GtkTreeEntry *
75GetEntry(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
c9433ea9 89//-----------------------------------------------------------------------------
4a46cbe8 90// "row-activated"
c9433ea9
RR
91//-----------------------------------------------------------------------------
92
865bb325 93extern "C" {
4a46cbe8 94static void
e4161a2a 95gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview),
4a46cbe8 96 GtkTreePath *path,
e4161a2a 97 GtkTreeViewColumn * WXUNUSED(col),
4a46cbe8 98 wxListBox *listbox)
c9433ea9 99{
4a46cbe8
RR
100 if (g_blockEventsOnDrag) return;
101 if (g_blockEventsOnScroll) return;
c9433ea9 102
470402b9 103 // This is triggered by either a double-click or a space press
c9433ea9 104
4a46cbe8 105 int sel = gtk_tree_path_get_indices(path)[0];
c9433ea9 106
09e744f5 107 listbox->GTKOnActivated(sel);
caaa4cfd 108}
865bb325 109}
66bd6b93 110
c801d85f 111//-----------------------------------------------------------------------------
470402b9 112// "changed"
c801d85f
KB
113//-----------------------------------------------------------------------------
114
4a46cbe8 115extern "C" {
470402b9 116static void
e4161a2a
VZ
117gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection),
118 wxListBox *listbox )
c801d85f 119{
470402b9 120 if (g_blockEventsOnDrag) return;
f4322df6 121
24ee1bef 122 listbox->GTKOnSelectionChanged();
4a46cbe8 123}
24ee1bef 124
6de97a3b 125}
c801d85f 126
a625c5b6
RR
127//-----------------------------------------------------------------------------
128// "key_press_event"
129//-----------------------------------------------------------------------------
130
131extern "C" {
9ff9d30c 132static gboolean
a625c5b6
RR
133gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
134 GdkEventKey *gdk_event,
135 wxListBox *listbox )
136{
03647350 137 if ((gdk_event->keyval == GDK_Return) ||
a625c5b6
RR
138 (gdk_event->keyval == GDK_ISO_Enter) ||
139 (gdk_event->keyval == GDK_KP_Enter))
140 {
f796e8f0
RR
141 int index = -1;
142 if (!listbox->HasMultipleSelection())
143 index = listbox->GetSelection();
144 else
a625c5b6 145 {
f796e8f0
RR
146 wxArrayInt sels;
147 if (listbox->GetSelections( sels ) < 1)
148 return FALSE;
149 index = sels[0];
150 }
03647350 151
f796e8f0
RR
152 if (index != wxNOT_FOUND)
153 {
09e744f5 154 listbox->GTKOnActivated(index);
03647350 155
9f400412
RR
156// wxMac and wxMSW always invoke default action
157// if (!ret)
a625c5b6
RR
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 }
03647350 168
a625c5b6
RR
169 // Always intercept, otherwise we'd get another dclick
170 // event from row_activated
171 return TRUE;
172 }
173 }
03647350 174
a625c5b6
RR
175 return FALSE;
176}
177}
178
4a46cbe8
RR
179//-----------------------------------------------------------------------------
180// GtkTreeEntry destruction (to destroy client data)
181//-----------------------------------------------------------------------------
182
865bb325 183extern "C" {
caf6e6de 184static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
4a46cbe8 185 wxListBox* listbox)
865bb325 186{
470402b9 187 if (listbox->HasClientObjectData())
4a46cbe8
RR
188 {
189 gpointer userdata = gtk_tree_entry_get_userdata(entry);
470402b9 190 if (userdata)
4a46cbe8
RR
191 delete (wxClientData *)userdata;
192 }
865bb325
VZ
193}
194}
195
4a46cbe8
RR
196//-----------------------------------------------------------------------------
197// Sorting callback (standard CmpNoCase return value)
198//-----------------------------------------------------------------------------
199
865bb325 200extern "C" {
e4161a2a 201static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model),
4a46cbe8
RR
202 GtkTreeIter *a,
203 GtkTreeIter *b,
204 wxListBox *listbox)
865bb325 205{
00d45d04
VZ
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"));
4a46cbe8
RR
211
212 //We compare collate keys here instead of calling g_utf8_collate
213 //as it is rather slow (and even the docs reccommend this)
00d45d04
VZ
214 return strcmp(gtk_tree_entry_get_collate_key(entry1),
215 gtk_tree_entry_get_collate_key(entry2)) >= 0;
865bb325
VZ
216}
217}
218
a60c99e6 219//-----------------------------------------------------------------------------
4a46cbe8 220// Searching callback (TRUE == not equal, FALSE == equal)
c801d85f
KB
221//-----------------------------------------------------------------------------
222
865bb325 223extern "C" {
e4161a2a
VZ
224static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model),
225 gint WXUNUSED(column),
4a46cbe8
RR
226 const gchar* key,
227 GtkTreeIter* iter,
228 wxListBox* listbox)
f2e93537 229{
00d45d04
VZ
230 wxGtkObject<GtkTreeEntry>
231 entry(GetEntry(listbox->m_liststore, iter, listbox));
4a46cbe8 232 wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
17a1ebd1 233
00d45d04 234 wxGtkString keycollatekey(g_utf8_collate_key(key, -1));
4a46cbe8 235
00d45d04 236 return strcmp(keycollatekey, gtk_tree_entry_get_collate_key(entry)) != 0;
f2e93537 237}
865bb325 238}
f2e93537
RR
239
240//-----------------------------------------------------------------------------
241// wxListBox
242//-----------------------------------------------------------------------------
243
2ee3ee1b
VZ
244// ----------------------------------------------------------------------------
245// construction
246// ----------------------------------------------------------------------------
247
b6e5dfef 248void wxListBox::Init()
c801d85f 249{
d3b9f782 250 m_treeview = NULL;
88ac883a 251#if wxUSE_CHECKLISTBOX
caf6e6de 252 m_hasCheckBoxes = false;
88ac883a 253#endif // wxUSE_CHECKLISTBOX
6de97a3b 254}
c801d85f 255
584ad2a3
MB
256bool 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
dcf40a56 268bool wxListBox::Create( wxWindow *parent, wxWindowID id,
fd0eed64
RR
269 const wxPoint &pos, const wxSize &size,
270 int n, const wxString choices[],
2ee3ee1b
VZ
271 long style, const wxValidator& validator,
272 const wxString &name )
c801d85f 273{
4dcaf11a
RR
274 if (!PreCreation( parent, pos, size ) ||
275 !CreateBase( parent, id, pos, size, style, validator, name ))
276 {
223d09f6 277 wxFAIL_MSG( wxT("wxListBox creation failed") );
caf6e6de 278 return false;
4dcaf11a 279 }
6de97a3b 280
d3b9f782 281 m_widget = gtk_scrolled_window_new( NULL, NULL );
9ff9d30c 282 g_object_ref(m_widget);
034be888
RR
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 }
ff8bfdbb 293
6493aaca 294
496e7ec6 295 GTKScrolledWindowSetBorder(m_widget, style);
6493aaca 296
4a46cbe8
RR
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
470402b9 303#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
304 if(m_hasCheckBoxes)
305 ((wxCheckListBox*)this)->DoCreateCheckList();
470402b9 306#endif // wxUSE_CHECKLISTBOX
4a46cbe8
RR
307
308 // Create the data column
caf6e6de 309 gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "",
4a46cbe8 310 gtk_cell_renderer_text_new(),
caf6e6de 311 "text",
4a46cbe8
RR
312 WXLISTBOX_DATACOLUMN, NULL);
313
314 // Now create+set the model (GtkListStore) - first argument # of columns
470402b9 315#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
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));
caf6e6de 324
3fe39b0c 325 g_object_unref (m_liststore); //free on treeview destruction
caf6e6de 326
4a46cbe8
RR
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
caf6e6de 331 // NB: If this is enabled a doubleclick event (activate) gets sent
4a46cbe8
RR
332 // on a successful search
333 gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN);
caf6e6de 334 gtk_tree_view_set_search_equal_func(m_treeview,
4a46cbe8
RR
335 (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback,
336 this,
337 NULL);
338
339 gtk_tree_view_set_enable_search(m_treeview, FALSE);
340
4a82abc8 341 GtkSelectionMode mode;
b4de6e0d
VZ
342 // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE
343 if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) )
4a82abc8 344 {
fd0eed64 345 mode = GTK_SELECTION_MULTIPLE;
4a82abc8 346 }
b4de6e0d 347 else // no multi-selection flags specified
4a82abc8 348 {
4a82abc8 349 m_windowStyle |= wxLB_SINGLE;
1d919083
VZ
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;
4a82abc8 356 }
6a6d4eed 357
1e6ffd66 358 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
4a46cbe8
RR
359 gtk_tree_selection_set_mode( selection, mode );
360
470402b9 361 // Handle sortable stuff
a236aa20 362 if(HasFlag(wxLB_SORT))
4a46cbe8 363 {
470402b9 364 // Setup sorting in ascending (wx) order
caf6e6de
WS
365 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
366 WXLISTBOX_DATACOLUMN,
4a46cbe8
RR
367 GTK_SORT_ASCENDING);
368
470402b9 369 // Set the sort callback
4a46cbe8
RR
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
dcf40a56 378
dcd3c79c 379 gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) );
caf6e6de 380
4a46cbe8 381 gtk_widget_show( GTK_WIDGET(m_treeview) );
0bb3fc29 382 m_focusWidget = GTK_WIDGET(m_treeview);
dcf40a56 383
a236aa20 384 Append(n, choices); // insert initial items
17a1ebd1 385
470402b9
RR
386 // generate dclick events
387 g_signal_connect_after(m_treeview, "row-activated",
4a46cbe8 388 G_CALLBACK(gtk_listbox_row_activated_callback), this);
2ee3ee1b 389
a625c5b6
RR
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);
f03fc89f 394 m_parent->DoAddChild( this );
ff8bfdbb 395
abdeb9e7 396 PostCreation(size);
170acdc9 397 SetInitialSize(size); // need this too because this is a wxControlWithItems
dcf40a56 398
1e6ffd66
RR
399 g_signal_connect_after (selection, "changed",
400 G_CALLBACK (gtk_listitem_changed_callback), this);
03647350 401
caf6e6de 402 return true;
6de97a3b 403}
c801d85f 404
fd0eed64 405wxListBox::~wxListBox()
c801d85f 406{
caf6e6de 407 m_hasVMT = false;
4a82abc8 408
caaa4cfd 409 Clear();
6de97a3b 410}
c801d85f 411
dec7b5a8 412void wxListBox::GTKDisableEvents()
1e6ffd66
RR
413{
414 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
415
416 g_signal_handlers_block_by_func(selection,
417 (gpointer) gtk_listitem_changed_callback, this);
418}
419
dec7b5a8 420void wxListBox::GTKEnableEvents()
1e6ffd66
RR
421{
422 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
423
424 g_signal_handlers_unblock_by_func(selection,
425 (gpointer) gtk_listitem_changed_callback, this);
03647350 426
05d790f8 427 UpdateOldSelections();
1e6ffd66
RR
428}
429
937fc7db
RR
430
431void wxListBox::Update()
432{
433 wxWindow::Update();
03647350 434
937fc7db 435 if (m_treeview)
385e8575 436 gdk_window_process_updates(gtk_widget_get_window(GTK_WIDGET(m_treeview)), true);
937fc7db
RR
437}
438
8161b5b9
VZ
439// ----------------------------------------------------------------------------
440// adding items
441// ----------------------------------------------------------------------------
442
a236aa20
VZ
443int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items,
444 unsigned int pos,
445 void **clientData,
cfe8a907 446 wxClientDataType type)
bb0ca8df 447{
a236aa20 448 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
2ee3ee1b 449
9f884528
RD
450 InvalidateBestSize();
451
2eb1512a
MR
452 GtkTreeIter* pIter = NULL; // append by default
453 GtkTreeIter iter;
a236aa20 454 if ( pos != GetCount() )
bb0ca8df 455 {
dec7b5a8 456 wxCHECK_MSG( GTKGetIteratorFor(pos, &iter), wxNOT_FOUND,
0d5f4ba3 457 wxT("internal wxListBox error in insertion") );
bb0ca8df 458
4a46cbe8 459 pIter = &iter;
bb0ca8df 460 }
2ee3ee1b 461
a236aa20
VZ
462 const unsigned int numItems = items.GetCount();
463 for ( unsigned int i = 0; i < numItems; ++i )
2ee3ee1b 464 {
00d45d04 465 wxGtkObject<GtkTreeEntry> entry(gtk_tree_entry_new());
a236aa20 466 gtk_tree_entry_set_label(entry, wxGTK_CONV(items[i]));
caf6e6de 467 gtk_tree_entry_set_destroy_func(entry,
4a46cbe8 468 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
9fa72bd2 469 this);
dcf40a56 470
4a46cbe8
RR
471 GtkTreeIter itercur;
472 gtk_list_store_insert_before(m_liststore, &itercur, pIter);
c9433ea9 473
dec7b5a8 474 GTKSetItem(itercur, entry);
fd0eed64 475
cfe8a907 476 if (clientData)
dec7b5a8 477 AssignNewItemClientData(GTKGetIndexFor(itercur), clientData, i, type);
4a46cbe8 478 }
17a1ebd1 479
bc60925f
RR
480 UpdateOldSelections();
481
a236aa20 482 return pos + numItems - 1;
fd0eed64 483}
dcf40a56 484
2ee3ee1b 485// ----------------------------------------------------------------------------
8161b5b9 486// deleting items
2ee3ee1b 487// ----------------------------------------------------------------------------
ff8bfdbb 488
a236aa20 489void wxListBox::DoClear()
fd0eed64 490{
4a46cbe8 491 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
fc54776e 492
dec7b5a8 493 GTKDisableEvents(); // just in case
2154130c 494
cdff1318
RD
495 InvalidateBestSize();
496
4a46cbe8 497 gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
03647350 498
dec7b5a8 499 GTKEnableEvents();
6de97a3b 500}
c801d85f 501
a236aa20 502void wxListBox::DoDeleteOneItem(unsigned int n)
c801d85f 503{
4a46cbe8 504 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
fc54776e 505
cdff1318
RD
506 InvalidateBestSize();
507
dec7b5a8 508 GTKDisableEvents(); // just in case
2154130c 509
4a46cbe8 510 GtkTreeIter iter;
dec7b5a8 511 wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("wrong listbox index") );
dcf40a56 512
0d5f4ba3
VZ
513 // this returns false if iter is invalid (e.g. deleting item at end) but
514 // since we don't use iter, we ignore the return value
4a46cbe8 515 gtk_list_store_remove(m_liststore, &iter);
03647350 516
dec7b5a8 517 GTKEnableEvents();
4a46cbe8 518}
dcf40a56 519
4a46cbe8 520// ----------------------------------------------------------------------------
0d5f4ba3 521// helper functions for working with iterators
4a46cbe8 522// ----------------------------------------------------------------------------
2ee3ee1b 523
dec7b5a8 524bool wxListBox::GTKGetIteratorFor(unsigned pos, GtkTreeIter *iter) const
4a46cbe8 525{
0d5f4ba3
VZ
526 if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore),
527 iter, NULL, pos) )
4a46cbe8 528 {
0d5f4ba3
VZ
529 wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos);
530 return false;
f5e27805 531 }
ff8bfdbb 532
0d5f4ba3
VZ
533 return true;
534}
535
dec7b5a8 536int wxListBox::GTKGetIndexFor(GtkTreeIter& iter) const
0d5f4ba3
VZ
537{
538 GtkTreePath *path =
539 gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter);
540
541 gint* pIntPath = gtk_tree_path_get_indices(path);
542
9a83f860 543 wxCHECK_MSG( pIntPath, wxNOT_FOUND, wxT("failed to get iterator path") );
0d5f4ba3
VZ
544
545 int idx = pIntPath[0];
546
547 gtk_tree_path_free( path );
548
549 return idx;
550}
551
552// get GtkTreeEntry from position (note: you need to g_unref it if valid)
dec7b5a8 553GtkTreeEntry *wxListBox::GTKGetEntry(unsigned n) const
0d5f4ba3
VZ
554{
555 GtkTreeIter iter;
dec7b5a8 556 if ( !GTKGetIteratorFor(n, &iter) )
0d5f4ba3
VZ
557 return NULL;
558
00d45d04 559 return GetEntry(m_liststore, &iter, this);
2ee3ee1b
VZ
560}
561
dec7b5a8 562void wxListBox::GTKSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry)
0d5f4ba3
VZ
563{
564#if wxUSE_CHECKLISTBOX
565 if ( m_hasCheckBoxes )
566 {
567 gtk_list_store_set(m_liststore, &iter,
568 0, FALSE, // FALSE == not toggled
569 1, entry,
570 -1);
571 }
572 else
573#endif // wxUSE_CHECKLISTBOX
574 {
575 gtk_list_store_set(m_liststore, &iter, 0, entry, -1);
576 }
577}
578
8161b5b9
VZ
579// ----------------------------------------------------------------------------
580// client data
581// ----------------------------------------------------------------------------
582
aa61d352 583void* wxListBox::DoGetItemClientData(unsigned int n) const
8161b5b9 584{
00d45d04 585 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
4a46cbe8 586 wxCHECK_MSG(entry, NULL, wxT("could not get entry"));
8161b5b9 587
00d45d04 588 return gtk_tree_entry_get_userdata( entry );
8161b5b9
VZ
589}
590
aa61d352 591void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
8161b5b9 592{
00d45d04 593 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
4a46cbe8 594 wxCHECK_RET(entry, wxT("could not get entry"));
8161b5b9 595
4a46cbe8 596 gtk_tree_entry_set_userdata( entry, clientData );
8161b5b9
VZ
597}
598
2ee3ee1b
VZ
599// ----------------------------------------------------------------------------
600// string list access
601// ----------------------------------------------------------------------------
602
33c6e437 603void wxListBox::SetString(unsigned int n, const wxString& label)
2ee3ee1b 604{
8228b893 605 wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") );
4a46cbe8 606 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
2ee3ee1b 607
dec7b5a8 608 GtkTreeEntry* entry = GTKGetEntry(n);
4a46cbe8 609 wxCHECK_RET( entry, wxT("wrong listbox index") );
2ee3ee1b 610
33c6e437
VZ
611 // update the item itself
612 gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
4a46cbe8 613
33c6e437
VZ
614 // and update the model which will refresh the tree too
615 GtkTreeIter iter;
dec7b5a8 616 wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("failed to get iterator") );
4a46cbe8 617
0d5f4ba3
VZ
618 // FIXME: this resets the checked status of a wxCheckListBox item
619
dec7b5a8 620 GTKSetItem(iter, entry);
6de97a3b 621}
c801d85f 622
aa61d352 623wxString wxListBox::GetString(unsigned int n) const
c801d85f 624{
4a46cbe8 625 wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") );
fc54776e 626
00d45d04 627 wxGtkObject<GtkTreeEntry> entry(GTKGetEntry(n));
4a46cbe8
RR
628 wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") );
629
00d45d04 630 return wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) );
2ee3ee1b
VZ
631}
632
aa61d352 633unsigned int wxListBox::GetCount() const
2ee3ee1b 634{
8228b893 635 wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") );
2ee3ee1b 636
aa61d352 637 return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL);
6de97a3b 638}
c801d85f 639
11e62fe6 640int wxListBox::FindString( const wxString &item, bool bCase ) const
c801d85f 641{
4a46cbe8 642 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
ff8bfdbb 643
4a46cbe8 644 //Sort of hackish - maybe there is a faster way
aa61d352 645 unsigned int nCount = wxListBox::GetCount();
ff8bfdbb 646
aa61d352 647 for(unsigned int i = 0; i < nCount; ++i)
4a46cbe8
RR
648 {
649 if( item.IsSameAs( wxListBox::GetString(i), bCase ) )
8228b893 650 return (int)i;
fd0eed64
RR
651 }
652
dcf40a56 653
4a46cbe8 654 // it's not an error if the string is not found -> no wxCHECK
2ee3ee1b 655 return wxNOT_FOUND;
6de97a3b 656}
c801d85f 657
2ee3ee1b
VZ
658// ----------------------------------------------------------------------------
659// selection
660// ----------------------------------------------------------------------------
661
09e744f5
VZ
662void wxListBox::GTKOnActivated(int item)
663{
664 SendEvent(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, item, IsSelected(item));
665}
666
24ee1bef
VZ
667void wxListBox::GTKOnSelectionChanged()
668{
669 if ( HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED) )
670 {
671 CalcAndSendEvent();
672 }
673 else // single selection
674 {
09e744f5
VZ
675 const int item = GetSelection();
676 if ( DoChangeSingleSelection(item) )
677 SendEvent(wxEVT_COMMAND_LISTBOX_SELECTED, item, true);
24ee1bef
VZ
678 }
679}
680
fd0eed64 681int wxListBox::GetSelection() const
c801d85f 682{
e6e83933
WS
683 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox"));
684 wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND,
4a46cbe8 685 wxT("must be single selection listbox"));
ff8bfdbb 686
caf6e6de 687 GtkTreeIter iter;
4a46cbe8
RR
688 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
689
caf6e6de 690 // only works on single-sel
4a46cbe8 691 if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
e6e83933 692 return wxNOT_FOUND;
4a46cbe8 693
dec7b5a8 694 return GTKGetIndexFor(iter);
6de97a3b 695}
c801d85f 696
fd0eed64 697int wxListBox::GetSelections( wxArrayInt& aSelections ) const
c801d85f 698{
e6e83933 699 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
c801d85f 700
fd0eed64
RR
701 aSelections.Empty();
702
05d790f8 703 int i = 0;
caf6e6de 704 GtkTreeIter iter;
4a46cbe8
RR
705 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
706
707 if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter))
708 { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
709 do
fd0eed64 710 {
4a46cbe8
RR
711 if (gtk_tree_selection_iter_is_selected(selection, &iter))
712 aSelections.Add(i);
713
714 i++;
715 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter));
6a6d4eed 716 }
dcf40a56 717
4a46cbe8 718 return aSelections.GetCount();
6de97a3b 719}
c801d85f 720
2ee3ee1b 721bool wxListBox::IsSelected( int n ) const
c801d85f 722{
caf6e6de 723 wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") );
ff8bfdbb 724
4a46cbe8 725 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
9ef6ff8c 726
4a46cbe8 727 GtkTreeIter iter;
dec7b5a8 728 wxCHECK_MSG( GTKGetIteratorFor(n, &iter), false, wxT("Invalid index") );
9ef6ff8c 729
4a46cbe8 730 return gtk_tree_selection_iter_is_selected(selection, &iter);
6de97a3b 731}
c801d85f 732
c6179a84 733void wxListBox::DoSetSelection( int n, bool select )
c801d85f 734{
1e6ffd66
RR
735 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
736
dec7b5a8 737 GTKDisableEvents();
03647350 738
1e6ffd66
RR
739 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
740
ef33382e
VZ
741 // passing -1 to SetSelection() is documented to deselect all items
742 if ( n == wxNOT_FOUND )
743 {
1e6ffd66 744 gtk_tree_selection_unselect_all(selection);
dec7b5a8 745 GTKEnableEvents();
470402b9 746 return;
ef33382e
VZ
747 }
748
749 wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
750
03647350 751
4a46cbe8 752 GtkTreeIter iter;
dec7b5a8 753 wxCHECK_RET( GTKGetIteratorFor(n, &iter), wxT("Invalid index") );
ff8bfdbb 754
fd0eed64 755 if (select)
4a46cbe8 756 gtk_tree_selection_select_iter(selection, &iter);
fd0eed64 757 else
4a46cbe8 758 gtk_tree_selection_unselect_iter(selection, &iter);
e4161a2a 759
0b2e06f9
RR
760 GtkTreePath* path = gtk_tree_model_get_path(
761 GTK_TREE_MODEL(m_liststore), &iter);
762
763 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f);
764
765 gtk_tree_path_free(path);
014b0d06 766
dec7b5a8 767 GTKEnableEvents();
1e6ffd66
RR
768}
769
0d29a482 770void wxListBox::DoScrollToCell(int n, float alignY, float alignX)
c801d85f 771{
4a46cbe8 772 wxCHECK_RET( m_treeview, wxT("invalid listbox") );
8228b893 773 wxCHECK_RET( IsValid(n), wxT("invalid index"));
9ef6ff8c 774
4a46cbe8 775 //RN: I have no idea why this line is needed...
fc9ab22a 776 if (gdk_pointer_is_grabbed () && gtk_widget_has_grab(GTK_WIDGET(m_treeview)))
9ef6ff8c 777 return;
f96b15a3 778
28354d90 779 GtkTreeIter iter;
dec7b5a8 780 if ( !GTKGetIteratorFor(n, &iter) )
0d5f4ba3 781 return;
4a46cbe8 782
28354d90
VZ
783 GtkTreePath* path = gtk_tree_model_get_path(
784 GTK_TREE_MODEL(m_liststore), &iter);
9ef6ff8c 785
28354d90
VZ
786 // Scroll to the desired cell (0.0 == topleft alignment)
787 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
0d29a482 788 TRUE, alignY, alignX);
4a46cbe8 789
28354d90 790 gtk_tree_path_free(path);
6de97a3b 791}
c801d85f 792
0d29a482
VZ
793void wxListBox::DoSetFirstItem(int n)
794{
795 DoScrollToCell(n, 0, 0);
796}
797
798void wxListBox::EnsureVisible(int n)
799{
800 DoScrollToCell(n, 0.5, 0);
801}
802
c00fed0e
VZ
803// ----------------------------------------------------------------------------
804// hittest
805// ----------------------------------------------------------------------------
806
57772185 807int wxListBox::DoListHitTest(const wxPoint& point) const
c00fed0e 808{
a183ddba
VZ
809 // gtk_tree_view_get_path_at_pos() also gets items that are not visible and
810 // we only want visible items we need to check for it manually here
22a35096 811 if ( !GetClientRect().Contains(point) )
a183ddba
VZ
812 return wxNOT_FOUND;
813
57772185 814 // need to translate from master window since it is in client coords
c00fed0e 815 gint binx, biny;
caf6e6de 816 gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview),
c00fed0e
VZ
817 &binx, &biny, NULL, NULL, NULL);
818
819 GtkTreePath* path;
57772185
VZ
820 if ( !gtk_tree_view_get_path_at_pos
821 (
caf6e6de 822 m_treeview,
57772185
VZ
823 point.x - binx,
824 point.y - biny,
825 &path,
826 NULL, // [out] column (always 0 here)
827 NULL, // [out] x-coord relative to the cell (not interested)
828 NULL // [out] y-coord relative to the cell
829 ) )
c00fed0e
VZ
830 {
831 return wxNOT_FOUND;
832 }
833
834 int index = gtk_tree_path_get_indices(path)[0];
835 gtk_tree_path_free(path);
836
837 return index;
838}
4a46cbe8 839
2ee3ee1b
VZ
840// ----------------------------------------------------------------------------
841// helpers
842// ----------------------------------------------------------------------------
c801d85f 843
fd0eed64 844GtkWidget *wxListBox::GetConnectWidget()
e3e65dac 845{
e5e41cfe
VZ
846 // the correct widget for listbox events (such as mouse clicks for example)
847 // is m_treeview, not the parent scrolled window
848 return GTK_WIDGET(m_treeview);
6de97a3b 849}
e3e65dac 850
1c2b98d6 851GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
868a2826 852{
1c2b98d6 853 return gtk_tree_view_get_bin_window(m_treeview);
868a2826 854}
e3e65dac 855
f40fdaa3 856void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
c058d771 857{
a1b806b9 858 if (m_hasBgCol && m_backgroundColour.IsOk())
e380f72b 859 {
04e044c4 860 GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
4a46cbe8 861 if (window)
f03fc89f 862 {
08f60019 863 m_backgroundColour.CalcPixel( gdk_drawable_get_colormap( window ) );
f03fc89f
VZ
864 gdk_window_set_background( window, m_backgroundColour.GetColor() );
865 gdk_window_clear( window );
866 }
e380f72b 867 }
ff8bfdbb 868
4a46cbe8 869 gtk_widget_modify_style( GTK_WIDGET(m_treeview), style );
68dda785 870}
dcf924a3 871
f68586e5
VZ
872wxSize wxListBox::DoGetBestSize() const
873{
4a46cbe8
RR
874 wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view"));
875
cdff1318 876 // Start with a minimum size that's not too small
f96b15a3 877 int cx, cy;
2b5f62a0 878 GetTextExtent( wxT("X"), &cx, &cy);
47179317 879 int lbWidth = 0;
c64371de 880 int lbHeight = 10;
cdff1318 881
47179317
VZ
882 // Find the widest string.
883 const unsigned int count = GetCount();
884 if ( count )
cdff1318
RD
885 {
886 int wLine;
47179317
VZ
887 for ( unsigned int i = 0; i < count; i++ )
888 {
889 GetTextExtent(GetString(i), &wLine, NULL);
890 if ( wLine > lbWidth )
891 lbWidth = wLine;
cdff1318 892 }
47179317 893 }
cdff1318 894
47179317 895 lbWidth += 3 * cx;
cdff1318 896
47179317
VZ
897 // And just a bit more for the checkbox if present and then some
898 // (these are rough guesses)
470402b9 899#if wxUSE_CHECKLISTBOX
47179317
VZ
900 if ( m_hasCheckBoxes )
901 {
902 lbWidth += 35;
903 cy = cy > 25 ? cy : 25; // rough height of checkbox
cdff1318 904 }
47179317 905#endif
caf6e6de 906
cdff1318
RD
907 // Add room for the scrollbar
908 lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
f96b15a3 909
47179317
VZ
910 // Don't make the listbox too tall but don't make it too small neither
911 lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
912
9f884528 913 wxSize best(lbWidth, lbHeight);
17a1ebd1 914 CacheBestSize(best);
9f884528 915 return best;
f68586e5
VZ
916}
917
9d522606
RD
918// static
919wxVisualAttributes
920wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
921{
4a46cbe8 922 return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new, true);
9d522606
RD
923}
924
3ae4c570 925#endif // wxUSE_LISTBOX