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                 bestSize.IncTo(pPage->GetBestSize());
 153         }
 154     }
 155
 156     // convert display area to window area, adding the size necessary for the
 157     // tabs
 158     wxSize best = CalcSizeFromPage(bestSize);
 159     CacheBestSize(best);
 160     return best;
 161 }
 162
 163 wxRect wxBookCtrlBase::GetPageRect() const
 164 {
 165     const wxSize size = GetControllerSize();
 166
 167     wxPoint pt;
 168     wxRect rectPage(pt, GetClientSize());
 169
 170     switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 171     {
 172         default:
 173             wxFAIL_MSG( wxT("unexpected alignment") );
 174             // fall through
 175
 176         case wxBK_TOP:
 177             rectPage.y = size.y + GetInternalBorder();
 178             // fall through
 179
 180         case wxBK_BOTTOM:
 181             rectPage.height -= size.y + GetInternalBorder();
 182             if (rectPage.height < 0)
 183                 rectPage.height = 0;
 184             break;
 185
 186         case wxBK_LEFT:
 187             rectPage.x = size.x + GetInternalBorder();
 188             // fall through
 189
 190         case wxBK_RIGHT:
 191             rectPage.width -= size.x + GetInternalBorder();
 192             if (rectPage.width < 0)
 193                 rectPage.width = 0;
 194             break;
 195     }
 196
 197     return rectPage;
 198 }
 199
 200 // Lay out controls
 201 void wxBookCtrlBase::DoSize()
 202 {
 203     if ( !m_bookctrl )
 204     {
 205         // we're not fully created yet or OnSize() should be hidden by derived class
 206         return;
 207     }
 208
 209     if (GetSizer())
 210         Layout();
 211     else
 212     {
 213         // resize controller and the page area to fit inside our new size
 214         const wxSize sizeClient( GetClientSize() ),
 215                     sizeBorder( m_bookctrl->GetSize() - m_bookctrl->GetClientSize() ),
 216                     sizeCtrl( GetControllerSize() );
 217
 218         m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
 219         // if this changes the visibility of the scrollbars the best size changes, relayout in this case
 220         wxSize sizeCtrl2 = GetControllerSize();
 221         if ( sizeCtrl != sizeCtrl2 )
 222         {
 223             wxSize sizeBorder2 = m_bookctrl->GetSize() - m_bookctrl->GetClientSize();
 224             m_bookctrl->SetClientSize( sizeCtrl2.x - sizeBorder2.x, sizeCtrl2.y - sizeBorder2.y );
 225         }
 226
 227         const wxSize sizeNew = m_bookctrl->GetSize();
 228         wxPoint posCtrl;
 229         switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 230         {
 231             default:
 232                 wxFAIL_MSG( wxT("unexpected alignment") );
 233                 // fall through
 234
 235             case wxBK_TOP:
 236             case wxBK_LEFT:
 237                 // posCtrl is already ok
 238                 break;
 239
 240             case wxBK_BOTTOM:
 241                 posCtrl.y = sizeClient.y - sizeNew.y;
 242                 break;
 243
 244             case wxBK_RIGHT:
 245                 posCtrl.x = sizeClient.x - sizeNew.x;
 246                 break;
 247         }
 248
 249         if ( m_bookctrl->GetPosition() != posCtrl )
 250             m_bookctrl->Move(posCtrl);
 251     }
 252
 253     // resize all pages to fit the new control size
 254     const wxRect pageRect = GetPageRect();
 255     const unsigned pagesCount = m_pages.GetCount();
 256     for ( unsigned int i = 0; i < pagesCount; ++i )
 257     {
 258         wxWindow * const page = m_pages[i];
 259         if ( !page )
 260         {
 261             wxASSERT_MSG( AllowNullPage(),
 262                 wxT("Null page in a control that does not allow null pages?") );
 263             continue;
 264         }
 265
 266         page->SetSize(pageRect);
 267     }
 268 }
 269
 270 void wxBookCtrlBase::OnSize(wxSizeEvent& event)
 271 {
 272     event.Skip();
 273
 274     DoSize();
 275 }
 276
 277 wxSize wxBookCtrlBase::GetControllerSize() const
 278 {
 279     // For at least some book controls (e.g. wxChoicebook) it may make sense to
 280     // (temporarily?) hide the controller and we shouldn't leave extra space
 281     // for the hidden control in this case.
 282     if ( !m_bookctrl || !m_bookctrl->IsShown() )
 283         return wxSize(0, 0);
 284
 285     const wxSize sizeClient = GetClientSize();
 286
 287     wxSize size;
 288
 289     // Ask for the best width/height considering the other direction.
 290     if ( IsVertical() )
 291     {
 292         size.x = sizeClient.x;
 293         size.y = m_bookctrl->GetBestHeight(sizeClient.x);
 294     }
 295     else // left/right aligned
 296     {
 297         size.x = m_bookctrl->GetBestWidth(sizeClient.y);
 298         size.y = sizeClient.y;
 299     }
 300
 301     return size;
 302 }
 303
 304 // ----------------------------------------------------------------------------
 305 // miscellaneous stuff
 306 // ----------------------------------------------------------------------------
 307
 308 #if wxUSE_HELP
 309
 310 void wxBookCtrlBase::OnHelp(wxHelpEvent& event)
 311 {
 312     // determine where does this even originate from to avoid redirecting it
 313     // back to the page which generated it (resulting in an infinite loop)
 314
 315     // notice that we have to check in the hard(er) way instead of just testing
 316     // if the event object == this because the book control can have other
 317     // subcontrols inside it (e.g. wxSpinButton in case of a notebook in wxUniv)
 318     wxWindow *source = wxStaticCast(event.GetEventObject(), wxWindow);
 319     while ( source && source != this && source->GetParent() != this )
 320     {
 321         source = source->GetParent();
 322     }
 323
 324     if ( source && m_pages.Index(source) == wxNOT_FOUND )
 325     {
 326         // this event is for the book control itself, redirect it to the
 327         // corresponding page
 328         wxWindow *page = NULL;
 329
 330         if ( event.GetOrigin() == wxHelpEvent::Origin_HelpButton )
 331         {
 332             // show help for the page under the mouse
 333             const int pagePos = HitTest(ScreenToClient(event.GetPosition()));
 334
 335             if ( pagePos != wxNOT_FOUND)
 336             {
 337                 page = GetPage((size_t)pagePos);
 338             }
 339         }
 340         else // event from keyboard or unknown source
 341         {
 342             // otherwise show the current page help
 343             page = GetCurrentPage();
 344         }
 345
 346         if ( page )
 347         {
 348             // change event object to the page to avoid infinite recursion if
 349             // we get this event ourselves if the page doesn't handle it
 350             event.SetEventObject(page);
 351
 352             if ( page->GetEventHandler()->ProcessEvent(event) )
 353             {
 354                 // don't call event.Skip()
 355                 return;
 356             }
 357         }
 358     }
 359     //else: event coming from one of our pages already
 360
 361     event.Skip();
 362 }
 363
 364 #endif // wxUSE_HELP
 365
 366 // ----------------------------------------------------------------------------
 367 // pages management
 368 // ----------------------------------------------------------------------------
 369
 370 bool
 371 wxBookCtrlBase::InsertPage(size_t nPage,
 372                            wxWindow *page,
 373                            const wxString& WXUNUSED(text),
 374                            bool WXUNUSED(bSelect),
 375                            int WXUNUSED(imageId))
 376 {
 377     wxCHECK_MSG( page || AllowNullPage(), false,
 378                  wxT("NULL page in wxBookCtrlBase::InsertPage()") );
 379     wxCHECK_MSG( nPage <= m_pages.size(), false,
 380                  wxT("invalid page index in wxBookCtrlBase::InsertPage()") );
 381
 382     m_pages.Insert(page, nPage);
 383     if ( page )
 384         page->SetSize(GetPageRect());
 385
 386     DoInvalidateBestSize();
 387
 388     return true;
 389 }
 390
 391 bool wxBookCtrlBase::DeletePage(size_t nPage)
 392 {
 393     wxWindow *page = DoRemovePage(nPage);
 394     if ( !(page || AllowNullPage()) )
 395         return false;
 396
 397     // delete NULL is harmless
 398     delete page;
 399
 400     return true;
 401 }
 402
 403 wxWindow *wxBookCtrlBase::DoRemovePage(size_t nPage)
 404 {
 405     wxCHECK_MSG( nPage < m_pages.size(), NULL,
 406                  wxT("invalid page index in wxBookCtrlBase::DoRemovePage()") );
 407
 408     wxWindow *pageRemoved = m_pages[nPage];
 409     m_pages.RemoveAt(nPage);
 410     DoInvalidateBestSize();
 411
 412     return pageRemoved;
 413 }
 414
 415 int wxBookCtrlBase::GetNextPage(bool forward) const
 416 {
 417     int nPage;
 418
 419     int nMax = GetPageCount();
 420     if ( nMax-- ) // decrement it to get the last valid index
 421     {
 422         int nSel = GetSelection();
 423
 424         // change selection wrapping if it becomes invalid
 425         nPage = forward ? nSel == nMax ? 0
 426                                        : nSel + 1
 427                         : nSel == 0 ? nMax
 428                                     : nSel - 1;
 429     }
 430     else // notebook is empty, no next page
 431     {
 432         nPage = wxNOT_FOUND;
 433     }
 434
 435     return nPage;
 436 }
 437
 438 bool wxBookCtrlBase::DoSetSelectionAfterInsertion(size_t n, bool bSelect)
 439 {
 440     if ( bSelect )
 441         SetSelection(n);
 442     else if ( m_selection == wxNOT_FOUND )
 443         ChangeSelection(0);
 444     else // We're not going to select this page.
 445         return false;
 446
 447     // Return true to indicate that we selected this page.
 448     return true;
 449 }
 450
 451 int wxBookCtrlBase::DoSetSelection(size_t n, int flags)
 452 {
 453     wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
 454                  wxT("invalid page index in wxBookCtrlBase::DoSetSelection()") );
 455
 456     const int oldSel = GetSelection();
 457
 458     if ( n != (size_t)oldSel )
 459     {
 460         wxBookCtrlEvent *event = CreatePageChangingEvent();
 461         bool allowed = false;
 462
 463         if ( flags & SetSelection_SendEvent )
 464         {
 465             event->SetSelection(n);
 466             event->SetOldSelection(oldSel);
 467             event->SetEventObject(this);
 468
 469             allowed = !GetEventHandler()->ProcessEvent(*event) || event->IsAllowed();
 470         }
 471
 472         if ( !(flags & SetSelection_SendEvent) || allowed)
 473         {
 474             if ( oldSel != wxNOT_FOUND )
 475                 DoShowPage(m_pages[oldSel], false);
 476
 477             wxWindow *page = m_pages[n];
 478             page->SetSize(GetPageRect());
 479             DoShowPage(page, true);
 480
 481             // change selection now to ignore the selection change event
 482             UpdateSelectedPage(n);
 483
 484             if ( flags & SetSelection_SendEvent )
 485             {
 486                 // program allows the page change
 487                 MakeChangedEvent(*event);
 488                 (void)GetEventHandler()->ProcessEvent(*event);
 489             }
 490         }
 491
 492         delete event;
 493     }
 494
 495     return oldSel;
 496 }
 497
 498 IMPLEMENT_DYNAMIC_CLASS(wxBookCtrlEvent, wxNotifyEvent)
 499
 500 #endif // wxUSE_BOOKCTRL