Doc tweaks

[wxWidgets.git] / src / generic / listbkg.cpp

diff --git a/src/generic/listbkg.cpp b/src/generic/listbkg.cpp
index c334b3d0120437f3bb48305098a5721a275b24e3..e9b4baa656b2be7e9776b6785f6ecc725c34abb0 100644 (file)
--- a/src/generic/listbkg.cpp
+++ b/src/generic/listbkg.cpp
@@ -34,6 +34,7 @@
 #include "wx/statline.h"
 #include "wx/listbook.h"
 #include "wx/imaglist.h"
 #include "wx/statline.h"
 #include "wx/listbook.h"
 #include "wx/imaglist.h"

+#include "wx/settings.h"

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -44,7 +45,14 @@
 const wxCoord MARGIN = 5;
 
 // ----------------------------------------------------------------------------
 const wxCoord MARGIN = 5;
 
 // ----------------------------------------------------------------------------

-// various wxWindows macros
+// various wxWidgets macros
+// ----------------------------------------------------------------------------
+
+// check that the page index is valid
+#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
+
+// ----------------------------------------------------------------------------
+// event table

 // ----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxControl)
 // ----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxListbook, wxControl)


@@ -52,11 +60,11 @@ IMPLEMENT_DYNAMIC_CLASS(wxListbookEvent, wxNotifyEvent)
 
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();
 
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING = wxNewEventType();
 const wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED = wxNewEventType();

+const int wxID_LISTBOOKLISTVIEW = wxNewId();

 
 

-BEGIN_EVENT_TABLE(wxListbook, wxBookCtrl)
+BEGIN_EVENT_TABLE(wxListbook, wxBookCtrlBase)

     EVT_SIZE(wxListbook::OnSize)
     EVT_SIZE(wxListbook::OnSize)

-
-    EVT_LIST_ITEM_SELECTED(wxID_ANY, wxListbook::OnListSelected)
+    EVT_LIST_ITEM_SELECTED(wxID_LISTBOOKLISTVIEW, wxListbook::OnListSelected)

 END_EVENT_TABLE()
 
 // ============================================================================
 END_EVENT_TABLE()
 
 // ============================================================================


@@ -70,7 +78,9 @@ END_EVENT_TABLE()
 void wxListbook::Init()
 {
     m_list = NULL;
 void wxListbook::Init()
 {
     m_list = NULL;

+#if wxUSE_LINE_IN_LISTBOOK

     m_line = NULL;
     m_line = NULL;

+#endif // wxUSE_LINE_IN_LISTBOOK

     m_selection = wxNOT_FOUND;
 }
 
     m_selection = wxNOT_FOUND;
 }
 


@@ -91,6 +101,11 @@ wxListbook::Create(wxWindow *parent,
 #endif // __WXMAC__/!__WXMAC__
     }
 
 #endif // __WXMAC__/!__WXMAC__
     }
 

+    // no border for this control, it doesn't look nice together with
+    // wxListCtrl border
+    style &= ~wxBORDER_MASK;
+    style |= wxBORDER_NONE;
+

     if ( !wxControl::Create(parent, id, pos, size, style,
                             wxDefaultValidator, name) )
         return false;
     if ( !wxControl::Create(parent, id, pos, size, style,
                             wxDefaultValidator, name) )
         return false;


