]> git.saurik.com Git - wxWidgets.git/blame - src/gtk/listbox.cpp
Invalidate only the specified rectangle
[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"
4a46cbe8 29#include "wx/gtk/treeentry_gtk.h"
291a8f20
RR
30
31#if wxUSE_TOOLTIPS
ad9835c9 32 #include "wx/tooltip.h"
291a8f20 33#endif
c801d85f 34
4a46cbe8 35#include <gtk/gtk.h>
a625c5b6 36#include <gdk/gdkkeysyms.h>
83624f79 37
66bd6b93
RR
38//-----------------------------------------------------------------------------
39// data
40//-----------------------------------------------------------------------------
41
d7fa7eaa
RR
42extern bool g_blockEventsOnDrag;
43extern bool g_blockEventsOnScroll;
caaa4cfd 44
7a30ee8f 45
4a82abc8 46
c9433ea9 47//-----------------------------------------------------------------------------
4a46cbe8 48// Macro to tell which row the strings are in (1 if native checklist, 0 if not)
c9433ea9
RR
49//-----------------------------------------------------------------------------
50
470402b9 51#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
52# define WXLISTBOX_DATACOLUMN_ARG(x) (x->m_hasCheckBoxes ? 1 : 0)
53#else
54# define WXLISTBOX_DATACOLUMN_ARG(x) (0)
470402b9 55#endif // wxUSE_CHECKLISTBOX
17a1ebd1 56
4a46cbe8 57#define WXLISTBOX_DATACOLUMN WXLISTBOX_DATACOLUMN_ARG(this)
c9433ea9
RR
58
59//-----------------------------------------------------------------------------
4a46cbe8 60// "row-activated"
c9433ea9
RR
61//-----------------------------------------------------------------------------
62
865bb325 63extern "C" {
4a46cbe8 64static void
e4161a2a 65gtk_listbox_row_activated_callback(GtkTreeView * WXUNUSED(treeview),
4a46cbe8 66 GtkTreePath *path,
e4161a2a 67 GtkTreeViewColumn * WXUNUSED(col),
4a46cbe8 68 wxListBox *listbox)
c9433ea9 69{
4a46cbe8
RR
70 if (g_blockEventsOnDrag) return;
71 if (g_blockEventsOnScroll) return;
c9433ea9 72
470402b9 73 // This is triggered by either a double-click or a space press
c9433ea9 74
4a46cbe8 75 int sel = gtk_tree_path_get_indices(path)[0];
c9433ea9 76
470402b9
RR
77 wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
78 event.SetEventObject( listbox );
acfd422a 79
470402b9 80 if (listbox->IsSelected(sel))
4a46cbe8 81 {
470402b9 82 GtkTreeEntry* entry = listbox->GtkGetEntry(sel);
f4322df6 83
470402b9 84 if (entry)
4a46cbe8 85 {
470402b9
RR
86 event.SetInt(sel);
87 event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
88
89 if ( listbox->HasClientObjectData() )
90 event.SetClientObject( (wxClientData*) gtk_tree_entry_get_userdata(entry) );
91 else if ( listbox->HasClientUntypedData() )
92 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
f4322df6 93
470402b9 94 g_object_unref (entry);
4a46cbe8 95 }
470402b9 96 else
c64371de 97 {
470402b9
RR
98 wxLogSysError(wxT("Internal error - could not get entry for double-click"));
99 event.SetInt(-1);
4a46cbe8 100 }
6c8a980f 101 }
470402b9 102 else
7a30ee8f 103 {
470402b9 104 event.SetInt(-1);
4f22cf8d
RR
105 }
106
937013e0 107 listbox->HandleWindowEvent( event );
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
b4de6e0d 122 if (listbox->HasFlag(wxLB_MULTIPLE | wxLB_EXTENDED))
159b66c0 123 {
05d790f8 124 listbox->CalcAndSendEvent();
470402b9 125 }
b4de6e0d 126 else // single selection
470402b9 127 {
05d790f8
RR
128 wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
129 event.SetEventObject( listbox );
130
470402b9
RR
131 int index = listbox->GetSelection();
132 if (index == wxNOT_FOUND)
133 {
134 // indicate that this is a deselection
135 event.SetExtraLong( 0 );
136 event.SetInt( -1 );
f4322df6 137
937013e0 138 listbox->HandleWindowEvent( event );
f4322df6 139
470402b9
RR
140 return;
141 }
142 else
143 {
144 GtkTreeEntry* entry = listbox->GtkGetEntry( index );
4a46cbe8 145
470402b9
RR
146 // indicate that this is a selection
147 event.SetExtraLong( 1 );
4a46cbe8 148
470402b9
RR
149 event.SetInt( index );
150 event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
dcf40a56 151
470402b9
RR
152 if ( listbox->HasClientObjectData() )
153 event.SetClientObject(
caf6e6de 154 (wxClientData*) gtk_tree_entry_get_userdata(entry)
4a46cbe8 155 );
470402b9
RR
156 else if ( listbox->HasClientUntypedData() )
157 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
09cf7c58 158
937013e0 159 listbox->HandleWindowEvent( event );
4a46cbe8 160
470402b9
RR
161 g_object_unref (entry);
162 }
4a46cbe8 163 }
4a46cbe8 164}
6de97a3b 165}
c801d85f 166
a625c5b6
RR
167//-----------------------------------------------------------------------------
168// "key_press_event"
169//-----------------------------------------------------------------------------
170
171extern "C" {
9ff9d30c 172static gboolean
a625c5b6
RR
173gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
174 GdkEventKey *gdk_event,
175 wxListBox *listbox )
176{
177 if ((gdk_event->keyval == GDK_Return) ||
178 (gdk_event->keyval == GDK_ISO_Enter) ||
179 (gdk_event->keyval == GDK_KP_Enter))
180 {
f796e8f0
RR
181 int index = -1;
182 if (!listbox->HasMultipleSelection())
183 index = listbox->GetSelection();
184 else
a625c5b6 185 {
f796e8f0
RR
186 wxArrayInt sels;
187 if (listbox->GetSelections( sels ) < 1)
188 return FALSE;
189 index = sels[0];
190 }
9f400412 191
f796e8f0
RR
192 if (index != wxNOT_FOUND)
193 {
a625c5b6
RR
194 wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
195 event.SetEventObject( listbox );
196
197 GtkTreeEntry* entry = listbox->GtkGetEntry( index );
198
199 // indicate that this is a selection
200 event.SetExtraLong( 1 );
201
202 event.SetInt( index );
203 event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
204
205 if ( listbox->HasClientObjectData() )
206 event.SetClientObject(
207 (wxClientData*) gtk_tree_entry_get_userdata(entry)
208 );
209 else if ( listbox->HasClientUntypedData() )
210 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
211
9f400412 212 /* bool ret = */ listbox->HandleWindowEvent( event );
a625c5b6
RR
213
214 g_object_unref (entry);
215
9f400412
RR
216// wxMac and wxMSW always invoke default action
217// if (!ret)
a625c5b6
RR
218 {
219 // DClick not handled -> invoke default action
220 wxWindow *tlw = wxGetTopLevelParent( listbox );
221 if (tlw)
222 {
223 GtkWindow *gtk_window = GTK_WINDOW( tlw->GetHandle() );
224 if (gtk_window)
225 gtk_window_activate_default( gtk_window );
226 }
227 }
228
229 // Always intercept, otherwise we'd get another dclick
230 // event from row_activated
231 return TRUE;
232 }
233 }
234
235 return FALSE;
236}
237}
238
4a46cbe8
RR
239//-----------------------------------------------------------------------------
240// GtkTreeEntry destruction (to destroy client data)
241//-----------------------------------------------------------------------------
242
865bb325 243extern "C" {
caf6e6de 244static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
4a46cbe8 245 wxListBox* listbox)
865bb325 246{
470402b9 247 if (listbox->HasClientObjectData())
4a46cbe8
RR
248 {
249 gpointer userdata = gtk_tree_entry_get_userdata(entry);
470402b9 250 if (userdata)
4a46cbe8
RR
251 delete (wxClientData *)userdata;
252 }
865bb325
VZ
253}
254}
255
4a46cbe8
RR
256//-----------------------------------------------------------------------------
257// Sorting callback (standard CmpNoCase return value)
258//-----------------------------------------------------------------------------
259
865bb325 260extern "C" {
e4161a2a 261static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model),
4a46cbe8
RR
262 GtkTreeIter *a,
263 GtkTreeIter *b,
264 wxListBox *listbox)
865bb325 265{
4a46cbe8
RR
266 GtkTreeEntry* entry;
267 GtkTreeEntry* entry2;
268
269 gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
270 a,
caf6e6de 271 WXLISTBOX_DATACOLUMN_ARG(listbox),
4a46cbe8
RR
272 &entry, -1);
273 gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
274 b,
caf6e6de 275 WXLISTBOX_DATACOLUMN_ARG(listbox),
4a46cbe8
RR
276 &entry2, -1);
277 wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
278 wxCHECK_MSG(entry2, 0, wxT("Could not get entry2"));
279
280 //We compare collate keys here instead of calling g_utf8_collate
281 //as it is rather slow (and even the docs reccommend this)
a236aa20
VZ
282 int ret = strcmp(gtk_tree_entry_get_collate_key(entry),
283 gtk_tree_entry_get_collate_key(entry2));
4a46cbe8 284
3fe39b0c
MR
285 g_object_unref (entry);
286 g_object_unref (entry2);
4a46cbe8
RR
287
288 return ret;
865bb325
VZ
289}
290}
291
a60c99e6 292//-----------------------------------------------------------------------------
4a46cbe8 293// Searching callback (TRUE == not equal, FALSE == equal)
c801d85f
KB
294//-----------------------------------------------------------------------------
295
865bb325 296extern "C" {
e4161a2a
VZ
297static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model),
298 gint WXUNUSED(column),
4a46cbe8
RR
299 const gchar* key,
300 GtkTreeIter* iter,
301 wxListBox* listbox)
f2e93537 302{
4a46cbe8
RR
303 GtkTreeEntry* entry;
304
305 gtk_tree_model_get(GTK_TREE_MODEL(listbox->m_liststore),
306 iter,
caf6e6de 307 WXLISTBOX_DATACOLUMN_ARG(listbox),
4a46cbe8
RR
308 &entry, -1);
309 wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
e808cf8a 310 wxGtkString keycollatekey(g_utf8_collate_key(key, -1));
17a1ebd1 311
a236aa20
VZ
312 int ret = strcmp(keycollatekey,
313 gtk_tree_entry_get_collate_key(entry));
17a1ebd1 314
3fe39b0c 315 g_object_unref (entry);
4a46cbe8
RR
316
317 return ret != 0;
f2e93537 318}
865bb325 319}
f2e93537
RR
320
321//-----------------------------------------------------------------------------
322// wxListBox
323//-----------------------------------------------------------------------------
324
b1294ada 325IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)
c801d85f 326
2ee3ee1b
VZ
327// ----------------------------------------------------------------------------
328// construction
329// ----------------------------------------------------------------------------
330
b6e5dfef 331void wxListBox::Init()
c801d85f 332{
d3b9f782 333 m_treeview = NULL;
88ac883a 334#if wxUSE_CHECKLISTBOX
caf6e6de 335 m_hasCheckBoxes = false;
88ac883a 336#endif // wxUSE_CHECKLISTBOX
6de97a3b 337}
c801d85f 338
584ad2a3
MB
339bool wxListBox::Create( wxWindow *parent, wxWindowID id,
340 const wxPoint &pos, const wxSize &size,
341 const wxArrayString& choices,
342 long style, const wxValidator& validator,
343 const wxString &name )
344{
345 wxCArrayString chs(choices);
346
347 return Create( parent, id, pos, size, chs.GetCount(), chs.GetStrings(),
348 style, validator, name );
349}
350
dcf40a56 351bool wxListBox::Create( wxWindow *parent, wxWindowID id,
fd0eed64
RR
352 const wxPoint &pos, const wxSize &size,
353 int n, const wxString choices[],
2ee3ee1b
VZ
354 long style, const wxValidator& validator,
355 const wxString &name )
c801d85f 356{
4dcaf11a
RR
357 if (!PreCreation( parent, pos, size ) ||
358 !CreateBase( parent, id, pos, size, style, validator, name ))
359 {
223d09f6 360 wxFAIL_MSG( wxT("wxListBox creation failed") );
caf6e6de 361 return false;
4dcaf11a 362 }
6de97a3b 363
d3b9f782 364 m_widget = gtk_scrolled_window_new( NULL, NULL );
9ff9d30c 365 g_object_ref(m_widget);
034be888
RR
366 if (style & wxLB_ALWAYS_SB)
367 {
368 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
369 GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS );
370 }
371 else
372 {
373 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
374 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
375 }
ff8bfdbb 376
6493aaca
VZ
377
378 GtkScrolledWindowSetBorder(m_widget, style);
379
4a46cbe8
RR
380 m_treeview = GTK_TREE_VIEW( gtk_tree_view_new( ) );
381
382 //wxListBox doesn't have a header :)
383 //NB: If enabled SetFirstItem doesn't work correctly
384 gtk_tree_view_set_headers_visible(m_treeview, FALSE);
385
470402b9 386#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
387 if(m_hasCheckBoxes)
388 ((wxCheckListBox*)this)->DoCreateCheckList();
470402b9 389#endif // wxUSE_CHECKLISTBOX
4a46cbe8
RR
390
391 // Create the data column
caf6e6de 392 gtk_tree_view_insert_column_with_attributes(m_treeview, -1, "",
4a46cbe8 393 gtk_cell_renderer_text_new(),
caf6e6de 394 "text",
4a46cbe8
RR
395 WXLISTBOX_DATACOLUMN, NULL);
396
397 // Now create+set the model (GtkListStore) - first argument # of columns
470402b9 398#if wxUSE_CHECKLISTBOX
4a46cbe8
RR
399 if(m_hasCheckBoxes)
400 m_liststore = gtk_list_store_new(2, G_TYPE_BOOLEAN,
401 GTK_TYPE_TREE_ENTRY);
402 else
403#endif
404 m_liststore = gtk_list_store_new(1, GTK_TYPE_TREE_ENTRY);
405
406 gtk_tree_view_set_model(m_treeview, GTK_TREE_MODEL(m_liststore));
caf6e6de 407
3fe39b0c 408 g_object_unref (m_liststore); //free on treeview destruction
caf6e6de 409
4a46cbe8
RR
410 // Disable the pop-up textctrl that enables searching - note that
411 // the docs specify that even if this disabled (which we are doing)
412 // the user can still have it through the start-interactive-search
413 // key binding...either way we want to provide a searchequal callback
caf6e6de 414 // NB: If this is enabled a doubleclick event (activate) gets sent
4a46cbe8
RR
415 // on a successful search
416 gtk_tree_view_set_search_column(m_treeview, WXLISTBOX_DATACOLUMN);
caf6e6de 417 gtk_tree_view_set_search_equal_func(m_treeview,
4a46cbe8
RR
418 (GtkTreeViewSearchEqualFunc) gtk_listbox_searchequal_callback,
419 this,
420 NULL);
421
422 gtk_tree_view_set_enable_search(m_treeview, FALSE);
423
4a82abc8 424 GtkSelectionMode mode;
b4de6e0d
VZ
425 // GTK_SELECTION_EXTENDED is a deprecated synonym for GTK_SELECTION_MULTIPLE
426 if ( style & (wxLB_MULTIPLE | wxLB_EXTENDED) )
4a82abc8 427 {
fd0eed64 428 mode = GTK_SELECTION_MULTIPLE;
4a82abc8 429 }
b4de6e0d 430 else // no multi-selection flags specified
4a82abc8 431 {
4a82abc8 432 m_windowStyle |= wxLB_SINGLE;
4fcfa27c 433 mode = GTK_SELECTION_SINGLE;
4a82abc8 434 }
6a6d4eed 435
1e6ffd66 436 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
4a46cbe8
RR
437 gtk_tree_selection_set_mode( selection, mode );
438
470402b9 439 // Handle sortable stuff
a236aa20 440 if(HasFlag(wxLB_SORT))
4a46cbe8 441 {
470402b9 442 // Setup sorting in ascending (wx) order
caf6e6de
WS
443 gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
444 WXLISTBOX_DATACOLUMN,
4a46cbe8
RR
445 GTK_SORT_ASCENDING);
446
470402b9 447 // Set the sort callback
4a46cbe8
RR
448 gtk_tree_sortable_set_sort_func(GTK_TREE_SORTABLE(m_liststore),
449 WXLISTBOX_DATACOLUMN,
450 (GtkTreeIterCompareFunc) gtk_listbox_sort_callback,
451 this, //userdata
452 NULL //"destroy notifier"
453 );
454 }
455
dcf40a56 456
dcd3c79c 457 gtk_container_add (GTK_CONTAINER (m_widget), GTK_WIDGET(m_treeview) );
caf6e6de 458
4a46cbe8 459 gtk_widget_show( GTK_WIDGET(m_treeview) );
0bb3fc29 460 m_focusWidget = GTK_WIDGET(m_treeview);
dcf40a56 461
a236aa20 462 Append(n, choices); // insert initial items
17a1ebd1 463
470402b9
RR
464 // generate dclick events
465 g_signal_connect_after(m_treeview, "row-activated",
4a46cbe8 466 G_CALLBACK(gtk_listbox_row_activated_callback), this);
2ee3ee1b 467
a625c5b6
RR
468 // for intercepting dclick generation by <ENTER>
469 g_signal_connect (m_treeview, "key_press_event",
470 G_CALLBACK (gtk_listbox_key_press_callback),
471 this);
f03fc89f 472 m_parent->DoAddChild( this );
ff8bfdbb 473
abdeb9e7 474 PostCreation(size);
170acdc9 475 SetInitialSize(size); // need this too because this is a wxControlWithItems
dcf40a56 476
1e6ffd66
RR
477 g_signal_connect_after (selection, "changed",
478 G_CALLBACK (gtk_listitem_changed_callback), this);
479
caf6e6de 480 return true;
6de97a3b 481}
c801d85f 482
fd0eed64 483wxListBox::~wxListBox()
c801d85f 484{
caf6e6de 485 m_hasVMT = false;
4a82abc8 486
caaa4cfd 487 Clear();
6de97a3b 488}
c801d85f 489
1e6ffd66
RR
490void wxListBox::GtkDisableEvents()
491{
492 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
493
494 g_signal_handlers_block_by_func(selection,
495 (gpointer) gtk_listitem_changed_callback, this);
496}
497
498void wxListBox::GtkEnableEvents()
499{
500 GtkTreeSelection* selection = gtk_tree_view_get_selection( m_treeview );
501
502 g_signal_handlers_unblock_by_func(selection,
503 (gpointer) gtk_listitem_changed_callback, this);
504
05d790f8 505 UpdateOldSelections();
1e6ffd66
RR
506}
507
937fc7db
RR
508
509void wxListBox::Update()
510{
511 wxWindow::Update();
512
513 if (m_treeview)
1975440b 514 gdk_window_process_updates(GTK_WIDGET(m_treeview)->window, TRUE);
937fc7db
RR
515}
516
8161b5b9
VZ
517// ----------------------------------------------------------------------------
518// adding items
519// ----------------------------------------------------------------------------
520
a236aa20
VZ
521int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items,
522 unsigned int pos,
523 void **clientData,
cfe8a907 524 wxClientDataType type)
bb0ca8df 525{
a236aa20 526 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
2ee3ee1b 527
9f884528
RD
528 InvalidateBestSize();
529
2eb1512a
MR
530 GtkTreeIter* pIter = NULL; // append by default
531 GtkTreeIter iter;
a236aa20 532 if ( pos != GetCount() )
bb0ca8df 533 {
a236aa20 534 wxCHECK_MSG( GtkGetIteratorFor(pos, &iter), wxNOT_FOUND,
0d5f4ba3 535 wxT("internal wxListBox error in insertion") );
bb0ca8df 536
4a46cbe8 537 pIter = &iter;
bb0ca8df 538 }
2ee3ee1b 539
a236aa20
VZ
540 const unsigned int numItems = items.GetCount();
541 for ( unsigned int i = 0; i < numItems; ++i )
2ee3ee1b 542 {
4a46cbe8 543 GtkTreeEntry* entry = gtk_tree_entry_new();
a236aa20 544 gtk_tree_entry_set_label(entry, wxGTK_CONV(items[i]));
caf6e6de 545 gtk_tree_entry_set_destroy_func(entry,
4a46cbe8 546 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
9fa72bd2 547 this);
dcf40a56 548
4a46cbe8
RR
549 GtkTreeIter itercur;
550 gtk_list_store_insert_before(m_liststore, &itercur, pIter);
c9433ea9 551
0d5f4ba3 552 GtkSetItem(itercur, entry);
fd0eed64 553
0d5f4ba3 554 g_object_unref (entry);
cfe8a907
PC
555
556 if (clientData)
557 AssignNewItemClientData(GtkGetIndexFor(itercur), clientData, i, type);
4a46cbe8 558 }
17a1ebd1 559
bc60925f
RR
560 UpdateOldSelections();
561
a236aa20 562 return pos + numItems - 1;
fd0eed64 563}
dcf40a56 564
2ee3ee1b 565// ----------------------------------------------------------------------------
8161b5b9 566// deleting items
2ee3ee1b 567// ----------------------------------------------------------------------------
ff8bfdbb 568
a236aa20 569void wxListBox::DoClear()
fd0eed64 570{
4a46cbe8 571 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
fc54776e 572
2154130c
RR
573 GtkDisableEvents(); // just in case
574
cdff1318
RD
575 InvalidateBestSize();
576
4a46cbe8 577 gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
2154130c
RR
578
579 GtkEnableEvents();
6de97a3b 580}
c801d85f 581
a236aa20 582void wxListBox::DoDeleteOneItem(unsigned int n)
c801d85f 583{
4a46cbe8 584 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
fc54776e 585
cdff1318
RD
586 InvalidateBestSize();
587
2154130c
RR
588 GtkDisableEvents(); // just in case
589
4a46cbe8 590 GtkTreeIter iter;
0d5f4ba3 591 wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("wrong listbox index") );
dcf40a56 592
0d5f4ba3
VZ
593 // this returns false if iter is invalid (e.g. deleting item at end) but
594 // since we don't use iter, we ignore the return value
4a46cbe8 595 gtk_list_store_remove(m_liststore, &iter);
2154130c
RR
596
597 GtkEnableEvents();
4a46cbe8 598}
dcf40a56 599
4a46cbe8 600// ----------------------------------------------------------------------------
0d5f4ba3 601// helper functions for working with iterators
4a46cbe8 602// ----------------------------------------------------------------------------
2ee3ee1b 603
0d5f4ba3 604bool wxListBox::GtkGetIteratorFor(unsigned pos, GtkTreeIter *iter) const
4a46cbe8 605{
0d5f4ba3
VZ
606 if ( !gtk_tree_model_iter_nth_child(GTK_TREE_MODEL(m_liststore),
607 iter, NULL, pos) )
4a46cbe8 608 {
0d5f4ba3
VZ
609 wxLogDebug(wxT("gtk_tree_model_iter_nth_child(%u) failed"), pos);
610 return false;
f5e27805 611 }
ff8bfdbb 612
0d5f4ba3
VZ
613 return true;
614}
615
616int wxListBox::GtkGetIndexFor(GtkTreeIter& iter) const
617{
618 GtkTreePath *path =
619 gtk_tree_model_get_path(GTK_TREE_MODEL(m_liststore), &iter);
620
621 gint* pIntPath = gtk_tree_path_get_indices(path);
622
623 wxCHECK_MSG( pIntPath, wxNOT_FOUND, _T("failed to get iterator path") );
624
625 int idx = pIntPath[0];
626
627 gtk_tree_path_free( path );
628
629 return idx;
630}
631
632// get GtkTreeEntry from position (note: you need to g_unref it if valid)
633GtkTreeEntry *wxListBox::GtkGetEntry(unsigned n) const
634{
635 GtkTreeIter iter;
636 if ( !GtkGetIteratorFor(n, &iter) )
637 return NULL;
638
4a46cbe8
RR
639
640 GtkTreeEntry* entry = NULL;
641 gtk_tree_model_get(GTK_TREE_MODEL(m_liststore), &iter,
642 WXLISTBOX_DATACOLUMN, &entry, -1);
643
644 return entry;
2ee3ee1b
VZ
645}
646
0d5f4ba3
VZ
647void wxListBox::GtkSetItem(GtkTreeIter& iter, const GtkTreeEntry *entry)
648{
649#if wxUSE_CHECKLISTBOX
650 if ( m_hasCheckBoxes )
651 {
652 gtk_list_store_set(m_liststore, &iter,
653 0, FALSE, // FALSE == not toggled
654 1, entry,
655 -1);
656 }
657 else
658#endif // wxUSE_CHECKLISTBOX
659 {
660 gtk_list_store_set(m_liststore, &iter, 0, entry, -1);
661 }
662}
663
8161b5b9
VZ
664// ----------------------------------------------------------------------------
665// client data
666// ----------------------------------------------------------------------------
667
aa61d352 668void* wxListBox::DoGetItemClientData(unsigned int n) const
8161b5b9 669{
aa61d352 670 wxCHECK_MSG( IsValid(n), NULL,
4a46cbe8 671 wxT("Invalid index passed to GetItemClientData") );
8161b5b9 672
4a46cbe8
RR
673 GtkTreeEntry* entry = GtkGetEntry(n);
674 wxCHECK_MSG(entry, NULL, wxT("could not get entry"));
8161b5b9 675
4a46cbe8 676 void* userdata = gtk_tree_entry_get_userdata( entry );
3fe39b0c 677 g_object_unref (entry);
4a46cbe8 678 return userdata;
8161b5b9
VZ
679}
680
aa61d352 681void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
8161b5b9 682{
aa61d352 683 wxCHECK_RET( IsValid(n),
4a46cbe8 684 wxT("Invalid index passed to SetItemClientData") );
8161b5b9 685
4a46cbe8
RR
686 GtkTreeEntry* entry = GtkGetEntry(n);
687 wxCHECK_RET(entry, wxT("could not get entry"));
8161b5b9 688
4a46cbe8 689 gtk_tree_entry_set_userdata( entry, clientData );
3fe39b0c 690 g_object_unref (entry);
8161b5b9
VZ
691}
692
2ee3ee1b
VZ
693// ----------------------------------------------------------------------------
694// string list access
695// ----------------------------------------------------------------------------
696
33c6e437 697void wxListBox::SetString(unsigned int n, const wxString& label)
2ee3ee1b 698{
8228b893 699 wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetString") );
4a46cbe8 700 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
2ee3ee1b 701
4a46cbe8
RR
702 GtkTreeEntry* entry = GtkGetEntry(n);
703 wxCHECK_RET( entry, wxT("wrong listbox index") );
2ee3ee1b 704
33c6e437
VZ
705 // update the item itself
706 gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
4a46cbe8 707
33c6e437
VZ
708 // and update the model which will refresh the tree too
709 GtkTreeIter iter;
0d5f4ba3 710 wxCHECK_RET( GtkGetIteratorFor(n, &iter), _T("failed to get iterator") );
4a46cbe8 711
0d5f4ba3
VZ
712 // FIXME: this resets the checked status of a wxCheckListBox item
713
714 GtkSetItem(iter, entry);
6de97a3b 715}
c801d85f 716
aa61d352 717wxString wxListBox::GetString(unsigned int n) const
c801d85f 718{
4a46cbe8 719 wxCHECK_MSG( m_treeview != NULL, wxEmptyString, wxT("invalid listbox") );
fc54776e 720
4a46cbe8
RR
721 GtkTreeEntry* entry = GtkGetEntry(n);
722 wxCHECK_MSG( entry, wxEmptyString, wxT("wrong listbox index") );
723
724 wxString label = wxGTK_CONV_BACK( gtk_tree_entry_get_label(entry) );
2ee3ee1b 725
3fe39b0c 726 g_object_unref (entry);
4a46cbe8 727 return label;
2ee3ee1b
VZ
728}
729
aa61d352 730unsigned int wxListBox::GetCount() const
2ee3ee1b 731{
8228b893 732 wxCHECK_MSG( m_treeview != NULL, 0, wxT("invalid listbox") );
2ee3ee1b 733
aa61d352 734 return (unsigned int)gtk_tree_model_iter_n_children(GTK_TREE_MODEL(m_liststore), NULL);
6de97a3b 735}
c801d85f 736
11e62fe6 737int wxListBox::FindString( const wxString &item, bool bCase ) const
c801d85f 738{
4a46cbe8 739 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
ff8bfdbb 740
4a46cbe8 741 //Sort of hackish - maybe there is a faster way
aa61d352 742 unsigned int nCount = wxListBox::GetCount();
ff8bfdbb 743
aa61d352 744 for(unsigned int i = 0; i < nCount; ++i)
4a46cbe8
RR
745 {
746 if( item.IsSameAs( wxListBox::GetString(i), bCase ) )
8228b893 747 return (int)i;
fd0eed64
RR
748 }
749
dcf40a56 750
4a46cbe8 751 // it's not an error if the string is not found -> no wxCHECK
2ee3ee1b 752 return wxNOT_FOUND;
6de97a3b 753}
c801d85f 754
2ee3ee1b
VZ
755// ----------------------------------------------------------------------------
756// selection
757// ----------------------------------------------------------------------------
758
fd0eed64 759int wxListBox::GetSelection() const
c801d85f 760{
e6e83933
WS
761 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox"));
762 wxCHECK_MSG( HasFlag(wxLB_SINGLE), wxNOT_FOUND,
4a46cbe8 763 wxT("must be single selection listbox"));
ff8bfdbb 764
caf6e6de 765 GtkTreeIter iter;
4a46cbe8
RR
766 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
767
caf6e6de 768 // only works on single-sel
4a46cbe8 769 if (!gtk_tree_selection_get_selected(selection, NULL, &iter))
e6e83933 770 return wxNOT_FOUND;
4a46cbe8 771
0d5f4ba3 772 return GtkGetIndexFor(iter);
6de97a3b 773}
c801d85f 774
fd0eed64 775int wxListBox::GetSelections( wxArrayInt& aSelections ) const
c801d85f 776{
e6e83933 777 wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
c801d85f 778
fd0eed64
RR
779 aSelections.Empty();
780
05d790f8 781 int i = 0;
caf6e6de 782 GtkTreeIter iter;
4a46cbe8
RR
783 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
784
785 if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(m_liststore), &iter))
786 { //gtk_tree_selection_get_selected_rows is GTK 2.2+ so iter instead
787 do
fd0eed64 788 {
4a46cbe8
RR
789 if (gtk_tree_selection_iter_is_selected(selection, &iter))
790 aSelections.Add(i);
791
792 i++;
793 } while(gtk_tree_model_iter_next(GTK_TREE_MODEL(m_liststore), &iter));
6a6d4eed 794 }
dcf40a56 795
4a46cbe8 796 return aSelections.GetCount();
6de97a3b 797}
c801d85f 798
2ee3ee1b 799bool wxListBox::IsSelected( int n ) const
c801d85f 800{
caf6e6de 801 wxCHECK_MSG( m_treeview != NULL, false, wxT("invalid listbox") );
ff8bfdbb 802
4a46cbe8 803 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
9ef6ff8c 804
4a46cbe8 805 GtkTreeIter iter;
0d5f4ba3 806 wxCHECK_MSG( GtkGetIteratorFor(n, &iter), false, wxT("Invalid index") );
9ef6ff8c 807
4a46cbe8 808 return gtk_tree_selection_iter_is_selected(selection, &iter);
6de97a3b 809}
c801d85f 810
c6179a84 811void wxListBox::DoSetSelection( int n, bool select )
c801d85f 812{
1e6ffd66
RR
813 wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
814
815 GtkDisableEvents();
816
817 GtkTreeSelection* selection = gtk_tree_view_get_selection(m_treeview);
818
ef33382e
VZ
819 // passing -1 to SetSelection() is documented to deselect all items
820 if ( n == wxNOT_FOUND )
821 {
1e6ffd66
RR
822 gtk_tree_selection_unselect_all(selection);
823 GtkEnableEvents();
470402b9 824 return;
ef33382e
VZ
825 }
826
827 wxCHECK_RET( IsValid(n), wxT("invalid index in wxListBox::SetSelection") );
828
1e6ffd66 829
4a46cbe8 830 GtkTreeIter iter;
0d5f4ba3 831 wxCHECK_RET( GtkGetIteratorFor(n, &iter), wxT("Invalid index") );
ff8bfdbb 832
fd0eed64 833 if (select)
4a46cbe8 834 gtk_tree_selection_select_iter(selection, &iter);
fd0eed64 835 else
4a46cbe8 836 gtk_tree_selection_unselect_iter(selection, &iter);
e4161a2a 837
0b2e06f9
RR
838 GtkTreePath* path = gtk_tree_model_get_path(
839 GTK_TREE_MODEL(m_liststore), &iter);
840
841 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f);
842
843 gtk_tree_path_free(path);
014b0d06 844
1e6ffd66
RR
845 GtkEnableEvents();
846}
847
0d29a482 848void wxListBox::DoScrollToCell(int n, float alignY, float alignX)
c801d85f 849{
4a46cbe8 850 wxCHECK_RET( m_treeview, wxT("invalid listbox") );
8228b893 851 wxCHECK_RET( IsValid(n), wxT("invalid index"));
9ef6ff8c 852
4a46cbe8
RR
853 //RN: I have no idea why this line is needed...
854 if (gdk_pointer_is_grabbed () && GTK_WIDGET_HAS_GRAB (m_treeview))
9ef6ff8c 855 return;
f96b15a3 856
28354d90 857 GtkTreeIter iter;
0d5f4ba3
VZ
858 if ( !GtkGetIteratorFor(n, &iter) )
859 return;
4a46cbe8 860
28354d90
VZ
861 GtkTreePath* path = gtk_tree_model_get_path(
862 GTK_TREE_MODEL(m_liststore), &iter);
9ef6ff8c 863
28354d90
VZ
864 // Scroll to the desired cell (0.0 == topleft alignment)
865 gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
0d29a482 866 TRUE, alignY, alignX);
4a46cbe8 867
28354d90 868 gtk_tree_path_free(path);
6de97a3b 869}
c801d85f 870
0d29a482
VZ
871void wxListBox::DoSetFirstItem(int n)
872{
873 DoScrollToCell(n, 0, 0);
874}
875
876void wxListBox::EnsureVisible(int n)
877{
878 DoScrollToCell(n, 0.5, 0);
879}
880
c00fed0e
VZ
881// ----------------------------------------------------------------------------
882// hittest
883// ----------------------------------------------------------------------------
884
57772185 885int wxListBox::DoListHitTest(const wxPoint& point) const
c00fed0e 886{
a183ddba
VZ
887 // gtk_tree_view_get_path_at_pos() also gets items that are not visible and
888 // we only want visible items we need to check for it manually here
22a35096 889 if ( !GetClientRect().Contains(point) )
a183ddba
VZ
890 return wxNOT_FOUND;
891
57772185 892 // need to translate from master window since it is in client coords
c00fed0e 893 gint binx, biny;
caf6e6de 894 gdk_window_get_geometry(gtk_tree_view_get_bin_window(m_treeview),
c00fed0e
VZ
895 &binx, &biny, NULL, NULL, NULL);
896
897 GtkTreePath* path;
57772185
VZ
898 if ( !gtk_tree_view_get_path_at_pos
899 (
caf6e6de 900 m_treeview,
57772185
VZ
901 point.x - binx,
902 point.y - biny,
903 &path,
904 NULL, // [out] column (always 0 here)
905 NULL, // [out] x-coord relative to the cell (not interested)
906 NULL // [out] y-coord relative to the cell
907 ) )
c00fed0e
VZ
908 {
909 return wxNOT_FOUND;
910 }
911
912 int index = gtk_tree_path_get_indices(path)[0];
913 gtk_tree_path_free(path);
914
915 return index;
916}
4a46cbe8 917
2ee3ee1b
VZ
918// ----------------------------------------------------------------------------
919// helpers
920// ----------------------------------------------------------------------------
c801d85f 921
ff8bfdbb 922#if wxUSE_TOOLTIPS
6e5f6c7c 923void wxListBox::ApplyToolTip( GtkTooltips *tips, const gchar *tip )
b1170810 924{
4a46cbe8 925 // RN: Is this needed anymore?
d3b9f782 926 gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, NULL );
b1170810 927}
ff8bfdbb 928#endif // wxUSE_TOOLTIPS
b1170810 929
fd0eed64 930GtkWidget *wxListBox::GetConnectWidget()
e3e65dac 931{
e5e41cfe
VZ
932 // the correct widget for listbox events (such as mouse clicks for example)
933 // is m_treeview, not the parent scrolled window
934 return GTK_WIDGET(m_treeview);
6de97a3b 935}
e3e65dac 936
1c2b98d6 937GdkWindow *wxListBox::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
868a2826 938{
1c2b98d6 939 return gtk_tree_view_get_bin_window(m_treeview);
868a2826 940}
e3e65dac 941
f40fdaa3 942void wxListBox::DoApplyWidgetStyle(GtkRcStyle *style)
c058d771 943{
f40fdaa3 944 if (m_hasBgCol && m_backgroundColour.Ok())
e380f72b 945 {
04e044c4 946 GdkWindow *window = gtk_tree_view_get_bin_window(m_treeview);
4a46cbe8 947 if (window)
f03fc89f 948 {
08f60019 949 m_backgroundColour.CalcPixel( gdk_drawable_get_colormap( window ) );
f03fc89f
VZ
950 gdk_window_set_background( window, m_backgroundColour.GetColor() );
951 gdk_window_clear( window );
952 }
e380f72b 953 }
ff8bfdbb 954
4a46cbe8 955 gtk_widget_modify_style( GTK_WIDGET(m_treeview), style );
68dda785 956}
dcf924a3 957
f68586e5
VZ
958wxSize wxListBox::DoGetBestSize() const
959{
4a46cbe8
RR
960 wxCHECK_MSG(m_treeview, wxDefaultSize, wxT("invalid tree view"));
961
cdff1318 962 // Start with a minimum size that's not too small
f96b15a3 963 int cx, cy;
2b5f62a0 964 GetTextExtent( wxT("X"), &cx, &cy);
47179317 965 int lbWidth = 0;
c64371de 966 int lbHeight = 10;
cdff1318 967
47179317
VZ
968 // Find the widest string.
969 const unsigned int count = GetCount();
970 if ( count )
cdff1318
RD
971 {
972 int wLine;
47179317
VZ
973 for ( unsigned int i = 0; i < count; i++ )
974 {
975 GetTextExtent(GetString(i), &wLine, NULL);
976 if ( wLine > lbWidth )
977 lbWidth = wLine;
cdff1318 978 }
47179317 979 }
cdff1318 980
47179317 981 lbWidth += 3 * cx;
cdff1318 982
47179317
VZ
983 // And just a bit more for the checkbox if present and then some
984 // (these are rough guesses)
470402b9 985#if wxUSE_CHECKLISTBOX
47179317
VZ
986 if ( m_hasCheckBoxes )
987 {
988 lbWidth += 35;
989 cy = cy > 25 ? cy : 25; // rough height of checkbox
cdff1318 990 }
47179317 991#endif
caf6e6de 992
cdff1318
RD
993 // Add room for the scrollbar
994 lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
f96b15a3 995
47179317
VZ
996 // Don't make the listbox too tall but don't make it too small neither
997 lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
998
9f884528 999 wxSize best(lbWidth, lbHeight);
17a1ebd1 1000 CacheBestSize(best);
9f884528 1001 return best;
f68586e5
VZ
1002}
1003
9d522606
RD
1004// static
1005wxVisualAttributes
1006wxListBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
1007{
4a46cbe8 1008 return GetDefaultAttributesFromGTKWidget(gtk_tree_view_new, true);
9d522606
RD
1009}
1010
3ae4c570 1011#endif // wxUSE_LISTBOX