image update
[wxWidgets.git] / src / gtk / listbox.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: listbox.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10
11 #ifdef __GNUG__
12 #pragma implementation "listbox.h"
13 #endif
14
15 #include "wx/dynarray.h"
16 #include "wx/listbox.h"
17 #include "wx/utils.h"
18 #include "wx/intl.h"
19 #include "wx/checklst.h"
20
21 #if wxUSE_DRAG_AND_DROP
22 #include "wx/dnd.h"
23 #endif
24
25 #include "gdk/gdk.h"
26 #include "gtk/gtk.h"
27
28 //-------------------------------------------------------------------------
29 // conditional compilation
30 //-------------------------------------------------------------------------
31
32 #if (GTK_MINOR_VERSION == 1)
33 #if (GTK_MICRO_VERSION >= 5)
34 #define NEW_GTK_SCROLL_CODE
35 #endif
36 #endif
37
38 //-----------------------------------------------------------------------------
39 // data
40 //-----------------------------------------------------------------------------
41
42 extern bool g_blockEventsOnDrag;
43 extern bool g_blockEventsOnScroll;
44
45 //-----------------------------------------------------------------------------
46 // "button_press_event"
47 //-----------------------------------------------------------------------------
48
49 static gint
50 gtk_listbox_button_press_callback( GtkWidget *widget, GdkEventButton *gdk_event, wxListBox *listbox )
51 {
52 if (g_blockEventsOnDrag) return FALSE;
53 if (g_blockEventsOnScroll) return FALSE;
54
55 if (!listbox->HasVMT()) return FALSE;
56
57 int sel = listbox->GetIndex( widget );
58
59 if ((listbox->m_hasCheckBoxes) && (gdk_event->x < 15) && (gdk_event->type != GDK_2BUTTON_PRESS))
60 {
61 wxCheckListBox *clb = (wxCheckListBox *)listbox;
62
63 clb->Check( sel, !clb->IsChecked(sel) );
64
65 wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
66 event.SetEventObject( listbox );
67 event.SetInt( sel );
68 listbox->GetEventHandler()->ProcessEvent( event );
69 }
70
71 if (gdk_event->type == GDK_2BUTTON_PRESS)
72 {
73 wxCommandEvent event( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
74 event.SetEventObject( listbox );
75 event.SetInt( sel );
76 listbox->GetEventHandler()->ProcessEvent( event );
77 }
78
79 return FALSE;
80 }
81
82 //-----------------------------------------------------------------------------
83 // "key_press_event"
84 //-----------------------------------------------------------------------------
85
86 static gint
87 gtk_listbox_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxListBox *listbox )
88 {
89 if (g_blockEventsOnDrag) return FALSE;
90
91 if (!listbox->HasVMT()) return FALSE;
92
93 if (gdk_event->keyval != ' ') return FALSE;
94
95 int sel = listbox->GetIndex( widget );
96
97 wxCheckListBox *clb = (wxCheckListBox *)listbox;
98
99 clb->Check( sel, !clb->IsChecked(sel) );
100
101 wxCommandEvent event( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED, listbox->GetId() );
102 event.SetEventObject( listbox );
103 event.SetInt( sel );
104 listbox->GetEventHandler()->ProcessEvent( event );
105
106 return FALSE;
107 }
108
109 //-----------------------------------------------------------------------------
110 // "select" and "deselect"
111 //-----------------------------------------------------------------------------
112
113 static void gtk_listitem_select_callback( GtkWidget *WXUNUSED(widget), wxListBox *listbox )
114 {
115 if (!listbox->HasVMT()) return;
116 if (g_blockEventsOnDrag) return;
117
118 wxCommandEvent event(wxEVT_COMMAND_LISTBOX_SELECTED, listbox->GetId() );
119
120 wxArrayInt aSelections;
121 int count = listbox->GetSelections(aSelections);
122 if ( count > 0 )
123 {
124 event.m_commandInt = aSelections[0] ;
125 event.m_clientData = listbox->GetClientData( event.m_commandInt );
126 wxString str(listbox->GetString(event.m_commandInt));
127 if (str != "") event.m_commandString = copystring((char *)(const char *)str);
128 }
129 else
130 {
131 event.m_commandInt = -1 ;
132 event.m_commandString = copystring("") ;
133 }
134
135 event.SetEventObject( listbox );
136
137 listbox->GetEventHandler()->ProcessEvent( event );
138 if (event.m_commandString) delete[] event.m_commandString ;
139 }
140
141 //-----------------------------------------------------------------------------
142 // wxListBox
143 //-----------------------------------------------------------------------------
144
145 IMPLEMENT_DYNAMIC_CLASS(wxListBox,wxControl)
146
147 wxListBox::wxListBox()
148 {
149 m_list = (GtkList *) NULL;
150 m_hasCheckBoxes = FALSE;
151 }
152
153 bool wxListBox::Create( wxWindow *parent, wxWindowID id,
154 const wxPoint &pos, const wxSize &size,
155 int n, const wxString choices[],
156 long style, const wxValidator& validator, const wxString &name )
157 {
158 m_needParent = TRUE;
159 m_acceptsFocus = TRUE;
160
161 PreCreation( parent, id, pos, size, style, name );
162
163 SetValidator( validator );
164
165 m_widget = gtk_scrolled_window_new( (GtkAdjustment*) NULL, (GtkAdjustment*) NULL );
166 gtk_scrolled_window_set_policy( GTK_SCROLLED_WINDOW(m_widget),
167 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC );
168
169 m_list = GTK_LIST( gtk_list_new() );
170
171 GtkSelectionMode mode = GTK_SELECTION_BROWSE;
172 if (style & wxLB_MULTIPLE)
173 mode = GTK_SELECTION_MULTIPLE;
174 else if (style & wxLB_EXTENDED)
175 mode = GTK_SELECTION_EXTENDED;
176
177 gtk_list_set_selection_mode( GTK_LIST(m_list), mode );
178
179 #ifdef NEW_GTK_SCROLL_CODE
180 gtk_scrolled_window_add_with_viewport( GTK_SCROLLED_WINDOW(m_widget), GTK_WIDGET(m_list) );
181 #else
182 gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_list) );
183 #endif
184
185 #ifdef __WXDEBUG__
186 debug_focus_in( m_widget, "wxListBox::m_widget", name );
187
188 debug_focus_in( GTK_WIDGET(m_list), "wxListBox::m_list", name );
189
190 GtkScrolledWindow *s_window = GTK_SCROLLED_WINDOW(m_widget);
191
192 debug_focus_in( s_window->hscrollbar, "wxWindow::hsrcollbar", name );
193 debug_focus_in( s_window->vscrollbar, "wxWindow::vsrcollbar", name );
194
195 #ifdef NEW_GTK_SCROLL_CODE
196 GtkViewport *viewport = GTK_VIEWPORT(s_window->child);
197 #else
198 GtkViewport *viewport = GTK_VIEWPORT(s_window->viewport);
199 #endif
200
201 debug_focus_in( GTK_WIDGET(viewport), "wxWindow::viewport", name );
202 #endif
203
204 gtk_widget_show( GTK_WIDGET(m_list) );
205
206 wxSize newSize = size;
207 if (newSize.x == -1) newSize.x = 100;
208 if (newSize.y == -1) newSize.y = 110;
209 SetSize( newSize.x, newSize.y );
210
211 for (int i = 0; i < n; i++)
212 {
213 m_clientDataList.Append( (wxObject*) NULL );
214 m_clientObjectList.Append( (wxObject*) NULL );
215
216 GtkWidget *list_item;
217
218 if (m_hasCheckBoxes)
219 {
220 wxString str = "[-] ";
221 str += choices[i];
222 list_item = gtk_list_item_new_with_label( str );
223 }
224 else
225 {
226 list_item = gtk_list_item_new_with_label( choices[i] );
227 }
228
229 #ifdef __WXDEBUG__
230 debug_focus_in( list_item, "wxListBox::list_item", name );
231 #endif
232
233 gtk_container_add( GTK_CONTAINER(m_list), list_item );
234
235 gtk_signal_connect( GTK_OBJECT(list_item), "select",
236 GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
237
238 if (style & wxLB_MULTIPLE)
239 gtk_signal_connect( GTK_OBJECT(list_item), "deselect",
240 GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
241
242 gtk_signal_connect( GTK_OBJECT(list_item),
243 "button_press_event",
244 (GtkSignalFunc)gtk_listbox_button_press_callback,
245 (gpointer) this );
246
247 gtk_signal_connect( GTK_OBJECT(list_item),
248 "key_press_event",
249 (GtkSignalFunc)gtk_listbox_key_press_callback,
250 (gpointer)this );
251
252 ConnectWidget( list_item );
253
254 gtk_widget_show( list_item );
255 }
256
257 m_parent->AddChild( this );
258
259 (m_parent->m_insertCallback)( m_parent, this );
260
261 PostCreation();
262
263 gtk_widget_realize( GTK_WIDGET(m_list) );
264
265 SetBackgroundColour( parent->GetBackgroundColour() );
266 SetForegroundColour( parent->GetForegroundColour() );
267
268 Show( TRUE );
269
270 return TRUE;
271 }
272
273 wxListBox::~wxListBox()
274 {
275 Clear();
276 }
277
278 void wxListBox::AppendCommon( const wxString &item )
279 {
280 wxCHECK_RET( m_list != NULL, "invalid listbox" );
281
282 GtkWidget *list_item;
283
284 if (m_hasCheckBoxes)
285 {
286 wxString str = "[-] ";
287 str += item;
288 list_item = gtk_list_item_new_with_label( str );
289 }
290 else
291 {
292 list_item = gtk_list_item_new_with_label( item );
293 }
294
295 gtk_signal_connect( GTK_OBJECT(list_item), "select",
296 GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
297
298 if (GetWindowStyleFlag() & wxLB_MULTIPLE)
299 gtk_signal_connect( GTK_OBJECT(list_item), "deselect",
300 GTK_SIGNAL_FUNC(gtk_listitem_select_callback), (gpointer)this );
301
302 gtk_container_add( GTK_CONTAINER(m_list), list_item );
303
304 if (m_widgetStyle) ApplyWidgetStyle();
305
306 gtk_signal_connect( GTK_OBJECT(list_item),
307 "button_press_event",
308 (GtkSignalFunc)gtk_listbox_button_press_callback,
309 (gpointer) this );
310
311 gtk_signal_connect( GTK_OBJECT(list_item),
312 "key_press_event",
313 (GtkSignalFunc)gtk_listbox_key_press_callback,
314 (gpointer)this );
315
316 gtk_widget_show( list_item );
317
318 ConnectWidget( list_item );
319
320 #if wxUSE_DRAG_AND_DROP
321 #ifndef NEW_GTK_DND_CODE
322 if (m_dropTarget) m_dropTarget->RegisterWidget( list_item );
323 #endif
324 #endif
325 }
326
327 void wxListBox::Append( const wxString &item )
328 {
329 m_clientDataList.Append( (wxObject*) NULL );
330 m_clientObjectList.Append( (wxObject*) NULL );
331
332 AppendCommon( item );
333 }
334
335 void wxListBox::Append( const wxString &item, void *clientData )
336 {
337 m_clientDataList.Append( (wxObject*) clientData );
338 m_clientObjectList.Append( (wxObject*) NULL );
339
340 AppendCommon( item );
341 }
342
343 void wxListBox::Append( const wxString &item, wxClientData *clientData )
344 {
345 m_clientObjectList.Append( (wxObject*) clientData );
346 m_clientDataList.Append( (wxObject*) NULL );
347
348 AppendCommon( item );
349 }
350
351 void wxListBox::SetClientData( int n, void* clientData )
352 {
353 wxCHECK_RET( m_widget != NULL, "invalid combobox" );
354
355 wxNode *node = m_clientDataList.Nth( n );
356 if (!node) return;
357
358 node->SetData( (wxObject*) clientData );
359 }
360
361 void* wxListBox::GetClientData( int n )
362 {
363 wxCHECK_MSG( m_widget != NULL, NULL, "invalid combobox" );
364
365 wxNode *node = m_clientDataList.Nth( n );
366 if (!node) return NULL;
367
368 return node->Data();
369 }
370
371 void wxListBox::SetClientObject( int n, wxClientData* clientData )
372 {
373 wxCHECK_RET( m_widget != NULL, "invalid combobox" );
374
375 wxNode *node = m_clientObjectList.Nth( n );
376 if (!node) return;
377
378 wxClientData *cd = (wxClientData*) node->Data();
379 if (cd) delete cd;
380
381 node->SetData( (wxObject*) clientData );
382 }
383
384 wxClientData* wxListBox::GetClientObject( int n )
385 {
386 wxCHECK_MSG( m_widget != NULL, (wxClientData*)NULL, "invalid combobox" );
387
388 wxNode *node = m_clientObjectList.Nth( n );
389 if (!node) return (wxClientData*) NULL;
390
391 return (wxClientData*) node->Data();
392 }
393
394 void wxListBox::Clear()
395 {
396 wxCHECK_RET( m_list != NULL, "invalid listbox" );
397
398 gtk_list_clear_items( m_list, 0, Number() );
399
400 wxNode *node = m_clientObjectList.First();
401 while (node)
402 {
403 wxClientData *cd = (wxClientData*)node->Data();
404 if (cd) delete cd;
405 node = node->Next();
406 }
407 m_clientObjectList.Clear();
408
409 m_clientDataList.Clear();
410 }
411
412 void wxListBox::Delete( int n )
413 {
414 wxCHECK_RET( m_list != NULL, "invalid listbox" );
415
416 GList *child = g_list_nth( m_list->children, n );
417
418 wxCHECK_RET( child, "wrong listbox index" );
419
420 GList *list = g_list_append( (GList*) NULL, child->data );
421 gtk_list_remove_items( m_list, list );
422 g_list_free( list );
423
424 wxNode *node = m_clientObjectList.Nth( n );
425 if (node)
426 {
427 wxClientData *cd = (wxClientData*)node->Data();
428 if (cd) delete cd;
429 m_clientObjectList.DeleteNode( node );
430 }
431
432 node = m_clientDataList.Nth( n );
433 if (node)
434 {
435 m_clientDataList.DeleteNode( node );
436 }
437 }
438
439 void wxListBox::Deselect( int n )
440 {
441 wxCHECK_RET( m_list != NULL, "invalid listbox" );
442
443 gtk_list_unselect_item( m_list, n );
444 }
445
446 int wxListBox::FindString( const wxString &item ) const
447 {
448 wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" );
449
450 GList *child = m_list->children;
451 int count = 0;
452 while (child)
453 {
454 GtkBin *bin = GTK_BIN( child->data );
455 GtkLabel *label = GTK_LABEL( bin->child );
456
457 wxString str = label->label;
458 if (m_hasCheckBoxes) str.Remove( 0, 4 );
459
460 if (str == item) return count;
461
462 count++;
463 child = child->next;
464 }
465
466 // it's not an error if the string is not found -> no wxCHECK
467
468 return -1;
469 }
470
471 int wxListBox::GetSelection() const
472 {
473 wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" );
474
475 GList *child = m_list->children;
476 int count = 0;
477 while (child)
478 {
479 if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED) return count;
480 count++;
481 child = child->next;
482 }
483 return -1;
484 }
485
486 int wxListBox::GetSelections( wxArrayInt& aSelections ) const
487 {
488 wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" );
489
490 // get the number of selected items first
491 GList *child = m_list->children;
492 int count = 0;
493 for (child = m_list->children; child != NULL; child = child->next)
494 {
495 if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
496 count++;
497 }
498
499 aSelections.Empty();
500
501 if (count > 0)
502 {
503 // now fill the list
504 aSelections.Alloc(count); // optimization attempt
505 int i = 0;
506 for (child = m_list->children; child != NULL; child = child->next, i++)
507 {
508 if (GTK_WIDGET(child->data)->state == GTK_STATE_SELECTED)
509 aSelections.Add(i);
510 }
511 }
512
513 return count;
514 }
515
516 wxString wxListBox::GetString( int n ) const
517 {
518 wxCHECK_MSG( m_list != NULL, "", "invalid listbox" );
519
520 GList *child = g_list_nth( m_list->children, n );
521 if (child)
522 {
523 GtkBin *bin = GTK_BIN( child->data );
524 GtkLabel *label = GTK_LABEL( bin->child );
525
526 wxString str = label->label;
527 if (m_hasCheckBoxes) str.Remove( 0, 4 );
528
529 return str;
530 }
531 wxFAIL_MSG("wrong listbox index");
532 return "";
533 }
534
535 wxString wxListBox::GetStringSelection() const
536 {
537 wxCHECK_MSG( m_list != NULL, "", "invalid listbox" );
538
539 GList *selection = m_list->selection;
540 if (selection)
541 {
542 GtkBin *bin = GTK_BIN( selection->data );
543 GtkLabel *label = GTK_LABEL( bin->child );
544
545 wxString str = label->label;
546 if (m_hasCheckBoxes) str.Remove( 0, 4 );
547
548 return str;
549 }
550
551 wxFAIL_MSG("no listbox selection available");
552 return "";
553 }
554
555 int wxListBox::Number()
556 {
557 wxCHECK_MSG( m_list != NULL, -1, "invalid listbox" );
558
559 GList *child = m_list->children;
560 int count = 0;
561 while (child) { count++; child = child->next; }
562 return count;
563 }
564
565 bool wxListBox::Selected( int n )
566 {
567 wxCHECK_MSG( m_list != NULL, FALSE, "invalid listbox" );
568
569 GList *target = g_list_nth( m_list->children, n );
570 if (target)
571 {
572 GList *child = m_list->selection;
573 while (child)
574 {
575 if (child->data == target->data) return TRUE;
576 child = child->next;
577 }
578 }
579 wxFAIL_MSG("wrong listbox index");
580 return FALSE;
581 }
582
583 void wxListBox::Set( int WXUNUSED(n), const wxString *WXUNUSED(choices) )
584 {
585 wxFAIL_MSG("wxListBox::Set not implemented");
586 }
587
588 void wxListBox::SetFirstItem( int WXUNUSED(n) )
589 {
590 wxFAIL_MSG("wxListBox::SetFirstItem not implemented");
591 }
592
593 void wxListBox::SetFirstItem( const wxString &WXUNUSED(item) )
594 {
595 wxFAIL_MSG("wxListBox::SetFirstItem not implemented");
596 }
597
598 void wxListBox::SetSelection( int n, bool select )
599 {
600 wxCHECK_RET( m_list != NULL, "invalid listbox" );
601
602 if (select)
603 gtk_list_select_item( m_list, n );
604 else
605 gtk_list_unselect_item( m_list, n );
606 }
607
608 void wxListBox::SetString( int n, const wxString &string )
609 {
610 wxCHECK_RET( m_list != NULL, "invalid listbox" );
611
612 GList *child = g_list_nth( m_list->children, n );
613 if (child)
614 {
615 GtkBin *bin = GTK_BIN( child->data );
616 GtkLabel *label = GTK_LABEL( bin->child );
617
618 wxString str;
619 if (m_hasCheckBoxes) str += "[-] ";
620 str += string;
621
622 gtk_label_set( label, str );
623 }
624 else
625 {
626 wxFAIL_MSG("wrong listbox index");
627 }
628 }
629
630 void wxListBox::SetStringSelection( const wxString &string, bool select )
631 {
632 wxCHECK_RET( m_list != NULL, "invalid listbox" );
633
634 SetSelection( FindString(string), select );
635 }
636
637 int wxListBox::GetIndex( GtkWidget *item ) const
638 {
639 if (item)
640 {
641 GList *child = m_list->children;
642 int count = 0;
643 while (child)
644 {
645 if (GTK_WIDGET(child->data) == item) return count;
646 count++;
647 child = child->next;
648 }
649 }
650 return -1;
651 }
652
653 #if wxUSE_DRAG_AND_DROP
654 void wxListBox::SetDropTarget( wxDropTarget *dropTarget )
655 {
656 wxCHECK_RET( m_list != NULL, "invalid listbox" );
657
658 #ifndef NEW_GTK_DND_CODE
659 if (m_dropTarget)
660 {
661 GList *child = m_list->children;
662 while (child)
663 {
664 m_dropTarget->UnregisterWidget( GTK_WIDGET( child->data ) );
665 child = child->next;
666 }
667 }
668 #endif
669
670 wxWindow::SetDropTarget( dropTarget );
671
672 #ifndef NEW_GTK_DND_CODE
673 if (m_dropTarget)
674 {
675 GList *child = m_list->children;
676 while (child)
677 {
678 m_dropTarget->RegisterWidget( GTK_WIDGET( child->data ) );
679 child = child->next;
680 }
681 }
682 #endif
683 }
684 #endif
685
686 GtkWidget *wxListBox::GetConnectWidget()
687 {
688 return GTK_WIDGET(m_list);
689 }
690
691 bool wxListBox::IsOwnGtkWindow( GdkWindow *window )
692 {
693 if (wxWindow::IsOwnGtkWindow( window )) return TRUE;
694
695 GList *child = m_list->children;
696 while (child)
697 {
698 GtkWidget *bin = GTK_WIDGET( child->data );
699 if (bin->window == window) return TRUE;
700 child = child->next;
701 }
702
703 return FALSE;
704 }
705
706 void wxListBox::ApplyWidgetStyle()
707 {
708 SetWidgetStyle();
709
710 if (m_backgroundColour.Ok())
711 {
712 GdkWindow *window = GTK_WIDGET(m_list)->window;
713 m_backgroundColour.CalcPixel( gdk_window_get_colormap( window ) );
714 gdk_window_set_background( window, m_backgroundColour.GetColor() );
715 gdk_window_clear( window );
716 }
717
718 GList *child = m_list->children;
719 while (child)
720 {
721 gtk_widget_set_style( GTK_WIDGET(child->data), m_widgetStyle );
722
723 GtkBin *bin = GTK_BIN( child->data );
724 GtkWidget *label = GTK_WIDGET( bin->child );
725 gtk_widget_set_style( label, m_widgetStyle );
726
727 child = child->next;
728 }
729 }