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
68 GtkWidget
*m_box
; // in which the label and image are packed
72 #include "wx/listimpl.cpp"
73 WX_DEFINE_LIST(wxGtkNotebookPagesList
)
76 //-----------------------------------------------------------------------------
78 //-----------------------------------------------------------------------------
81 static void gtk_notebook_page_changing_callback( GtkNotebook
*widget
,
82 GtkNotebookPage
*WXUNUSED(gpage
),
84 wxNotebook
*notebook
)
86 int old
= gtk_notebook_get_current_page( widget
);
88 if ( !notebook
->SendPageChangingEvent(page
) )
90 // program doesn't allow the page change
91 g_signal_stop_emission_by_name(notebook
->m_widget
, "switch_page");
95 // the page change event also reports the old page
96 notebook
->m_oldSelection
= old
;
102 static void gtk_notebook_page_changed_callback( GtkNotebook
* WXUNUSED(widget
),
103 GtkNotebookPage
*WXUNUSED(gpage
),
104 guint
WXUNUSED(page
),
105 wxNotebook
*notebook
)
107 int old
= notebook
->m_oldSelection
;
108 notebook
->SendPageChangedEvent( old
);
112 //-----------------------------------------------------------------------------
113 // "realize" from m_widget
114 //-----------------------------------------------------------------------------
118 gtk_notebook_realized_callback( GtkWidget
* WXUNUSED(widget
), wxWindow
*win
)
120 /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize
121 here in order to make repositioning before showing to take effect. */
122 gtk_widget_queue_resize( win
->m_widget
);
126 //-----------------------------------------------------------------------------
127 // InsertChild callback for wxNotebook
128 //-----------------------------------------------------------------------------
130 static void wxInsertChildInNotebook(wxWindow
* parent
, wxWindow
* child
)
132 // Hack Alert! (Part I): This sets the notebook as the parent of the child
133 // widget, and takes care of some details such as updating the state and
134 // style of the child to reflect its new location. We do this early
135 // because without it GetBestSize (which is used to set the initial size
136 // of controls if an explicit size is not given) will often report
137 // incorrect sizes since the widget's style context is not fully known.
138 // See bug #901694 for details
139 // (http://sourceforge.net/tracker/?func=detail&aid=901694&group_id=9863&atid=109863)
140 gtk_widget_set_parent(child
->m_widget
, parent
->m_widget
);
142 // NOTE: This should be considered a temporary workaround until we can
143 // work out the details and implement delaying the setting of the initial
144 // size of widgets until the size is really needed.
147 //-----------------------------------------------------------------------------
149 //-----------------------------------------------------------------------------
151 IMPLEMENT_DYNAMIC_CLASS(wxNotebook
,wxBookCtrlBase
)
153 BEGIN_EVENT_TABLE(wxNotebook
, wxBookCtrlBase
)
154 EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey
)
157 void wxNotebook::Init()
161 m_imageList
= (wxImageList
*) NULL
;
163 m_themeEnabled
= true;
166 wxNotebook::wxNotebook()
171 wxNotebook::wxNotebook( wxWindow
*parent
, wxWindowID id
,
172 const wxPoint
& pos
, const wxSize
& size
,
173 long style
, const wxString
& name
)
176 Create( parent
, id
, pos
, size
, style
, name
);
179 wxNotebook::~wxNotebook()
184 bool wxNotebook::Create(wxWindow
*parent
, wxWindowID id
,
185 const wxPoint
& pos
, const wxSize
& size
,
186 long style
, const wxString
& name
)
188 m_insertCallback
= wxInsertChildInNotebook
;
190 if ( (style
& wxBK_ALIGN_MASK
) == wxBK_DEFAULT
)
193 if (!PreCreation( parent
, pos
, size
) ||
194 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
196 wxFAIL_MSG( wxT("wxNoteBook creation failed") );
201 m_widget
= gtk_notebook_new();
203 gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget
), 1 );
205 g_signal_connect (m_widget
, "switch_page",
206 G_CALLBACK (gtk_notebook_page_changing_callback
), this);
208 g_signal_connect_after (m_widget
, "switch_page",
209 G_CALLBACK (gtk_notebook_page_changed_callback
), this);
211 m_parent
->DoAddChild( this );
213 if (m_windowStyle
& wxBK_RIGHT
)
214 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_RIGHT
);
215 if (m_windowStyle
& wxBK_LEFT
)
216 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_LEFT
);
217 if (m_windowStyle
& wxBK_BOTTOM
)
218 gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget
), GTK_POS_BOTTOM
);
222 g_signal_connect (m_widget
, "realize",
223 G_CALLBACK (gtk_notebook_realized_callback
), this);
228 int wxNotebook::GetSelection() const
230 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
232 return gtk_notebook_get_current_page( GTK_NOTEBOOK(m_widget
) );
235 wxString
wxNotebook::GetPageText( size_t page
) const
237 wxCHECK_MSG( m_widget
!= NULL
, wxEmptyString
, wxT("invalid notebook") );
239 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
241 return nb_page
->m_text
;
243 return wxEmptyString
;
246 int wxNotebook::GetPageImage( size_t page
) const
248 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
250 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
252 return nb_page
->m_image
;
257 wxGtkNotebookPage
* wxNotebook::GetNotebookPage( int page
) const
259 wxCHECK_MSG( m_widget
!= NULL
, (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook") );
261 wxCHECK_MSG( page
< (int)m_pagesData
.GetCount(), (wxGtkNotebookPage
*) NULL
, wxT("invalid notebook index") );
263 return m_pagesData
.Item(page
)->GetData();
266 int wxNotebook::DoSetSelection( size_t page
, int flags
)
268 wxCHECK_MSG( m_widget
!= NULL
, -1, wxT("invalid notebook") );
270 wxCHECK_MSG( page
< m_pagesData
.GetCount(), -1, wxT("invalid notebook index") );
272 int selOld
= GetSelection();
274 if ( !(flags
& SetSelection_SendEvent
) )
276 g_signal_handlers_block_by_func(m_widget
,
277 (gpointer
)gtk_notebook_page_changing_callback
, this);
279 g_signal_handlers_block_by_func(m_widget
,
280 (gpointer
)gtk_notebook_page_changed_callback
, this);
283 gtk_notebook_set_current_page( GTK_NOTEBOOK(m_widget
), page
);
285 if ( !(flags
& SetSelection_SendEvent
) )
287 g_signal_handlers_unblock_by_func(m_widget
,
288 (gpointer
)gtk_notebook_page_changing_callback
, this);
290 g_signal_handlers_unblock_by_func(m_widget
,
291 (gpointer
)gtk_notebook_page_changed_callback
, this);
294 wxNotebookPage
*client
= GetPage(page
);
301 bool wxNotebook::SetPageText( size_t page
, const wxString
&text
)
303 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
305 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
307 wxCHECK_MSG( nb_page
, false, wxT("SetPageText: invalid page index") );
309 nb_page
->m_text
= text
;
311 gtk_label_set_text( nb_page
->m_label
, wxGTK_CONV( nb_page
->m_text
) );
316 bool wxNotebook::SetPageImage( size_t page
, int image
)
318 /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
320 wxGtkNotebookPage
* nb_page
= GetNotebookPage(page
);
322 if (!nb_page
) return false;
324 /* Optimization posibility: return immediately if image unchanged.
325 * Not enabled because it may break existing (stupid) code that
326 * manipulates the imagelist to cycle images */
328 /* if (image == nb_page->m_image) return true; */
330 /* For different cases:
331 1) no image -> no image
336 if (image
== -1 && nb_page
->m_image
== -1)
337 return true; /* Case 1): Nothing to do. */
339 GtkWidget
*pixmapwid
= (GtkWidget
*) NULL
;
341 if (nb_page
->m_image
!= -1)
343 /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
345 GList
*child
= gtk_container_get_children(GTK_CONTAINER(nb_page
->m_box
));
348 if (GTK_IS_IMAGE(child
->data
))
350 pixmapwid
= GTK_WIDGET(child
->data
);
356 /* We should have the pixmap widget now */
357 wxASSERT(pixmapwid
!= NULL
);
361 /* If there's no new widget, just remove the old from the box */
362 gtk_container_remove(GTK_CONTAINER(nb_page
->m_box
), pixmapwid
);
363 nb_page
->m_image
= -1;
365 return true; /* Case 2) */
369 /* Only cases 3) and 4) left */
370 wxASSERT( m_imageList
!= NULL
); /* Just in case */
372 /* Construct the new pixmap */
373 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(image
);
375 if (pixmapwid
== NULL
)
377 /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
378 pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
380 /* CHECKME: Are these pack flags okay? */
381 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
382 gtk_widget_show(pixmapwid
);
386 /* Case 4) Simply replace the pixmap */
387 gtk_image_set_from_pixbuf((GtkImage
*)pixmapwid
, bmp
->GetPixbuf());
390 nb_page
->m_image
= image
;
395 void wxNotebook::SetPageSize( const wxSize
&WXUNUSED(size
) )
397 wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") );
400 void wxNotebook::SetPadding( const wxSize
&padding
)
402 wxCHECK_RET( m_widget
!= NULL
, wxT("invalid notebook") );
404 m_padding
= padding
.GetWidth();
407 for (i
=0; i
<int(GetPageCount()); i
++)
409 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
410 wxASSERT(nb_page
!= NULL
);
412 if (nb_page
->m_image
!= -1)
414 // gtk_box_set_child_packing sets padding on BOTH sides
415 // icon provides left padding, label provides center and right
416 int image
= nb_page
->m_image
;
418 SetPageImage(i
,image
);
420 wxASSERT(nb_page
->m_label
);
421 gtk_box_set_child_packing(GTK_BOX(nb_page
->m_box
),
422 GTK_WIDGET(nb_page
->m_label
),
423 FALSE
, FALSE
, m_padding
, GTK_PACK_END
);
427 void wxNotebook::SetTabSize(const wxSize
& WXUNUSED(sz
))
429 wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") );
432 bool wxNotebook::DeleteAllPages()
434 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
436 while (m_pagesData
.GetCount() > 0)
437 DeletePage( m_pagesData
.GetCount()-1 );
439 wxASSERT_MSG( GetPageCount() == 0, _T("all pages must have been deleted") );
441 InvalidateBestSize();
442 return wxNotebookBase::DeleteAllPages();
445 wxNotebookPage
*wxNotebook::DoRemovePage( size_t page
)
447 // We cannot remove the page yet, as GTK sends the "switch_page"
448 // signal before it has removed the notebook-page from its
449 // corresponding list. Thus, if we were to remove the page from
450 // m_pages at this point, the two lists of pages would be out
451 // of sync during the PAGE_CHANGING/PAGE_CHANGED events.
452 wxNotebookPage
*client
= GetPage(page
);
456 gtk_widget_ref( client
->m_widget
);
457 gtk_widget_unrealize( client
->m_widget
);
459 // we don't need to unparent the client->m_widget; GTK+ will do
460 // that for us (and will throw a warning if we do it!)
461 gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget
), page
);
463 // It's safe to remove the page now.
464 wxASSERT_MSG(GetPage(page
) == client
, wxT("pages changed during delete"));
465 wxNotebookBase::DoRemovePage(page
);
467 wxGtkNotebookPage
* p
= GetNotebookPage(page
);
468 m_pagesData
.DeleteObject(p
);
474 bool wxNotebook::InsertPage( size_t position
,
476 const wxString
& text
,
480 wxCHECK_MSG( m_widget
!= NULL
, false, wxT("invalid notebook") );
482 wxCHECK_MSG( win
->GetParent() == this, false,
483 wxT("Can't add a page whose parent is not the notebook!") );
485 wxCHECK_MSG( position
<= GetPageCount(), false,
486 _T("invalid page index in wxNotebookPage::InsertPage()") );
488 // Hack Alert! (Part II): See above in wxInsertChildInNotebook callback
489 // why this has to be done. NOTE: using gtk_widget_unparent here does not
490 // work as it seems to undo too much and will cause errors in the
491 // gtk_notebook_insert_page below, so instead just clear the parent by
493 win
->m_widget
->parent
= NULL
;
496 win
->SetThemeEnabled(true);
498 GtkNotebook
*notebook
= GTK_NOTEBOOK(m_widget
);
500 wxGtkNotebookPage
*nb_page
= new wxGtkNotebookPage();
502 if ( position
== GetPageCount() )
503 m_pagesData
.Append( nb_page
);
505 m_pagesData
.Insert( position
, nb_page
);
507 m_pages
.Insert(win
, position
);
509 // set the label image and text
510 // this must be done before adding the page, as GetPageText
511 // and GetPageImage will otherwise return wrong values in
512 // the page-changed event that results from inserting the
514 nb_page
->m_image
= imageId
;
515 nb_page
->m_text
= wxStripMenuCodes(text
);
517 nb_page
->m_box
= gtk_hbox_new( FALSE
, 1 );
518 gtk_container_set_border_width((GtkContainer
*)nb_page
->m_box
, 2);
520 gtk_notebook_insert_page(notebook
, win
->m_widget
, nb_page
->m_box
, position
);
524 wxASSERT( m_imageList
!= NULL
);
526 const wxBitmap
*bmp
= m_imageList
->GetBitmapPtr(imageId
);
527 GtkWidget
* pixmapwid
= gtk_image_new_from_pixbuf(bmp
->GetPixbuf());
528 gtk_box_pack_start(GTK_BOX(nb_page
->m_box
), pixmapwid
, FALSE
, FALSE
, m_padding
);
529 gtk_widget_show(pixmapwid
);
532 /* set the label text */
533 nb_page
->m_label
= GTK_LABEL( gtk_label_new(wxGTK_CONV(nb_page
->m_text
)) );
534 gtk_box_pack_end( GTK_BOX(nb_page
->m_box
), GTK_WIDGET(nb_page
->m_label
), FALSE
, FALSE
, m_padding
);
536 /* apply current style */
537 GtkRcStyle
*style
= CreateWidgetStyle();
540 gtk_widget_modify_style(GTK_WIDGET(nb_page
->m_label
), style
);
541 gtk_rc_style_unref(style
);
545 gtk_widget_show( GTK_WIDGET(nb_page
->m_label
) );
547 if (select
&& (m_pagesData
.GetCount() > 1))
549 SetSelection( position
);
552 InvalidateBestSize();
556 // helper for HitTest(): check if the point lies inside the given widget which
557 // is the child of the notebook whose position and border size are passed as
560 IsPointInsideWidget(const wxPoint
& pt
, GtkWidget
*w
,
561 gint x
, gint y
, gint border
= 0)
564 (pt
.x
>= w
->allocation
.x
- x
- border
) &&
565 (pt
.x
<= w
->allocation
.x
- x
+ border
+ w
->allocation
.width
) &&
566 (pt
.y
>= w
->allocation
.y
- y
- border
) &&
567 (pt
.y
<= w
->allocation
.y
- y
+ border
+ w
->allocation
.height
);
570 int wxNotebook::HitTest(const wxPoint
& pt
, long *flags
) const
572 const gint x
= m_widget
->allocation
.x
;
573 const gint y
= m_widget
->allocation
.y
;
575 const size_t count
= GetPageCount();
578 GtkNotebook
* notebook
= GTK_NOTEBOOK(m_widget
);
579 if (gtk_notebook_get_scrollable(notebook
))
580 i
= g_list_position( notebook
->children
, notebook
->first_tab
);
582 for ( ; i
< count
; i
++ )
584 wxGtkNotebookPage
* nb_page
= GetNotebookPage(i
);
585 GtkWidget
*box
= nb_page
->m_box
;
587 const gint border
= gtk_container_get_border_width(GTK_CONTAINER(box
));
589 if ( IsPointInsideWidget(pt
, box
, x
, y
, border
) )
591 // ok, we're inside this tab -- now find out where, if needed
594 GtkWidget
*pixmap
= NULL
;
596 GList
*children
= gtk_container_get_children(GTK_CONTAINER(box
));
597 for ( GList
*child
= children
; child
; child
= child
->next
)
599 if (GTK_IS_IMAGE(child
->data
))
601 pixmap
= GTK_WIDGET(child
->data
);
607 g_list_free(children
);
609 if ( pixmap
&& IsPointInsideWidget(pt
, pixmap
, x
, y
) )
611 *flags
= wxBK_HITTEST_ONICON
;
613 else if ( IsPointInsideWidget(pt
, GTK_WIDGET(nb_page
->m_label
), x
, y
) )
615 *flags
= wxBK_HITTEST_ONLABEL
;
619 *flags
= wxBK_HITTEST_ONITEM
;
629 *flags
= wxBK_HITTEST_NOWHERE
;
630 wxWindowBase
* page
= GetCurrentPage();
633 // rect origin is in notebook's parent coordinates
634 wxRect rect
= page
->GetRect();
636 // adjust it to the notebook's coordinates
637 wxPoint pos
= GetPosition();
640 if ( rect
.Contains( pt
) )
641 *flags
|= wxBK_HITTEST_ONPAGE
;
648 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent
& event
)
650 if (event
.IsWindowChange())
651 AdvanceSelection( event
.GetDirection() );
656 #if wxUSE_CONSTRAINTS
658 // override these 2 functions to do nothing: everything is done in OnSize
659 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse
) )
661 // don't set the sizes of the pages - their correct size is not yet known
662 wxControl::SetConstraintSizes(false);
665 bool wxNotebook::DoPhase( int WXUNUSED(nPhase
) )
672 void wxNotebook::DoApplyWidgetStyle(GtkRcStyle
*style
)
674 gtk_widget_modify_style(m_widget
, style
);
675 size_t cnt
= m_pagesData
.GetCount();
676 for (size_t i
= 0; i
< cnt
; i
++)
677 gtk_widget_modify_style(GTK_WIDGET(GetNotebookPage(i
)->m_label
), style
);
680 GdkWindow
*wxNotebook::GTKGetWindow(wxArrayGdkWindows
& windows
) const
682 windows
.push_back(m_widget
->window
);
683 windows
.push_back(GTK_NOTEBOOK(m_widget
)->event_window
);
690 wxNotebook::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
692 return GetDefaultAttributesFromGTKWidget(gtk_notebook_new
);
695 //-----------------------------------------------------------------------------
697 //-----------------------------------------------------------------------------
699 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent
, wxNotifyEvent
)