@@ -98,21 +113,34 @@ wxListbook::Create(wxWindow *parent,
     m_list = new wxListView
                  (
                     this,
     m_list = new wxListView
                  (
                     this,

-                    -1,
+                    wxID_LISTBOOKLISTVIEW,

                     wxDefaultPosition,
                     wxDefaultSize,
                     wxDefaultPosition,
                     wxDefaultSize,

-                    wxLC_ICON | wxLC_SINGLE_SEL
+                    wxLC_ICON | wxLC_SINGLE_SEL |
+                        (IsVertical() ? wxLC_ALIGN_LEFT : wxLC_ALIGN_TOP)

                  );
 
                  );
 

+#if wxUSE_LINE_IN_LISTBOOK

     m_line = new wxStaticLine
                  (
                     this,
     m_line = new wxStaticLine
                  (
                     this,

-                    -1,
+                    wxID_ANY,

                     wxDefaultPosition,
                     wxDefaultSize,
                     IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
                  );
                     wxDefaultPosition,
                     wxDefaultSize,
                     IsVertical() ? wxLI_HORIZONTAL : wxLI_VERTICAL
                  );

-
+#endif // wxUSE_LINE_IN_LISTBOOK
+
+#ifdef __WXMSW__
+    // On XP with themes enabled the GetViewRect used in GetListSize to
+    // determine the space needed for the list view will incorrectly return
+    // (0,0,0,0) the first time.  So send a pending event so OnSize will be
+    // called again after the window is ready to go.  Technically we don't
+    // need to do this on non-XP windows, but if things are already sized
+    // correctly then nothing changes and so there is no harm.
+    wxSizeEvent evt;
+    GetEventHandler()->AddPendingEvent(evt);
+#endif

     return true;
 }
 
     return true;
 }
 


