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 #include "wx/panel.h"
  16 #include "wx/utils.h"
  17 #include "wx/imaglist.h"
  18 #include "wx/intl.h"
  19 #include "wx/log.h"
  20
  21 #include "gdk/gdk.h"
  22 #include "gtk/gtk.h"
  23 #include "wx/gtk/win_gtk.h"
  24 #include "gdk/gdkkeysyms.h"
  25
  26 //-----------------------------------------------------------------------------
  27 // data
  28 //-----------------------------------------------------------------------------
  29
  30 extern bool   g_blockEventsOnDrag;
  31
  32 //-----------------------------------------------------------------------------
  33 // wxNotebookPage
  34 //-----------------------------------------------------------------------------
  35
  36 class wxNotebookPage: public wxObject
  37 {
  38 public:
  39   wxNotebookPage()
  40   {
  41     m_id = -1;
  42     m_text = "";
  43     m_image = -1;
  44     m_page = (GtkNotebookPage *) NULL;
  45     m_client = (wxWindow *) NULL;
  46     m_parent = (GtkNotebook *) NULL;
  47     m_box = (GtkWidget *) NULL;
  48     m_added = FALSE;
  49   }
  50
  51   /*
  52      mark page as "added' to the notebook, return FALSE if the page was
  53      already added
  54    */
  55
  56   bool Add()
  57   {
  58     if ( WasAdded() )
  59       return FALSE;
  60
  61     m_added = TRUE;
  62     return TRUE;
  63   }
  64
  65   bool WasAdded() const { return m_added; }
  66
  67   int                m_id;
  68   wxString           m_text;
  69   int                m_image;
  70   GtkNotebookPage   *m_page;
  71   GtkLabel          *m_label;
  72   wxWindow          *m_client;
  73   GtkNotebook       *m_parent;
  74   GtkWidget         *m_box;     // in which the label and image are packed
  75
  76 private:
  77   bool m_added;
  78 };
  79
  80 //-----------------------------------------------------------------------------
  81 // "switch_page"
  82 //-----------------------------------------------------------------------------
  83
  84 static void gtk_notebook_page_change_callback(GtkNotebook *WXUNUSED(widget),
  85                                               GtkNotebookPage *WXUNUSED(page),
  86                                               gint nPage,
  87                                               gpointer data)
  88 {
  89     wxNotebook *notebook = (wxNotebook *)data;
  90
  91     int old = notebook->GetSelection();
  92
  93     // TODO: emulate PAGE_CHANGING event
  94
  95     wxNotebookEvent event( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
  96                            notebook->GetId(),  nPage, old );
  97     event.SetEventObject( notebook );
  98     notebook->GetEventHandler()->ProcessEvent( event );
  99 }
 100
 101 //-----------------------------------------------------------------------------
 102 // "size_allocate"
 103 //-----------------------------------------------------------------------------
 104
 105 static void gtk_page_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxWindow *win )
 106 {
 107     if ((win->m_x == alloc->x) &&
 108         (win->m_y == alloc->y) &&
 109         (win->m_width == alloc->width) &&
 110         (win->m_height == alloc->height))
 111     {
 112         return;
 113     }
 114
 115     win->SetSize( alloc->x, alloc->y, alloc->width, alloc->height );
 116
 117     if (win->GetAutoLayout()) win->Layout();
 118 }
 119
 120 //-----------------------------------------------------------------------------
 121 // "key_press_event"
 122 //-----------------------------------------------------------------------------
 123
 124 static gint
 125 gtk_notebook_key_press_callback( GtkWidget *widget, GdkEventKey *gdk_event, wxNotebook *notebook )
 126 {
 127     if (g_blockEventsOnDrag) return FALSE;
 128
 129     if (!notebook->HasVMT()) return FALSE;
 130
 131     /* this code makes jumping down from the handles of the notebooks
 132        to the actual items in the visible notebook page possible with
 133        the down-arrow key */
 134
 135     if (gdk_event->keyval != GDK_Down) return FALSE;
 136
 137     if (notebook != notebook->FindFocus()) return FALSE;
 138
 139     if (notebook->m_pages.GetCount() == 0) return FALSE;
 140
 141     wxNode *node = notebook->m_pages.Nth( notebook->GetSelection() );
 142
 143     if (!node) return FALSE;
 144
 145     wxNotebookPage *page = (wxNotebookPage*) node->Data();
 146
 147     // don't let others the key event
 148     gtk_signal_emit_stop_by_name( GTK_OBJECT(widget), "key_press_event" );
 149
 150     page->m_client->SetFocus();
 151
 152     return TRUE;
 153 }
 154
 155 //-----------------------------------------------------------------------------
 156 // InsertChild callback for wxNotebook
 157 //-----------------------------------------------------------------------------
 158
 159 static void wxInsertChildInNotebook( wxNotebook* parent, wxWindow* child )
 160 {
 161     wxNotebookPage *page = new wxNotebookPage();
 162
 163     page->m_id = parent->GetPageCount();
 164
 165     page->m_box = gtk_hbox_new (FALSE, 0);
 166     gtk_container_border_width(GTK_CONTAINER(page->m_box), 2);
 167
 168     GtkNotebook *notebook = GTK_NOTEBOOK(parent->m_widget);
 169
 170     page->m_client = child;
 171     gtk_notebook_append_page( notebook, child->m_widget, page->m_box );
 172
 173     page->m_page = (GtkNotebookPage*) (g_list_last(notebook->children)->data);
 174
 175     page->m_parent = notebook;
 176
 177     gtk_signal_connect( GTK_OBJECT(child->m_widget), "size_allocate",
 178       GTK_SIGNAL_FUNC(gtk_page_size_callback), (gpointer)child );
 179
 180     wxASSERT_MSG( page->m_page, "Notebook page creation error" );
 181
 182     parent->m_pages.Append( page );
 183 }
 184
 185 //-----------------------------------------------------------------------------
 186 // wxNotebook
 187 //-----------------------------------------------------------------------------
 188
 189 IMPLEMENT_DYNAMIC_CLASS(wxNotebook,wxControl)
 190
 191 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 192     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
 193 END_EVENT_TABLE()
 194
 195 void wxNotebook::Init()
 196 {
 197     m_imageList = (wxImageList *) NULL;
 198     m_pages.DeleteContents( TRUE );
 199     m_idHandler = 0;
 200 }
 201
 202 wxNotebook::wxNotebook()
 203 {
 204     Init();
 205 }
 206
 207 wxNotebook::wxNotebook( wxWindow *parent, wxWindowID id,
 208       const wxPoint& pos, const wxSize& size,
 209       long style, const wxString& name )
 210 {
 211     Init();
 212     Create( parent, id, pos, size, style, name );
 213 }
 214
 215 wxNotebook::~wxNotebook()
 216 {
 217     // don't generate change page events any more
 218     if (m_idHandler != 0)
 219       gtk_signal_disconnect(GTK_OBJECT(m_widget), m_idHandler);
 220
 221     DeleteAllPages();
 222 }
 223
 224 bool wxNotebook::Create(wxWindow *parent, wxWindowID id,
 225       const wxPoint& pos, const wxSize& size,
 226       long style, const wxString& name )
 227 {
 228     m_needParent = TRUE;
 229     m_acceptsFocus = TRUE;
 230     m_insertCallback = (wxInsertChildFunction)wxInsertChildInNotebook;
 231
 232     PreCreation( parent, id, pos, size, style, name );
 233
 234     m_widget = gtk_notebook_new();
 235
 236 #ifdef __WXDEBUG__
 237     debug_focus_in( m_widget, "wxNotebook::m_widget", name );
 238 #endif
 239
 240     gtk_notebook_set_scrollable( GTK_NOTEBOOK(m_widget), 1 );
 241
 242     m_idHandler = gtk_signal_connect (
 243                   GTK_OBJECT(m_widget), "switch_page",
 244                   GTK_SIGNAL_FUNC(gtk_notebook_page_change_callback),
 245                   (gpointer)this );
 246
 247     m_parent->AddChild( this );
 248
 249     (m_parent->m_insertCallback)( m_parent, this );
 250
 251     gtk_signal_connect( GTK_OBJECT(m_widget), "key_press_event",
 252       GTK_SIGNAL_FUNC(gtk_notebook_key_press_callback), (gpointer)this );
 253
 254     PostCreation();
 255
 256     Show( TRUE );
 257
 258     return TRUE;
 259 }
 260
 261 int wxNotebook::GetSelection() const
 262 {
 263     wxCHECK_MSG( m_widget != NULL, -1, "invalid notebook" );
 264
 265     if (m_pages.Number() == 0) return -1;
 266
 267     GtkNotebookPage *g_page = GTK_NOTEBOOK(m_widget)->cur_page;
 268     if (!g_page) return -1;
 269
 270     wxNotebookPage *page = (wxNotebookPage *) NULL;
 271
 272     wxNode *node = m_pages.First();
 273     while (node)
 274     {
 275         page = (wxNotebookPage*)node->Data();
 276
 277         if ((page->m_page == g_page) || (page->m_page == (GtkNotebookPage*)NULL))
 278         {
 279             // page->m_page is NULL directly after gtk_notebook_append. gtk emits
 280             // "switch_page" then and we ask for GetSelection() in the handler for
 281             // "switch_page". otherwise m_page should never be NULL. all this
 282             // might also be wrong.
 283             break;
 284         }
 285         node = node->Next();
 286     }
 287
 288     wxCHECK_MSG( node != NULL, -1, "wxNotebook: no selection?" );
 289
 290     return page->m_id;
 291 }
 292
 293 int wxNotebook::GetPageCount() const
 294 {
 295     // count only the pages which were already added to the notebook for MSW
 296     // compatibility (and, in fact, this behaviour makes more sense anyhow
 297     // because only the added pages are shown)
 298
 299     int n = 0;
 300     for ( wxNode *node = m_pages.First(); node; node = node->Next() )
 301     {
 302         wxNotebookPage *page = (wxNotebookPage*)node->Data();
 303
 304         if (page->WasAdded()) n++;
 305     }
 306
 307     return n;
 308 }
 309
 310 int wxNotebook::GetRowCount() const
 311 {
 312     return 1;
 313 }
 314
 315 wxString wxNotebook::GetPageText( int page ) const
 316 {
 317     wxCHECK_MSG( m_widget != NULL, "", "invalid notebook" );
 318
 319     wxNotebookPage* nb_page = GetNotebookPage(page);
 320     if (nb_page)
 321         return nb_page->m_text;
 322     else
 323         return "";
 324 }
 325
 326 int wxNotebook::GetPageImage( int page ) const
 327 {
 328     wxCHECK_MSG( m_widget != NULL, 0, "invalid notebook" );
 329
 330     wxNotebookPage* nb_page = GetNotebookPage(page);
 331     if (nb_page)
 332         return nb_page->m_image;
 333     else
 334         return 0;
 335 }
 336
 337 wxNotebookPage* wxNotebook::GetNotebookPage(int page) const
 338 {
 339     wxCHECK_MSG( m_widget != NULL, (wxNotebookPage*)NULL, "invalid notebook" );
 340
 341     wxNotebookPage *nb_page = (wxNotebookPage *) NULL;
 342
 343     wxNode *node = m_pages.First();
 344     while (node)
 345     {
 346         nb_page = (wxNotebookPage*)node->Data();
 347         if (nb_page->m_id == page)
 348             return nb_page;
 349         node = node->Next();
 350     }
 351
 352     wxFAIL_MSG( "Notebook page not found!" );
 353
 354     return (wxNotebookPage *) NULL;
 355 }
 356
 357 int wxNotebook::SetSelection( int page )
 358 {
 359     wxCHECK_MSG( m_widget != NULL, -1, "invalid notebook" );
 360
 361     int selOld = GetSelection();
 362     wxNotebookPage* nb_page = GetNotebookPage(page);
 363
 364     if (!nb_page) return -1;
 365
 366     int page_num = 0;
 367     GList *child = GTK_NOTEBOOK(m_widget)->children;
 368     while (child)
 369     {
 370         if (nb_page->m_page == (GtkNotebookPage*)child->data)  break;
 371         page_num++;
 372         child = child->next;
 373     }
 374
 375     if (!child) return -1;
 376
 377     gtk_notebook_set_page( GTK_NOTEBOOK(m_widget), page_num );
 378
 379     return selOld;
 380 }
 381
 382 void wxNotebook::AdvanceSelection( bool bForward )
 383 {
 384     wxCHECK_RET( m_widget != NULL, "invalid notebook" );
 385
 386     int sel = GetSelection();
 387     int max = GetPageCount();
 388
 389     if (bForward)
 390         SetSelection( sel == max ? 0 : sel + 1 );
 391     else
 392         SetSelection( sel == 0 ? max-1 : sel - 1 );
 393 }
 394
 395 void wxNotebook::SetImageList( wxImageList* imageList )
 396 {
 397     m_imageList = imageList;
 398 }
 399
 400 bool wxNotebook::SetPageText( int page, const wxString &text )
 401 {
 402     wxCHECK_MSG( m_widget != NULL, FALSE, "invalid notebook" );
 403
 404     wxNotebookPage* nb_page = GetNotebookPage(page);
 405
 406     if (!nb_page) return FALSE;
 407
 408     nb_page->m_text = text;
 409
 410     if (nb_page->m_text.IsEmpty()) nb_page->m_text = "";
 411
 412     gtk_label_set(nb_page->m_label, nb_page->m_text);
 413
 414     return TRUE;
 415 }
 416
 417 bool wxNotebook::SetPageImage( int page, int image )
 418 {
 419     /* HvdH 28-12-98: now it works, but it's a bit of a kludge */
 420
 421     wxNotebookPage* nb_page = GetNotebookPage(page);
 422
 423     if (!nb_page) return FALSE;
 424
 425     /* Optimization posibility: return immediately if image unchanged.
 426      * Not enabled because it may break existing (stupid) code that
 427      * manipulates the imagelist to cycle images */
 428
 429     /* if (image == nb_page->m_image) return TRUE; */
 430
 431     /* For different cases:
 432        1) no image -> no image
 433        2) image -> no image
 434        3) no image -> image
 435        4) image -> image */
 436
 437     if (image == -1 && nb_page->m_image == -1)
 438         return TRUE; /* Case 1): Nothing to do. */
 439
 440     GtkWidget *pixmapwid = (GtkWidget*) NULL;
 441
 442     if (nb_page->m_image != -1)
 443     {
 444         /* Case 2) or 4). There is already an image in the gtkhbox. Let's find it */
 445
 446         GList *child = gtk_container_children(GTK_CONTAINER(nb_page->m_box));
 447         while (child)
 448         {
 449             if (GTK_IS_PIXMAP(child->data))
 450             {
 451                 pixmapwid = GTK_WIDGET(child->data);
 452                 break;
 453             }
 454             child = child->next;
 455         }
 456
 457         /* We should have the pixmap widget now */
 458         wxASSERT(pixmapwid != NULL);
 459
 460         if (image == -1)
 461         {
 462             /* If there's no new widget, just remove the old from the box */
 463             gtk_container_remove(GTK_CONTAINER(nb_page->m_box), pixmapwid);
 464             nb_page->m_image = -1;
 465
 466             return TRUE; /* Case 2) */
 467         }
 468     }
 469
 470     /* Only cases 3) and 4) left */
 471     wxASSERT( m_imageList != NULL ); /* Just in case */
 472
 473     /* Construct the new pixmap */
 474     const wxBitmap *bmp = m_imageList->GetBitmap(image);
 475     GdkPixmap *pixmap = bmp->GetPixmap();
 476     GdkBitmap *mask = (GdkBitmap*) NULL;
 477     if ( bmp->GetMask() )
 478     {
 479         mask = bmp->GetMask()->GetBitmap();
 480     }
 481
 482     if (pixmapwid == NULL)
 483     {
 484         /* Case 3) No old pixmap. Create a new one and prepend it to the hbox */
 485         pixmapwid = gtk_pixmap_new (pixmap, mask );
 486
 487         /* CHECKME: Are these pack flags okay? */
 488         gtk_box_pack_start(GTK_BOX(nb_page->m_box), pixmapwid, FALSE, FALSE, 3);
 489         gtk_widget_show(pixmapwid);
 490     }
 491     else
 492     {
 493         /* Case 4) Simply replace the pixmap */
 494         gtk_pixmap_set(GTK_PIXMAP(pixmapwid), pixmap, mask);
 495     }
 496
 497     nb_page->m_image = image;
 498
 499     return TRUE;
 500 }
 501
 502 void wxNotebook::SetPageSize( const wxSize &WXUNUSED(size) )
 503 {
 504     wxFAIL_MSG( "wxNotebook::SetPageSize not implemented" );
 505 }
 506
 507 void wxNotebook::SetPadding( const wxSize &WXUNUSED(padding) )
 508 {
 509     wxFAIL_MSG( "wxNotebook::SetPadding not implemented" );
 510 }
 511
 512 bool wxNotebook::DeleteAllPages()
 513 {
 514     wxCHECK_MSG( m_widget != NULL, FALSE, "invalid notebook" );
 515
 516     wxNode *page_node = m_pages.First();
 517     while (page_node)
 518     {
 519         wxNotebookPage *page = (wxNotebookPage*)page_node->Data();
 520
 521         DeletePage( page->m_id );
 522
 523         page_node = m_pages.First();
 524     }
 525
 526     return TRUE;
 527 }
 528
 529 bool wxNotebook::DeletePage( int page )
 530 {
 531     wxNotebookPage* nb_page = GetNotebookPage(page);
 532     if (!nb_page) return FALSE;
 533
 534     int page_num = 0;
 535     GList *child = GTK_NOTEBOOK(m_widget)->children;
 536     while (child)
 537     {
 538         if (nb_page->m_page == (GtkNotebookPage*)child->data) break;
 539         page_num++;
 540         child = child->next;
 541     }
 542
 543     wxCHECK_MSG( child != NULL, FALSE, "illegal notebook index" );
 544
 545     delete nb_page->m_client;
 546
 547     m_pages.DeleteObject( nb_page );
 548
 549     return TRUE;
 550 }
 551
 552 bool wxNotebook::RemovePage( int page )
 553 {
 554     wxNotebookPage* nb_page = GetNotebookPage(page);
 555     if (!nb_page) return FALSE;
 556
 557     int page_num = 0;
 558     GList *child = GTK_NOTEBOOK(m_widget)->children;
 559     while (child)
 560     {
 561         if (nb_page->m_page == (GtkNotebookPage*)child->data) break;
 562         page_num++;
 563         child = child->next;
 564     }
 565
 566     wxCHECK_MSG( child != NULL, FALSE, "illegal notebook index" );
 567
 568     gtk_notebook_remove_page( GTK_NOTEBOOK(m_widget), page_num );
 569
 570     m_pages.DeleteObject( nb_page );
 571
 572     return TRUE;
 573 }
 574
 575 bool wxNotebook::AddPage(wxWindow* win, const wxString& text,
 576                          bool select, int imageId)
 577 {
 578     wxCHECK_MSG( m_widget != NULL, FALSE, "invalid notebook" );
 579
 580     /* we've created the notebook page in AddChild(). Now we just have to set
 581        the caption for the page and set the others parameters. */
 582
 583     wxNotebookPage *page = (wxNotebookPage *) NULL;
 584
 585     wxNode *node = m_pages.First();
 586     while (node)
 587     {
 588         page = (wxNotebookPage*)node->Data();
 589         if ( page->m_client == win ) break;
 590         node = node->Next();
 591     }
 592
 593     wxCHECK_MSG( page != NULL, FALSE,
 594                "Can't add a page whose parent is not the notebook!" );
 595
 596     wxCHECK_MSG( page->Add(), FALSE,
 597                "Can't add the same page twice to a notebook." );
 598
 599     if (imageId != -1)
 600     {
 601         wxASSERT( m_imageList != NULL );
 602
 603         const wxBitmap *bmp = m_imageList->GetBitmap(imageId);
 604         GdkPixmap *pixmap = bmp->GetPixmap();
 605         GdkBitmap *mask = (GdkBitmap*) NULL;
 606         if ( bmp->GetMask() )
 607         {
 608             mask = bmp->GetMask()->GetBitmap();
 609         }
 610
 611         GtkWidget *pixmapwid = gtk_pixmap_new (pixmap, mask );
 612
 613         gtk_box_pack_start(GTK_BOX(page->m_box), pixmapwid, FALSE, FALSE, 3);
 614
 615         gtk_widget_show(pixmapwid);
 616     }
 617
 618     /* then set the attributes */
 619     page->m_text = text;
 620     if (page->m_text.IsEmpty()) page->m_text = "";
 621     page->m_image = imageId;
 622     page->m_label = (GtkLabel *)gtk_label_new(page->m_text);
 623     gtk_box_pack_end( GTK_BOX(page->m_box), (GtkWidget *)page->m_label, FALSE, FALSE, 3);
 624
 625     /* @@@: what does this do? do we still need it?
 626     gtk_misc_set_alignment(GTK_MISC(page->m_label), 0.0, 0.5); */
 627
 628     gtk_widget_show((GtkWidget *)page->m_label);
 629
 630     if (select) SetSelection( GetPageCount()-1 );
 631
 632     return TRUE;
 633 }
 634
 635 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 636 {
 637     if (event.IsWindowChange())
 638         AdvanceSelection( event.GetDirection() );
 639     else
 640         event.Skip();
 641 }
 642
 643 wxWindow *wxNotebook::GetPage( int page ) const
 644 {
 645     wxCHECK_MSG( m_widget != NULL, (wxWindow*) NULL, "invalid notebook" );
 646
 647     wxNotebookPage* nb_page = GetNotebookPage(page);
 648     if (!nb_page)
 649         return (wxWindow *) NULL;
 650     else
 651         return nb_page->m_client;
 652 }
 653
 654 // override these 2 functions to do nothing: everything is done in OnSize
 655 void wxNotebook::SetConstraintSizes( bool WXUNUSED(recurse) )
 656 {
 657     // don't set the sizes of the pages - their correct size is not yet known
 658     wxControl::SetConstraintSizes(FALSE);
 659 }
 660
 661 bool wxNotebook::DoPhase( int WXUNUSED(nPhase) )
 662 {
 663     return TRUE;
 664 }
 665
 666 void wxNotebook::ApplyWidgetStyle()
 667 {
 668     SetWidgetStyle();
 669     gtk_widget_set_style( m_widget, m_widgetStyle );
 670 }
 671
 672 //-----------------------------------------------------------------------------
 673 // wxNotebookEvent
 674 //-----------------------------------------------------------------------------
 675
 676 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 677