///////////////////////////////////////////////////////////////////////////// // Name: src/gtk/notebook.cpp // Purpose: // Author: Robert Roebling // Id: $Id: notebook.cpp 55094 2008-08-15 04:52:13Z PC $ // Copyright: (c) 1998 Robert Roebling, Vadim Zeitlin // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #if wxUSE_NOTEBOOK #include "wx/notebook.h" #ifndef WX_PRECOMP #include "wx/intl.h" #include "wx/log.h" #include "wx/utils.h" #include "wx/msgdlg.h" #include "wx/bitmap.h" #endif #include "wx/imaglist.h" #include "wx/fontutil.h" #include "wx/gtk/private.h" #include "wx/gtk/win_gtk.h" #include // ---------------------------------------------------------------------------- // events // ---------------------------------------------------------------------------- DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED) DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING) //----------------------------------------------------------------------------- // data //----------------------------------------------------------------------------- extern bool g_blockEventsOnDrag; //----------------------------------------------------------------------------- // wxGtkNotebookPage //----------------------------------------------------------------------------- // VZ: this is rather ugly as we keep the pages themselves in an array (it // allows us to have quite a few functions implemented in the base class) // but the page data is kept in a separate list, so we must maintain them // in sync manually... of course, the list had been there before the base // class which explains it but it still would be nice to do something // about this one day class wxGtkNotebookPage: public wxObject { public: wxGtkNotebookPage() { m_image = -1; m_page = NULL; m_box = NULL; } wxString m_text; int m_image; GtkWidget *m_page; GtkLabel *m_label; GtkWidget *m_box; // in which the label and image are packed }; #include "wx/listimpl.cpp" WX_DEFINE_LIST(wxGtkNotebookPagesList) extern "C" { static void event_after(GtkNotebook*, GdkEvent*, wxNotebook*); } //----------------------------------------------------------------------------- // "switch_page" //----------------------------------------------------------------------------- extern "C" { static void switch_page_after(GtkWidget* widget, GtkNotebookPage*, guint, wxNotebook* win) { g_signal_handlers_block_by_func(widget, (void*)switch_page_after, win); win->SendPageChangedEvent(win->m_oldSelection); } } extern "C" { static void switch_page(GtkNotebook* widget, GtkNotebookPage*, int page, wxNotebook* win) { win->m_oldSelection = gtk_notebook_get_current_page(widget); if (win->SendPageChangingEvent(page)) // allow change, unblock handler for changed event g_signal_handlers_unblock_by_func(widget, (void*)switch_page_after, win); else // change vetoed, unblock handler to set selection back g_signal_handlers_unblock_by_func(widget, (void*)event_after, win); } } //----------------------------------------------------------------------------- // "event_after" from m_widget //----------------------------------------------------------------------------- extern "C" { static void event_after(GtkNotebook* widget, GdkEvent*, wxNotebook* win) { g_signal_handlers_block_by_func(widget, (void*)event_after, win); g_signal_handlers_block_by_func(widget, (void*)switch_page, win); // restore previous selection gtk_notebook_set_current_page(widget, win->m_oldSelection); g_signal_handlers_unblock_by_func(widget, (void*)switch_page, win); } } //----------------------------------------------------------------------------- // "size_allocate" //----------------------------------------------------------------------------- extern "C" { static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win ) { if (g_isIdle) wxapp_install_idle_handler(); // wxWindowGTK::SetSize() ignores position if parent does not have // m_wxwindow, and infinite sizing loop can result if position is part // of this check. See patch 1907189. if ((win->m_width == alloc->width) && (win->m_height == alloc->height)) { return; } win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height ); /* GTK 1.2 up to version 1.2.5 is broken so that we have to call allocate here in order to make repositioning after resizing to take effect. */ if ((gtk_major_version == 1) && (gtk_minor_version == 2) && (gtk_micro_version < 6) && (win->m_wxwindow) && (GTK_WIDGET_REALIZED(win->m_wxwindow))) { gtk_widget_size_allocate( win->m_wxwindow, alloc ); } } } //----------------------------------------------------------------------------- // "realize" from m_widget //----------------------------------------------------------------------------- extern "C" { static void gtk_notebook_realized_callback( GtkWidget * WXUNUSED(widget), wxWindow *win ) { if (g_isIdle) wxapp_install_idle_handler(); /* GTK 1.2 up to version 1.2.5 is broken so that we have to call a queue_resize here in order to make repositioning before showing to take effect. */ gtk_widget_queue_resize( win->m_widget ); } } //----------------------------------------------------------------------------- // "key_press_event" //----------------------------------------------------------------------------- extern "C" { static gboolean gtk_notebook_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxNotebook *notebook ) { // don't need to install idle handler, its done from "event" signal if (!notebook->m_hasVMT) return FALSE; if (g_blockEventsOnDrag) return FALSE; /* win is a control: tab can be propagated up */ if ((gdk_event->keyval == GDK_Left) || (gdk_event->keyval == GDK_Right)) { int page; int nMax = notebook->GetPageCount(); if ( nMax-- ) // decrement it to get the last valid index { int nSel = notebook->GetSelection(); // change selection wrapping if it becomes invalid page = (gdk_event->keyval != GDK_Left) ? nSel == nMax ? 0 : nSel + 1 : nSel == 0 ? nMax : nSel - 1; } else // notebook is empty, no next page { return FALSE; } gtk_notebook_set_current_page( GTK_NOTEBOOK(widget), page ); return TRUE; } /* win is a control: tab can be propagated up */ if ((gdk_event->keyval == GDK_Tab) || (gdk_event->keyval == GDK_ISO_Left_Tab)) { int sel = notebook->GetSelection(); if (sel == -1) return TRUE; wxGtkNotebookPage *nb_page = notebook->GetNotebookPage(sel); wxCHECK_MSG( nb_page, FALSE, _T("invalid selection in wxNotebook") ); wxNavigationKeyEvent event; event.SetEventObject( notebook ); /* GDK reports GDK_ISO_Left_Tab for SHIFT-TAB */ event.SetDirection( (gdk_event->keyval == GDK_Tab) ); /* CTRL-TAB changes the (parent) window, i.e. switch notebook page */ event.SetWindowChange( (gdk_event->state & GDK_CONTROL_MASK) || (gdk_event->keyval == GDK_Left) || (gdk_event->keyval == GDK_Right) ); event.SetCurrentFocus( notebook ); wxNotebookPage *client = notebook->GetPage(sel); if ( !client->GetEventHandler()->ProcessEvent( event ) ) { client->SetFocus(); } return TRUE; } return FALSE; } } //----------------------------------------------------------------------------- // InsertChild callback for wxNotebook //----------------------------------------------------------------------------- static void wxInsertChildInNotebook( wxNotebook* parent, wxWindow* child ) { // Hack Alert! (Part I): This sets the notebook as the parent of the child // widget, and takes care of some details such as updating the state and // style of the child to reflect its new location. We do this early // because without it GetBestSize (which is used to set the initial size // of controls if an explicit size is not given) will often report // incorrect sizes since the widget's style context is not fully known. // See bug #901694 for details // (http://sourceforge.net/tracker/?func=detail&aid=901694&group_id=9863&atid=109863) gtk_widget_set_parent(child->m_widget, parent->m_widget); // NOTE: This should be considered a temporary workaround until we can // work out the details and implement delaying the setting of the initial // size of widgets until the size is really needed. } //----------------------------------------------------------------------------- // wxNotebook //----------------------------------------------------------------------------- IMPLEMENT_DYNAMIC_CLASS(wxNotebook,wxBookCtrlBase) BEGIN_EVENT_TABLE(wxNotebook, wxBookCtrlBase) EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey) END_EVENT_TABLE() void wxNotebook::Init() { m_padding = 0; m_imageList = (wxImageList *) NULL; m_oldSelection = -1; m_themeEnabled = true; } wxNotebook::wxNotebook() { Init(); } wxNotebook::wxNotebook( wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style, const wxString& name ) { Init(); Create( parent, id, pos, size, style, name ); } wxNotebook::~wxNotebook() { DeleteAllPages(); } bool wxNotebook::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style, const wxString& name ) { m_needParent = true; m_acceptsFocus = true; m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook; if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT ) style |= wxBK_TOP; if (!PreCreation( parent, pos, size ) || !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name )) { wxFAIL_MSG( wxT("wxNoteBook creation failed") ); return false; } m_widget = gtk_notebook_new(); gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 ); g_signal_connect (m_widget, "switch_page", G_CALLBACK(switch_page), this); g_signal_connect_after (m_widget, "switch_page", G_CALLBACK (switch_page_after), this); g_signal_handlers_block_by_func(m_widget, (void*)switch_page_after, this); g_signal_connect(m_widget, "event_after", G_CALLBACK(event_after), this); g_signal_handlers_block_by_func(m_widget, (void*)event_after, this); m_parent->DoAddChild( this ); if (m_windowStyle & wxBK_RIGHT) gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_RIGHT ); if (m_windowStyle & wxBK_LEFT) gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_LEFT ); if (m_windowStyle & wxBK_BOTTOM) gtk_notebook_set_tab_pos( GTK_NOTEBOOK(m_widget), GTK_POS_BOTTOM ); g_signal_connect (m_widget, "key_press_event", G_CALLBACK (gtk_notebook_key_press_callback), this); PostCreation(size); g_signal_connect (m_widget, "realize", G_CALLBACK (gtk_notebook_realized_callback), this); return true; } int wxNotebook::GetSelection() const { wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") ); return gtk_notebook_get_current_page( GTK_NOTEBOOK(m_widget) ); } wxString wxNotebook::GetPageText( size_t page ) const { wxCHECK_MSG( m_widget != NULL, wxEmptyString, wxT("invalid notebook") ); wxGtkNotebookPage* nb_page = GetNotebookPage(page); if (nb_page) return nb_page->m_text; else return wxEmptyString; } int wxNotebook::GetPageImage( size_t page ) const { wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") ); wxGtkNotebookPage* nb_page = GetNotebookPage(page); if (nb_page) return nb_page->m_image; else return -1; } wxGtkNotebookPage* wxNotebook::GetNotebookPage( int page ) const { wxCHECK_MSG( m_widget != NULL, (wxGtkNotebookPage*) NULL, wxT("invalid notebook") ); wxCHECK_MSG( page < (int)m_pagesData.GetCount(), (wxGtkNotebookPage*) NULL, wxT("invalid notebook index") ); return m_pagesData.Item(page)->GetData(); } int wxNotebook::DoSetSelection( size_t page, int flags ) { wxCHECK_MSG( m_widget != NULL, -1, wxT("invalid notebook") ); wxCHECK_MSG( page < m_pagesData.GetCount(), -1, wxT("invalid notebook index") ); int selOld = GetSelection(); if ( !(flags & SetSelection_SendEvent) ) { g_signal_handlers_block_by_func(m_widget, (void*)switch_page, this); } gtk_notebook_set_current_page( GTK_NOTEBOOK(m_widget), page ); if ( !(flags & SetSelection_SendEvent) ) { g_signal_handlers_unblock_by_func(m_widget, (void*)switch_page, this); } wxNotebookPage *client = GetPage(page); if ( client ) client->SetFocus(); return selOld; } bool wxNotebook::SetPageText( size_t page, const wxString &text ) { wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") ); wxGtkNotebookPage* nb_page = GetNotebookPage(page); wxCHECK_MSG( nb_page, false, wxT("SetPageText: invalid page index") ); nb_page->m_text = text; gtk_label_set_text( nb_page->m_label, wxGTK_CONV( nb_page->m_text ) ); return true; } bool wxNotebook::SetPageImage( size_t page, int image ) { /* HvdH 28-12-98: now it works, but it's a bit of a kludge */ wxGtkNotebookPage* nb_page = GetNotebookPage(page); if (!nb_page) return false; /* Optimization posibility: return immediately if image unchanged. * Not enabled because it may break existing (stupid) code that * manipulates the imagelist to cycle images */ /* if (image == nb_page->m_image) return true; */ /* For different cases: 1) no image -> no image 2) image -> no image 3) no image -> image 4) image -> image */ if (image == -1 && nb_page->m_image == -1) return true; /* Case 1): Nothing to do. */ GtkWidget *pixmapwid = (GtkWidget*) NULL; if (nb_page->m_image != -1) { /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */ GList *child = gtk_container_get_children(GTK_CONTAINER(nb_page->m_box)); while (child) { if (GTK_IS_IMAGE(child->data)) { pixmapwid = GTK_WIDGET(child->data); break; } child = child->next; } /* We should have the pixmap widget now */ wxASSERT(pixmapwid != NULL); if (image == -1) { /* If there's no new widget, just remove the old from the box */ gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid); nb_page->m_image = -1; return true; /* Case 2) */ } } /* Only cases 3) and 4) left */ wxASSERT( m_imageList != NULL ); /* Just in case */ /* Construct the new pixmap */ const wxBitmap *bmp = m_imageList->GetBitmapPtr(image); if (pixmapwid == NULL) { /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */ pixmapwid = gtk_image_new_from_pixbuf(bmp->GetPixbuf()); /* CHECKME: Are these pack flags okay? */ gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, m_padding); gtk_widget_show(pixmapwid); } else { /* Case 4) Simply replace the pixmap */ gtk_image_set_from_pixbuf((GtkImage*)pixmapwid, bmp->GetPixbuf()); } nb_page->m_image = image; return true; } void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) ) { wxFAIL_MSG( wxT("wxNotebook::SetPageSize not implemented") ); } void wxNotebook::SetPadding( const wxSize &padding ) { wxCHECK_RET( m_widget != NULL, wxT("invalid notebook") ); m_padding = padding.GetWidth(); int i; for (i=0; im_image != -1) { // gtk_box_set_child_packing sets padding on BOTH sides // icon provides left padding, label provides center and right int image = nb_page->m_image; SetPageImage(i,-1); SetPageImage(i,image); } wxASSERT(nb_page->m_label); gtk_box_set_child_packing(GTK_BOX(nb_page->m_box), GTK_WIDGET(nb_page->m_label), FALSE, FALSE, m_padding, GTK_PACK_END); } } void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz)) { wxFAIL_MSG( wxT("wxNotebook::SetTabSize not implemented") ); } bool wxNotebook::DeleteAllPages() { wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") ); while (m_pagesData.GetCount() > 0) DeletePage( m_pagesData.GetCount()-1 ); wxASSERT_MSG( GetPageCount() == 0, _T("all pages must have been deleted") ); InvalidateBestSize(); return wxNotebookBase::DeleteAllPages(); } wxNotebookPage *wxNotebook::DoRemovePage( size_t page ) { // We cannot remove the page yet, as GTK sends the "switch_page" // signal before it has removed the notebook-page from its // corresponding list. Thus, if we were to remove the page from // m_pages at this point, the two lists of pages would be out // of sync during the PAGE_CHANGING/PAGE_CHANGED events. wxNotebookPage *client = GetPage(page); if ( !client ) return NULL; gtk_widget_ref( client->m_widget ); gtk_widget_unrealize( client->m_widget ); // we don't need to unparent the client->m_widget; GTK+ will do // that for us (and will throw a warning if we do it!) gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget), page ); // It's safe to remove the page now. wxASSERT_MSG(GetPage(page) == client, wxT("pages changed during delete")); wxNotebookBase::DoRemovePage(page); wxGtkNotebookPage* p = GetNotebookPage(page); m_pagesData.DeleteObject(p); delete p; return client; } bool wxNotebook::InsertPage( size_t position, wxNotebookPage* win, const wxString& text, bool select, int imageId ) { wxCHECK_MSG( m_widget != NULL, false, wxT("invalid notebook") ); wxCHECK_MSG( win->GetParent() == this, false, wxT("Can't add a page whose parent is not the notebook!") ); wxCHECK_MSG( position <= GetPageCount(), false, _T("invalid page index in wxNotebookPage::InsertPage()") ); // Hack Alert! (Part II): See above in wxInsertChildInNotebook callback // why this has to be done. NOTE: using gtk_widget_unparent here does not // work as it seems to undo too much and will cause errors in the // gtk_notebook_insert_page below, so instead just clear the parent by // hand here. win->m_widget->parent = NULL; if (m_themeEnabled) win->SetThemeEnabled(true); GtkNotebook *notebook = GTK_NOTEBOOK(m_widget); wxGtkNotebookPage *nb_page = new wxGtkNotebookPage(); if ( position == GetPageCount() ) m_pagesData.Append( nb_page ); else m_pagesData.Insert( position, nb_page ); m_pages.Insert(win, position); // set the label image and text // this must be done before adding the page, as GetPageText // and GetPageImage will otherwise return wrong values in // the page-changed event that results from inserting the // first page. nb_page->m_image = imageId; nb_page->m_text = wxStripMenuCodes(text); nb_page->m_box = gtk_hbox_new( FALSE, 1 ); gtk_container_set_border_width((GtkContainer*)nb_page->m_box, 2); g_signal_connect (win->m_widget, "size_allocate", G_CALLBACK (gtk_page_size_callback), win); gtk_notebook_insert_page(notebook, win->m_widget, nb_page->m_box, position); nb_page->m_page = gtk_notebook_get_nth_page(notebook, position); if (imageId != -1) { wxASSERT( m_imageList != NULL ); const wxBitmap *bmp = m_imageList->GetBitmapPtr(imageId); GtkWidget* pixmapwid = gtk_image_new_from_pixbuf(bmp->GetPixbuf()); gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, m_padding); gtk_widget_show(pixmapwid); } /* set the label text */ nb_page->m_label = GTK_LABEL( gtk_label_new(wxGTK_CONV(nb_page->m_text)) ); gtk_box_pack_end( GTK_BOX(nb_page->m_box), GTK_WIDGET(nb_page->m_label), FALSE, FALSE, m_padding ); /* apply current style */ GtkRcStyle *style = CreateWidgetStyle(); if ( style ) { gtk_widget_modify_style(GTK_WIDGET(nb_page->m_label), style); gtk_rc_style_unref(style); } /* show the label */ gtk_widget_show( GTK_WIDGET(nb_page->m_label) ); if (select && (m_pagesData.GetCount() > 1)) { SetSelection( position ); } InvalidateBestSize(); return true; } // helper for HitTest(): check if the point lies inside the given widget which // is the child of the notebook whose position and border size are passed as // parameters static bool IsPointInsideWidget(const wxPoint& pt, GtkWidget *w, gint x, gint y, gint border = 0) { return (pt.x >= w->allocation.x - x - border) && (pt.x <= w->allocation.x - x + border + w->allocation.width) && (pt.y >= w->allocation.y - y - border) && (pt.y <= w->allocation.y - y + border + w->allocation.height); } int wxNotebook::HitTest(const wxPoint& pt, long *flags) const { const gint x = m_widget->allocation.x; const gint y = m_widget->allocation.y; const size_t count = GetPageCount(); size_t i = 0; GtkNotebook * notebook = GTK_NOTEBOOK(m_widget); if (gtk_notebook_get_scrollable(notebook)) i = g_list_position( notebook->children, notebook->first_tab ); for ( ; i < count; i++ ) { wxGtkNotebookPage* nb_page = GetNotebookPage(i); GtkWidget *box = nb_page->m_box; const gint border = gtk_container_get_border_width(GTK_CONTAINER(box)); if ( IsPointInsideWidget(pt, box, x, y, border) ) { // ok, we're inside this tab -- now find out where, if needed if ( flags ) { GtkWidget *pixmap = NULL; GList *children = gtk_container_get_children(GTK_CONTAINER(box)); for ( GList *child = children; child; child = child->next ) { if (GTK_IS_IMAGE(child->data)) { pixmap = GTK_WIDGET(child->data); break; } } if ( children ) g_list_free(children); if ( pixmap && IsPointInsideWidget(pt, pixmap, x, y) ) { *flags = wxBK_HITTEST_ONICON; } else if ( IsPointInsideWidget(pt, GTK_WIDGET(nb_page->m_label), x, y) ) { *flags = wxBK_HITTEST_ONLABEL; } else { *flags = wxBK_HITTEST_ONITEM; } } return i; } } if ( flags ) { *flags = wxBK_HITTEST_NOWHERE; wxWindowBase * page = GetCurrentPage(); if ( page ) { // rect origin is in notebook's parent coordinates wxRect rect = page->GetRect(); // adjust it to the notebook's coordinates wxPoint pos = GetPosition(); rect.x -= pos.x; rect.y -= pos.y; if ( rect.Contains( pt ) ) *flags |= wxBK_HITTEST_ONPAGE; } } return wxNOT_FOUND; } void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event) { if (event.IsWindowChange()) AdvanceSelection( event.GetDirection() ); else event.Skip(); } #if wxUSE_CONSTRAINTS // override these 2 functions to do nothing: everything is done in OnSize void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) ) { // don't set the sizes of the pages - their correct size is not yet known wxControl::SetConstraintSizes(false); } bool wxNotebook::DoPhase( int WXUNUSED(nPhase) ) { return true; } #endif void wxNotebook::DoApplyWidgetStyle(GtkRcStyle *style) { gtk_widget_modify_style(m_widget, style); size_t cnt = m_pagesData.GetCount(); for (size_t i = 0; i < cnt; i++) gtk_widget_modify_style(GTK_WIDGET(GetNotebookPage(i)->m_label), style); } GdkWindow *wxNotebook::GTKGetWindow(wxArrayGdkWindows& windows) const { windows.push_back(m_widget->window); windows.push_back(GTK_NOTEBOOK(m_widget)->event_window); return NULL; } // static wxVisualAttributes wxNotebook::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant)) { return GetDefaultAttributesFromGTKWidget(gtk_notebook_new); } //----------------------------------------------------------------------------- // wxNotebookEvent //----------------------------------------------------------------------------- IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent) #endif