1 /////////////////////////////////////////////////////////////////////////////
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
11 #pragma implementation "notebook.h"
14 #include "wx/notebook.h"
20 #include "wx/imaglist.h"
23 #include "wx/bitmap.h"
25 #include "wx/gtk/private.h"
26 #include "wx/gtk/win_gtk.h"
28 #include <gdk/gdkkeysyms.h>
30 // ----------------------------------------------------------------------------
32 // ----------------------------------------------------------------------------
34 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
35 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
37 //-----------------------------------------------------------------------------
39 //-----------------------------------------------------------------------------
41 extern void wxapp_install_idle_handler();
44 //-----------------------------------------------------------------------------
46 //-----------------------------------------------------------------------------
48 extern bool g_blockEventsOnDrag
;
50 //-----------------------------------------------------------------------------
52 //-----------------------------------------------------------------------------
54 // VZ: this is rather ugly as we keep the pages themselves in an array (it
55 // allows us to have quite a few functions implemented in the base class)
56 // but the page data is kept in a separate list, so we must maintain them
57 // in sync manually... of course, the list had been there before the base
58 // class which explains it but it still would be nice to do something
61 class wxGtkNotebookPage
: public wxObject
67 m_page
= (GtkNotebookPage
*) NULL
;
68 m_box
= (GtkWidget
*) NULL
;
73 GtkNotebookPage
*m_page
;
75 GtkWidget
*m_box
; // in which the label and image are packed
78 #include "wx/listimpl.cpp"
79 WX_DEFINE_LIST(wxGtkNotebookPagesList
);
81 //-----------------------------------------------------------------------------
83 //-----------------------------------------------------------------------------
85 static void gtk_notebook_page_change_callback(GtkNotebook
*WXUNUSED(widget
),
86 GtkNotebookPage
*WXUNUSED(page
),
88 wxNotebook
*notebook
)
90 // are you trying to call SetSelection() from a notebook event handler?
92 wxCHECK_RET( !notebook
->m_inSwitchPage
,
93 _T("gtk_notebook_page_change_callback reentered") );
95 notebook
->m_inSwitchPage
= TRUE
;
97 wxapp_install_idle_handler();
99 int old
= notebook
->GetSelection();
101 wxNotebookEvent
eventChanging( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
,
102 notebook
->GetId(), page
, old
);
103 eventChanging
.SetEventObject( notebook
);
105 if ( (notebook
->GetEventHandler()->ProcessEvent(eventChanging
)) &&
106 !eventChanging
.IsAllowed() )
108 /* program doesn't allow the page change */
109 gtk_signal_emit_stop_by_name( GTK_OBJECT(notebook
->m_widget
),
112 else // change allowed
114 // make wxNotebook::GetSelection() return the correct (i.e. consistent
115 // with wxNotebookEvent::GetSelection()) value even though the page is
116 // not really changed in GTK+
117 notebook
->m_selection
= page
;
119 wxNotebookEvent
eventChanged( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
,
120 notebook
->GetId(), page
, old
);
121 eventChanged
.SetEventObject( notebook
);
122 notebook
->GetEventHandler()->ProcessEvent( eventChanged
);
125 notebook
->m_inSwitchPage
= FALSE
;
128 //-----------------------------------------------------------------------------
130 //-----------------------------------------------------------------------------
132 static void gtk_page_size_callback( GtkWidget
*WXUNUSED(widget
), GtkAllocation
* alloc
, wxWindow
*win
)
135 wxapp_install_idle_handler();
137 if ((win
->m_x
== alloc
->x
) &&
138 (win
->m_y
== alloc
->y
) &&
139 (win
->m_width
== alloc
->width
) &&
140 (win
->m_height
== alloc
->height
))
145 win
->SetSize( alloc
->x
, alloc
->y
, alloc
->width
, alloc
->height
);
147 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call allocate
148 here in order to make repositioning after resizing to take effect. */
149 if ((gtk_major_version
== 1) &&
150 (gtk_minor_version
== 2) &&
151 (gtk_micro_version
< 6) &&
153 (GTK_WIDGET_REALIZED(win
->m_wxwindow
)))
155 gtk_widget_size_allocate( win
->m_wxwindow
, alloc
);
159 //-----------------------------------------------------------------------------
160 // "realize" from m_widget
161 //-----------------------------------------------------------------------------
164 gtk_notebook_realized_callback( GtkWidget
* WXUNUSED(widget
), wxWindow
*win
)
167 wxapp_install_idle_handler();
169 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize
170 here in order to make repositioning before showing to take effect. */
171 gtk_widget_queue_resize( win
->m_widget
);
176 //-----------------------------------------------------------------------------
178 //-----------------------------------------------------------------------------
180 static gint
gtk_notebook_key_press_callback( GtkWidget
*widget
, GdkEventKey
*gdk_event
, wxNotebook
*win
)
183 wxapp_install_idle_handler();
185 if (!win
->m_hasVMT
) return FALSE
;
186 if (g_blockEventsOnDrag
) return FALSE
;
188 /* win is a control: tab can be propagated up */
189 if ((gdk_event
->keyval
== GDK_Tab
) || (gdk_event
->keyval
== GDK_ISO_Left_Tab
))
191 int sel
= win
->GetSelection();
192 wxGtkNotebookPage
*nb_page
= win
->GetNotebookPage(sel
);
193 wxCHECK_MSG( nb_page
, FALSE
, _T("invalid selection in wxNotebook") );
195 wxNavigationKeyEvent event
;
196 event
.SetEventObject( win
);
197 /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */
198 event
.SetDirection( (gdk_event
->keyval
== GDK_Tab
) );
199 /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */
200 event
.SetWindowChange( (gdk_event
->state
& GDK_CONTROL_MASK
) );
201 event
.SetCurrentFocus( win
);
203 wxNotebookPage
*client
= win
->GetPage(sel
);
204 if ( !client
->GetEventHandler()->ProcessEvent( event
) )
209 gtk_signal_emit_stop_by_name( GTK_OBJECT(widget
), "key_press_event" );
216 //-----------------------------------------------------------------------------
217 // InsertChild callback for wxNotebook
218 //-----------------------------------------------------------------------------
220 static void wxInsertChildInNotebook( wxNotebook
* WXUNUSED(parent
), wxWindow
* WXUNUSED(child
) )
222 /* we don't do anything here but pray */
225 //-----------------------------------------------------------------------------
227 //-----------------------------------------------------------------------------
229 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
,wxControl
)
231 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
232 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
235 void wxNotebook::Init()
238 m_inSwitchPage
= FALSE
;
240 m_imageList
= (wxImageList
*) NULL
;
241 m_pagesData
.DeleteContents( TRUE
);
243 m_themeEnabled
= TRUE
;
246 wxNotebook::wxNotebook()
251 wxNotebook::wxNotebook( wxWindow
*parent
, wxWindowID id
,
252 const wxPoint
& pos
, const wxSize
& size
,
253 long style
, const wxString
& name
)
256 Create( parent
, id
, pos
, size
, style
, name
);
259 wxNotebook::~wxNotebook()
261 /* don't generate change page events any more */
262 gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget
),
263 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback
), (gpointer
) this );
268 bool wxNotebook::Create(wxWindow
*parent
, wxWindowID id
,
269 const wxPoint
& pos
, const wxSize
& size
,
270 long style
, const wxString
& name
)
273 m_acceptsFocus
= TRUE
;
274 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInNotebook
;
276 if (!PreCreation( parent
, pos
, size
) ||
277 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
279 wxFAIL_MSG( wxT("wxNoteBook creation failed") );
284 m_widget
= gtk_notebook_new();
286 gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget
), 1 );
288 gtk_signal_connect( GTK_OBJECT(m_widget
), "switch_page",
289 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback
), (gpointer
)this );
291 m_parent
->DoAddChild( this );
293 if (m_windowStyle
& wxNB_RIGHT
)
294 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_RIGHT
);
295 if (m_windowStyle
& wxNB_LEFT
)
296 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_LEFT
);
297 if (m_windowStyle
& wxNB_BOTTOM
)
298 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_BOTTOM
);
300 gtk_signal_connect( GTK_OBJECT(m_widget
), "key_press_event",
301 GTK_SIGNAL_FUNC(gtk_notebook_key_press_callback
), (gpointer
)this );
305 SetFont( parent
->GetFont() );
307 gtk_signal_connect( GTK_OBJECT(m_widget
), "realize",
308 GTK_SIGNAL_FUNC(gtk_notebook_realized_callback
), (gpointer
) this );
315 int wxNotebook::GetSelection() const
317 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
319 if ( m_selection
== -1 )
321 GList
*nb_pages
= GTK_NOTEBOOK(m_widget
)->children
;
323 if (g_list_length(nb_pages
) != 0)
325 GtkNotebook
*notebook
= GTK_NOTEBOOK(m_widget
);
327 gpointer cur
= notebook
->cur_page
;
330 wxConstCast(this, wxNotebook
)->m_selection
=
331 g_list_index( nb_pages
, cur
);
339 wxString
wxNotebook::GetPageText( int page
) const
341 wxCHECK_MSG( m_widget
!= NULL
, wxT(""), wxT("invalid notebook") );
343 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
345 return nb_page
->m_text
;
350 int wxNotebook::GetPageImage( int page
) const
352 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
354 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
356 return nb_page
->m_image
;
361 wxGtkNotebookPage
* wxNotebook::GetNotebookPage( int page
) const
363 wxCHECK_MSG( m_widget
!= NULL
, (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook") );
365 wxCHECK_MSG( page
< (int)m_pagesData
.GetCount(), (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook index") );
367 return m_pagesData
.Item(page
)->GetData();
370 int wxNotebook::SetSelection( int page
)
372 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
374 wxCHECK_MSG( page
< (int)m_pagesData
.GetCount(), -1, wxT("invalid notebook index") );
376 int selOld
= GetSelection();
378 // cache the selection
380 gtk_notebook_set_page( GTK_NOTEBOOK(m_widget
), page
);
382 wxNotebookPage
*client
= GetPage(page
);
389 bool wxNotebook::SetPageText( int page
, const wxString
&text
)
391 wxCHECK_MSG( m_widget
!= NULL
, FALSE
, wxT("invalid notebook") );
393 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
395 wxCHECK_MSG( nb_page
, FALSE
, wxT("SetPageText: invalid page index") );
397 nb_page
->m_text
= text
;
399 gtk_label_set( nb_page
->m_label
, wxGTK_CONV( nb_page
->m_text
) );
404 bool wxNotebook::SetPageImage( int page
, int image
)
406 /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
408 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
410 if (!nb_page
) return FALSE
;
412 /* Optimization posibility: return immediately if image unchanged.
413 * Not enabled because it may break existing (stupid) code that
414 * manipulates the imagelist to cycle images */
416 /* if (image == nb_page->m_image) return TRUE; */
418 /* For different cases:
419 1) no image -> no image
424 if (image
== -1 && nb_page
->m_image
== -1)
425 return TRUE
; /* Case 1): Nothing to do. */
427 GtkWidget
*pixmapwid
= (GtkWidget
*) NULL
;
429 if (nb_page
->m_image
!= -1)
431 /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
433 GList
*child
= gtk_container_children(GTK_CONTAINER(nb_page
->m_box
));
436 if (GTK_IS_PIXMAP(child
->data
))
438 pixmapwid
= GTK_WIDGET(child
->data
);
444 /* We should have the pixmap widget now */
445 wxASSERT(pixmapwid
!= NULL
);
449 /* If there's no new widget, just remove the old from the box */
450 gtk_container_remove(GTK_CONTAINER(nb_page
->m_box
), pixmapwid
);
451 nb_page
->m_image
= -1;
453 return TRUE
; /* Case 2) */
457 /* Only cases 3) and 4) left */
458 wxASSERT( m_imageList
!= NULL
); /* Just in case */
460 /* Construct the new pixmap */
461 const wxBitmap
*bmp
= m_imageList
->GetBitmap(image
);
462 GdkPixmap
*pixmap
= bmp
->GetPixmap();
463 GdkBitmap
*mask
= (GdkBitmap
*) NULL
;
464 if ( bmp
->GetMask() )
466 mask
= bmp
->GetMask()->GetBitmap();
469 if (pixmapwid
== NULL
)
471 /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
472 pixmapwid
= gtk_pixmap_new (pixmap
, mask
);
474 /* CHECKME: Are these pack flags okay? */
475 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
476 gtk_widget_show(pixmapwid
);
480 /* Case 4) Simply replace the pixmap */
481 gtk_pixmap_set(GTK_PIXMAP(pixmapwid
), pixmap
, mask
);
484 nb_page
->m_image
= image
;
489 void wxNotebook::SetPageSize( const wxSize
&WXUNUSED(size
) )
491 wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
494 void wxNotebook::SetPadding( const wxSize
&padding
)
496 wxCHECK_RET( m_widget
!= NULL
, wxT("invalid notebook") );
498 m_padding
= padding
.GetWidth();
501 for (i
=0; i
<int(GetPageCount()); i
++)
503 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
504 wxASSERT(nb_page
!= NULL
);
506 if (nb_page
->m_image
!= -1)
508 // gtk_box_set_child_packing sets padding on BOTH sides
509 // icon provides left padding, label provides center and right
510 int image
= nb_page
->m_image
;
512 SetPageImage(i
,image
);
514 wxASSERT(nb_page
->m_label
);
515 gtk_box_set_child_packing(GTK_BOX(nb_page
->m_box
),
516 GTK_WIDGET(nb_page
->m_label
),
517 FALSE
, FALSE
, m_padding
, GTK_PACK_END
);
521 void wxNotebook::SetTabSize(const wxSize
& WXUNUSED(sz
))
523 wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
526 bool wxNotebook::DeleteAllPages()
528 wxCHECK_MSG( m_widget
!= NULL
, FALSE
, wxT("invalid notebook") );
530 while (m_pagesData
.GetCount() > 0)
531 DeletePage( m_pagesData
.GetCount()-1 );
533 wxASSERT_MSG( GetPageCount() == 0, _T("all pages must have been deleted") );
535 return wxNotebookBase::DeleteAllPages();
538 bool wxNotebook::DeletePage( int page
)
540 // GTK sets GtkNotebook.cur_page to NULL before sending the switch page
541 // event so we have to store the selection internally
542 if ( m_selection
== -1 )
544 m_selection
= GetSelection();
545 if ( m_selection
== (int)m_pagesData
.GetCount() - 1 )
547 // the index will become invalid after the page is deleted
552 // it will call our DoRemovePage() to do the real work
553 return wxNotebookBase::DeletePage(page
);
556 wxNotebookPage
*wxNotebook::DoRemovePage( int page
)
558 wxNotebookPage
*client
= wxNotebookBase::DoRemovePage(page
);
562 gtk_widget_ref( client
->m_widget
);
563 gtk_widget_unrealize( client
->m_widget
);
564 gtk_widget_unparent( client
->m_widget
);
566 gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget
), page
);
568 m_pagesData
.DeleteObject(GetNotebookPage(page
));
573 bool wxNotebook::InsertPage( int position
,
575 const wxString
& text
,
579 wxCHECK_MSG( m_widget
!= NULL
, FALSE
, wxT("invalid notebook") );
581 wxCHECK_MSG( win
->GetParent() == this, FALSE
,
582 wxT("Can't add a page whose parent is not the notebook!") );
584 wxCHECK_MSG( position
>= 0 && position
<= GetPageCount(), FALSE
,
585 _T("invalid page index in wxNotebookPage::InsertPage()") );
587 /* don't receive switch page during addition */
588 gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget
),
589 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback
), (gpointer
) this );
592 win
->SetThemeEnabled(TRUE
);
594 GtkNotebook
*notebook
= GTK_NOTEBOOK(m_widget
);
596 wxGtkNotebookPage
*nb_page
= new wxGtkNotebookPage();
598 if ( position
== GetPageCount() )
599 m_pagesData
.Append( nb_page
);
601 m_pagesData
.Insert( m_pagesData
.Item( position
), nb_page
);
603 m_pages
.Insert(win
, position
);
605 nb_page
->m_box
= gtk_hbox_new( FALSE
, 1 );
606 gtk_container_border_width( GTK_CONTAINER(nb_page
->m_box
), 2 );
608 gtk_signal_connect( GTK_OBJECT(win
->m_widget
), "size_allocate",
609 GTK_SIGNAL_FUNC(gtk_page_size_callback
), (gpointer
)win
);
612 gtk_notebook_append_page( notebook
, win
->m_widget
, nb_page
->m_box
);
614 gtk_notebook_insert_page( notebook
, win
->m_widget
, nb_page
->m_box
, position
);
616 nb_page
->m_page
= (GtkNotebookPage
*) g_list_last(notebook
->children
)->data
;
618 /* set the label image */
619 nb_page
->m_image
= imageId
;
623 wxASSERT( m_imageList
!= NULL
);
625 const wxBitmap
*bmp
= m_imageList
->GetBitmap(imageId
);
626 GdkPixmap
*pixmap
= bmp
->GetPixmap();
627 GdkBitmap
*mask
= (GdkBitmap
*) NULL
;
628 if ( bmp
->GetMask() )
630 mask
= bmp
->GetMask()->GetBitmap();
633 GtkWidget
*pixmapwid
= gtk_pixmap_new (pixmap
, mask
);
635 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
637 gtk_widget_show(pixmapwid
);
640 /* set the label text */
641 nb_page
->m_text
= text
;
642 if (nb_page
->m_text
.IsEmpty()) nb_page
->m_text
= wxT("");
644 nb_page
->m_label
= GTK_LABEL( gtk_label_new(nb_page
->m_text
.mbc_str()) );
645 gtk_box_pack_end( GTK_BOX(nb_page
->m_box
), GTK_WIDGET(nb_page
->m_label
), FALSE
, FALSE
, m_padding
);
648 gtk_widget_show( GTK_WIDGET(nb_page
->m_label
) );
649 if (select
&& (m_pagesData
.GetCount() > 1))
652 SetSelection( GetPageCount()-1 );
654 SetSelection( position
);
657 gtk_signal_connect( GTK_OBJECT(m_widget
), "switch_page",
658 GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback
), (gpointer
)this );
663 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
665 if (event
.IsWindowChange())
666 AdvanceSelection( event
.GetDirection() );
671 #if wxUSE_CONSTRAINTS
673 // override these 2 functions to do nothing: everything is done in OnSize
674 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse
) )
676 // don't set the sizes of the pages - their correct size is not yet known
677 wxControl::SetConstraintSizes(FALSE
);
680 bool wxNotebook::DoPhase( int WXUNUSED(nPhase
) )
687 void wxNotebook::ApplyWidgetStyle()
689 // TODO, font for labels etc
692 gtk_widget_set_style( m_widget
, m_widgetStyle
);
695 bool wxNotebook::IsOwnGtkWindow( GdkWindow
*window
)
697 return ((m_widget
->window
== window
) ||
698 (NOTEBOOK_PANEL(m_widget
) == window
));
701 //-----------------------------------------------------------------------------
703 //-----------------------------------------------------------------------------
705 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)