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