Added Set/GetThemeEnabled and used this for determining whether to paint a theme
[wxWidgets.git] / src / gtk1 / notebook.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: notebook.cpp
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifdef __GNUG__
11 #pragma implementation "notebook.h"
12 #endif
13
14 #include "wx/notebook.h"
15
16 #if wxUSE_NOTEBOOK
17
18 #include "wx/panel.h"
19 #include "wx/utils.h"
20 #include "wx/imaglist.h"
21 #include "wx/intl.h"
22 #include "wx/log.h"
23
24 #include <gdk/gdk.h>
25 #include <gtk/gtk.h>
26 #include "wx/gtk/win_gtk.h"
27 #include <gdk/gdkkeysyms.h>
28
29 //-----------------------------------------------------------------------------
30 // idle system
31 //-----------------------------------------------------------------------------
32
33 extern void wxapp_install_idle_handler();
34 extern bool g_isIdle;
35
36 //-----------------------------------------------------------------------------
37 // data
38 //-----------------------------------------------------------------------------
39
40 extern bool g_blockEventsOnDrag;
41
42 //-----------------------------------------------------------------------------
43 // debug
44 //-----------------------------------------------------------------------------
45
46 #ifdef __WXDEBUG__
47
48 extern void debug_focus_in( GtkWidget* widget, const wxChar* name, const wxChar *window );
49
50 #endif
51
52 //-----------------------------------------------------------------------------
53 // wxGtkNotebookPage
54 //-----------------------------------------------------------------------------
55
56 class wxGtkNotebookPage: public wxObject
57 {
58 public:
59 wxGtkNotebookPage()
60 {
61 m_text = "";
62 m_image = -1;
63 m_page = (GtkNotebookPage *) NULL;
64 m_client = (wxNotebookPage *) NULL;
65 m_box = (GtkWidget *) NULL;
66 }
67
68 wxString m_text;
69 int m_image;
70 GtkNotebookPage *m_page;
71 GtkLabel *m_label;
72 wxNotebookPage *m_client;
73 GtkWidget *m_box; // in which the label and image are packed
74 };
75
76 //-----------------------------------------------------------------------------
77 // "switch_page"
78 //-----------------------------------------------------------------------------
79
80 static void gtk_notebook_page_change_callback(GtkNotebook *WXUNUSED(widget),
81 GtkNotebookPage *WXUNUSED(page),
82 gint page,
83 wxNotebook *notebook )
84 {
85 if (g_isIdle)
86 wxapp_install_idle_handler();
87
88 int old = notebook->GetSelection();
89
90 wxNotebookEvent event1( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
91 notebook->GetId(), page, old );
92 event1.SetEventObject( notebook );
93
94 if ((notebook->GetEventHandler()->ProcessEvent( event1 )) &&
95 !event1.IsAllowed() )
96 {
97 /* program doesn't allow the page change */
98 gtk_signal_emit_stop_by_name( GTK_OBJECT(notebook->m_widget), "switch_page" );
99 return;
100 }
101
102 wxNotebookEvent event2( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
103 notebook->GetId(), page, old );
104 event2.SetEventObject( notebook );
105 notebook->GetEventHandler()->ProcessEvent( event2 );
106 }
107
108 //-----------------------------------------------------------------------------
109 // "size_allocate"
110 //-----------------------------------------------------------------------------
111
112 static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win )
113 {
114 if (g_isIdle)
115 wxapp_install_idle_handler();
116
117 if ((win->m_x == alloc->x) &&
118 (win->m_y == alloc->y) &&
119 (win->m_width == alloc->width) &&
120 (win->m_height == alloc->height))
121 {
122 return;
123 }
124
125 win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height );
126
127 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call allocate
128 here in order to make repositioning after resizing to take effect. */
129 if ((gtk_major_version == 1) &&
130 (gtk_minor_version == 2) &&
131 (gtk_micro_version < 6) &&
132 (win->m_wxwindow) &&
133 (GTK_WIDGET_REALIZED(win->m_wxwindow)))
134 {
135 gtk_widget_size_allocate( win->m_wxwindow, alloc );
136 }
137 }
138
139 //-----------------------------------------------------------------------------
140 // "realize" from m_widget
141 //-----------------------------------------------------------------------------
142
143 static gint
144 gtk_notebook_realized_callback( GtkWidget * WXUNUSED(widget), wxWindow *win )
145 {
146 if (g_isIdle)
147 wxapp_install_idle_handler();
148
149 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize
150 here in order to make repositioning before showing to take effect. */
151 gtk_widget_queue_resize( win->m_widget );
152
153 return FALSE;
154 }
155
156 //-----------------------------------------------------------------------------
157 // "key_press_event"
158 //-----------------------------------------------------------------------------
159
160 static gint gtk_notebook_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxNotebook *win )
161 {
162 if (g_isIdle)
163 wxapp_install_idle_handler();
164
165 if (!win->m_hasVMT) return FALSE;
166 if (g_blockEventsOnDrag) return FALSE;
167
168 /* win is a control: tab can be propagated up */
169 if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab))
170 {
171 wxNode *node = win->m_pages.Nth( win->GetSelection() );
172 if (!node) return FALSE;
173
174 wxGtkNotebookPage *page = (wxGtkNotebookPage*) node->Data();
175
176 wxNavigationKeyEvent event;
177 event.SetEventObject( win );
178 /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
179 event.SetDirection( (gdk_event->keyval == GDK_Tab) );
180 /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
181 event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) );
182 event.SetCurrentFocus( win );
183 if (!page->m_client->GetEventHandler()->ProcessEvent( event ))
184 {
185 page->m_client->SetFocus();
186 }
187
188 gtk_signal_emit_stop_by_name( GTK_OBJECT(widget), "key_press_event" );
189 return TRUE;
190 }
191
192 return FALSE;
193 }
194
195 //-----------------------------------------------------------------------------
196 // InsertChild callback for wxNotebook
197 //-----------------------------------------------------------------------------
198
199 static void wxInsertChildInNotebook( wxNotebook* WXUNUSED(parent), wxWindow* WXUNUSED(child) )
200 {
201 /* we don't do anything here but pray */
202 }
203
204 //-----------------------------------------------------------------------------
205 // wxNotebook
206 //-----------------------------------------------------------------------------
207
208 IMPLEMENT_DYNAMIC_CLASS(wxNotebook,wxControl)
209
210 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
211 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
212 END_EVENT_TABLE()
213
214 void wxNotebook::Init()
215 {
216 m_imageList = (wxImageList *) NULL;
217 m_pages.DeleteContents( TRUE );
218 m_lastSelection = -1;
219 m_themeEnabled = TRUE;
220 }
221
222 wxNotebook::wxNotebook()
223 {
224 Init();
225 }
226
227 wxNotebook::wxNotebook( wxWindow *parent, wxWindowID id,
228 const wxPoint& pos, const wxSize& size,
229 long style, const wxString& name )
230 {
231 Init();
232 Create( parent, id, pos, size, style, name );
233 }
234
235 wxNotebook::~wxNotebook()
236 {
237 /* don't generate change page events any more */
238 gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
239 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
240
241 DeleteAllPages();
242 }
243
244 bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
245 const wxPoint& pos, const wxSize& size,
246 long style, const wxString& name )
247 {
248 m_needParent = TRUE;
249 m_acceptsFocus = TRUE;
250 m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook;
251
252 if (!PreCreation( parent, pos, size ) ||
253 !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
254 {
255 wxFAIL_MSG( wxT("wxNoteBook creation failed") );
256 return FALSE;
257 }
258
259
260 m_widget = gtk_notebook_new();
261
262 #ifdef __WXDEBUG__
263 debug_focus_in( m_widget, wxT("wxNotebook::m_widget"), name );
264 #endif
265
266 gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
267
268 gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
269 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
270
271 m_parent->DoAddChild( this );
272
273 if (m_windowStyle & wxNB_RIGHT)
274 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_RIGHT );
275 if (m_windowStyle & wxNB_LEFT)
276 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_LEFT );
277 if (m_windowStyle & wxNB_BOTTOM)
278 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_BOTTOM );
279
280 gtk_signal_connect( GTK_OBJECT(m_widget), "key_press_event",
281 GTK_SIGNAL_FUNC(gtk_notebook_key_press_callback), (gpointer)this );
282
283 PostCreation();
284
285 SetFont( parent->GetFont() );
286
287 gtk_signal_connect( GTK_OBJECT(m_widget), "realize",
288 GTK_SIGNAL_FUNC(gtk_notebook_realized_callback), (gpointer) this );
289
290 Show( TRUE );
291
292 return TRUE;
293 }
294
295 int wxNotebook::GetSelection() const
296 {
297 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") );
298
299 GList *pages = GTK_NOTEBOOK(m_widget)->children;
300
301 if (g_list_length(pages) == 0) return -1;
302
303 GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
304
305 if (notebook->cur_page == NULL) return m_lastSelection;
306
307 return g_list_index( pages, (gpointer)(notebook->cur_page) );
308 }
309
310 int wxNotebook::GetPageCount() const
311 {
312 return (int) g_list_length( GTK_NOTEBOOK(m_widget)->children );
313 }
314
315 int wxNotebook::GetRowCount() const
316 {
317 return 1;
318 }
319
320 wxString wxNotebook::GetPageText( int page ) const
321 {
322 wxCHECK_MSG( m_widget != NULL, wxT(""), wxT("invalid notebook") );
323
324 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
325 if (nb_page)
326 return nb_page->m_text;
327 else
328 return wxT("");
329 }
330
331 int wxNotebook::GetPageImage( int page ) const
332 {
333 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") );
334
335 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
336 if (nb_page)
337 return nb_page->m_image;
338 else
339 return -1;
340 }
341
342 wxGtkNotebookPage* wxNotebook::GetNotebookPage( int page ) const
343 {
344 wxCHECK_MSG( m_widget != NULL, (wxGtkNotebookPage*) NULL, wxT("invalid notebook") );
345
346 wxCHECK_MSG( page < (int)m_pages.GetCount(), (wxGtkNotebookPage*) NULL, wxT("invalid notebook index") );
347
348 wxNode *node = m_pages.Nth( page );
349
350 return (wxGtkNotebookPage *) node->Data();
351 }
352
353 int wxNotebook::SetSelection( int page )
354 {
355 wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") );
356
357 wxCHECK_MSG( page < (int)m_pages.GetCount(), -1, wxT("invalid notebook index") );
358
359 int selOld = GetSelection();
360
361 gtk_notebook_set_page( GTK_NOTEBOOK(m_widget), page );
362
363 wxGtkNotebookPage* g_page = GetNotebookPage( page );
364 if (g_page->m_client)
365 g_page->m_client->SetFocus();
366
367 return selOld;
368 }
369
370 void wxNotebook::AdvanceSelection( bool forward )
371 {
372 wxCHECK_RET( m_widget != NULL, wxT("invalid notebook") );
373
374 int max = GetPageCount();
375 if ( !max )
376 {
377 // nothing to do with empty notebook
378 return;
379 }
380
381 int sel = GetSelection();
382
383 if (forward)
384 SetSelection( sel == max - 1 ? 0 : sel + 1 );
385 else
386 SetSelection( sel == 0 ? max - 1 : sel - 1 );
387 }
388
389 void wxNotebook::SetImageList( wxImageList* imageList )
390 {
391 m_imageList = imageList;
392 }
393
394 bool wxNotebook::SetPageText( int page, const wxString &text )
395 {
396 wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
397
398 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
399
400 wxCHECK_MSG( nb_page, FALSE, wxT("SetPageText: invalid page index") );
401
402 nb_page->m_text = text;
403
404 gtk_label_set( nb_page->m_label, nb_page->m_text.mbc_str() );
405
406 return TRUE;
407 }
408
409 bool wxNotebook::SetPageImage( int page, int image )
410 {
411 /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
412
413 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
414
415 if (!nb_page) return FALSE;
416
417 /* Optimization posibility: return immediately if image unchanged.
418 * Not enabled because it may break existing (stupid) code that
419 * manipulates the imagelist to cycle images */
420
421 /* if (image == nb_page->m_image) return TRUE; */
422
423 /* For different cases:
424 1) no image -> no image
425 2) image -> no image
426 3) no image -> image
427 4) image -> image */
428
429 if (image == -1 && nb_page->m_image == -1)
430 return TRUE; /* Case 1): Nothing to do. */
431
432 GtkWidget *pixmapwid = (GtkWidget*) NULL;
433
434 if (nb_page->m_image != -1)
435 {
436 /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
437
438 GList *child = gtk_container_children(GTK_CONTAINER(nb_page->m_box));
439 while (child)
440 {
441 if (GTK_IS_PIXMAP(child->data))
442 {
443 pixmapwid = GTK_WIDGET(child->data);
444 break;
445 }
446 child = child->next;
447 }
448
449 /* We should have the pixmap widget now */
450 wxASSERT(pixmapwid != NULL);
451
452 if (image == -1)
453 {
454 /* If there's no new widget, just remove the old from the box */
455 gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid);
456 nb_page->m_image = -1;
457
458 return TRUE; /* Case 2) */
459 }
460 }
461
462 /* Only cases 3) and 4) left */
463 wxASSERT( m_imageList != NULL ); /* Just in case */
464
465 /* Construct the new pixmap */
466 const wxBitmap *bmp = m_imageList->GetBitmap(image);
467 GdkPixmap *pixmap = bmp->GetPixmap();
468 GdkBitmap *mask = (GdkBitmap*) NULL;
469 if ( bmp->GetMask() )
470 {
471 mask = bmp->GetMask()->GetBitmap();
472 }
473
474 if (pixmapwid == NULL)
475 {
476 /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
477 pixmapwid = gtk_pixmap_new (pixmap, mask );
478
479 /* CHECKME: Are these pack flags okay? */
480 gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, 3);
481 gtk_widget_show(pixmapwid);
482 }
483 else
484 {
485 /* Case 4) Simply replace the pixmap */
486 gtk_pixmap_set(GTK_PIXMAP(pixmapwid), pixmap, mask);
487 }
488
489 nb_page->m_image = image;
490
491 return TRUE;
492 }
493
494 void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) )
495 {
496 wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
497 }
498
499 void wxNotebook::SetPadding( const wxSize &WXUNUSED(padding) )
500 {
501 wxFAIL_MSG( wxT("wxNotebook::SetPadding not implemented") );
502 }
503
504 void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
505 {
506 wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
507 }
508
509 bool wxNotebook::DeleteAllPages()
510 {
511 wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
512
513 while (m_pages.GetCount() > 0)
514 DeletePage( m_pages.GetCount()-1 );
515
516 return TRUE;
517 }
518
519 bool wxNotebook::DeletePage( int page )
520 {
521 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
522 if (!nb_page) return FALSE;
523
524 /* GTK sets GtkNotebook.cur_page to NULL before sending
525 the switch page event */
526 m_lastSelection = GetSelection();
527
528 nb_page->m_client->Destroy();
529 m_pages.DeleteObject( nb_page );
530
531 m_lastSelection = -1;
532
533 return TRUE;
534 }
535
536 bool wxNotebook::RemovePage( int page )
537 {
538 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
539
540 wxCHECK_MSG( nb_page, FALSE, _T("wxNotebook::RemovePage: invalid page") );
541
542 gtk_widget_ref( nb_page->m_client->m_widget );
543 gtk_widget_unrealize( nb_page->m_client->m_widget );
544 gtk_widget_unparent( nb_page->m_client->m_widget );
545
546 gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget), page );
547
548 m_pages.DeleteObject( nb_page );
549
550 return TRUE;
551 }
552
553 bool wxNotebook::InsertPage( int position, wxNotebookPage* win, const wxString& text,
554 bool select, int imageId )
555 {
556 wxCHECK_MSG( m_widget != NULL, FALSE, wxT("invalid notebook") );
557
558 wxCHECK_MSG( win->GetParent() == this, FALSE,
559 wxT("Can't add a page whose parent is not the notebook!") );
560
561 /* don't receive switch page during addition */
562 gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
563 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
564
565 if (m_themeEnabled)
566 win->SetThemeEnabled(TRUE);
567
568 GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
569
570 wxGtkNotebookPage *page = new wxGtkNotebookPage();
571
572 if (position < 0)
573 m_pages.Append( page );
574 else
575 m_pages.Insert( m_pages.Nth( position ), page );
576
577 page->m_client = win;
578
579 page->m_box = gtk_hbox_new( FALSE, 0 );
580 gtk_container_border_width( GTK_CONTAINER(page->m_box), 2 );
581
582 gtk_signal_connect( GTK_OBJECT(win->m_widget), "size_allocate",
583 GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)win );
584
585 if (position < 0)
586 gtk_notebook_append_page( notebook, win->m_widget, page->m_box );
587 else
588 gtk_notebook_insert_page( notebook, win->m_widget, page->m_box, position );
589
590 page->m_page = (GtkNotebookPage*) g_list_last(notebook->children)->data;
591
592 /* set the label image */
593 page->m_image = imageId;
594
595 if (imageId != -1)
596 {
597 wxASSERT( m_imageList != NULL );
598
599 const wxBitmap *bmp = m_imageList->GetBitmap(imageId);
600 GdkPixmap *pixmap = bmp->GetPixmap();
601 GdkBitmap *mask = (GdkBitmap*) NULL;
602 if ( bmp->GetMask() )
603 {
604 mask = bmp->GetMask()->GetBitmap();
605 }
606
607 GtkWidget *pixmapwid = gtk_pixmap_new (pixmap, mask );
608
609 gtk_box_pack_start(GTK_BOX(page->m_box), pixmapwid, FALSE, FALSE, 3);
610
611 gtk_widget_show(pixmapwid);
612 }
613
614 /* set the label text */
615 page->m_text = text;
616 if (page->m_text.IsEmpty()) page->m_text = wxT("");
617
618 page->m_label = GTK_LABEL( gtk_label_new(page->m_text.mbc_str()) );
619 gtk_box_pack_end( GTK_BOX(page->m_box), GTK_WIDGET(page->m_label), FALSE, FALSE, 3 );
620
621 /* show the label */
622 gtk_widget_show( GTK_WIDGET(page->m_label) );
623
624 if (select && (m_pages.GetCount() > 1))
625 {
626 if (position < 0)
627 SetSelection( GetPageCount()-1 );
628 else
629 SetSelection( position );
630 }
631
632 gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
633 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
634
635 return TRUE;
636 }
637
638 bool wxNotebook::AddPage(wxNotebookPage* win, const wxString& text,
639 bool select, int imageId)
640 {
641 return InsertPage( -1, win, text, select, imageId );
642 }
643
644 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
645 {
646 if (event.IsWindowChange())
647 AdvanceSelection( event.GetDirection() );
648 else
649 event.Skip();
650 }
651
652 wxNotebookPage *wxNotebook::GetPage( int page ) const
653 {
654 wxCHECK_MSG( m_widget != NULL, (wxWindow*) NULL, wxT("invalid notebook") );
655
656 wxGtkNotebookPage* nb_page = GetNotebookPage(page);
657 if (!nb_page)
658 return (wxNotebookPage *) NULL;
659 else
660 return nb_page->m_client;
661 }
662
663 #if wxUSE_CONSTRAINTS
664
665 // override these 2 functions to do nothing: everything is done in OnSize
666 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) )
667 {
668 // don't set the sizes of the pages - their correct size is not yet known
669 wxControl::SetConstraintSizes(FALSE);
670 }
671
672 bool wxNotebook::DoPhase( int WXUNUSED(nPhase) )
673 {
674 return TRUE;
675 }
676
677 #endif
678
679 void wxNotebook::ApplyWidgetStyle()
680 {
681 // TODO, font for labels etc
682
683 SetWidgetStyle();
684 gtk_widget_set_style( m_widget, m_widgetStyle );
685 }
686
687 bool wxNotebook::IsOwnGtkWindow( GdkWindow *window )
688 {
689 return ((m_widget->window == window) ||
690 (GTK_NOTEBOOK(m_widget)->panel == window));
691 }
692
693 //-----------------------------------------------------------------------------
694 // wxNotebookEvent
695 //-----------------------------------------------------------------------------
696
697 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
698
699 #endif