src/gtk/notebook.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Vadim Zeitlin
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifdef __GNUG__
  11 #pragma implementation "notebook.h"
  12 #endif
  13
  14 #include "wx/notebook.h"
  15
  16 #if wxUSE_NOTEBOOK
  17
  18 #include "wx/panel.h"
  19 #include "wx/utils.h"
  20 #include "wx/imaglist.h"
  21 #include "wx/intl.h"
  22 #include "wx/log.h"
  23
  24 #include "gdk/gdk.h"
  25 #include "gtk/gtk.h"
  26 #include "wx/gtk/win_gtk.h"
  27 #include "gdk/gdkkeysyms.h"
  28
  29 //-----------------------------------------------------------------------------
  30 // idle system
  31 //-----------------------------------------------------------------------------
  32
  33 extern void wxapp_install_idle_handler();
  34 extern bool g_isIdle;
  35
  36 //-----------------------------------------------------------------------------
  37 // data
  38 //-----------------------------------------------------------------------------
  39
  40 extern bool   g_blockEventsOnDrag;
  41
  42 //-----------------------------------------------------------------------------
  43 // debug
  44 //-----------------------------------------------------------------------------
  45
  46 #ifdef __WXDEBUG__
  47
  48 extern void debug_focus_in( GtkWidget* widget, const wxChar* name, const wxChar *window );
  49
  50 #endif
  51
  52 //-----------------------------------------------------------------------------
  53 // wxNotebookPage
  54 //-----------------------------------------------------------------------------
  55
  56 class wxNotebookPage: public wxObject
  57 {
  58 public:
  59   wxNotebookPage()
  60   {
  61     m_text = "";
  62     m_image = -1;
  63     m_page = (GtkNotebookPage *) NULL;
  64     m_client = (wxWindow *) NULL;
  65     m_box = (GtkWidget *) NULL;
  66   }
  67
  68   wxString           m_text;
  69   int                m_image;
  70   GtkNotebookPage   *m_page;
  71   GtkLabel          *m_label;
  72   wxWindow          *m_client;
  73   GtkWidget         *m_box;     // in which the label and image are packed
  74 };
  75
  76 //-----------------------------------------------------------------------------
  77 // "switch_page"
  78 //-----------------------------------------------------------------------------
  79
  80 static void gtk_notebook_page_change_callback(GtkNotebook *WXUNUSED(widget),
  81                                               GtkNotebookPage *WXUNUSED(page),
  82                                               gint page,
  83                                               wxNotebook *notebook )
  84 {
  85     if (g_isIdle)
  86         wxapp_install_idle_handler();
  87
  88     int old = notebook->GetSelection();
  89
  90     wxNotebookEvent event1( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
  91                             notebook->GetId(), page, old );
  92     event1.SetEventObject( notebook );
  93
  94     if ((notebook->GetEventHandler()->ProcessEvent( event1 )) &&
  95         !event1.IsAllowed() )
  96     {
  97         /* program doesn't allow the page change */
  98         gtk_signal_emit_stop_by_name( GTK_OBJECT(notebook->m_widget), "switch_page" );
  99         return;
 100     }
 101
 102     wxNotebookEvent event2( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
 103                             notebook->GetId(), page, old );
 104     event2.SetEventObject( notebook );
 105     notebook->GetEventHandler()->ProcessEvent( event2 );
 106 }
 107
 108 //-----------------------------------------------------------------------------
 109 // "size_allocate"
 110 //-----------------------------------------------------------------------------
 111
 112 static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win )
 113 {
 114     if (g_isIdle)
 115         wxapp_install_idle_handler();
 116
 117     if ((win->m_x == alloc->x) &&
 118         (win->m_y == alloc->y) &&
 119         (win->m_width == alloc->width) &&
 120         (win->m_height == alloc->height))
 121     {
 122         return;
 123     }
 124
 125     win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height );
 126
 127     if (win->GetAutoLayout()) win->Layout();
 128 }
 129
 130 //-----------------------------------------------------------------------------
 131 // InsertChild callback for wxNotebook
 132 //-----------------------------------------------------------------------------
 133
 134 static void wxInsertChildInNotebook( wxNotebook* WXUNUSED(parent), wxWindow* WXUNUSED(child) )
 135 {
 136     /* we don't do anything here but pray */
 137 }
 138
 139 //-----------------------------------------------------------------------------
 140 // wxNotebook
 141 //-----------------------------------------------------------------------------
 142
 143 IMPLEMENT_DYNAMIC_CLASS(wxNotebook,wxControl)
 144
 145 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 146     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 147 END_EVENT_TABLE()
 148
 149 void wxNotebook::Init()
 150 {
 151     m_imageList = (wxImageList *) NULL;
 152     m_pages.DeleteContents( TRUE );
 153     m_lastSelection = -1;
 154 }
 155
 156 wxNotebook::wxNotebook()
 157 {
 158     Init();
 159 }
 160
 161 wxNotebook::wxNotebook( wxWindow *parent, wxWindowID id,
 162       const wxPoint& pos, const wxSize& size,
 163       long style, const wxString& name )
 164 {
 165     Init();
 166     Create( parent, id, pos, size, style, name );
 167 }
 168
 169 wxNotebook::~wxNotebook()
 170 {
 171     /* don't generate change page events any more */
 172     gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
 173       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
 174
 175     DeleteAllPages();
 176 }
 177
 178 bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
 179       const wxPoint& pos, const wxSize& size,
 180       long style, const wxString& name )
 181 {
 182     m_needParent = TRUE;
 183     m_acceptsFocus = TRUE;
 184     m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook;
 185
 186     if (!PreCreation( parent, pos, size ) ||
 187         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 188     {
 189         wxFAIL_MSG( _T("wxNoteBook creation failed") );
 190         return FALSE;
 191     }
 192
 193
 194     m_widget = gtk_notebook_new();
 195
 196 #ifdef __WXDEBUG__
 197     debug_focus_in( m_widget, _T("wxNotebook::m_widget"), name );
 198 #endif
 199
 200     gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
 201
 202     gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
 203       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
 204
 205     m_parent->DoAddChild( this );
 206
 207     PostCreation();
 208
 209     Show( TRUE );
 210
 211     return TRUE;
 212 }
 213
 214 void wxNotebook::SetFocus()
 215 {
 216     if (m_pages.GetCount() == 0) return;
 217
 218     wxNode *node = m_pages.Nth( GetSelection() );
 219
 220     if (!node) return;
 221
 222     wxNotebookPage *page = (wxNotebookPage*) node->Data();
 223
 224     page->m_client->SetFocus();
 225 }
 226
 227 int wxNotebook::GetSelection() const
 228 {
 229     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 230
 231     GList *pages = GTK_NOTEBOOK(m_widget)->children;
 232
 233     if (g_list_length(pages) == 0) return -1;
 234
 235     GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
 236
 237     if (notebook->cur_page == NULL) return m_lastSelection;
 238
 239     return g_list_index( pages, (gpointer)(notebook->cur_page) );
 240 }
 241
 242 int wxNotebook::GetPageCount() const
 243 {
 244     return (int) g_list_length( GTK_NOTEBOOK(m_widget)->children );
 245 }
 246
 247 int wxNotebook::GetRowCount() const
 248 {
 249     return 1;
 250 }
 251
 252 wxString wxNotebook::GetPageText( int page ) const
 253 {
 254     wxCHECK_MSG( m_widget != NULL, _T(""), _T("invalid notebook") );
 255
 256     wxNotebookPage* nb_page = GetNotebookPage(page);
 257     if (nb_page)
 258         return nb_page->m_text;
 259     else
 260         return _T("");
 261 }
 262
 263 int wxNotebook::GetPageImage( int page ) const
 264 {
 265     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 266
 267     wxNotebookPage* nb_page = GetNotebookPage(page);
 268     if (nb_page)
 269         return nb_page->m_image;
 270     else
 271         return -1;
 272 }
 273
 274 wxNotebookPage* wxNotebook::GetNotebookPage( int page ) const
 275 {
 276     wxCHECK_MSG( m_widget != NULL, (wxNotebookPage*) NULL, _T("invalid notebook") );
 277
 278     wxCHECK_MSG( page < (int)m_pages.GetCount(), (wxNotebookPage*) NULL, _T("invalid notebook index") );
 279
 280     wxNode *node = m_pages.Nth( page );
 281
 282     return (wxNotebookPage *) node->Data();
 283 }
 284
 285 int wxNotebook::SetSelection( int page )
 286 {
 287     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 288
 289     wxCHECK_MSG( page < (int)m_pages.GetCount(), -1, _T("invalid notebook index") );
 290
 291     int selOld = GetSelection();
 292
 293     gtk_notebook_set_page( GTK_NOTEBOOK(m_widget), page );
 294
 295     return selOld;
 296 }
 297
 298 void wxNotebook::AdvanceSelection( bool forward )
 299 {
 300     wxCHECK_RET( m_widget != NULL, _T("invalid notebook") );
 301
 302     int sel = GetSelection();
 303     int max = GetPageCount();
 304
 305     if (forward)
 306         SetSelection( sel == max ? 0 : sel + 1 );
 307     else
 308         SetSelection( sel == 0 ? max-1 : sel - 1 );
 309 }
 310
 311 void wxNotebook::SetImageList( wxImageList* imageList )
 312 {
 313     m_imageList = imageList;
 314 }
 315
 316 bool wxNotebook::SetPageText( int page, const wxString &text )
 317 {
 318     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 319
 320     wxNotebookPage* nb_page = GetNotebookPage(page);
 321
 322     wxCHECK_MSG( nb_page, FALSE, _T("SetPageText: invalid page index") );
 323
 324     nb_page->m_text = text;
 325
 326     gtk_label_set( nb_page->m_label, nb_page->m_text.mbc_str() );
 327
 328     return TRUE;
 329 }
 330
 331 bool wxNotebook::SetPageImage( int page, int image )
 332 {
 333     /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
 334
 335     wxNotebookPage* nb_page = GetNotebookPage(page);
 336
 337     if (!nb_page) return FALSE;
 338
 339     /* Optimization posibility: return immediately if image unchanged.
 340      * Not enabled because it may break existing (stupid) code that
 341      * manipulates the imagelist to cycle images */
 342
 343     /* if (image == nb_page->m_image) return TRUE; */
 344
 345     /* For different cases:
 346        1) no image -> no image
 347        2) image -> no image
 348        3) no image -> image
 349        4) image -> image */
 350
 351     if (image == -1 && nb_page->m_image == -1)
 352         return TRUE; /* Case 1): Nothing to do. */
 353
 354     GtkWidget *pixmapwid = (GtkWidget*) NULL;
 355
 356     if (nb_page->m_image != -1)
 357     {
 358         /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
 359
 360         GList *child = gtk_container_children(GTK_CONTAINER(nb_page->m_box));
 361         while (child)
 362         {
 363             if (GTK_IS_PIXMAP(child->data))
 364             {
 365                 pixmapwid = GTK_WIDGET(child->data);
 366                 break;
 367             }
 368             child = child->next;
 369         }
 370
 371         /* We should have the pixmap widget now */
 372         wxASSERT(pixmapwid != NULL);
 373
 374         if (image == -1)
 375         {
 376             /* If there's no new widget, just remove the old from the box */
 377             gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid);
 378             nb_page->m_image = -1;
 379
 380             return TRUE; /* Case 2) */
 381         }
 382     }
 383
 384     /* Only cases 3) and 4) left */
 385     wxASSERT( m_imageList != NULL ); /* Just in case */
 386
 387     /* Construct the new pixmap */
 388     const wxBitmap *bmp = m_imageList->GetBitmap(image);
 389     GdkPixmap *pixmap = bmp->GetPixmap();
 390     GdkBitmap *mask = (GdkBitmap*) NULL;
 391     if ( bmp->GetMask() )
 392     {
 393         mask = bmp->GetMask()->GetBitmap();
 394     }
 395
 396     if (pixmapwid == NULL)
 397     {
 398         /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
 399         pixmapwid = gtk_pixmap_new (pixmap, mask );
 400
 401         /* CHECKME: Are these pack flags okay? */
 402         gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, 3);
 403         gtk_widget_show(pixmapwid);
 404     }
 405     else
 406     {
 407         /* Case 4) Simply replace the pixmap */
 408         gtk_pixmap_set(GTK_PIXMAP(pixmapwid), pixmap, mask);
 409     }
 410
 411     nb_page->m_image = image;
 412
 413     return TRUE;
 414 }
 415
 416 void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) )
 417 {
 418     wxFAIL_MSG( _T("wxNotebook::SetPageSize not implemented") );
 419 }
 420
 421 void wxNotebook::SetPadding( const wxSize &WXUNUSED(padding) )
 422 {
 423     wxFAIL_MSG( _T("wxNotebook::SetPadding not implemented") );
 424 }
 425
 426 void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
 427 {
 428     wxFAIL_MSG( _T("wxNotebook::SetTabSize not implemented") );
 429 }
 430
 431 bool wxNotebook::DeleteAllPages()
 432 {
 433     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 434
 435     while (m_pages.GetCount() > 0)
 436         DeletePage( m_pages.GetCount()-1 );
 437
 438     return TRUE;
 439 }
 440
 441 bool wxNotebook::DeletePage( int page )
 442 {
 443     wxNotebookPage* nb_page = GetNotebookPage(page);
 444     if (!nb_page) return FALSE;
 445
 446     /* GTK sets GtkNotebook.cur_page to NULL before sending
 447        the switvh page event */
 448     m_lastSelection = GetSelection();
 449
 450     nb_page->m_client->Destroy();
 451     m_pages.DeleteObject( nb_page );
 452
 453     m_lastSelection = -1;
 454
 455     return TRUE;
 456 }
 457
 458 bool wxNotebook::RemovePage( int page )
 459 {
 460     wxNotebookPage* nb_page = GetNotebookPage(page);
 461
 462     if (!nb_page) return FALSE;
 463
 464     gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget), page );
 465
 466     m_pages.DeleteObject( nb_page );
 467
 468     return TRUE;
 469 }
 470
 471 bool wxNotebook::InsertPage( int position, wxWindow* win, const wxString& text,
 472                              bool select, int imageId )
 473 {
 474     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 475
 476     wxCHECK_MSG( win->GetParent() == this, FALSE,
 477                _T("Can't add a page whose parent is not the notebook!") );
 478
 479     /* don't receive switch page during addition */
 480     gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
 481       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
 482
 483     GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
 484
 485     wxNotebookPage *page = new wxNotebookPage();
 486
 487     if (position < 0)
 488         m_pages.Append( page );
 489     else
 490         m_pages.Insert( m_pages.Nth( position ), page );
 491
 492     page->m_client = win;
 493
 494     page->m_box = gtk_hbox_new( FALSE, 0 );
 495     gtk_container_border_width( GTK_CONTAINER(page->m_box), 2 );
 496
 497     gtk_signal_connect( GTK_OBJECT(win->m_widget), "size_allocate",
 498       GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)win );
 499
 500     if (position < 0)
 501         gtk_notebook_append_page( notebook, win->m_widget, page->m_box );
 502     else
 503         gtk_notebook_insert_page( notebook, win->m_widget, page->m_box, position );
 504
 505     page->m_page = (GtkNotebookPage*) g_list_last(notebook->children)->data;
 506
 507     /* set the label image */
 508     page->m_image = imageId;
 509
 510     if (imageId != -1)
 511     {
 512         wxASSERT( m_imageList != NULL );
 513
 514         const wxBitmap *bmp = m_imageList->GetBitmap(imageId);
 515         GdkPixmap *pixmap = bmp->GetPixmap();
 516         GdkBitmap *mask = (GdkBitmap*) NULL;
 517         if ( bmp->GetMask() )
 518         {
 519             mask = bmp->GetMask()->GetBitmap();
 520         }
 521
 522         GtkWidget *pixmapwid = gtk_pixmap_new (pixmap, mask );
 523
 524         gtk_box_pack_start(GTK_BOX(page->m_box), pixmapwid, FALSE, FALSE, 3);
 525
 526         gtk_widget_show(pixmapwid);
 527     }
 528
 529     /* set the label text */
 530     page->m_text = text;
 531     if (page->m_text.IsEmpty()) page->m_text = _T("");
 532
 533     page->m_label = GTK_LABEL( gtk_label_new(page->m_text.mbc_str()) );
 534     gtk_box_pack_end( GTK_BOX(page->m_box), GTK_WIDGET(page->m_label), FALSE, FALSE, 3 );
 535
 536     /* show the label */
 537     gtk_widget_show( GTK_WIDGET(page->m_label) );
 538
 539     if (select && (m_pages.GetCount() > 1))
 540     {
 541         if (position < 0)
 542             SetSelection( GetPageCount()-1 );
 543         else
 544             SetSelection( position );
 545     }
 546
 547     gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
 548       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
 549
 550     return TRUE;
 551 }
 552
 553 bool wxNotebook::AddPage(wxWindow* win, const wxString& text,
 554                          bool select, int imageId)
 555 {
 556     return InsertPage( -1, win, text, select, imageId );
 557 }
 558
 559 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 560 {
 561     if (event.IsWindowChange())
 562         AdvanceSelection( event.GetDirection() );
 563     else
 564         event.Skip();
 565 }
 566
 567 wxWindow *wxNotebook::GetPage( int page ) const
 568 {
 569     wxCHECK_MSG( m_widget != NULL, (wxWindow*) NULL, _T("invalid notebook") );
 570
 571     wxNotebookPage* nb_page = GetNotebookPage(page);
 572     if (!nb_page)
 573         return (wxWindow *) NULL;
 574     else
 575         return nb_page->m_client;
 576 }
 577
 578 // override these 2 functions to do nothing: everything is done in OnSize
 579 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) )
 580 {
 581     // don't set the sizes of the pages - their correct size is not yet known
 582     wxControl::SetConstraintSizes(FALSE);
 583 }
 584
 585 bool wxNotebook::DoPhase( int WXUNUSED(nPhase) )
 586 {
 587     return TRUE;
 588 }
 589
 590 void wxNotebook::ApplyWidgetStyle()
 591 {
 592     SetWidgetStyle();
 593     gtk_widget_set_style( m_widget, m_widgetStyle );
 594 }
 595
 596 bool wxNotebook::IsOwnGtkWindow( GdkWindow *window )
 597 {
 598     return ((m_widget->window == window) ||
 599             (GTK_NOTEBOOK(m_widget)->panel == window));
 600 }
 601
 602 //-----------------------------------------------------------------------------
 603 // wxNotebookEvent
 604 //-----------------------------------------------------------------------------
 605
 606 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 607
 608 #endif