src/generic/listbkg.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        generic/listbkg.cpp
   3 // Purpose:     generic implementation of wxListbook
   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_LISTBOOK
  28
  29 #include "wx/listctrl.h"
  30 #include "wx/statline.h"
  31 #include "wx/listbook.h"
  32 #include "wx/imaglist.h"
  33 #include "wx/settings.h"
  34
  35 // ----------------------------------------------------------------------------
  36 // various wxWidgets macros
  37 // ----------------------------------------------------------------------------
  38
  39 // check that the page index is valid
  40 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
  41
  42 // ----------------------------------------------------------------------------
  43 // event table
  44 // ----------------------------------------------------------------------------
  45
  46 IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxControl)
  47 IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
  48
  49 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
  50 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
  51 const int wxID_LISTBOOKLISTVIEW = wxNewId();
  52
  53 BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
  54     EVT_SIZE(wxListbook::OnSize)
  55     EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
  56 END_EVENT_TABLE()
  57
  58 // ============================================================================
  59 // wxListbook implementation
  60 // ============================================================================
  61
  62 // ----------------------------------------------------------------------------
  63 // wxListbook creation
  64 // ----------------------------------------------------------------------------
  65
  66 void wxListbook::Init()
  67 {
  68     m_list = NULL;
  69 #if wxUSE_LINE_IN_LISTBOOK
  70     m_line = NULL;
  71 #endif // wxUSE_LINE_IN_LISTBOOK
  72     m_selection = wxNOT_FOUND;
  73 }
  74
  75 bool
  76 wxListbook::Create(wxWindow *parent,
  77                    wxWindowID id,
  78                    const wxPoint& pos,
  79                    const wxSize& size,
  80                    long style,
  81                    const wxString& name)
  82 {
  83     if ( (style & wxLB_ALIGN_MASK) == wxLB_DEFAULT )
  84     {
  85 #ifdef __WXMAC__
  86         style |= wxLB_TOP;
  87 #else // !__WXMAC__
  88         style |= wxLB_LEFT;
  89 #endif // __WXMAC__/!__WXMAC__
  90     }
  91
  92     // no border for this control, it doesn't look nice together with
  93     // wxListCtrl border
  94     style &= ~wxBORDER_MASK;
  95     style |= wxBORDER_NONE;
  96
  97     if ( !wxControl::Create(parent, id, pos, size, style,
  98                             wxDefaultValidator, name) )
  99         return false;
 100
 101     m_list = new wxListView
 102                  (
 103                     this,
 104                     wxID_LISTBOOKLISTVIEW,
 105                     wxDefaultPosition,
 106                     wxDefaultSize,
 107                     wxLC_ICON | wxLC_SINGLE_SEL |
 108                         (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
 109                  );
 110
 111 #if wxUSE_LINE_IN_LISTBOOK
 112     m_line = new wxStaticLine
 113                  (
 114                     this,
 115                     wxID_ANY,
 116                     wxDefaultPosition,
 117                     wxDefaultSize,
 118                     IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
 119                  );
 120 #endif // wxUSE_LINE_IN_LISTBOOK
 121
 122 #ifdef __WXMSW__
 123     // On XP with themes enabled the GetViewRect used in GetListSize to
 124     // determine the space needed for the list view will incorrectly return
 125     // (0,0,0,0) the first time.  So send a pending event so OnSize will be
 126     // called again after the window is ready to go.  Technically we don't
 127     // need to do this on non-XP windows, but if things are already sized
 128     // correctly then nothing changes and so there is no harm.
 129     wxSizeEvent evt;
 130     GetEventHandler()->AddPendingEvent(evt);
 131 #endif
 132     return true;
 133 }
 134
 135 // ----------------------------------------------------------------------------
 136 // wxListbook geometry management
 137 // ----------------------------------------------------------------------------
 138
 139 wxSize wxListbook::GetListSize() const
 140 {
 141     const wxSize sizeClient = GetClientSize(),
 142                  sizeBorder = m_list->GetSize() - m_list->GetClientSize(),
 143                  sizeList = m_list->GetViewRect().GetSize() + sizeBorder;
 144
 145     wxSize size;
 146     if ( IsVertical() )
 147     {
 148         size.x = sizeClient.x;
 149         size.y = sizeList.y;
 150     }
 151     else // left/right aligned
 152     {
 153         size.x = sizeList.x;
 154         size.y = sizeClient.y;
 155     }
 156
 157     return size;
 158 }
 159
 160 wxRect wxListbook::GetPageRect() const
 161 {
 162     const wxSize sizeList = m_list->GetSize();
 163
 164     wxPoint pt;
 165     wxRect rectPage(pt, GetClientSize());
 166     switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
 167     {
 168         default:
 169             wxFAIL_MSG( _T("unexpected wxListbook alignment") );
 170             // fall through
 171
 172         case wxLB_TOP:
 173             rectPage.y = sizeList.y + GetInternalBorder();
 174             // fall through
 175
 176         case wxLB_BOTTOM:
 177             rectPage.height -= sizeList.y + GetInternalBorder();
 178             break;
 179
 180         case wxLB_LEFT:
 181             rectPage.x = sizeList.x + GetInternalBorder();
 182             // fall through
 183
 184         case wxLB_RIGHT:
 185             rectPage.width -= sizeList.x + GetInternalBorder();
 186             break;
 187     }
 188
 189     return rectPage;
 190 }
 191
 192 void wxListbook::OnSize(wxSizeEvent& event)
 193 {
 194     event.Skip();
 195
 196     if ( !m_list )
 197     {
 198         // we're not fully created yet
 199         return;
 200     }
 201
 202     // arrange the icons before calling SetClientSize(), otherwise it wouldn't
 203     // account for the scrollbars the list control might need and, at least
 204     // under MSW, we'd finish with an ugly looking list control with both
 205     // vertical and horizontal scrollbar (with one of them being added because
 206     // the other one is not accounted for in client size computations)
 207     m_list->Arrange();
 208
 209     // resize the list control and the page area to fit inside our new size
 210     const wxSize sizeClient = GetClientSize(),
 211                  sizeBorder = m_list->GetSize() - m_list->GetClientSize(),
 212                  sizeList = GetListSize();
 213
 214     m_list->SetClientSize( sizeList.x - sizeBorder.x, sizeList.y - sizeBorder.y );
 215
 216     const wxSize sizeNew = m_list->GetSize();
 217     wxPoint posList;
 218     switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
 219     {
 220         default:
 221             wxFAIL_MSG( _T("unexpected wxListbook alignment") );
 222             // fall through
 223
 224         case wxLB_TOP:
 225         case wxLB_LEFT:
 226             // posList is already ok
 227             break;
 228
 229         case wxLB_BOTTOM:
 230             posList.y = sizeClient.y - sizeNew.y;
 231             break;
 232
 233         case wxLB_RIGHT:
 234             posList.x = sizeClient.x - sizeNew.x;
 235             break;
 236     }
 237
 238     if ( m_list->GetPosition() != posList )
 239         m_list->Move(posList);
 240
 241 #if wxUSE_LINE_IN_LISTBOOK
 242     if ( m_line )
 243     {
 244         wxRect rectLine(sizeClient);
 245
 246         switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
 247         {
 248             case wxLB_TOP:
 249                 rectLine.y = sizeNew.y + 1;
 250                 rectLine.height = GetInternalBorder() - 2;
 251                 break;
 252
 253             case wxLB_BOTTOM:
 254                 rectLine.height = GetInternalBorder() - 2;
 255                 rectLine.y = sizeClient.y - sizeNew.y - rectLine.height;
 256                 break;
 257
 258             case wxLB_LEFT:
 259                 rectLine.x = sizeNew.x + 1;
 260                 rectLine.width = GetInternalBorder() - 2;
 261                 break;
 262
 263             case wxLB_RIGHT:
 264                 rectLine.width = GetInternalBorder() - 2;
 265                 rectLine.x = sizeClient.x - sizeNew.x - rectLine.width;
 266                 break;
 267         }
 268
 269         m_line->SetSize(rectLine);
 270     }
 271 #endif // wxUSE_LINE_IN_LISTBOOK
 272
 273     // resize the currently shown page
 274     if (m_selection != wxNOT_FOUND )
 275     {
 276         wxWindow *page = m_pages[m_selection];
 277         wxCHECK_RET( page, _T("NULL page in wxListbook?") );
 278         page->SetSize(GetPageRect());
 279     }
 280 }
 281
 282 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 283 {
 284     // we need to add the size of the list control and the border between
 285     const wxSize sizeList = GetListSize();
 286
 287     wxSize size = sizePage;
 288     if ( IsVertical() )
 289     {
 290         size.y += sizeList.y + GetInternalBorder();
 291     }
 292     else // left/right aligned
 293     {
 294         size.x += sizeList.x + GetInternalBorder();
 295     }
 296
 297     return size;
 298 }
 299
 300
 301 // ----------------------------------------------------------------------------
 302 // accessing the pages
 303 // ----------------------------------------------------------------------------
 304
 305 bool wxListbook::SetPageText(size_t n, const wxString& strText)
 306 {
 307     m_list->SetItemText(n, strText);
 308
 309     return true;
 310 }
 311
 312 wxString wxListbook::GetPageText(size_t n) const
 313 {
 314     return m_list->GetItemText(n);
 315 }
 316
 317 int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 318 {
 319     wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
 320
 321     return wxNOT_FOUND;
 322 }
 323
 324 bool wxListbook::SetPageImage(size_t n, int imageId)
 325 {
 326     return m_list->SetItemImage(n, imageId);
 327 }
 328
 329 // ----------------------------------------------------------------------------
 330 // image list stuff
 331 // ----------------------------------------------------------------------------
 332
 333 void wxListbook::SetImageList(wxImageList *imageList)
 334 {
 335     m_list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
 336
 337     wxBookCtrlBase::SetImageList(imageList);
 338 }
 339
 340 // ----------------------------------------------------------------------------
 341 // selection
 342 // ----------------------------------------------------------------------------
 343
 344 int wxListbook::GetSelection() const
 345 {
 346     return m_selection;
 347 }
 348
 349 int wxListbook::SetSelection(size_t n)
 350 {
 351     wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
 352                  wxT("invalid page index in wxListbook::SetSelection()") );
 353
 354     const int oldSel = m_selection;
 355
 356     if ( int(n) != m_selection )
 357     {
 358         wxListbookEvent event(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
 359         event.SetSelection(n);
 360         event.SetOldSelection(m_selection);
 361         event.SetEventObject(this);
 362         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 363         {
 364             if ( m_selection != wxNOT_FOUND )
 365                 m_pages[m_selection]->Hide();
 366
 367             wxWindow *page = m_pages[n];
 368             page->SetSize(GetPageRect());
 369             page->Show();
 370
 371             // change m_selection now to ignore the selection change event
 372             m_selection = n;
 373             m_list->Select(n);
 374             m_list->Focus(n);
 375
 376             // program allows the page change
 377             event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
 378             (void)GetEventHandler()->ProcessEvent(event);
 379         }
 380     }
 381
 382     return oldSel;
 383 }
 384
 385 // ----------------------------------------------------------------------------
 386 // adding/removing the pages
 387 // ----------------------------------------------------------------------------
 388
 389 bool
 390 wxListbook::InsertPage(size_t n,
 391                        wxWindow *page,
 392                        const wxString& text,
 393                        bool bSelect,
 394                        int imageId)
 395 {
 396     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 397         return false;
 398
 399     m_list->InsertItem(n, text, imageId);
 400
 401     // if the inserted page is before the selected one, we must update the
 402     // index of the selected page
 403     if ( int(n) <= m_selection )
 404     {
 405         // one extra page added
 406         m_selection++;
 407         m_list->Select(m_selection);
 408         m_list->Focus(m_selection);
 409     }
 410
 411     // some page should be selected: either this one or the first one if there
 412     // is still no selection
 413     int selNew = -1;
 414     if ( bSelect )
 415         selNew = n;
 416     else if ( m_selection == -1 )
 417         selNew = 0;
 418
 419     if ( selNew != m_selection )
 420         page->Hide();
 421
 422     if ( selNew != -1 )
 423         SetSelection(selNew);
 424
 425     InvalidateBestSize();
 426     m_list->Arrange();
 427     return true;
 428 }
 429
 430 wxWindow *wxListbook::DoRemovePage(size_t page)
 431 {
 432     const size_t page_count = GetPageCount();
 433     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 434
 435     if ( win )
 436     {
 437         m_list->DeleteItem(page);
 438
 439         if (m_selection >= (int)page)
 440         {
 441             // force new sel valid if possible
 442             int sel = m_selection - 1;
 443             if (page_count == 1)
 444                 sel = wxNOT_FOUND;
 445             else if ((page_count == 2) || (sel == -1))
 446                 sel = 0;
 447
 448             // force sel invalid if deleting current page - don't try to hide it
 449             m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
 450
 451             if ((sel != wxNOT_FOUND) && (sel != m_selection))
 452                 SetSelection(sel);
 453         }
 454
 455         m_list->Arrange();
 456     }
 457
 458     return win;
 459 }
 460
 461
 462 bool wxListbook::DeleteAllPages()
 463 {
 464     m_list->DeleteAllItems();
 465     return wxBookCtrlBase::DeleteAllPages();
 466 }
 467
 468 // ----------------------------------------------------------------------------
 469 // wxListbook events
 470 // ----------------------------------------------------------------------------
 471
 472 void wxListbook::OnListSelected(wxListEvent& eventList)
 473 {
 474     const int selNew = eventList.GetIndex();
 475
 476     if ( selNew == m_selection )
 477     {
 478         // this event can only come from our own Select(m_selection) below
 479         // which we call when the page change is vetoed, so we should simply
 480         // ignore it
 481         return;
 482     }
 483
 484     SetSelection(selNew);
 485
 486     // change wasn't allowed, return to previous state
 487     if (m_selection != selNew)
 488     {
 489         m_list->Select(m_selection);
 490         m_list->Focus(m_selection);
 491     }
 492 }
 493
 494 #endif // wxUSE_LISTBOOK