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"
30 #include <gdk/gdkkeysyms.h>
32 // ----------------------------------------------------------------------------
34 // ----------------------------------------------------------------------------
36 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
)
37 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
)
39 //-----------------------------------------------------------------------------
41 //-----------------------------------------------------------------------------
43 extern bool g_blockEventsOnDrag
;
45 //-----------------------------------------------------------------------------
47 //-----------------------------------------------------------------------------
49 // VZ: this is rather ugly as we keep the pages themselves in an array (it
50 // allows us to have quite a few functions implemented in the base class)
51 // but the page data is kept in a separate list, so we must maintain them
52 // in sync manually... of course, the list had been there before the base
53 // class which explains it but it still would be nice to do something
56 class wxGtkNotebookPage
: public wxObject
62 m_page
= (GtkNotebookPage
*) NULL
;
63 m_box
= (GtkWidget
*) NULL
;
68 GtkNotebookPage
*m_page
;
70 GtkWidget
*m_box
; // in which the label and image are packed
74 #include "wx/listimpl.cpp"
75 WX_DEFINE_LIST(wxGtkNotebookPagesList
)
78 //-----------------------------------------------------------------------------
80 //-----------------------------------------------------------------------------
83 static void gtk_notebook_page_changing_callback( GtkNotebook
*widget
,
84 GtkNotebookPage
*WXUNUSED(gpage
),
86 wxNotebook
*notebook
)
88 int old
= gtk_notebook_get_current_page( widget
);
90 if ( !notebook
->SendPageChangingEvent(page
) )
92 // program doesn't allow the page change
93 g_signal_stop_emission_by_name(notebook
->m_widget
, "switch_page");
97 // the page change event also reports the old page
98 notebook
->m_oldSelection
= old
;
104 static void gtk_notebook_page_changed_callback( GtkNotebook
* WXUNUSED(widget
),
105 GtkNotebookPage
*WXUNUSED(gpage
),
106 guint
WXUNUSED(page
),
107 wxNotebook
*notebook
)
109 int old
= notebook
->m_oldSelection
;
110 notebook
->SendPageChangedEvent( old
);
114 //-----------------------------------------------------------------------------
116 //-----------------------------------------------------------------------------
119 static void gtk_page_size_callback( GtkWidget
*WXUNUSED(widget
), GtkAllocation
* alloc
, wxWindow
*win
)
121 if ((win
->m_x
== alloc
->x
) &&
122 (win
->m_y
== alloc
->y
) &&
123 (win
->m_width
== alloc
->width
) &&
124 (win
->m_height
== alloc
->height
))
129 win
->SetSize( alloc
->x
, alloc
->y
, alloc
->width
, alloc
->height
);
133 //-----------------------------------------------------------------------------
134 // "realize" from m_widget
135 //-----------------------------------------------------------------------------
139 gtk_notebook_realized_callback( GtkWidget
* WXUNUSED(widget
), wxWindow
*win
)
141 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize
142 here in order to make repositioning before showing to take effect. */
143 gtk_widget_queue_resize( win
->m_widget
);
147 //-----------------------------------------------------------------------------
148 // InsertChild callback for wxNotebook
149 //-----------------------------------------------------------------------------
151 static void wxInsertChildInNotebook(wxWindow
* parent
, wxWindow
* child
)
153 // Hack Alert! (Part I): This sets the notebook as the parent of the child
154 // widget, and takes care of some details such as updating the state and
155 // style of the child to reflect its new location. We do this early
156 // because without it GetBestSize (which is used to set the initial size
157 // of controls if an explicit size is not given) will often report
158 // incorrect sizes since the widget's style context is not fully known.
159 // See bug #901694 for details
160 // (http://sourceforge.net/tracker/?func=detail&aid=901694&group_id=9863&atid=109863)
161 gtk_widget_set_parent(child
->m_widget
, parent
->m_widget
);
163 // NOTE: This should be considered a temporary workaround until we can
164 // work out the details and implement delaying the setting of the initial
165 // size of widgets until the size is really needed.
168 //-----------------------------------------------------------------------------
170 //-----------------------------------------------------------------------------
172 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
,wxBookCtrlBase
)
174 BEGIN_EVENT_TABLE(wxNotebook
, wxBookCtrlBase
)
175 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
178 void wxNotebook::Init()
182 m_imageList
= (wxImageList
*) NULL
;
184 m_themeEnabled
= true;
187 wxNotebook::wxNotebook()
192 wxNotebook::wxNotebook( wxWindow
*parent
, wxWindowID id
,
193 const wxPoint
& pos
, const wxSize
& size
,
194 long style
, const wxString
& name
)
197 Create( parent
, id
, pos
, size
, style
, name
);
200 wxNotebook::~wxNotebook()
205 bool wxNotebook::Create(wxWindow
*parent
, wxWindowID id
,
206 const wxPoint
& pos
, const wxSize
& size
,
207 long style
, const wxString
& name
)
209 m_insertCallback
= wxInsertChildInNotebook
;
211 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
214 if (!PreCreation( parent
, pos
, size
) ||
215 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
217 wxFAIL_MSG( wxT("wxNoteBook creation failed") );
222 m_widget
= gtk_notebook_new();
224 gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget
), 1 );
226 g_signal_connect (m_widget
, "switch_page",
227 G_CALLBACK (gtk_notebook_page_changing_callback
), this);
229 g_signal_connect_after (m_widget
, "switch_page",
230 G_CALLBACK (gtk_notebook_page_changed_callback
), this);
232 m_parent
->DoAddChild( this );
234 if (m_windowStyle
& wxBK_RIGHT
)
235 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_RIGHT
);
236 if (m_windowStyle
& wxBK_LEFT
)
237 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_LEFT
);
238 if (m_windowStyle
& wxBK_BOTTOM
)
239 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_BOTTOM
);
243 g_signal_connect (m_widget
, "realize",
244 G_CALLBACK (gtk_notebook_realized_callback
), this);
249 int wxNotebook::GetSelection() const
251 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
253 return gtk_notebook_get_current_page( GTK_NOTEBOOK(m_widget
) );
256 wxString
wxNotebook::GetPageText( size_t page
) const
258 wxCHECK_MSG( m_widget
!= NULL
, wxEmptyString
, wxT("invalid notebook") );
260 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
262 return nb_page
->m_text
;
264 return wxEmptyString
;
267 int wxNotebook::GetPageImage( size_t page
) const
269 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
271 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
273 return nb_page
->m_image
;
278 wxGtkNotebookPage
* wxNotebook::GetNotebookPage( int page
) const
280 wxCHECK_MSG( m_widget
!= NULL
, (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook") );
282 wxCHECK_MSG( page
< (int)m_pagesData
.GetCount(), (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook index") );
284 return m_pagesData
.Item(page
)->GetData();
287 int wxNotebook::DoSetSelection( size_t page
, int flags
)
289 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
291 wxCHECK_MSG( page
< m_pagesData
.GetCount(), -1, wxT("invalid notebook index") );
293 int selOld
= GetSelection();
295 if ( !(flags
& SetSelection_SendEvent
) )
297 g_signal_handlers_block_by_func(m_widget
,
298 (gpointer
)gtk_notebook_page_changing_callback
, this);
300 g_signal_handlers_block_by_func(m_widget
,
301 (gpointer
)gtk_notebook_page_changed_callback
, this);
304 gtk_notebook_set_current_page( GTK_NOTEBOOK(m_widget
), page
);
306 if ( !(flags
& SetSelection_SendEvent
) )
308 g_signal_handlers_unblock_by_func(m_widget
,
309 (gpointer
)gtk_notebook_page_changing_callback
, this);
311 g_signal_handlers_unblock_by_func(m_widget
,
312 (gpointer
)gtk_notebook_page_changed_callback
, this);
315 wxNotebookPage
*client
= GetPage(page
);
322 bool wxNotebook::SetPageText( size_t page
, const wxString
&text
)
324 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
326 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
328 wxCHECK_MSG( nb_page
, false, wxT("SetPageText: invalid page index") );
330 nb_page
->m_text
= text
;
332 gtk_label_set_text( nb_page
->m_label
, wxGTK_CONV( nb_page
->m_text
) );
337 bool wxNotebook::SetPageImage( size_t page
, int image
)
339 /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
341 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
343 if (!nb_page
) return false;
345 /* Optimization posibility: return immediately if image unchanged.
346 * Not enabled because it may break existing (stupid) code that
347 * manipulates the imagelist to cycle images */
349 /* if (image == nb_page->m_image) return true; */
351 /* For different cases:
352 1) no image -> no image
357 if (image
== -1 && nb_page
->m_image
== -1)
358 return true; /* Case 1): Nothing to do. */
360 GtkWidget
*pixmapwid
= (GtkWidget
*) NULL
;
362 if (nb_page
->m_image
!= -1)
364 /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
366 GList
*child
= gtk_container_get_children(GTK_CONTAINER(nb_page
->m_box
));
369 if (GTK_IS_IMAGE(child
->data
))
371 pixmapwid
= GTK_WIDGET(child
->data
);
377 /* We should have the pixmap widget now */
378 wxASSERT(pixmapwid
!= NULL
);
382 /* If there's no new widget, just remove the old from the box */
383 gtk_container_remove(GTK_CONTAINER(nb_page
->m_box
), pixmapwid
);
384 nb_page
->m_image
= -1;
386 return true; /* Case 2) */
390 /* Only cases 3) and 4) left */
391 wxASSERT( m_imageList
!= NULL
); /* Just in case */
393 /* Construct the new pixmap */
394 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(image
);
396 if (pixmapwid
== NULL
)
398 /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
399 pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
401 /* CHECKME: Are these pack flags okay? */
402 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
403 gtk_widget_show(pixmapwid
);
407 /* Case 4) Simply replace the pixmap */
408 gtk_image_set_from_pixbuf((GtkImage
*)pixmapwid
, bmp
->GetPixbuf());
411 nb_page
->m_image
= image
;
416 void wxNotebook::SetPageSize( const wxSize
&WXUNUSED(size
) )
418 wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
421 void wxNotebook::SetPadding( const wxSize
&padding
)
423 wxCHECK_RET( m_widget
!= NULL
, wxT("invalid notebook") );
425 m_padding
= padding
.GetWidth();
428 for (i
=0; i
<int(GetPageCount()); i
++)
430 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
431 wxASSERT(nb_page
!= NULL
);
433 if (nb_page
->m_image
!= -1)
435 // gtk_box_set_child_packing sets padding on BOTH sides
436 // icon provides left padding, label provides center and right
437 int image
= nb_page
->m_image
;
439 SetPageImage(i
,image
);
441 wxASSERT(nb_page
->m_label
);
442 gtk_box_set_child_packing(GTK_BOX(nb_page
->m_box
),
443 GTK_WIDGET(nb_page
->m_label
),
444 FALSE
, FALSE
, m_padding
, GTK_PACK_END
);
448 void wxNotebook::SetTabSize(const wxSize
& WXUNUSED(sz
))
450 wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
453 bool wxNotebook::DeleteAllPages()
455 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
457 while (m_pagesData
.GetCount() > 0)
458 DeletePage( m_pagesData
.GetCount()-1 );
460 wxASSERT_MSG( GetPageCount() == 0, _T("all pages must have been deleted") );
462 InvalidateBestSize();
463 return wxNotebookBase::DeleteAllPages();
466 wxNotebookPage
*wxNotebook::DoRemovePage( size_t page
)
468 // We cannot remove the page yet, as GTK sends the "switch_page"
469 // signal before it has removed the notebook-page from its
470 // corresponding list. Thus, if we were to remove the page from
471 // m_pages at this point, the two lists of pages would be out
472 // of sync during the PAGE_CHANGING/PAGE_CHANGED events.
473 wxNotebookPage
*client
= GetPage(page
);
477 gtk_widget_ref( client
->m_widget
);
478 gtk_widget_unrealize( client
->m_widget
);
480 // we don't need to unparent the client->m_widget; GTK+ will do
481 // that for us (and will throw a warning if we do it!)
482 gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget
), page
);
484 // It's safe to remove the page now.
485 wxASSERT_MSG(GetPage(page
) == client
, wxT("pages changed during delete"));
486 wxNotebookBase::DoRemovePage(page
);
488 wxGtkNotebookPage
* p
= GetNotebookPage(page
);
489 m_pagesData
.DeleteObject(p
);
495 bool wxNotebook::InsertPage( size_t position
,
497 const wxString
& text
,
501 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
503 wxCHECK_MSG( win
->GetParent() == this, false,
504 wxT("Can't add a page whose parent is not the notebook!") );
506 wxCHECK_MSG( position
<= GetPageCount(), false,
507 _T("invalid page index in wxNotebookPage::InsertPage()") );
509 // Hack Alert! (Part II): See above in wxInsertChildInNotebook callback
510 // why this has to be done. NOTE: using gtk_widget_unparent here does not
511 // work as it seems to undo too much and will cause errors in the
512 // gtk_notebook_insert_page below, so instead just clear the parent by
514 win
->m_widget
->parent
= NULL
;
517 win
->SetThemeEnabled(true);
519 GtkNotebook
*notebook
= GTK_NOTEBOOK(m_widget
);
521 wxGtkNotebookPage
*nb_page
= new wxGtkNotebookPage();
523 if ( position
== GetPageCount() )
524 m_pagesData
.Append( nb_page
);
526 m_pagesData
.Insert( position
, nb_page
);
528 m_pages
.Insert(win
, position
);
530 nb_page
->m_box
= gtk_hbox_new( FALSE
, 1 );
531 gtk_container_set_border_width((GtkContainer
*)nb_page
->m_box
, 2);
533 g_signal_connect (win
->m_widget
, "size_allocate",
534 G_CALLBACK (gtk_page_size_callback
), win
);
536 gtk_notebook_insert_page( notebook
, win
->m_widget
, nb_page
->m_box
, position
);
538 nb_page
->m_page
= (GtkNotebookPage
*) g_list_last(notebook
->children
)->data
;
540 /* set the label image */
541 nb_page
->m_image
= imageId
;
545 wxASSERT( m_imageList
!= NULL
);
547 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(imageId
);
548 GtkWidget
* pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
549 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
550 gtk_widget_show(pixmapwid
);
553 /* set the label text */
555 nb_page
->m_text
= wxStripMenuCodes(text
);
556 if (nb_page
->m_text
.empty()) nb_page
->m_text
= wxEmptyString
;
558 nb_page
->m_label
= GTK_LABEL( gtk_label_new(wxGTK_CONV(nb_page
->m_text
)) );
559 gtk_box_pack_end( GTK_BOX(nb_page
->m_box
), GTK_WIDGET(nb_page
->m_label
), FALSE
, FALSE
, m_padding
);
561 /* apply current style */
562 GtkRcStyle
*style
= CreateWidgetStyle();
565 gtk_widget_modify_style(GTK_WIDGET(nb_page
->m_label
), style
);
566 gtk_rc_style_unref(style
);
570 gtk_widget_show( GTK_WIDGET(nb_page
->m_label
) );
572 if (select
&& (m_pagesData
.GetCount() > 1))
574 SetSelection( position
);
577 InvalidateBestSize();
581 // helper for HitTest(): check if the point lies inside the given widget which
582 // is the child of the notebook whose position and border size are passed as
585 IsPointInsideWidget(const wxPoint
& pt
, GtkWidget
*w
,
586 gint x
, gint y
, gint border
= 0)
589 (pt
.x
>= w
->allocation
.x
- x
- border
) &&
590 (pt
.x
<= w
->allocation
.x
- x
+ border
+ w
->allocation
.width
) &&
591 (pt
.y
>= w
->allocation
.y
- y
- border
) &&
592 (pt
.y
<= w
->allocation
.y
- y
+ border
+ w
->allocation
.height
);
595 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
597 const gint x
= m_widget
->allocation
.x
;
598 const gint y
= m_widget
->allocation
.y
;
600 const size_t count
= GetPageCount();
603 GtkNotebook
* notebook
= GTK_NOTEBOOK(m_widget
);
604 if (gtk_notebook_get_scrollable(notebook
))
605 i
= g_list_position( notebook
->children
, notebook
->first_tab
);
607 for ( ; i
< count
; i
++ )
609 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
610 GtkWidget
*box
= nb_page
->m_box
;
612 const gint border
= gtk_container_get_border_width(GTK_CONTAINER(box
));
614 if ( IsPointInsideWidget(pt
, box
, x
, y
, border
) )
616 // ok, we're inside this tab -- now find out where, if needed
619 GtkWidget
*pixmap
= NULL
;
621 GList
*children
= gtk_container_get_children(GTK_CONTAINER(box
));
622 for ( GList
*child
= children
; child
; child
= child
->next
)
624 if (GTK_IS_IMAGE(child
->data
))
626 pixmap
= GTK_WIDGET(child
->data
);
632 g_list_free(children
);
634 if ( pixmap
&& IsPointInsideWidget(pt
, pixmap
, x
, y
) )
636 *flags
= wxBK_HITTEST_ONICON
;
638 else if ( IsPointInsideWidget(pt
, GTK_WIDGET(nb_page
->m_label
), x
, y
) )
640 *flags
= wxBK_HITTEST_ONLABEL
;
644 *flags
= wxBK_HITTEST_ONITEM
;
654 *flags
= wxBK_HITTEST_NOWHERE
;
655 wxWindowBase
* page
= GetCurrentPage();
658 // rect origin is in notebook's parent coordinates
659 wxRect rect
= page
->GetRect();
661 // adjust it to the notebook's coordinates
662 wxPoint pos
= GetPosition();
665 if ( rect
.Contains( pt
) )
666 *flags
|= wxBK_HITTEST_ONPAGE
;
673 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
675 if (event
.IsWindowChange())
676 AdvanceSelection( event
.GetDirection() );
681 #if wxUSE_CONSTRAINTS
683 // override these 2 functions to do nothing: everything is done in OnSize
684 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse
) )
686 // don't set the sizes of the pages - their correct size is not yet known
687 wxControl::SetConstraintSizes(false);
690 bool wxNotebook::DoPhase( int WXUNUSED(nPhase
) )
697 void wxNotebook::DoApplyWidgetStyle(GtkRcStyle
*style
)
699 gtk_widget_modify_style(m_widget
, style
);
700 size_t cnt
= m_pagesData
.GetCount();
701 for (size_t i
= 0; i
< cnt
; i
++)
702 gtk_widget_modify_style(GTK_WIDGET(GetNotebookPage(i
)->m_label
), style
);
705 GdkWindow
*wxNotebook::GTKGetWindow(wxArrayGdkWindows
& windows
) const
707 windows
.push_back(m_widget
->window
);
708 windows
.push_back(GTK_NOTEBOOK(m_widget
)->event_window
);
715 wxNotebook::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
717 return GetDefaultAttributesFromGTKWidget(gtk_notebook_new
);
720 //-----------------------------------------------------------------------------
722 //-----------------------------------------------------------------------------
724 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)