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 * WXUNUSED(flags)) const
 165 {
 166     int pagePos = wxNOT_FOUND;
 167
 168     const wxPoint clientPt = ClientToScreen(GetListView()->ScreenToClient(pt));
 169
 170     if ( wxRect(GetListView()->GetSize()).Inside(clientPt) )
 171     {
 172         int flagsList;
 173         pagePos = GetListView()->HitTest(clientPt, flagsList);
 174
 175         if ( !(flagsList & wxLIST_HITTEST_ONITEM) )
 176         {
 177             pagePos = wxNOT_FOUND;
 178         }
 179     }
 180
 181     return pagePos;
 182 }
 183
 184 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 185 {
 186     // we need to add the size of the list control and the border between
 187     const wxSize sizeList = GetControllerSize();
 188
 189     wxSize size = sizePage;
 190     if ( IsVertical() )
 191     {
 192         size.y += sizeList.y + GetInternalBorder();
 193     }
 194     else // left/right aligned
 195     {
 196         size.x += sizeList.x + GetInternalBorder();
 197     }
 198
 199     return size;
 200 }
 201
 202
 203 // ----------------------------------------------------------------------------
 204 // accessing the pages
 205 // ----------------------------------------------------------------------------
 206
 207 bool wxListbook::SetPageText(size_t n, const wxString& strText)
 208 {
 209     GetListView()->SetItemText(n, strText);
 210
 211     return true;
 212 }
 213
 214 wxString wxListbook::GetPageText(size_t n) const
 215 {
 216     return GetListView()->GetItemText(n);
 217 }
 218
 219 int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 220 {
 221     wxFAIL_MSG( _T("wxListbook::GetPageImage() not implemented") );
 222
 223     return wxNOT_FOUND;
 224 }
 225
 226 bool wxListbook::SetPageImage(size_t n, int imageId)
 227 {
 228     return GetListView()->SetItemImage(n, imageId);
 229 }
 230
 231 // ----------------------------------------------------------------------------
 232 // image list stuff
 233 // ----------------------------------------------------------------------------
 234
 235 void wxListbook::SetImageList(wxImageList *imageList)
 236 {
 237     GetListView()->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
 238
 239     wxBookCtrlBase::SetImageList(imageList);
 240 }
 241
 242 // ----------------------------------------------------------------------------
 243 // selection
 244 // ----------------------------------------------------------------------------
 245
 246 int wxListbook::GetSelection() const
 247 {
 248     return m_selection;
 249 }
 250
 251 int wxListbook::SetSelection(size_t n)
 252 {
 253     wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
 254                  wxT("invalid page index in wxListbook::SetSelection()") );
 255
 256     const int oldSel = m_selection;
 257
 258     if ( int(n) != m_selection )
 259     {
 260         wxListbookEvent event(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
 261         event.SetSelection(n);
 262         event.SetOldSelection(m_selection);
 263         event.SetEventObject(this);
 264         if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
 265         {
 266             if ( m_selection != wxNOT_FOUND )
 267                 m_pages[m_selection]->Hide();
 268
 269             wxWindow *page = m_pages[n];
 270             page->SetSize(GetPageRect());
 271             page->Show();
 272
 273             // change m_selection now to ignore the selection change event
 274             m_selection = n;
 275             GetListView()->Select(n);
 276             GetListView()->Focus(n);
 277
 278             // program allows the page change
 279             event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
 280             (void)GetEventHandler()->ProcessEvent(event);
 281         }
 282     }
 283
 284     return oldSel;
 285 }
 286
 287 // ----------------------------------------------------------------------------
 288 // adding/removing the pages
 289 // ----------------------------------------------------------------------------
 290
 291 bool
 292 wxListbook::InsertPage(size_t n,
 293                        wxWindow *page,
 294                        const wxString& text,
 295                        bool bSelect,
 296                        int imageId)
 297 {
 298     if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )
 299         return false;
 300
 301     GetListView()->InsertItem(n, text, imageId);
 302
 303     // if the inserted page is before the selected one, we must update the
 304     // index of the selected page
 305     if ( int(n) <= m_selection )
 306     {
 307         // one extra page added
 308         m_selection++;
 309         GetListView()->Select(m_selection);
 310         GetListView()->Focus(m_selection);
 311     }
 312
 313     // some page should be selected: either this one or the first one if there
 314     // is still no selection
 315     int selNew = -1;
 316     if ( bSelect )
 317         selNew = n;
 318     else if ( m_selection == -1 )
 319         selNew = 0;
 320
 321     if ( selNew != m_selection )
 322         page->Hide();
 323
 324     if ( selNew != -1 )
 325         SetSelection(selNew);
 326
 327     InvalidateBestSize();
 328     // GetListView()->InvalidateBestSize();
 329     GetListView()->Arrange();
 330
 331     if (GetPageCount() == 1)
 332     {
 333         wxSizeEvent sz(GetSize(), GetId());
 334         ProcessEvent(sz);
 335     }
 336     return true;
 337 }
 338
 339 wxWindow *wxListbook::DoRemovePage(size_t page)
 340 {
 341     const size_t page_count = GetPageCount();
 342     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 343
 344     if ( win )
 345     {
 346         GetListView()->DeleteItem(page);
 347
 348         if (m_selection >= (int)page)
 349         {
 350             // force new sel valid if possible
 351             int sel = m_selection - 1;
 352             if (page_count == 1)
 353                 sel = wxNOT_FOUND;
 354             else if ((page_count == 2) || (sel == -1))
 355                 sel = 0;
 356
 357             // force sel invalid if deleting current page - don't try to hide it
 358             m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
 359
 360             if ((sel != wxNOT_FOUND) && (sel != m_selection))
 361                 SetSelection(sel);
 362         }
 363
 364         GetListView()->Arrange();
 365         if (GetPageCount() == 0)
 366         {
 367             wxSizeEvent sz(GetSize(), GetId());
 368             ProcessEvent(sz);
 369         }
 370     }
 371
 372     return win;
 373 }
 374
 375
 376 bool wxListbook::DeleteAllPages()
 377 {
 378     GetListView()->DeleteAllItems();
 379     if (!wxBookCtrlBase::DeleteAllPages())
 380         return false;
 381
 382     m_selection = -1;
 383
 384     wxSizeEvent sz(GetSize(), GetId());
 385     ProcessEvent(sz);
 386
 387     return true;
 388 }
 389
 390 // ----------------------------------------------------------------------------
 391 // wxListbook events
 392 // ----------------------------------------------------------------------------
 393
 394 void wxListbook::OnListSelected(wxListEvent& eventList)
 395 {
 396     const int selNew = eventList.GetIndex();
 397
 398     if ( selNew == m_selection )
 399     {
 400         // this event can only come from our own Select(m_selection) below
 401         // which we call when the page change is vetoed, so we should simply
 402         // ignore it
 403         return;
 404     }
 405
 406     SetSelection(selNew);
 407
 408     // change wasn't allowed, return to previous state
 409     if (m_selection != selNew)
 410     {
 411         GetListView()->Select(m_selection);
 412         GetListView()->Focus(m_selection);
 413     }
 414 }
 415
 416 #endif // wxUSE_LISTBOOK