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