@@ -122,38 +150,18 @@ wxListbook::Create(wxWindow *parent,
 
 wxSize wxListbook::GetListSize() const
 {
 
 wxSize wxListbook::GetListSize() const
 {

-    const wxSize sizeClient = GetClientSize();
-
-    // we need to find the longest/tallest label
-    wxCoord widthMax = 0,
-            heightMax = 0;
-    const int count = m_list->GetItemCount();
-    if ( count )
-    {
-        for ( int i = 0; i < count; i++ )
-        {
-            wxRect r;
-            m_list->GetItemRect(i, r);
-
-            wxCoord w = r.x + r.width,
-                    h = r.y + r.height;
-
-            if ( w > widthMax )
-                widthMax = w;
-            if ( h > heightMax )
-                heightMax = h;
-        }
-    }
+    const wxSize sizeClient = GetClientSize(),
+                 sizeList = m_list->GetViewRect().GetSize();

 
     wxSize size;
     if ( IsVertical() )
     {
         size.x = sizeClient.x;
 
     wxSize size;
     if ( IsVertical() )
     {
         size.x = sizeClient.x;

-        size.y = heightMax;
+        size.y = sizeList.y;

     }
     else // left/right aligned
     {
     }
     else // left/right aligned
     {

-        size.x = widthMax + 10;
+        size.x = sizeList.x;

         size.y = sizeClient.y;
     }
 
         size.y = sizeClient.y;
     }
 


@@ -162,9 +170,10 @@ wxSize wxListbook::GetListSize() const
 
 wxRect wxListbook::GetPageRect() const
 {
 
 wxRect wxListbook::GetPageRect() const
 {

-    const wxSize sizeList = GetListSize();
+    const wxSize sizeList = m_list->GetSize();

 
 

-    wxRect rectPage(wxPoint(0, 0), GetClientSize());
+    wxPoint pt;
+    wxRect rectPage(pt, GetClientSize());

     switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
     {
         default:
     switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
     {
         default:


@@ -193,6 +202,14 @@ wxRect wxListbook::GetPageRect() const
 
 void wxListbook::OnSize(wxSizeEvent& event)
 {
 
 void wxListbook::OnSize(wxSizeEvent& event)
 {

+    event.Skip();
+
+    if ( !m_list )
+    {
+        // we're not fully created yet
+        return;
+    }
+

     // resize the list control and the page area to fit inside our new size
     const wxSize sizeClient = GetClientSize(),
                  sizeList = GetListSize();
     // resize the list control and the page area to fit inside our new size
     const wxSize sizeClient = GetClientSize(),
                  sizeList = GetListSize();


@@ -218,11 +235,13 @@ void wxListbook::OnSize(wxSizeEvent& event)
             break;
     }
 
             break;
     }
 

-    m_list->SetSize(posList.x, posList.y, sizeList.x, sizeList.y);
+    m_list->Move(posList.x, posList.y);
+    m_list->SetClientSize(sizeList.x, sizeList.y);

 
 

+#if wxUSE_LINE_IN_LISTBOOK

     if ( m_line )
     {
     if ( m_line )
     {

-        wxRect rectLine(wxPoint(0, 0), sizeClient);
+        wxRect rectLine(sizeClient);

 
         switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
         {
 
         switch ( GetWindowStyle() & wxLB_ALIGN_MASK )
         {


@@ -249,26 +268,15 @@ void wxListbook::OnSize(wxSizeEvent& event)
 
         m_line->SetSize(rectLine);
     }
 
         m_line->SetSize(rectLine);
     }

+#endif // wxUSE_LINE_IN_LISTBOOK

 
 

-    // we should always have some selection if possible
-    if ( m_selection == wxNOT_FOUND && GetPageCount() )
-    {
-        SetSelection(0);
-    }
-
-    if ( m_selection != wxNOT_FOUND )
+    // resize the currently shown page
+    if (m_selection != wxNOT_FOUND )

     {
         wxWindow *page = m_pages[m_selection];
         wxCHECK_RET( page, _T("NULL page in wxListbook?") );
     {
         wxWindow *page = m_pages[m_selection];
         wxCHECK_RET( page, _T("NULL page in wxListbook?") );

-

         page->SetSize(GetPageRect());
         page->SetSize(GetPageRect());

-        if ( !page->IsShown() )
-        {
-            page->Show();

         }
         }

-    }
-
-    event.Skip();

 }
 
 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const
 }
 
 wxSize wxListbook::CalcSizeFromPage(const wxSize& sizePage) const


@@ -315,7 +323,7 @@ int wxListbook::GetPageImage(size_t WXUNUSED(n)) const
 
 bool wxListbook::SetPageImage(size_t n, int imageId)
 {
 
 bool wxListbook::SetPageImage(size_t n, int imageId)
 {

-    return m_list->SetItemImage(n, imageId, imageId);
+    return m_list->SetItemImage(n, imageId);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -326,7 +334,7 @@ void wxListbook::SetImageList(wxImageList *imageList)
 {
     m_list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
 
 {
     m_list->SetImageList(imageList, wxIMAGE_LIST_NORMAL);
 

-    wxBookCtrl::SetImageList(imageList);
+    wxBookCtrlBase::SetImageList(imageList);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -340,23 +348,40 @@ int wxListbook::GetSelection() const
 
 int wxListbook::SetSelection(size_t n)
 {
 
 int wxListbook::SetSelection(size_t n)
 {

-    wxCHECK_MSG( n < GetPageCount(), wxNOT_FOUND,
-                 _T("invalid page index in wxListbook::SetSelection()") );
+    wxCHECK_MSG( IS_VALID_PAGE(n), wxNOT_FOUND,
+                 wxT("invalid page index in wxListbook::SetSelection()") );

 
 

-    int selOld = m_selection;
+    const int oldSel = m_selection;

 
 

-    if ( (int)n != m_selection )
+    if ( int(n) != m_selection )

     {
     {

-        m_selection = n;
+        wxListbookEvent event(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, m_windowId);
+        event.SetSelection(n);
+        event.SetOldSelection(m_selection);
+        event.SetEventObject(this);
+        if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+        {
+            if ( m_selection != wxNOT_FOUND )
+                m_pages[m_selection]->Hide();

 
 

-        m_list->Select(m_selection);
-        m_list->Focus(m_selection);
+            wxWindow *page = m_pages[n];
+            page->SetSize(GetPageRect());
+            page->Show();
+
+            // change m_selection now to ignore the selection change event
+            m_selection = n;
+            m_list->Select(n);
+            m_list->Focus(n);
+
+            // program allows the page change
+            event.SetEventType(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED);
+            (void)GetEventHandler()->ProcessEvent(event);
+        }

     }
 
     }
 

-    return selOld;
+    return oldSel;

 }
 
 }
 

-

 // ----------------------------------------------------------------------------
 // adding/removing the pages
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // adding/removing the pages
 // ----------------------------------------------------------------------------


@@ -368,36 +393,75 @@ wxListbook::InsertPage(size_t n,
                        bool bSelect,
                        int imageId)
 {
                        bool bSelect,
                        int imageId)
 {

-    if ( !wxBookCtrl::InsertPage(n, page, text, bSelect, imageId) )
+    if ( !wxBookCtrlBase::InsertPage(n, page, text, bSelect, imageId) )

         return false;
 
     m_list->InsertItem(n, text, imageId);
 
         return false;
 
     m_list->InsertItem(n, text, imageId);
 

-    if ( bSelect )
+    // if the inserted page is before the selected one, we must update the
+    // index of the selected page
+    if ( int(n) <= m_selection )

     {
     {

-        m_list->Select(n);
-        m_list->Focus(n);
+        // one extra page added
+        m_selection++;
+        m_list->Select(m_selection);
+        m_list->Focus(m_selection);

     }
     }

-    else // don't select this page
-    {
-        // it will be shown only when selected
+
+    // some page should be selected: either this one or the first one if there
+    // is still no selection
+    int selNew = -1;
+    if ( bSelect )
+        selNew = n;
+    else if ( m_selection == -1 )
+        selNew = 0;
+
+    if ( selNew != m_selection )

         page->Hide();
         page->Hide();

-    }

 
 

+    if ( selNew != -1 )
+        SetSelection(selNew);
+
+    InvalidateBestSize();

     return true;
 }
 
 wxWindow *wxListbook::DoRemovePage(size_t page)
 {
     return true;
 }
 
 wxWindow *wxListbook::DoRemovePage(size_t page)
 {

-    wxWindow *win = wxBookCtrl::DoRemovePage(page);
+    const int page_count = GetPageCount();
+    wxWindow *win = wxBookCtrlBase::DoRemovePage(page);
+

     if ( win )
     {
         m_list->DeleteItem(page);
     if ( win )
     {
         m_list->DeleteItem(page);

+
+        if (m_selection >= (int)page)
+        {
+            // force new sel valid if possible
+            int sel = m_selection - 1;
+            if (page_count == 1)
+                sel = wxNOT_FOUND;
+            else if ((page_count == 2) || (sel == -1))
+                sel = 0;
+
+            // force sel invalid if deleting current page - don't try to hide it
+            m_selection = (m_selection == (int)page) ? wxNOT_FOUND : m_selection - 1;
+
+            if ((sel != wxNOT_FOUND) && (sel != m_selection))
+                SetSelection(sel);
+        }

     }
 
     return win;
 }
 
     }
 
     return win;
 }
 

+
+bool wxListbook::DeleteAllPages()
+{
+    m_list->DeleteAllItems();
+    return wxBookCtrlBase::DeleteAllPages();
+}
+

 // ----------------------------------------------------------------------------
 // wxListbook events
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxListbook events
 // ----------------------------------------------------------------------------


@@ -414,32 +478,14 @@ void wxListbook::OnListSelected(wxListEvent& eventList)
         return;
     }
 
         return;
     }
 

-    // first send "change in progress" event which may be vetoed by user
-    wxListbookEvent eventIng(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, GetId());
+    SetSelection(selNew);

 
 

-    eventIng.SetEventObject(this);
-    eventIng.SetSelection(selNew);
-    eventIng.SetOldSelection(m_selection);
-    if ( GetEventHandler()->ProcessEvent(eventIng) && !eventIng.IsAllowed() )
+    // change wasn't allowed, return to previous state
+    if (m_selection != selNew)

     {
         m_list->Select(m_selection);
     {
         m_list->Select(m_selection);

-        return;
+        m_list->Focus(m_selection);

     }
     }

-
-    // change allowed: do change the page and notify the user about it
-    if ( m_selection != wxNOT_FOUND )
-        m_pages[m_selection]->Hide();
-    wxWindow *page = m_pages[m_selection = selNew];
-    page->SetSize(GetPageRect());
-    page->Show();
-
-    wxListbookEvent eventEd(wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, GetId());
-
-    eventEd.SetEventObject(this);
-    eventEd.SetSelection(selNew);
-    eventEd.SetOldSelection(m_selection);
-
-    (void)GetEventHandler()->ProcessEvent(eventEd);

 }
 
 #endif // wxUSE_LISTBOOK
 }
 
 #endif // wxUSE_LISTBOOK