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_bookctrl = NULL;
  57     m_imageList = NULL;
  58     m_ownsImageList = false;
  59     m_fitToCurrentPage = false;
  60
  61 #if defined(__WXWINCE__)
  62     m_internalBorder = 1;
  63 #else
  64     m_internalBorder = 5;
  65 #endif
  66
  67     m_controlMargin = 0;
  68     m_controlSizer = NULL;
  69 }
  70
  71 bool
  72 wxBookCtrlBase::Create(wxWindow *parent,
  73                        wxWindowID id,
  74                        const wxPoint& pos,
  75                        const wxSize& size,
  76                        long style,
  77                        const wxString& name)
  78 {
  79     return wxControl::Create
  80                      (
  81                         parent,
  82                         id,
  83                         pos,
  84                         size,
  85                         style,
  86                         wxDefaultValidator,
  87                         name
  88                      );
  89 }
  90
  91 wxBookCtrlBase::~wxBookCtrlBase()
  92 {
  93     if ( m_ownsImageList )
  94     {
  95         // may be NULL, ok
  96         delete m_imageList;
  97     }
  98 }
  99
 100 // ----------------------------------------------------------------------------
 101 // image list
 102 // ----------------------------------------------------------------------------
 103
 104 void wxBookCtrlBase::SetImageList(wxImageList *imageList)
 105 {
 106     if ( m_ownsImageList )
 107     {
 108         // may be NULL, ok
 109         delete m_imageList;
 110
 111         m_ownsImageList = false;
 112     }
 113
 114     m_imageList = imageList;
 115 }
 116
 117 void wxBookCtrlBase::AssignImageList(wxImageList* imageList)
 118 {
 119     SetImageList(imageList);
 120
 121     m_ownsImageList = true;
 122 }
 123
 124 // ----------------------------------------------------------------------------
 125 // geometry
 126 // ----------------------------------------------------------------------------
 127
 128 void wxBookCtrlBase::SetPageSize(const wxSize& size)
 129 {
 130     SetClientSize(CalcSizeFromPage(size));
 131 }
 132
 133 wxSize wxBookCtrlBase::DoGetBestSize() const
 134 {
 135     wxSize bestSize;
 136
 137     // iterate over all pages, get the largest width and height
 138     const size_t nCount = m_pages.size();
 139     for ( size_t nPage = 0; nPage < nCount; nPage++ )
 140     {
 141         const wxWindow * const pPage = m_pages[nPage];
 142         if( pPage )
 143         {
 144             wxSize childBestSize(pPage->GetBestSize());
 145
 146             if ( childBestSize.x > bestSize.x )
 147                 bestSize.x = childBestSize.x;
 148
 149             if ( childBestSize.y > bestSize.y )
 150                 bestSize.y = childBestSize.y;
 151         }
 152     }
 153
 154     if (m_fitToCurrentPage && GetCurrentPage())
 155         bestSize = GetCurrentPage()->GetBestSize();
 156
 157     // convert display area to window area, adding the size necessary for the
 158     // tabs
 159     wxSize best = CalcSizeFromPage(bestSize);
 160     CacheBestSize(best);
 161     return best;
 162 }
 163
 164 #if wxUSE_HELP
 165 void wxBookCtrlBase::OnHelp(wxHelpEvent& event)
 166 {
 167     // ignore the events not coming from the book control itself, otherwise we
 168     // could attempt to redirect a help event generated by one of our pages
 169     // back to the same page resulting in an infinite loop
 170     if ( event.GetEventObject() != this )
 171     {
 172         event.Skip();
 173         return;
 174     }
 175
 176     // find the corresponding page
 177     wxWindow *page = NULL;
 178
 179     if ( event.GetOrigin() == wxHelpEvent::Origin_HelpButton )
 180     {
 181         // show help for the page under the mouse
 182         const int pagePos = HitTest(ScreenToClient(event.GetPosition()));
 183
 184         if ( pagePos != wxNOT_FOUND)
 185         {
 186             page = GetPage((size_t)pagePos);
 187         }
 188     }
 189
 190     if ( !page )
 191     {
 192         page = GetCurrentPage();
 193     }
 194
 195     if ( !page || !page->GetEventHandler()->ProcessEvent(event) )
 196     {
 197         event.Skip();
 198     }
 199 }
 200 #endif // wxUSE_HELP
 201
 202 // ----------------------------------------------------------------------------
 203 // pages management
 204 // ----------------------------------------------------------------------------
 205
 206 bool
 207 wxBookCtrlBase::InsertPage(size_t nPage,
 208                            wxWindow *page,
 209                            const wxString& WXUNUSED(text),
 210                            bool WXUNUSED(bSelect),
 211                            int WXUNUSED(imageId))
 212 {
 213     wxCHECK_MSG( page || AllowNullPage(), false,
 214                  _T("NULL page in wxBookCtrlBase::InsertPage()") );
 215     wxCHECK_MSG( nPage <= m_pages.size(), false,
 216                  _T("invalid page index in wxBookCtrlBase::InsertPage()") );
 217
 218     m_pages.Insert(page, nPage);
 219     if ( page )
 220         page->SetSize(GetPageRect());
 221
 222     InvalidateBestSize();
 223
 224     return true;
 225 }
 226
 227 bool wxBookCtrlBase::DeletePage(size_t nPage)
 228 {
 229     wxWindow *page = DoRemovePage(nPage);
 230     if ( !(page || AllowNullPage()) )
 231         return false;
 232
 233     // delete NULL is harmless
 234     delete page;
 235
 236     return true;
 237 }
 238
 239 wxWindow *wxBookCtrlBase::DoRemovePage(size_t nPage)
 240 {
 241     wxCHECK_MSG( nPage < m_pages.size(), NULL,
 242                  _T("invalid page index in wxBookCtrlBase::DoRemovePage()") );
 243
 244     wxWindow *pageRemoved = m_pages[nPage];
 245     m_pages.RemoveAt(nPage);
 246     InvalidateBestSize();
 247
 248     return pageRemoved;
 249 }
 250
 251 int wxBookCtrlBase::GetNextPage(bool forward) const
 252 {
 253     int nPage;
 254
 255     int nMax = GetPageCount();
 256     if ( nMax-- ) // decrement it to get the last valid index
 257     {
 258         int nSel = GetSelection();
 259
 260         // change selection wrapping if it becomes invalid
 261         nPage = forward ? nSel == nMax ? 0
 262                                        : nSel + 1
 263                         : nSel == 0 ? nMax
 264                                     : nSel - 1;
 265     }
 266     else // notebook is empty, no next page
 267     {
 268         nPage = wxNOT_FOUND;
 269     }
 270
 271     return nPage;
 272 }
 273
 274 wxRect wxBookCtrlBase::GetPageRect() const
 275 {
 276     const wxSize size = GetControllerSize();
 277
 278     wxPoint pt;
 279     wxRect rectPage(pt, GetClientSize());
 280
 281     switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 282     {
 283         default:
 284             wxFAIL_MSG( _T("unexpected alignment") );
 285             // fall through
 286
 287         case wxBK_TOP:
 288             rectPage.y = size.y + GetInternalBorder();
 289             // fall through
 290
 291         case wxBK_BOTTOM:
 292             rectPage.height -= size.y + GetInternalBorder();
 293             break;
 294
 295         case wxBK_LEFT:
 296             rectPage.x = size.x + GetInternalBorder();
 297             // fall through
 298
 299         case wxBK_RIGHT:
 300             rectPage.width -= size.x + GetInternalBorder();
 301             break;
 302     }
 303
 304     return rectPage;
 305 }
 306
 307 // Lay out controls
 308 void wxBookCtrlBase::DoSize()
 309 {
 310     if ( !m_bookctrl )
 311     {
 312         // we're not fully created yet or OnSize() should be hidden by derived class
 313         return;
 314     }
 315
 316     if (GetSizer())
 317         Layout();
 318     else
 319     {
 320         // resize controller and the page area to fit inside our new size
 321         const wxSize sizeClient( GetClientSize() ),
 322                     sizeBorder( m_bookctrl->GetSize() - m_bookctrl->GetClientSize() ),
 323                     sizeCtrl( GetControllerSize() );
 324
 325         m_bookctrl->SetClientSize( sizeCtrl.x - sizeBorder.x, sizeCtrl.y - sizeBorder.y );
 326
 327         const wxSize sizeNew = m_bookctrl->GetSize();
 328         wxPoint posCtrl;
 329         switch ( GetWindowStyle() & wxBK_ALIGN_MASK )
 330         {
 331             default:
 332                 wxFAIL_MSG( _T("unexpected alignment") );
 333                 // fall through
 334
 335             case wxBK_TOP:
 336             case wxBK_LEFT:
 337                 // posCtrl is already ok
 338                 break;
 339
 340             case wxBK_BOTTOM:
 341                 posCtrl.y = sizeClient.y - sizeNew.y;
 342                 break;
 343
 344             case wxBK_RIGHT:
 345                 posCtrl.x = sizeClient.x - sizeNew.x;
 346                 break;
 347         }
 348
 349         if ( m_bookctrl->GetPosition() != posCtrl )
 350             m_bookctrl->Move(posCtrl);
 351     }
 352
 353     // resize all pages to fit the new control size
 354     const wxRect pageRect = GetPageRect();
 355     const unsigned pagesCount = m_pages.Count();
 356     for ( unsigned int i = 0; i < pagesCount; ++i )
 357     {
 358         wxWindow * const page = m_pages[i];
 359         if ( !page )
 360         {
 361             wxASSERT_MSG( AllowNullPage(),
 362                 _T("Null page in a control that does not allow null pages?") );
 363             continue;
 364         }
 365
 366         page->SetSize(pageRect);
 367     }
 368 }
 369
 370 void wxBookCtrlBase::OnSize(wxSizeEvent& event)
 371 {
 372     event.Skip();
 373
 374     DoSize();
 375 }
 376
 377 wxSize wxBookCtrlBase::GetControllerSize() const
 378 {
 379     if(!m_bookctrl)
 380         return wxSize(0,0);
 381
 382     const wxSize sizeClient = GetClientSize(),
 383                  sizeBorder = m_bookctrl->GetSize() - m_bookctrl->GetClientSize(),
 384                  sizeCtrl = m_bookctrl->GetBestSize() + sizeBorder;
 385
 386     wxSize size;
 387
 388     if ( IsVertical() )
 389     {
 390         size.x = sizeClient.x;
 391         size.y = sizeCtrl.y;
 392     }
 393     else // left/right aligned
 394     {
 395         size.x = sizeCtrl.x;
 396         size.y = sizeClient.y;
 397     }
 398
 399     return size;
 400 }
 401
 402 #endif // wxUSE_BOOKCTRL