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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  21     #pragma implementation "listbook.h"
  22 #endif
  23
  24 // For compilers that support precompilation, includes "wx.h".
  25 #include "wx/wxprec.h"
  26
  27 #ifdef __BORLANDC__
  28     #pragma hdrstop
  29 #endif
  30
  31 #if wxUSE_LISTBOOK
  32
  33 #include "wx/listctrl.h"
  34 #include "wx/statline.h"
  35 #include "wx/listbook.h"
  36 #include "wx/imaglist.h"
  37 #include "wx/settings.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // constants
  41 // ----------------------------------------------------------------------------
  42
  43 // margin between the list and the page, should be bigger than wxStaticLine
  44 // size
  45 const wxCoord MARGIN = 5;
  46
  47 // ----------------------------------------------------------------------------
  48 // various wxWidgets macros
  49 // ----------------------------------------------------------------------------
  50
  51 // check that the page index is valid
  52 #define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
  53
  54 // ----------------------------------------------------------------------------
  55 // event table
  56 // ----------------------------------------------------------------------------
  57
  58 IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxControl)
  59 IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
  60
  61 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
  62 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
  63 const int wxID_LISTBOOKLISTVIEW = wxNewId();
  64
  65 BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)
  66     EVT_SIZE(wxListbook::OnSize)
  67     EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)
  68 END_EVENT_TABLE()
  69
  70 // ============================================================================
  71 // wxListbook implementation
  72 // ============================================================================
  73
  74 // ----------------------------------------------------------------------------
  75 // wxListbook creation
  76 // ----------------------------------------------------------------------------
  77
  78 void wxListbook::Init()
  79 {
  80     m_list = NULL;
  81 #if wxUSE_LINE_IN_LISTBOOK
  82     m_line = NULL;
  83 #endif // wxUSE_LINE_IN_LISTBOOK
  84     m_selection = wxNOT_FOUND;
  85 }
  86
  87 bool
  88 wxListbook::Create(wxWindow *parent,
  89                    wxWindowID id,
  90                    const wxPoint& pos,
  91                    const wxSize& size,
  92                    long style,
  93                    const wxString& name)
  94 {
  95     if ( (style & wxLB_ALIGN_MASK) == wxLB_DEFAULT )
  96     {
  97 #ifdef __WXMAC__
  98         style |= wxLB_TOP;
  99 #else // !__WXMAC__
 100         style |= wxLB_LEFT;
 101 #endif // __WXMAC__/!__WXMAC__
 102     }
 103
 104     // no border for this control, it doesn't look nice together with
 105     // wxListCtrl border
 106     style &= ~wxBORDER_MASK;
 107     style |= wxBORDER_NONE;
 108
 109     if ( !wxControl::Create(parent, id, pos, size, style,
 110                             wxDefaultValidator, name) )
 111         return false;
 112
 113     m_list = new wxListView
 114                  (
 115                     this,
 116                     wxID_LISTBOOKLISTVIEW,
 117                     wxDefaultPosition,
 118                     wxDefaultSize,
 119                     wxLC_ICON | wxLC_SINGLE_SEL |
 120                         (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)
 121                  );
 122
 123 #if wxUSE_LINE_IN_LISTBOOK
 124     m_line = new wxStaticLine
 125                  (
 126                     this,
 127                     wxID_ANY,
 128                     wxDefaultPosition,
 129                     wxDefaultSize,
 130                     IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
 131                  );
 132 #endif // wxUSE_LINE_IN_LISTBOOK
 133
 134 #ifdef __WXMSW__
 135     // On XP with themes enabled the GetViewRect used in GetListSize to
 136     // determine the space needed for the list view will incorrectly return
 137     // (0,0,0,0) the first time.  So send a pending event so OnSize wiull be
 138     // called again after the window is ready to go.  Technically we don't
 139     // need to do this on non-XP windows, but if things are already sized
 140     // correctly then nothing changes and so there is no harm.
 141     wxSizeEvent evt;
 142     GetEventHandler()->AddPendingEvent(evt);
 143 #endif
 144     return true;
 145 }
 146
 147 // ----------------------------------------------------------------------------
 148 // wxListbook geometry management
 149 // ----------------------------------------------------------------------------
 150
 151 wxSize wxListbook::GetListSize() const
 152 {
 153     const wxSize sizeClient = GetClientSize(),
 154                  sizeList = m_list->GetViewRect().GetSize();
 155
 156     wxSize size;
 157     if ( IsVertical() )
 158     {
 159         size.x = sizeClient.x;
 160         size.y = sizeList.y;
 161     }
 162     else // left/right aligned
 163     {
 164         size.x = sizeList.x;
 165         size.y = sizeClient.y;
 166     }
 167
 168     return size;
 169 }
 170
 171 wxRect wxListbook::GetPageRect() const
 172 {
 173     const wxSize sizeList = m_list->GetSize();
 174
 175     wxPoint pt(0, 0);
 176     wxRect rectPage(pt, GetClientSize());
 177     switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
 178     {
 179         default:
 180             wxFAIL_MSG( _T("unexpected wxListbook alignment") );
 181             // fall through
 182
 183         case wxLB_TOP:
 184             rectPage.y = sizeList.y + MARGIN;
 185             // fall through
 186
 187         case wxLB_BOTTOM:
 188             rectPage.height -= sizeList.y + MARGIN;
 189             break;
 190
 191         case wxLB_LEFT:
 192             rectPage.x = sizeList.x + MARGIN;
 193             // fall through
 194
 195         case wxLB_RIGHT:
 196             rectPage.width -= sizeList.x + MARGIN;
 197             break;
 198     }
 199
 200     return rectPage;
 201 }
 202
 203 void wxListbook::OnSize(wxSizeEvent& event)
 204 {
 205     event.Skip();
 206
 207     if ( !m_list )
 208     {
 209         // we're not fully created yet
 210         return;
 211     }
 212
 213     // resize the list control and the page area to fit inside our new size
 214     const wxSize sizeClient = GetClientSize(),
 215                  sizeList = GetListSize();
 216
 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 - sizeList.y;
 231             break;
 232
 233         case wxLB_RIGHT:
 234             posList.x = sizeClient.x - sizeList.x;
 235             break;
 236     }
 237
 238     m_list->Move(posList.x, posList.y);
 239     m_list->SetClientSize(sizeList.x, sizeList.y);
 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 = sizeList.y + 1;
 250                 rectLine.height = MARGIN - 2;
 251                 break;
 252
 253             case wxLB_BOTTOM:
 254                 rectLine.height = MARGIN - 2;
 255                 rectLine.y = sizeClient.y - sizeList.y - rectLine.height;
 256                 break;
 257
 258             case wxLB_LEFT:
 259                 rectLine.x = sizeList.x + 1;
 260                 rectLine.width = MARGIN - 2;
 261                 break;
 262
 263             case wxLB_RIGHT:
 264                 rectLine.width = MARGIN - 2;
 265                 rectLine.x = sizeClient.x - sizeList.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 margin
 285     const wxSize sizeList = GetListSize();
 286
 287     wxSize size = sizePage;
 288     if ( IsVertical() )
 289     {
 290         size.y += sizeList.y + MARGIN;
 291     }
 292     else // left/right aligned
 293     {
 294         size.x += sizeList.x + MARGIN;
 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 -1;
 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     return true;
 427 }
 428
 429 wxWindow *wxListbook::DoRemovePage(size_t page)
 430 {
 431     const int page_count = GetPageCount();
 432     wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
 433
 434     if ( win )
 435     {
 436         m_list->DeleteItem(page);
 437
 438         if (m_selection >= (int)page)
 439         {
 440             // force new sel valid if possible
 441             int sel = m_selection - 1;
 442             if (page_count == 1)
 443                 sel = wxNOT_FOUND;
 444             else if ((page_count == 2) || (sel == -1))
 445                 sel = 0;
 446
 447             // force sel invalid if deleting current page - don't try to hide it
 448             m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
 449
 450             if ((sel != wxNOT_FOUND) && (sel != m_selection))
 451                 SetSelection(sel);
 452         }
 453     }
 454
 455     return win;
 456 }
 457
 458
 459 bool wxListbook::DeleteAllPages()
 460 {
 461     m_list->DeleteAllItems();
 462     return wxBookCtrlBase::DeleteAllPages();
 463 }
 464
 465 // ----------------------------------------------------------------------------
 466 // wxListbook events
 467 // ----------------------------------------------------------------------------
 468
 469 void wxListbook::OnListSelected(wxListEvent& eventList)
 470 {
 471     const int selNew = eventList.GetIndex();
 472
 473     if ( selNew == m_selection )
 474     {
 475         // this event can only come from our own Select(m_selection) below
 476         // which we call when the page change is vetoed, so we should simply
 477         // ignore it
 478         return;
 479     }
 480
 481     SetSelection(selNew);
 482
 483     // change wasn't allowed, return to previous state
 484     if (m_selection != selNew)
 485     {
 486         m_list->Select(m_selection);
 487         m_list->Focus(m_selection);
 488     }
 489 }
 490
 491 #endif // wxUSE_LISTBOOK
 492