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 // "key_press_event"
 132 //-----------------------------------------------------------------------------
 133
 134 static gint
 135 gtk_notebook_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxNotebook *notebook )
 136 {
 137     if (g_isIdle) wxapp_install_idle_handler();
 138
 139     if (g_blockEventsOnDrag) return FALSE;
 140
 141     if (!notebook->m_hasVMT) return FALSE;
 142
 143     /* this code makes jumping down from the handles of the notebooks
 144        to the actual items in the visible notebook page possible with
 145        the down-arrow key */
 146
 147     if (gdk_event->keyval != GDK_Down) return FALSE;
 148
 149     if (notebook != notebook->FindFocus()) return FALSE;
 150
 151     if (notebook->m_pages.GetCount() == 0) return FALSE;
 152
 153     wxNode *node = notebook->m_pages.Nth( notebook->GetSelection() );
 154
 155     if (!node) return FALSE;
 156
 157     wxNotebookPage *page = (wxNotebookPage*) node->Data();
 158
 159     // don't let others the key event
 160     gtk_signal_emit_stop_by_name( GTK_OBJECT(widget), "key_press_event" );
 161
 162     page->m_client->SetFocus();
 163
 164     return TRUE;
 165 }
 166
 167 //-----------------------------------------------------------------------------
 168 // InsertChild callback for wxNotebook
 169 //-----------------------------------------------------------------------------
 170
 171 static void wxInsertChildInNotebook( wxNotebook* WXUNUSED(parent), wxWindow* WXUNUSED(child) )
 172 {
 173     /* we don't do anything here but pray */
 174 }
 175
 176 //-----------------------------------------------------------------------------
 177 // wxNotebook
 178 //-----------------------------------------------------------------------------
 179
 180 IMPLEMENT_DYNAMIC_CLASS(wxNotebook,wxControl)
 181
 182 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 183     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 184 END_EVENT_TABLE()
 185
 186 void wxNotebook::Init()
 187 {
 188     m_imageList = (wxImageList *) NULL;
 189     m_pages.DeleteContents( TRUE );
 190     m_lastSelection = -1;
 191 }
 192
 193 wxNotebook::wxNotebook()
 194 {
 195     Init();
 196 }
 197
 198 wxNotebook::wxNotebook( wxWindow *parent, wxWindowID id,
 199       const wxPoint& pos, const wxSize& size,
 200       long style, const wxString& name )
 201 {
 202     Init();
 203     Create( parent, id, pos, size, style, name );
 204 }
 205
 206 wxNotebook::~wxNotebook()
 207 {
 208     /* don't generate change page events any more */
 209     gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
 210       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
 211
 212     DeleteAllPages();
 213 }
 214
 215 bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
 216       const wxPoint& pos, const wxSize& size,
 217       long style, const wxString& name )
 218 {
 219     m_needParent = TRUE;
 220     m_acceptsFocus = TRUE;
 221     m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook;
 222
 223     if (!PreCreation( parent, pos, size ) ||
 224         !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 225     {
 226         wxFAIL_MSG( _T("wxNoteBook creation failed") );
 227         return FALSE;
 228     }
 229
 230
 231     m_widget = gtk_notebook_new();
 232
 233 #ifdef __WXDEBUG__
 234     debug_focus_in( m_widget, _T("wxNotebook::m_widget"), name );
 235 #endif
 236
 237     gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
 238
 239     gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
 240       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
 241
 242     m_parent->DoAddChild( this );
 243
 244     gtk_signal_connect( GTK_OBJECT(m_widget), "key_press_event",
 245       GTK_SIGNAL_FUNC(gtk_notebook_key_press_callback), (gpointer)this );
 246
 247     PostCreation();
 248
 249     Show( TRUE );
 250
 251     return TRUE;
 252 }
 253
 254 int wxNotebook::GetSelection() const
 255 {
 256     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 257
 258     GList *pages = GTK_NOTEBOOK(m_widget)->children;
 259
 260     if (g_list_length(pages) == 0) return -1;
 261
 262     GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
 263
 264     if (notebook->cur_page == NULL) return m_lastSelection;
 265
 266     return g_list_index( pages, (gpointer)(notebook->cur_page) );
 267 }
 268
 269 int wxNotebook::GetPageCount() const
 270 {
 271     return (int) g_list_length( GTK_NOTEBOOK(m_widget)->children );
 272 }
 273
 274 int wxNotebook::GetRowCount() const
 275 {
 276     return 1;
 277 }
 278
 279 wxString wxNotebook::GetPageText( int page ) const
 280 {
 281     wxCHECK_MSG( m_widget != NULL, _T(""), _T("invalid notebook") );
 282
 283     wxNotebookPage* nb_page = GetNotebookPage(page);
 284     if (nb_page)
 285         return nb_page->m_text;
 286     else
 287         return "";
 288 }
 289
 290 int wxNotebook::GetPageImage( int page ) const
 291 {
 292     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 293
 294     wxNotebookPage* nb_page = GetNotebookPage(page);
 295     if (nb_page)
 296         return nb_page->m_image;
 297     else
 298         return -1;
 299 }
 300
 301 wxNotebookPage* wxNotebook::GetNotebookPage( int page ) const
 302 {
 303     wxCHECK_MSG( m_widget != NULL, (wxNotebookPage*) NULL, _T("invalid notebook") );
 304
 305     wxCHECK_MSG( page < (int)m_pages.GetCount(), (wxNotebookPage*) NULL, _T("invalid notebook index") );
 306
 307     wxNode *node = m_pages.Nth( page );
 308
 309     return (wxNotebookPage *) node->Data();
 310 }
 311
 312 int wxNotebook::SetSelection( int page )
 313 {
 314     wxCHECK_MSG( m_widget != NULL, -1, _T("invalid notebook") );
 315
 316     wxCHECK_MSG( page < (int)m_pages.GetCount(), -1, _T("invalid notebook index") );
 317
 318     int selOld = GetSelection();
 319
 320     gtk_notebook_set_page( GTK_NOTEBOOK(m_widget), page );
 321
 322     return selOld;
 323 }
 324
 325 void wxNotebook::AdvanceSelection( bool forward )
 326 {
 327     wxCHECK_RET( m_widget != NULL, _T("invalid notebook") );
 328
 329     int sel = GetSelection();
 330     int max = GetPageCount();
 331
 332     if (forward)
 333         SetSelection( sel == max ? 0 : sel + 1 );
 334     else
 335         SetSelection( sel == 0 ? max-1 : sel - 1 );
 336 }
 337
 338 void wxNotebook::SetImageList( wxImageList* imageList )
 339 {
 340     m_imageList = imageList;
 341 }
 342
 343 bool wxNotebook::SetPageText( int page, const wxString &text )
 344 {
 345     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 346
 347     wxNotebookPage* nb_page = GetNotebookPage(page);
 348
 349     wxCHECK_MSG( nb_page, FALSE, _T("SetPageText: invalid page index") );
 350
 351     nb_page->m_text = text;
 352
 353     gtk_label_set( nb_page->m_label, nb_page->m_text.mbc_str() );
 354
 355     return TRUE;
 356 }
 357
 358 bool wxNotebook::SetPageImage( int page, int image )
 359 {
 360     /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
 361
 362     wxNotebookPage* nb_page = GetNotebookPage(page);
 363
 364     if (!nb_page) return FALSE;
 365
 366     /* Optimization posibility: return immediately if image unchanged.
 367      * Not enabled because it may break existing (stupid) code that
 368      * manipulates the imagelist to cycle images */
 369
 370     /* if (image == nb_page->m_image) return TRUE; */
 371
 372     /* For different cases:
 373        1) no image -> no image
 374        2) image -> no image
 375        3) no image -> image
 376        4) image -> image */
 377
 378     if (image == -1 && nb_page->m_image == -1)
 379         return TRUE; /* Case 1): Nothing to do. */
 380
 381     GtkWidget *pixmapwid = (GtkWidget*) NULL;
 382
 383     if (nb_page->m_image != -1)
 384     {
 385         /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
 386
 387         GList *child = gtk_container_children(GTK_CONTAINER(nb_page->m_box));
 388         while (child)
 389         {
 390             if (GTK_IS_PIXMAP(child->data))
 391             {
 392                 pixmapwid = GTK_WIDGET(child->data);
 393                 break;
 394             }
 395             child = child->next;
 396         }
 397
 398         /* We should have the pixmap widget now */
 399         wxASSERT(pixmapwid != NULL);
 400
 401         if (image == -1)
 402         {
 403             /* If there's no new widget, just remove the old from the box */
 404             gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid);
 405             nb_page->m_image = -1;
 406
 407             return TRUE; /* Case 2) */
 408         }
 409     }
 410
 411     /* Only cases 3) and 4) left */
 412     wxASSERT( m_imageList != NULL ); /* Just in case */
 413
 414     /* Construct the new pixmap */
 415     const wxBitmap *bmp = m_imageList->GetBitmap(image);
 416     GdkPixmap *pixmap = bmp->GetPixmap();
 417     GdkBitmap *mask = (GdkBitmap*) NULL;
 418     if ( bmp->GetMask() )
 419     {
 420         mask = bmp->GetMask()->GetBitmap();
 421     }
 422
 423     if (pixmapwid == NULL)
 424     {
 425         /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
 426         pixmapwid = gtk_pixmap_new (pixmap, mask );
 427
 428         /* CHECKME: Are these pack flags okay? */
 429         gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, 3);
 430         gtk_widget_show(pixmapwid);
 431     }
 432     else
 433     {
 434         /* Case 4) Simply replace the pixmap */
 435         gtk_pixmap_set(GTK_PIXMAP(pixmapwid), pixmap, mask);
 436     }
 437
 438     nb_page->m_image = image;
 439
 440     return TRUE;
 441 }
 442
 443 void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) )
 444 {
 445     wxFAIL_MSG( _T("wxNotebook::SetPageSize not implemented") );
 446 }
 447
 448 void wxNotebook::SetPadding( const wxSize &WXUNUSED(padding) )
 449 {
 450     wxFAIL_MSG( _T("wxNotebook::SetPadding not implemented") );
 451 }
 452
 453 void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
 454 {
 455     wxFAIL_MSG( _T("wxNotebook::SetTabSize not implemented") );
 456 }
 457
 458 bool wxNotebook::DeleteAllPages()
 459 {
 460     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 461
 462     while (m_pages.GetCount() > 0)
 463         DeletePage( m_pages.GetCount()-1 );
 464
 465     return TRUE;
 466 }
 467
 468 bool wxNotebook::DeletePage( int page )
 469 {
 470     wxNotebookPage* nb_page = GetNotebookPage(page);
 471     if (!nb_page) return FALSE;
 472
 473     /* GTK sets GtkNotebook.cur_page to NULL before sending
 474        the switvh page event */
 475     m_lastSelection = GetSelection();
 476
 477     nb_page->m_client->Destroy();
 478     m_pages.DeleteObject( nb_page );
 479
 480     m_lastSelection = -1;
 481
 482     return TRUE;
 483 }
 484
 485 bool wxNotebook::RemovePage( int page )
 486 {
 487     wxNotebookPage* nb_page = GetNotebookPage(page);
 488
 489     if (!nb_page) return FALSE;
 490
 491     gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget), page );
 492
 493     m_pages.DeleteObject( nb_page );
 494
 495     return TRUE;
 496 }
 497
 498 bool wxNotebook::InsertPage( int position, wxWindow* win, const wxString& text,
 499                              bool select, int imageId )
 500 {
 501     wxCHECK_MSG( m_widget != NULL, FALSE, _T("invalid notebook") );
 502
 503     wxCHECK_MSG( win->GetParent() == this, FALSE,
 504                _T("Can't add a page whose parent is not the notebook!") );
 505
 506     /* don't receive switch page during addition */
 507     gtk_signal_disconnect_by_func( GTK_OBJECT(m_widget),
 508       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer) this );
 509
 510     GtkNotebook *notebook = GTK_NOTEBOOK(m_widget);
 511
 512     wxNotebookPage *page = new wxNotebookPage();
 513
 514     if (position < 0)
 515         m_pages.Append( page );
 516     else
 517         m_pages.Insert( m_pages.Nth( position ), page );
 518
 519     page->m_client = win;
 520
 521     page->m_box = gtk_hbox_new( FALSE, 0 );
 522     gtk_container_border_width( GTK_CONTAINER(page->m_box), 2 );
 523
 524     gtk_signal_connect( GTK_OBJECT(win->m_widget), "size_allocate",
 525       GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)win );
 526
 527     if (position < 0)
 528         gtk_notebook_append_page( notebook, win->m_widget, page->m_box );
 529     else
 530         gtk_notebook_insert_page( notebook, win->m_widget, page->m_box, position );
 531
 532     page->m_page = (GtkNotebookPage*) g_list_last(notebook->children)->data;
 533
 534     /* set the label image */
 535     page->m_image = imageId;
 536
 537     if (imageId != -1)
 538     {
 539         wxASSERT( m_imageList != NULL );
 540
 541         const wxBitmap *bmp = m_imageList->GetBitmap(imageId);
 542         GdkPixmap *pixmap = bmp->GetPixmap();
 543         GdkBitmap *mask = (GdkBitmap*) NULL;
 544         if ( bmp->GetMask() )
 545         {
 546             mask = bmp->GetMask()->GetBitmap();
 547         }
 548
 549         GtkWidget *pixmapwid = gtk_pixmap_new (pixmap, mask );
 550
 551         gtk_box_pack_start(GTK_BOX(page->m_box), pixmapwid, FALSE, FALSE, 3);
 552
 553         gtk_widget_show(pixmapwid);
 554     }
 555
 556     /* set the label text */
 557     page->m_text = text;
 558     if (page->m_text.IsEmpty()) page->m_text = _T("");
 559
 560     page->m_label = GTK_LABEL( gtk_label_new(page->m_text.mbc_str()) );
 561     gtk_box_pack_end( GTK_BOX(page->m_box), GTK_WIDGET(page->m_label), FALSE, FALSE, 3 );
 562
 563     /* show the label */
 564     gtk_widget_show( GTK_WIDGET(page->m_label) );
 565
 566     if (select && (m_pages.GetCount() > 1))
 567     {
 568         if (position < 0)
 569             SetSelection( GetPageCount()-1 );
 570         else
 571             SetSelection( position );
 572     }
 573
 574     gtk_signal_connect( GTK_OBJECT(m_widget), "switch_page",
 575       GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback), (gpointer)this );
 576
 577     return TRUE;
 578 }
 579
 580 bool wxNotebook::AddPage(wxWindow* win, const wxString& text,
 581                          bool select, int imageId)
 582 {
 583     return InsertPage( -1, win, text, select, imageId );
 584 }
 585
 586 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 587 {
 588     if (event.IsWindowChange())
 589         AdvanceSelection( event.GetDirection() );
 590     else
 591         event.Skip();
 592 }
 593
 594 wxWindow *wxNotebook::GetPage( int page ) const
 595 {
 596     wxCHECK_MSG( m_widget != NULL, (wxWindow*) NULL, _T("invalid notebook") );
 597
 598     wxNotebookPage* nb_page = GetNotebookPage(page);
 599     if (!nb_page)
 600         return (wxWindow *) NULL;
 601     else
 602         return nb_page->m_client;
 603 }
 604
 605 // override these 2 functions to do nothing: everything is done in OnSize
 606 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) )
 607 {
 608     // don't set the sizes of the pages - their correct size is not yet known
 609     wxControl::SetConstraintSizes(FALSE);
 610 }
 611
 612 bool wxNotebook::DoPhase( int WXUNUSED(nPhase) )
 613 {
 614     return TRUE;
 615 }
 616
 617 void wxNotebook::ApplyWidgetStyle()
 618 {
 619     SetWidgetStyle();
 620     gtk_widget_set_style( m_widget, m_widgetStyle );
 621 }
 622
 623 bool wxNotebook::IsOwnGtkWindow( GdkWindow *window )
 624 {
 625     return ((m_widget->window == window) ||
 626             (GTK_NOTEBOOK(m_widget)->panel == window));
 627 }
 628
 629 //-----------------------------------------------------------------------------
 630 // wxNotebookEvent
 631 //-----------------------------------------------------------------------------
 632
 633 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 634
 635 #endif