src/common/bookctrl.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/bookctrl.cpp
   3 // Purpose:     wxBookCtrlBase implementation
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     19.08.03
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_BOOKCTRL
  28
  29 #include "wx/imaglist.h"
  30
  31 #include "wx/bookctrl.h"
  32
  33 // ============================================================================
  34 // implementation
  35 // ============================================================================
  36
  37 // ----------------------------------------------------------------------------
  38 // event table
  39 // ----------------------------------------------------------------------------
  40
  41 IMPLEMENT_ABSTRACT_CLASS(wxBookCtrlBase, wxControl)
  42
  43 BEGIN_EVENT_TABLE(wxBookCtrlBase, wxControl)
  44     EVT_SIZE(wxBookCtrlBase::OnSize)
  45 #if wxUSE_HELP
  46     EVT_HELP(wxID_ANY, wxBookCtrlBase::OnHelp)
  47 #endif // wxUSE_HELP
  48 END_EVENT_TABLE()
  49
  50 // ----------------------------------------------------------------------------
  51 // constructors and destructors
  52 // ----------------------------------------------------------------------------
  53
  54 void wxBookCtrlBase::Init()
  55 {
  56     m_selection = wxNOT_FOUND;
  57     m_bookctrl = NULL;
  58     m_fitToCurrentPage = false;
  59
  60 #if defined(__WXWINCE__)
  61     m_internalBorder = 1;
  62 #else
  63     m_internalBorder = 5;
  64 #endif
  65
  66     m_controlMargin = 0;
  67     m_controlSizer = NULL;
  68 }
  69
  70 bool
  71 wxBookCtrlBase::Create(wxWindow *parent,
  72                        wxWindowID id,
  73                        const wxPoint& pos,
  74                        const wxSize& size,
  75                        long style,
  76                        const wxString& name)
  77 {
  78     return wxControl::Create
  79                      (
  80                         parent,
  81                         id,
  82                         pos,
  83                         size,
  84                         style,
  85                         wxDefaultValidator,
  86                         name
  87                      );
  88 }
  89
  90 // ----------------------------------------------------------------------------
  91 // geometry
  92 // ----------------------------------------------------------------------------
  93
  94 void wxBookCtrlBase::DoInvalidateBestSize()
  95 {
  96     // notice that it is not necessary to invalidate our own best size
  97     // explicitly if we have m_bookctrl as it will already invalidate the best
  98     // size of its parent when its own size is invalidated and its parent is
  99     // this control
 100     if ( m_bookctrl )
 101         m_bookctrl->InvalidateBestSize();
 102     else
 103         wxControl::InvalidateBestSize();
 104 }
 105
 106 wxSize wxBookCtrlBase::CalcSizeFromPage(const wxSize& sizePage) const
 107 {
 108     // Add the size of the controller and the border between if it's shown.
 109     if ( !m_bookctrl || !m_bookctrl->IsShown() )
 110         return sizePage;
 111
 112     const wxSize sizeController = GetControllerSize();
 113
 114     wxSize size = sizePage;
 115     if ( IsVertical() )
 116     {
 117         if ( sizeController.x > sizePage.x )
 118             size.x = sizeController.x;
 119         size.y += sizeController.y + GetInternalBorder();
 120     }
 121     else // left/right aligned
 122     {
 123         size.x += sizeController.x + GetInternalBorder();
 124         if ( sizeController.y > sizePage.y )
 125             size.y = sizeController.y;
 126     }
 127
 128     return size;
 129 }
 130
 131 void wxBookCtrlBase::SetPageSize(const wxSize& size)
 132 {
 133     SetClientSize(CalcSizeFromPage(size));
 134 }
 135
 136 wxSize wxBookCtrlBase::DoGetBestSize() const
 137 {
 138     wxSize bestSize;
 139
 140     if (m_fitToCurrentPage && GetCurrentPage())
 141     {
 142         bestSize = GetCurrentPage()->GetBestSize();
 143     }
 144     else
 145     {
 146         // iterate over all pages, get the largest width and height
 147         const size_t nCount = m_pages.size();
 148         for ( size_t nPage = 0; nPage < nCount; nPage++ )
 149         {
 150             const wxWindow * const pPage = m_pages[nPage];
 151             if( pPage )
 152             {
 153                 wxSize childBestSize(pPage->GetBestSize());
 154
 155                 if ( childBestSize.x > bestSize.x )
 156                     bestSize.x = childBestSize.x;
 157
 158                 if ( childBestSize.y > bestSize.y )
 159                     bestSize.y = childBestSize.y;
 160             }
 161         }
 162     }
 163
 164     // convert display area to window area, adding the size necessary for the
 165     // tabs
 166     wxSize best = CalcSizeFromPage(bestSize);
 167     CacheBestSize(best);
 168     return best;
 169 }
 170
 171 wxRect wxBookCtrlBase::GetPageRect() const
 172 {
 173     const wxSize size = GetControllerSize();
 174
 175     wxPoint pt;
 176     wxRect rectPage(pt, GetClientSize());
 177
 178     switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 179     {
 180         default:
 181             wxFAIL_MSG( wxT("unexpected alignment") );
 182             // fall through
 183
 184         case wxBK_TOP:
 185             rectPage.y = size.y + GetInternalBorder();
 186             // fall through
 187
 188         case wxBK_BOTTOM:
 189             rectPage.height -= size.y + GetInternalBorder();
 190             if (rectPage.height < 0)
 191                 rectPage.height = 0;
 192             break;
 193
 194         case wxBK_LEFT:
 195             rectPage.x = size.x + GetInternalBorder();
 196             // fall through
 197
 198         case wxBK_RIGHT:
 199             rectPage.width -= size.x + GetInternalBorder();
 200             if (rectPage.width < 0)
 201                 rectPage.width = 0;
 202             break;
 203     }
 204
 205     return rectPage;
 206 }
 207
 208 // Lay out controls
 209 void wxBookCtrlBase::DoSize()
 210 {
 211     if ( !m_bookctrl )
 212     {
 213         // we're not fully created yet or OnSize() should be hidden by derived class
 214         return;
 215     }
 216
 217     if (GetSizer())
 218         Layout();
 219     else
 220     {
 221         // resize controller and the page area to fit inside our new size
 222         const wxSize sizeClient( GetClientSize() ),
 223                     sizeBorder( m_bookctrl->GetSize() - m_bookctrl->GetClientSize() ),
 224                     sizeCtrl( GetControllerSize() );
 225
 226         m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
 227         // if this changes the visibility of the scrollbars the best size changes, relayout in this case
 228         wxSize sizeCtrl2 = GetControllerSize();
 229         if ( sizeCtrl != sizeCtrl2 )
 230         {
 231             wxSize sizeBorder2 = m_bookctrl->GetSize() - m_bookctrl->GetClientSize();
 232             m_bookctrl->SetClientSize( sizeCtrl2.x - sizeBorder2.x, sizeCtrl2.y - sizeBorder2.y );
 233         }
 234
 235         const wxSize sizeNew = m_bookctrl->GetSize();
 236         wxPoint posCtrl;
 237         switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 238         {
 239             default:
 240                 wxFAIL_MSG( wxT("unexpected alignment") );
 241                 // fall through
 242
 243             case wxBK_TOP:
 244             case wxBK_LEFT:
 245                 // posCtrl is already ok
 246                 break;
 247
 248             case wxBK_BOTTOM:
 249                 posCtrl.y = sizeClient.y - sizeNew.y;
 250                 break;
 251
 252             case wxBK_RIGHT:
 253                 posCtrl.x = sizeClient.x - sizeNew.x;
 254                 break;
 255         }
 256
 257         if ( m_bookctrl->GetPosition() != posCtrl )
 258             m_bookctrl->Move(posCtrl);
 259     }
 260
 261     // resize all pages to fit the new control size
 262     const wxRect pageRect = GetPageRect();
 263     const unsigned pagesCount = m_pages.GetCount();
 264     for ( unsigned int i = 0; i < pagesCount; ++i )
 265     {
 266         wxWindow * const page = m_pages[i];
 267         if ( !page )
 268         {
 269             wxASSERT_MSG( AllowNullPage(),
 270                 wxT("Null page in a control that does not allow null pages?") );
 271             continue;
 272         }
 273
 274         page->SetSize(pageRect);
 275     }
 276 }
 277
 278 void wxBookCtrlBase::OnSize(wxSizeEvent& event)
 279 {
 280     event.Skip();
 281
 282     DoSize();
 283 }
 284
 285 wxSize wxBookCtrlBase::GetControllerSize() const
 286 {
 287     // For at least some book controls (e.g. wxChoicebook) it may make sense to
 288     // (temporarily?) hide the controller and we shouldn't leave extra space
 289     // for the hidden control in this case.
 290     if ( !m_bookctrl || !m_bookctrl->IsShown() )
 291         return wxSize(0, 0);
 292
 293     const wxSize sizeClient = GetClientSize();
 294
 295     wxSize size;
 296
 297     // Ask for the best width/height considering the other direction.
 298     if ( IsVertical() )
 299     {
 300         size.x = sizeClient.x;
 301         size.y = m_bookctrl->GetBestHeight(sizeClient.x);
 302     }
 303     else // left/right aligned
 304     {
 305         size.x = m_bookctrl->GetBestWidth(sizeClient.y);
 306         size.y = sizeClient.y;
 307     }
 308
 309     return size;
 310 }
 311
 312 // ----------------------------------------------------------------------------
 313 // miscellaneous stuff
 314 // ----------------------------------------------------------------------------
 315
 316 #if wxUSE_HELP
 317
 318 void wxBookCtrlBase::OnHelp(wxHelpEvent& event)
 319 {
 320     // determine where does this even originate from to avoid redirecting it
 321     // back to the page which generated it (resulting in an infinite loop)
 322
 323     // notice that we have to check in the hard(er) way instead of just testing
 324     // if the event object == this because the book control can have other
 325     // subcontrols inside it (e.g. wxSpinButton in case of a notebook in wxUniv)
 326     wxWindow *source = wxStaticCast(event.GetEventObject(), wxWindow);
 327     while ( source && source != this && source->GetParent() != this )
 328     {
 329         source = source->GetParent();
 330     }
 331
 332     if ( source && m_pages.Index(source) == wxNOT_FOUND )
 333     {
 334         // this event is for the book control itself, redirect it to the
 335         // corresponding page
 336         wxWindow *page = NULL;
 337
 338         if ( event.GetOrigin() == wxHelpEvent::Origin_HelpButton )
 339         {
 340             // show help for the page under the mouse
 341             const int pagePos = HitTest(ScreenToClient(event.GetPosition()));
 342
 343             if ( pagePos != wxNOT_FOUND)
 344             {
 345                 page = GetPage((size_t)pagePos);
 346             }
 347         }
 348         else // event from keyboard or unknown source
 349         {
 350             // otherwise show the current page help
 351             page = GetCurrentPage();
 352         }
 353
 354         if ( page )
 355         {
 356             // change event object to the page to avoid infinite recursion if
 357             // we get this event ourselves if the page doesn't handle it
 358             event.SetEventObject(page);
 359
 360             if ( page->GetEventHandler()->ProcessEvent(event) )
 361             {
 362                 // don't call event.Skip()
 363                 return;
 364             }
 365         }
 366     }
 367     //else: event coming from one of our pages already
 368
 369     event.Skip();
 370 }
 371
 372 #endif // wxUSE_HELP
 373
 374 // ----------------------------------------------------------------------------
 375 // pages management
 376 // ----------------------------------------------------------------------------
 377
 378 bool
 379 wxBookCtrlBase::InsertPage(size_t nPage,
 380                            wxWindow *page,
 381                            const wxString& WXUNUSED(text),
 382                            bool WXUNUSED(bSelect),
 383                            int WXUNUSED(imageId))
 384 {
 385     wxCHECK_MSG( page || AllowNullPage(), false,
 386                  wxT("NULL page in wxBookCtrlBase::InsertPage()") );
 387     wxCHECK_MSG( nPage <= m_pages.size(), false,
 388                  wxT("invalid page index in wxBookCtrlBase::InsertPage()") );
 389
 390     m_pages.Insert(page, nPage);
 391     if ( page )
 392         page->SetSize(GetPageRect());
 393
 394     DoInvalidateBestSize();
 395
 396     return true;
 397 }
 398
 399 bool wxBookCtrlBase::DeletePage(size_t nPage)
 400 {
 401     wxWindow *page = DoRemovePage(nPage);
 402     if ( !(page || AllowNullPage()) )
 403         return false;
 404
 405     // delete NULL is harmless
 406     delete page;
 407
 408     return true;
 409 }
 410
 411 wxWindow *wxBookCtrlBase::DoRemovePage(size_t nPage)
 412 {
 413     wxCHECK_MSG( nPage < m_pages.size(), NULL,
 414                  wxT("invalid page index in wxBookCtrlBase::DoRemovePage()") );
 415
 416     wxWindow *pageRemoved = m_pages[nPage];
 417     m_pages.RemoveAt(nPage);
 418     DoInvalidateBestSize();
 419
 420     return pageRemoved;
 421 }
 422
 423 int wxBookCtrlBase::GetNextPage(bool forward) const
 424 {
 425     int nPage;
 426
 427     int nMax = GetPageCount();
 428     if ( nMax-- ) // decrement it to get the last valid index
 429     {
 430         int nSel = GetSelection();
 431
 432         // change selection wrapping if it becomes invalid
 433         nPage = forward ? nSel == nMax ? 0
 434                                        : nSel + 1
 435                         : nSel == 0 ? nMax
 436                                     : nSel - 1;
 437     }
 438     else // notebook is empty, no next page
 439     {
 440         nPage = wxNOT_FOUND;
 441     }
 442
 443     return nPage;
 444 }
 445
 446 bool wxBookCtrlBase::DoSetSelectionAfterInsertion(size_t n, bool bSelect)
 447 {
 448     if ( bSelect )
 449         SetSelection(n);
 450     else if ( m_selection == wxNOT_FOUND )
 451         ChangeSelection(0);
 452     else // We're not going to select this page.
 453         return false;
 454
 455     // Return true to indicate that we selected this page.
 456     return true;
 457 }
 458
 459 int wxBookCtrlBase::DoSetSelection(size_t n, int flags)
 460 {
 461     wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
 462                  wxT("invalid page index in wxBookCtrlBase::DoSetSelection()") );
 463
 464     const int oldSel = GetSelection();
 465
 466     if ( n != (size_t)oldSel )
 467     {
 468         wxBookCtrlEvent *event = CreatePageChangingEvent();
 469         bool allowed = false;
 470
 471         if ( flags & SetSelection_SendEvent )
 472         {
 473             event->SetSelection(n);
 474             event->SetOldSelection(oldSel);
 475             event->SetEventObject(this);
 476
 477             allowed = !GetEventHandler()->ProcessEvent(*event) || event->IsAllowed();
 478         }
 479
 480         if ( !(flags & SetSelection_SendEvent) || allowed)
 481         {
 482             if ( oldSel != wxNOT_FOUND )
 483                 DoShowPage(m_pages[oldSel], false);
 484
 485             wxWindow *page = m_pages[n];
 486             page->SetSize(GetPageRect());
 487             DoShowPage(page, true);
 488
 489             // change selection now to ignore the selection change event
 490             UpdateSelectedPage(n);
 491
 492             if ( flags & SetSelection_SendEvent )
 493             {
 494                 // program allows the page change
 495                 MakeChangedEvent(*event);
 496                 (void)GetEventHandler()->ProcessEvent(*event);
 497             }
 498         }
 499
 500         delete event;
 501     }
 502
 503     return oldSel;
 504 }
 505
 506 IMPLEMENT_DYNAMIC_CLASS(wxBookCtrlEvent, wxNotifyEvent)
 507
 508 #endif // wxUSE_BOOKCTRL