1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk/notebook.cpp
4 // Author: Robert Roebling
6 // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
15 #include "wx/notebook.h"
21 #include "wx/msgdlg.h"
22 #include "wx/bitmap.h"
25 #include "wx/imaglist.h"
26 #include "wx/fontutil.h"
28 #include "wx/gtk/private.h"
29 #include "wx/gtk/win_gtk.h"
31 #include <gdk/gdkkeysyms.h>
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
37 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
38 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
40 //-----------------------------------------------------------------------------
42 //-----------------------------------------------------------------------------
44 extern bool g_blockEventsOnDrag
;
46 //-----------------------------------------------------------------------------
48 //-----------------------------------------------------------------------------
50 // VZ: this is rather ugly as we keep the pages themselves in an array (it
51 // allows us to have quite a few functions implemented in the base class)
52 // but the page data is kept in a separate list, so we must maintain them
53 // in sync manually... of course, the list had been there before the base
54 // class which explains it but it still would be nice to do something
57 class wxGtkNotebookPage
: public wxObject
63 m_page
= (GtkNotebookPage
*) NULL
;
64 m_box
= (GtkWidget
*) NULL
;
69 GtkNotebookPage
*m_page
;
71 GtkWidget
*m_box
; // in which the label and image are packed
75 #include "wx/listimpl.cpp"
76 WX_DEFINE_LIST(wxGtkNotebookPagesList
)
79 //-----------------------------------------------------------------------------
81 //-----------------------------------------------------------------------------
84 static void gtk_notebook_page_changing_callback( GtkNotebook
*widget
,
85 GtkNotebookPage
*WXUNUSED(gpage
),
87 wxNotebook
*notebook
)
89 int old
= gtk_notebook_get_current_page( widget
);
91 if ( !notebook
->SendPageChangingEvent(page
) )
93 // program doesn't allow the page change
94 g_signal_stop_emission_by_name(notebook
->m_widget
, "switch_page");
98 // the page change event also reports the old page
99 notebook
->m_oldSelection
= old
;
105 static void gtk_notebook_page_changed_callback( GtkNotebook
*widget
,
106 GtkNotebookPage
*WXUNUSED(gpage
),
108 wxNotebook
*notebook
)
110 int old
= notebook
->m_oldSelection
;
111 notebook
->SendPageChangedEvent( old
);
115 //-----------------------------------------------------------------------------
117 //-----------------------------------------------------------------------------
120 static void gtk_page_size_callback( GtkWidget
*WXUNUSED(widget
), GtkAllocation
* alloc
, wxWindow
*win
)
123 wxapp_install_idle_handler();
125 if ((win
->m_x
== alloc
->x
) &&
126 (win
->m_y
== alloc
->y
) &&
127 (win
->m_width
== alloc
->width
) &&
128 (win
->m_height
== alloc
->height
))
133 win
->SetSize( alloc
->x
, alloc
->y
, alloc
->width
, alloc
->height
);
135 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call allocate
136 here in order to make repositioning after resizing to take effect. */
137 if ((gtk_major_version
== 1) &&
138 (gtk_minor_version
== 2) &&
139 (gtk_micro_version
< 6) &&
141 (GTK_WIDGET_REALIZED(win
->m_wxwindow
)))
143 gtk_widget_size_allocate( win
->m_wxwindow
, alloc
);
148 //-----------------------------------------------------------------------------
149 // "realize" from m_widget
150 //-----------------------------------------------------------------------------
154 gtk_notebook_realized_callback( GtkWidget
* WXUNUSED(widget
), wxWindow
*win
)
157 wxapp_install_idle_handler();
159 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize
160 here in order to make repositioning before showing to take effect. */
161 gtk_widget_queue_resize( win
->m_widget
);
165 //-----------------------------------------------------------------------------
166 // InsertChild callback for wxNotebook
167 //-----------------------------------------------------------------------------
169 static void wxInsertChildInNotebook( wxNotebook
* parent
, wxWindow
* child
)
171 // Hack Alert! (Part I): This sets the notebook as the parent of the child
172 // widget, and takes care of some details such as updating the state and
173 // style of the child to reflect its new location. We do this early
174 // because without it GetBestSize (which is used to set the initial size
175 // of controls if an explicit size is not given) will often report
176 // incorrect sizes since the widget's style context is not fully known.
177 // See bug #901694 for details
178 // (http://sourceforge.net/tracker/?func=detail&aid=901694&group_id=9863&atid=109863)
179 gtk_widget_set_parent(child
->m_widget
, parent
->m_widget
);
181 // NOTE: This should be considered a temporary workaround until we can
182 // work out the details and implement delaying the setting of the initial
183 // size of widgets until the size is really needed.
186 //-----------------------------------------------------------------------------
188 //-----------------------------------------------------------------------------
190 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
,wxControl
)
192 BEGIN_EVENT_TABLE(wxNotebook
, wxControl
)
193 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
196 void wxNotebook::Init()
200 m_imageList
= (wxImageList
*) NULL
;
202 m_themeEnabled
= true;
205 wxNotebook::wxNotebook()
210 wxNotebook::wxNotebook( wxWindow
*parent
, wxWindowID id
,
211 const wxPoint
& pos
, const wxSize
& size
,
212 long style
, const wxString
& name
)
215 Create( parent
, id
, pos
, size
, style
, name
);
218 wxNotebook::~wxNotebook()
223 bool wxNotebook::Create(wxWindow
*parent
, wxWindowID id
,
224 const wxPoint
& pos
, const wxSize
& size
,
225 long style
, const wxString
& name
)
228 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInNotebook
;
230 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
233 if (!PreCreation( parent
, pos
, size
) ||
234 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
236 wxFAIL_MSG( wxT("wxNoteBook creation failed") );
241 m_widget
= gtk_notebook_new();
243 gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget
), 1 );
245 g_signal_connect (m_widget
, "switch_page",
246 G_CALLBACK (gtk_notebook_page_changing_callback
), this);
248 g_signal_connect_after (m_widget
, "switch_page",
249 G_CALLBACK (gtk_notebook_page_changed_callback
), this);
251 m_parent
->DoAddChild( this );
253 if (m_windowStyle
& wxBK_RIGHT
)
254 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_RIGHT
);
255 if (m_windowStyle
& wxBK_LEFT
)
256 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_LEFT
);
257 if (m_windowStyle
& wxBK_BOTTOM
)
258 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_BOTTOM
);
262 g_signal_connect (m_widget
, "realize",
263 G_CALLBACK (gtk_notebook_realized_callback
), this);
268 int wxNotebook::GetSelection() const
270 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
272 return gtk_notebook_get_current_page( GTK_NOTEBOOK(m_widget
) );
275 wxString
wxNotebook::GetPageText( size_t page
) const
277 wxCHECK_MSG( m_widget
!= NULL
, wxEmptyString
, wxT("invalid notebook") );
279 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
281 return nb_page
->m_text
;
283 return wxEmptyString
;
286 int wxNotebook::GetPageImage( size_t page
) const
288 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
290 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
292 return nb_page
->m_image
;
297 wxGtkNotebookPage
* wxNotebook::GetNotebookPage( int page
) const
299 wxCHECK_MSG( m_widget
!= NULL
, (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook") );
301 wxCHECK_MSG( page
< (int)m_pagesData
.GetCount(), (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook index") );
303 return m_pagesData
.Item(page
)->GetData();
306 int wxNotebook::DoSetSelection( size_t page
, int flags
)
308 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
310 wxCHECK_MSG( page
< m_pagesData
.GetCount(), -1, wxT("invalid notebook index") );
312 int selOld
= GetSelection();
314 if ( !(flags
& SetSelection_SendEvent
) )
316 g_signal_handlers_disconnect_by_func (m_widget
,
317 (gpointer
) gtk_notebook_page_changing_callback
,
320 g_signal_handlers_disconnect_by_func (m_widget
,
321 (gpointer
) gtk_notebook_page_changed_callback
,
325 gtk_notebook_set_current_page( GTK_NOTEBOOK(m_widget
), page
);
327 if ( !(flags
& SetSelection_SendEvent
) )
329 // reconnect to signals
331 g_signal_connect (m_widget
, "switch_page",
332 G_CALLBACK (gtk_notebook_page_changing_callback
), this);
334 g_signal_connect_after (m_widget
, "switch_page",
335 G_CALLBACK (gtk_notebook_page_changed_callback
), this);
338 wxNotebookPage
*client
= GetPage(page
);
345 bool wxNotebook::SetPageText( size_t page
, const wxString
&text
)
347 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
349 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
351 wxCHECK_MSG( nb_page
, false, wxT("SetPageText: invalid page index") );
353 nb_page
->m_text
= text
;
355 gtk_label_set_text( nb_page
->m_label
, wxGTK_CONV( nb_page
->m_text
) );
360 bool wxNotebook::SetPageImage( size_t page
, int image
)
362 /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
364 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
366 if (!nb_page
) return false;
368 /* Optimization posibility: return immediately if image unchanged.
369 * Not enabled because it may break existing (stupid) code that
370 * manipulates the imagelist to cycle images */
372 /* if (image == nb_page->m_image) return true; */
374 /* For different cases:
375 1) no image -> no image
380 if (image
== -1 && nb_page
->m_image
== -1)
381 return true; /* Case 1): Nothing to do. */
383 GtkWidget
*pixmapwid
= (GtkWidget
*) NULL
;
385 if (nb_page
->m_image
!= -1)
387 /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
389 GList
*child
= gtk_container_get_children(GTK_CONTAINER(nb_page
->m_box
));
392 if (GTK_IS_IMAGE(child
->data
))
394 pixmapwid
= GTK_WIDGET(child
->data
);
400 /* We should have the pixmap widget now */
401 wxASSERT(pixmapwid
!= NULL
);
405 /* If there's no new widget, just remove the old from the box */
406 gtk_container_remove(GTK_CONTAINER(nb_page
->m_box
), pixmapwid
);
407 nb_page
->m_image
= -1;
409 return true; /* Case 2) */
413 /* Only cases 3) and 4) left */
414 wxASSERT( m_imageList
!= NULL
); /* Just in case */
416 /* Construct the new pixmap */
417 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(image
);
419 if (pixmapwid
== NULL
)
421 /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
422 pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
424 /* CHECKME: Are these pack flags okay? */
425 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
426 gtk_widget_show(pixmapwid
);
430 /* Case 4) Simply replace the pixmap */
431 gtk_image_set_from_pixbuf((GtkImage
*)pixmapwid
, bmp
->GetPixbuf());
434 nb_page
->m_image
= image
;
439 void wxNotebook::SetPageSize( const wxSize
&WXUNUSED(size
) )
441 wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
444 void wxNotebook::SetPadding( const wxSize
&padding
)
446 wxCHECK_RET( m_widget
!= NULL
, wxT("invalid notebook") );
448 m_padding
= padding
.GetWidth();
451 for (i
=0; i
<int(GetPageCount()); i
++)
453 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
454 wxASSERT(nb_page
!= NULL
);
456 if (nb_page
->m_image
!= -1)
458 // gtk_box_set_child_packing sets padding on BOTH sides
459 // icon provides left padding, label provides center and right
460 int image
= nb_page
->m_image
;
462 SetPageImage(i
,image
);
464 wxASSERT(nb_page
->m_label
);
465 gtk_box_set_child_packing(GTK_BOX(nb_page
->m_box
),
466 GTK_WIDGET(nb_page
->m_label
),
467 FALSE
, FALSE
, m_padding
, GTK_PACK_END
);
471 void wxNotebook::SetTabSize(const wxSize
& WXUNUSED(sz
))
473 wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
476 bool wxNotebook::DeleteAllPages()
478 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
480 while (m_pagesData
.GetCount() > 0)
481 DeletePage( m_pagesData
.GetCount()-1 );
483 wxASSERT_MSG( GetPageCount() == 0, _T("all pages must have been deleted") );
485 InvalidateBestSize();
486 return wxNotebookBase::DeleteAllPages();
489 wxNotebookPage
*wxNotebook::DoRemovePage( size_t page
)
491 wxNotebookPage
*client
= wxNotebookBase::DoRemovePage(page
);
495 gtk_widget_ref( client
->m_widget
);
496 gtk_widget_unrealize( client
->m_widget
);
498 // we don't need to unparent the client->m_widget; GTK+ will do
499 // that for us (and will throw a warning if we do it!)
501 gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget
), page
);
503 wxGtkNotebookPage
* p
= GetNotebookPage(page
);
504 m_pagesData
.DeleteObject(p
);
510 bool wxNotebook::InsertPage( size_t position
,
512 const wxString
& text
,
516 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
518 wxCHECK_MSG( win
->GetParent() == this, false,
519 wxT("Can't add a page whose parent is not the notebook!") );
521 wxCHECK_MSG( position
<= GetPageCount(), false,
522 _T("invalid page index in wxNotebookPage::InsertPage()") );
524 // Hack Alert! (Part II): See above in wxInsertChildInNotebook callback
525 // why this has to be done. NOTE: using gtk_widget_unparent here does not
526 // work as it seems to undo too much and will cause errors in the
527 // gtk_notebook_insert_page below, so instead just clear the parent by
529 win
->m_widget
->parent
= NULL
;
532 win
->SetThemeEnabled(true);
534 GtkNotebook
*notebook
= GTK_NOTEBOOK(m_widget
);
536 wxGtkNotebookPage
*nb_page
= new wxGtkNotebookPage();
538 if ( position
== GetPageCount() )
539 m_pagesData
.Append( nb_page
);
541 m_pagesData
.Insert( position
, nb_page
);
543 m_pages
.Insert(win
, position
);
545 nb_page
->m_box
= gtk_hbox_new( FALSE
, 1 );
546 gtk_container_set_border_width((GtkContainer
*)nb_page
->m_box
, 2);
548 g_signal_connect (win
->m_widget
, "size_allocate",
549 G_CALLBACK (gtk_page_size_callback
), win
);
551 gtk_notebook_insert_page( notebook
, win
->m_widget
, nb_page
->m_box
, position
);
553 nb_page
->m_page
= (GtkNotebookPage
*) g_list_last(notebook
->children
)->data
;
555 /* set the label image */
556 nb_page
->m_image
= imageId
;
560 wxASSERT( m_imageList
!= NULL
);
562 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(imageId
);
563 GtkWidget
* pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
564 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
565 gtk_widget_show(pixmapwid
);
568 /* set the label text */
570 nb_page
->m_text
= wxStripMenuCodes(text
);
571 if (nb_page
->m_text
.empty()) nb_page
->m_text
= wxEmptyString
;
573 nb_page
->m_label
= GTK_LABEL( gtk_label_new(wxGTK_CONV(nb_page
->m_text
)) );
574 gtk_box_pack_end( GTK_BOX(nb_page
->m_box
), GTK_WIDGET(nb_page
->m_label
), FALSE
, FALSE
, m_padding
);
576 /* apply current style */
577 GtkRcStyle
*style
= CreateWidgetStyle();
580 gtk_widget_modify_style(GTK_WIDGET(nb_page
->m_label
), style
);
581 gtk_rc_style_unref(style
);
585 gtk_widget_show( GTK_WIDGET(nb_page
->m_label
) );
587 if (select
&& (m_pagesData
.GetCount() > 1))
589 SetSelection( position
);
592 InvalidateBestSize();
596 // helper for HitTest(): check if the point lies inside the given widget which
597 // is the child of the notebook whose position and border size are passed as
600 IsPointInsideWidget(const wxPoint
& pt
, GtkWidget
*w
,
601 gint x
, gint y
, gint border
= 0)
604 (pt
.x
>= w
->allocation
.x
- x
- border
) &&
605 (pt
.x
<= w
->allocation
.x
- x
+ border
+ w
->allocation
.width
) &&
606 (pt
.y
>= w
->allocation
.y
- y
- border
) &&
607 (pt
.y
<= w
->allocation
.y
- y
+ border
+ w
->allocation
.height
);
610 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
612 const gint x
= m_widget
->allocation
.x
;
613 const gint y
= m_widget
->allocation
.y
;
615 const size_t count
= GetPageCount();
618 GtkNotebook
* notebook
= GTK_NOTEBOOK(m_widget
);
619 if (gtk_notebook_get_scrollable(notebook
))
620 i
= g_list_position( notebook
->children
, notebook
->first_tab
);
622 for ( ; i
< count
; i
++ )
624 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
625 GtkWidget
*box
= nb_page
->m_box
;
627 const gint border
= gtk_container_get_border_width(GTK_CONTAINER(box
));
629 if ( IsPointInsideWidget(pt
, box
, x
, y
, border
) )
631 // ok, we're inside this tab -- now find out where, if needed
634 GtkWidget
*pixmap
= NULL
;
636 GList
*children
= gtk_container_get_children(GTK_CONTAINER(box
));
637 for ( GList
*child
= children
; child
; child
= child
->next
)
639 if (GTK_IS_IMAGE(child
->data
))
641 pixmap
= GTK_WIDGET(child
->data
);
647 g_list_free(children
);
649 if ( pixmap
&& IsPointInsideWidget(pt
, pixmap
, x
, y
) )
651 *flags
= wxBK_HITTEST_ONICON
;
653 else if ( IsPointInsideWidget(pt
, GTK_WIDGET(nb_page
->m_label
), x
, y
) )
655 *flags
= wxBK_HITTEST_ONLABEL
;
659 *flags
= wxBK_HITTEST_ONITEM
;
669 *flags
= wxBK_HITTEST_NOWHERE
;
670 wxWindowBase
* page
= GetCurrentPage();
673 // rect origin is in notebook's parent coordinates
674 wxRect rect
= page
->GetRect();
676 // adjust it to the notebook's coordinates
677 wxPoint pos
= GetPosition();
680 if ( rect
.Contains( pt
) )
681 *flags
|= wxBK_HITTEST_ONPAGE
;
688 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
690 if (event
.IsWindowChange())
691 AdvanceSelection( event
.GetDirection() );
696 #if wxUSE_CONSTRAINTS
698 // override these 2 functions to do nothing: everything is done in OnSize
699 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse
) )
701 // don't set the sizes of the pages - their correct size is not yet known
702 wxControl::SetConstraintSizes(false);
705 bool wxNotebook::DoPhase( int WXUNUSED(nPhase
) )
712 void wxNotebook::DoApplyWidgetStyle(GtkRcStyle
*style
)
714 gtk_widget_modify_style(m_widget
, style
);
715 size_t cnt
= m_pagesData
.GetCount();
716 for (size_t i
= 0; i
< cnt
; i
++)
717 gtk_widget_modify_style(GTK_WIDGET(GetNotebookPage(i
)->m_label
), style
);
720 GdkWindow
*wxNotebook::GTKGetWindow(wxArrayGdkWindows
& windows
) const
722 windows
.push_back(m_widget
->window
);
723 windows
.push_back(GTK_NOTEBOOK(m_widget
)->event_window
);
730 wxNotebook::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
732 return GetDefaultAttributesFromGTKWidget(gtk_notebook_new
);
735 //-----------------------------------------------------------------------------
737 //-----------------------------------------------------------------------------
739 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)