src/generic/listbkg.cpp

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