simplified and cleaned up wxGTK's focus handling
[wxWidgets.git] / src / gtk / radiobox.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/radiobox.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
12
13 #if wxUSE_RADIOBOX
14
15 #include "wx/radiobox.h"
16
17 #ifndef WX_PRECOMP
18 #include "wx/log.h"
19 #include "wx/frame.h"
20 #include "wx/dialog.h"
21 #endif
22
23 #if wxUSE_TOOLTIPS
24 #include "wx/tooltip.h"
25 #endif
26
27 #include "wx/gtk/private.h"
28 #include <gdk/gdkkeysyms.h>
29
30 //-----------------------------------------------------------------------------
31 // wxGTKRadioButtonInfo
32 //-----------------------------------------------------------------------------
33 // structure internally used by wxRadioBox to store its child buttons
34
35 class wxGTKRadioButtonInfo : public wxObject
36 {
37 public:
38 wxGTKRadioButtonInfo( GtkRadioButton * abutton, const wxRect & arect )
39 : button( abutton ), rect( arect ) {}
40
41 GtkRadioButton * button;
42 wxRect rect;
43 };
44
45 //-----------------------------------------------------------------------------
46 // data
47 //-----------------------------------------------------------------------------
48
49 #include "wx/listimpl.cpp"
50 WX_DEFINE_LIST( wxRadioBoxButtonsInfoList )
51
52 extern bool g_blockEventsOnDrag;
53
54 //-----------------------------------------------------------------------------
55 // "clicked"
56 //-----------------------------------------------------------------------------
57
58 extern "C" {
59 static void gtk_radiobutton_clicked_callback( GtkToggleButton *button, wxRadioBox *rb )
60 {
61 if (!rb->m_hasVMT) return;
62 if (g_blockEventsOnDrag) return;
63
64 if (!button->active) return;
65
66 wxCommandEvent event( wxEVT_COMMAND_RADIOBOX_SELECTED, rb->GetId() );
67 event.SetInt( rb->GetSelection() );
68 event.SetString( rb->GetStringSelection() );
69 event.SetEventObject( rb );
70 rb->HandleWindowEvent(event);
71 }
72 }
73
74 //-----------------------------------------------------------------------------
75 // "key_press_event"
76 //-----------------------------------------------------------------------------
77
78 extern "C" {
79 static gint gtk_radiobox_keypress_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxRadioBox *rb )
80 {
81 if (!rb->m_hasVMT) return FALSE;
82 if (g_blockEventsOnDrag) return FALSE;
83
84 if ( ((gdk_event->keyval == GDK_Tab) ||
85 (gdk_event->keyval == GDK_ISO_Left_Tab)) &&
86 rb->GetParent() && (rb->GetParent()->HasFlag( wxTAB_TRAVERSAL)) )
87 {
88 wxNavigationKeyEvent new_event;
89 new_event.SetEventObject( rb->GetParent() );
90 // GDK reports GDK_ISO_Left_Tab for SHIFT-TAB
91 new_event.SetDirection( (gdk_event->keyval == GDK_Tab) );
92 // CTRL-TAB changes the (parent) window, i.e. switch notebook page
93 new_event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) );
94 new_event.SetCurrentFocus( rb );
95 return rb->GetParent()->HandleWindowEvent(new_event);
96 }
97
98 if ((gdk_event->keyval != GDK_Up) &&
99 (gdk_event->keyval != GDK_Down) &&
100 (gdk_event->keyval != GDK_Left) &&
101 (gdk_event->keyval != GDK_Right))
102 {
103 return FALSE;
104 }
105
106 wxRadioBoxButtonsInfoList::compatibility_iterator node = rb->m_buttonsInfo.GetFirst();
107 while( node && GTK_WIDGET( node->GetData()->button ) != widget )
108 {
109 node = node->GetNext();
110 }
111 if (!node)
112 {
113 return FALSE;
114 }
115
116 if ((gdk_event->keyval == GDK_Up) ||
117 (gdk_event->keyval == GDK_Left))
118 {
119 if (node == rb->m_buttonsInfo.GetFirst())
120 node = rb->m_buttonsInfo.GetLast();
121 else
122 node = node->GetPrevious();
123 }
124 else
125 {
126 if (node == rb->m_buttonsInfo.GetLast())
127 node = rb->m_buttonsInfo.GetFirst();
128 else
129 node = node->GetNext();
130 }
131
132 GtkWidget *button = (GtkWidget*) node->GetData()->button;
133
134 gtk_widget_grab_focus( button );
135
136 return TRUE;
137 }
138 }
139
140 extern "C" {
141 static gint gtk_radiobutton_focus_out( GtkWidget * WXUNUSED(widget),
142 GdkEventFocus *WXUNUSED(event),
143 wxRadioBox *win )
144 {
145 // NB: This control is composed of several GtkRadioButton widgets and
146 // when focus changes from one of them to another in the same
147 // wxRadioBox, we get a focus-out event followed by focus-in for
148 // another GtkRadioButton owned by the same control. We don't want
149 // to generate two spurious wxEVT_SET_FOCUS events in this case,
150 // so we defer sending wx events until idle time.
151 win->GTKHandleFocusOut();
152
153 // never stop the signal emission, it seems to break the kbd handling
154 // inside the radiobox
155 return FALSE;
156 }
157 }
158
159 extern "C" {
160 static gint gtk_radiobutton_focus_in( GtkWidget * WXUNUSED(widget),
161 GdkEventFocus *WXUNUSED(event),
162 wxRadioBox *win )
163 {
164 win->GTKHandleFocusIn();
165
166 // never stop the signal emission, it seems to break the kbd handling
167 // inside the radiobox
168 return FALSE;
169 }
170 }
171
172 extern "C" {
173 static void gtk_radiobutton_size_allocate( GtkWidget *widget,
174 GtkAllocation * alloc,
175 wxRadioBox *win )
176 {
177 for ( wxRadioBoxButtonsInfoList::compatibility_iterator node = win->m_buttonsInfo.GetFirst();
178 node;
179 node = node->GetNext())
180 {
181 if (widget == GTK_WIDGET(node->GetData()->button))
182 {
183 const wxPoint origin = win->GetPosition();
184 wxRect rect = wxRect( alloc->x - origin.x, alloc->y - origin.y,
185 alloc->width, alloc->height );
186 node->GetData()->rect = rect;
187 break;
188 }
189 }
190 }
191 }
192
193
194 //-----------------------------------------------------------------------------
195 // wxRadioBox
196 //-----------------------------------------------------------------------------
197
198 IMPLEMENT_DYNAMIC_CLASS(wxRadioBox,wxControl)
199
200 bool wxRadioBox::Create( wxWindow *parent, wxWindowID id,
201 const wxString& title,
202 const wxPoint &pos, const wxSize &size,
203 const wxArrayString& choices, int majorDim,
204 long style, const wxValidator& validator,
205 const wxString &name )
206 {
207 wxCArrayString chs(choices);
208
209 return Create( parent, id, title, pos, size, chs.GetCount(),
210 chs.GetStrings(), majorDim, style, validator, name );
211 }
212
213 bool wxRadioBox::Create( wxWindow *parent, wxWindowID id, const wxString& title,
214 const wxPoint &pos, const wxSize &size,
215 int n, const wxString choices[], int majorDim,
216 long style, const wxValidator& validator,
217 const wxString &name )
218 {
219 if (!PreCreation( parent, pos, size ) ||
220 !CreateBase( parent, id, pos, size, style, validator, name ))
221 {
222 wxFAIL_MSG( wxT("wxRadioBox creation failed") );
223 return false;
224 }
225
226 m_widget = GTKCreateFrame(title);
227 wxControl::SetLabel(title);
228 if ( HasFlag(wxNO_BORDER) )
229 {
230 // If we don't do this here, the wxNO_BORDER style is ignored in Show()
231 gtk_frame_set_shadow_type(GTK_FRAME(m_widget), GTK_SHADOW_NONE);
232 }
233
234
235 // majorDim may be 0 if all trailing parameters were omitted, so don't
236 // assert here but just use the correct value for it
237 SetMajorDim(majorDim == 0 ? n : majorDim, style);
238
239
240 unsigned int num_of_cols = GetColumnCount();
241 unsigned int num_of_rows = GetRowCount();
242
243 GtkRadioButton *rbtn = (GtkRadioButton*) NULL;
244
245 GtkWidget *table = gtk_table_new( num_of_rows, num_of_cols, FALSE );
246 gtk_table_set_col_spacings( GTK_TABLE(table), 1 );
247 gtk_table_set_row_spacings( GTK_TABLE(table), 1 );
248 gtk_widget_show( table );
249 gtk_container_add( GTK_CONTAINER(m_widget), table );
250
251 wxString label;
252 GSList *radio_button_group = (GSList *) NULL;
253 for (unsigned int i = 0; i < (unsigned int)n; i++)
254 {
255 if ( i != 0 )
256 radio_button_group = gtk_radio_button_get_group( GTK_RADIO_BUTTON(rbtn) );
257
258 label.Empty();
259 for ( wxString::const_iterator pc = choices[i].begin();
260 pc != choices[i].end(); ++pc )
261 {
262 if ( *pc != wxT('&') )
263 label += *pc;
264 }
265
266 rbtn = GTK_RADIO_BUTTON( gtk_radio_button_new_with_label( radio_button_group, wxGTK_CONV( label ) ) );
267 gtk_widget_show( GTK_WIDGET(rbtn) );
268
269 g_signal_connect (rbtn, "key_press_event",
270 G_CALLBACK (gtk_radiobox_keypress_callback), this);
271
272 m_buttonsInfo.Append( new wxGTKRadioButtonInfo( rbtn, wxRect() ) );
273
274 if (HasFlag(wxRA_SPECIFY_COLS))
275 {
276 int left = i%num_of_cols;
277 int right = (i%num_of_cols) + 1;
278 int top = i/num_of_cols;
279 int bottom = (i/num_of_cols)+1;
280 gtk_table_attach( GTK_TABLE(table), GTK_WIDGET(rbtn), left, right, top, bottom,
281 GTK_FILL, GTK_FILL, 1, 1 );
282 }
283 else
284 {
285 int left = i/num_of_rows;
286 int right = (i/num_of_rows) + 1;
287 int top = i%num_of_rows;
288 int bottom = (i%num_of_rows)+1;
289 gtk_table_attach( GTK_TABLE(table), GTK_WIDGET(rbtn), left, right, top, bottom,
290 GTK_FILL, GTK_FILL, 1, 1 );
291 }
292
293 ConnectWidget( GTK_WIDGET(rbtn) );
294
295 if (!i)
296 gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(rbtn), TRUE );
297
298 g_signal_connect (rbtn, "clicked",
299 G_CALLBACK (gtk_radiobutton_clicked_callback), this);
300 g_signal_connect (rbtn, "focus_in_event",
301 G_CALLBACK (gtk_radiobutton_focus_in), this);
302 g_signal_connect (rbtn, "focus_out_event",
303 G_CALLBACK (gtk_radiobutton_focus_out), this);
304 g_signal_connect (rbtn, "size_allocate",
305 G_CALLBACK (gtk_radiobutton_size_allocate), this);
306 }
307
308 m_parent->DoAddChild( this );
309
310 PostCreation(size);
311
312 return true;
313 }
314
315 wxRadioBox::~wxRadioBox()
316 {
317 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
318 while (node)
319 {
320 GtkWidget *button = GTK_WIDGET( node->GetData()->button );
321 gtk_widget_destroy( button );
322 node = node->GetNext();
323 }
324 WX_CLEAR_LIST( wxRadioBoxButtonsInfoList, m_buttonsInfo );
325 }
326
327 bool wxRadioBox::Show( bool show )
328 {
329 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid radiobox") );
330
331 if (!wxControl::Show(show))
332 {
333 // nothing to do
334 return false;
335 }
336
337 if ( HasFlag(wxNO_BORDER) )
338 gtk_widget_hide( m_widget );
339
340 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
341 while (node)
342 {
343 GtkWidget *button = GTK_WIDGET( node->GetData()->button );
344
345 if (show)
346 gtk_widget_show( button );
347 else
348 gtk_widget_hide( button );
349
350 node = node->GetNext();
351 }
352
353 return true;
354 }
355
356 void wxRadioBox::SetSelection( int n )
357 {
358 wxCHECK_RET( m_widget != NULL, wxT("invalid radiobox") );
359
360 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( n );
361
362 wxCHECK_RET( node, wxT("radiobox wrong index") );
363
364 GtkToggleButton *button = GTK_TOGGLE_BUTTON( node->GetData()->button );
365
366 GtkDisableEvents();
367
368 gtk_toggle_button_set_active( button, 1 );
369
370 GtkEnableEvents();
371 }
372
373 int wxRadioBox::GetSelection(void) const
374 {
375 wxCHECK_MSG( m_widget != NULL, wxNOT_FOUND, wxT("invalid radiobox") );
376
377 int count = 0;
378
379 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
380 while (node)
381 {
382 GtkToggleButton *button = GTK_TOGGLE_BUTTON( node->GetData()->button );
383 if (button->active) return count;
384 count++;
385 node = node->GetNext();
386 }
387
388 wxFAIL_MSG( wxT("wxRadioBox none selected") );
389
390 return wxNOT_FOUND;
391 }
392
393 wxString wxRadioBox::GetString(unsigned int n) const
394 {
395 wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid radiobox") );
396
397 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( n );
398
399 wxCHECK_MSG( node, wxEmptyString, wxT("radiobox wrong index") );
400
401 GtkLabel *label = GTK_LABEL(GTK_BIN(node->GetData()->button)->child);
402
403 wxString str( wxGTK_CONV_BACK( gtk_label_get_text(label) ) );
404
405 return str;
406 }
407
408 void wxRadioBox::SetLabel( const wxString& label )
409 {
410 wxCHECK_RET( m_widget != NULL, wxT("invalid radiobox") );
411
412 GTKSetLabelForFrame(GTK_FRAME(m_widget), label);
413 }
414
415 void wxRadioBox::SetString(unsigned int item, const wxString& label)
416 {
417 wxCHECK_RET( m_widget != NULL, wxT("invalid radiobox") );
418
419 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( item );
420
421 wxCHECK_RET( node, wxT("radiobox wrong index") );
422
423 GtkLabel *g_label = GTK_LABEL(GTK_BIN(node->GetData()->button)->child);
424
425 gtk_label_set_text( g_label, wxGTK_CONV( label ) );
426 }
427
428 bool wxRadioBox::Enable( bool enable )
429 {
430 if ( !wxControl::Enable( enable ) )
431 return false;
432
433 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
434 while (node)
435 {
436 GtkButton *button = GTK_BUTTON( node->GetData()->button );
437 GtkLabel *label = GTK_LABEL(GTK_BIN(button)->child);
438
439 gtk_widget_set_sensitive( GTK_WIDGET(button), enable );
440 gtk_widget_set_sensitive( GTK_WIDGET(label), enable );
441 node = node->GetNext();
442 }
443
444 return true;
445 }
446
447 bool wxRadioBox::Enable(unsigned int item, bool enable)
448 {
449 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid radiobox") );
450
451 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( item );
452
453 wxCHECK_MSG( node, false, wxT("radiobox wrong index") );
454
455 GtkButton *button = GTK_BUTTON( node->GetData()->button );
456 GtkLabel *label = GTK_LABEL(GTK_BIN(button)->child);
457
458 gtk_widget_set_sensitive( GTK_WIDGET(button), enable );
459 gtk_widget_set_sensitive( GTK_WIDGET(label), enable );
460
461 return true;
462 }
463
464 bool wxRadioBox::IsItemEnabled(unsigned int item) const
465 {
466 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid radiobox") );
467
468 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( item );
469
470 wxCHECK_MSG( node, false, wxT("radiobox wrong index") );
471
472 GtkButton *button = GTK_BUTTON( node->GetData()->button );
473
474 // don't use GTK_WIDGET_IS_SENSITIVE() here, we want to return true even if
475 // the parent radiobox is disabled
476 return GTK_WIDGET_SENSITIVE(GTK_WIDGET(button));
477 }
478
479 bool wxRadioBox::Show(unsigned int item, bool show)
480 {
481 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid radiobox") );
482
483 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( item );
484
485 wxCHECK_MSG( node, false, wxT("radiobox wrong index") );
486
487 GtkWidget *button = GTK_WIDGET( node->GetData()->button );
488
489 if (show)
490 gtk_widget_show( button );
491 else
492 gtk_widget_hide( button );
493
494 return true;
495 }
496
497 bool wxRadioBox::IsItemShown(unsigned int item) const
498 {
499 wxCHECK_MSG( m_widget != NULL, false, wxT("invalid radiobox") );
500
501 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.Item( item );
502
503 wxCHECK_MSG( node, false, wxT("radiobox wrong index") );
504
505 GtkButton *button = GTK_BUTTON( node->GetData()->button );
506
507 return GTK_WIDGET_VISIBLE(GTK_WIDGET(button));
508 }
509
510 unsigned int wxRadioBox::GetCount() const
511 {
512 return m_buttonsInfo.GetCount();
513 }
514
515 void wxRadioBox::GtkDisableEvents()
516 {
517 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
518 while (node)
519 {
520 g_signal_handlers_block_by_func(node->GetData()->button,
521 (gpointer)gtk_radiobutton_clicked_callback, this);
522
523 node = node->GetNext();
524 }
525 }
526
527 void wxRadioBox::GtkEnableEvents()
528 {
529 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
530 while (node)
531 {
532 g_signal_handlers_unblock_by_func(node->GetData()->button,
533 (gpointer)gtk_radiobutton_clicked_callback, this);
534
535 node = node->GetNext();
536 }
537 }
538
539 void wxRadioBox::DoApplyWidgetStyle(GtkRcStyle *style)
540 {
541 GTKFrameApplyWidgetStyle(GTK_FRAME(m_widget), style);
542
543 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
544 while (node)
545 {
546 GtkWidget *widget = GTK_WIDGET( node->GetData()->button );
547
548 gtk_widget_modify_style( widget, style );
549 gtk_widget_modify_style(GTK_BIN(widget)->child, style);
550
551 node = node->GetNext();
552 }
553 }
554
555 bool wxRadioBox::GTKWidgetNeedsMnemonic() const
556 {
557 return true;
558 }
559
560 void wxRadioBox::GTKWidgetDoSetMnemonic(GtkWidget* w)
561 {
562 GTKFrameSetMnemonicWidget(GTK_FRAME(m_widget), w);
563 }
564
565 #if wxUSE_TOOLTIPS
566 void wxRadioBox::ApplyToolTip(GtkTooltips * WXUNUSED(tips), const gchar *tip)
567 {
568 // set this tooltip for all radiobuttons which don't have their own tips
569 unsigned n = 0;
570 for ( wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
571 node;
572 node = node->GetNext(), n++ )
573 {
574 if ( !GetItemToolTip(n) )
575 {
576 wxToolTip::Apply(GTK_WIDGET(node->GetData()->button), tip);
577 }
578 }
579 }
580
581 void wxRadioBox::DoSetItemToolTip(unsigned int n, wxToolTip *tooltip)
582 {
583 wxCharBuffer buf;
584 if ( !tooltip )
585 tooltip = GetToolTip();
586 if ( tooltip )
587 buf = wxGTK_CONV(tooltip->GetTip());
588
589 wxToolTip::Apply(GTK_WIDGET(m_buttonsInfo[n]->button), buf);
590 }
591
592 #endif // wxUSE_TOOLTIPS
593
594 GdkWindow *wxRadioBox::GTKGetWindow(wxArrayGdkWindows& windows) const
595 {
596 windows.push_back(m_widget->window);
597
598 wxRadioBoxButtonsInfoList::compatibility_iterator node = m_buttonsInfo.GetFirst();
599 while (node)
600 {
601 GtkWidget *button = GTK_WIDGET( node->GetData()->button );
602
603 windows.push_back(button->window);
604
605 node = node->GetNext();
606 }
607
608 return NULL;
609 }
610
611 // static
612 wxVisualAttributes
613 wxRadioBox::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
614 {
615 wxVisualAttributes attr;
616 // NB: we need toplevel window so that GTK+ can find the right style
617 GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
618 GtkWidget* widget = gtk_radio_button_new_with_label(NULL, "");
619 gtk_container_add(GTK_CONTAINER(wnd), widget);
620 attr = GetDefaultAttributesFromGTKWidget(widget);
621 gtk_widget_destroy(wnd);
622 return attr;
623 }
624
625 int wxRadioBox::GetItemFromPoint(const wxPoint& point) const
626 {
627 const wxPoint pt = ScreenToClient(point);
628 unsigned n = 0;
629 for ( wxRadioBoxButtonsInfoList::compatibility_iterator
630 node = m_buttonsInfo.GetFirst(); node; node = node->GetNext(), n++ )
631 {
632 if ( m_buttonsInfo[n]->rect.Contains(pt) )
633 return n;
634 }
635
636 return wxNOT_FOUND;
637 }
638
639 #endif // wxUSE_RADIOBOX