]> git.saurik.com Git - wxWidgets.git/blobdiff - src/univ/notebook.cpp
rename wxDECLARE_LOCAL_EVENT to just wxDECLARE_EVENT
[wxWidgets.git] / src / univ / notebook.cpp
index cb24dadee14aa425f848b8f278bf3e666f58d741..d219fa2162d231ce63196cd647dd84ba931c95da 100644 (file)
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        univ/notebook.cpp
+// Name:        src/univ/notebook.cpp
 // Purpose:     wxNotebook implementation
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     01.02.01
 // RCS-ID:      $Id$
-// Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
+// Copyright:   (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma implementation "univnotebook.h"
-#endif
-
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 
 #if wxUSE_NOTEBOOK
 
-#include "wx/imaglist.h"
 #include "wx/notebook.h"
 
+#ifndef WX_PRECOMP
+    #include "wx/dcmemory.h"
+#endif
+
+#include "wx/imaglist.h"
 #include "wx/spinbutt.h"
 
 #include "wx/univ/renderer.h"
 
+// ----------------------------------------------------------------------------
+// wxStdNotebookInputHandler: translates SPACE and ENTER keys and the left mouse
+// click into button press/release actions
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxStdNotebookInputHandler : public wxStdInputHandler
+{
+public:
+    wxStdNotebookInputHandler(wxInputHandler *inphand);
+
+    virtual bool HandleKey(wxInputConsumer *consumer,
+                           const wxKeyEvent& event,
+                           bool pressed);
+    virtual bool HandleMouse(wxInputConsumer *consumer,
+                             const wxMouseEvent& event);
+    virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
+    virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
+    virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
+
+protected:
+    void HandleFocusChange(wxInputConsumer *consumer);
+};
+
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
-#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
+#if 0
+// due to unsigned type nPage is always >= 0
+#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((size_t(nPage)) < GetPageCount()))
+#else
+#define IS_VALID_PAGE(nPage) (((size_t)nPage) < GetPageCount())
+#endif
 
 // ----------------------------------------------------------------------------
 // constants
@@ -56,7 +84,7 @@ class wxNotebookSpinBtn : public wxSpinButton
 {
 public:
     wxNotebookSpinBtn(wxNotebook *nb)
-        : wxSpinButton(nb, -1,
+        : wxSpinButton(nb, wxID_ANY,
                        wxDefaultPosition, wxDefaultSize,
                        nb->IsVertical() ? wxSP_VERTICAL : wxSP_HORIZONTAL)
     {
@@ -76,15 +104,14 @@ private:
 };
 
 BEGIN_EVENT_TABLE(wxNotebookSpinBtn, wxSpinButton)
-    EVT_SPIN(-1, wxNotebookSpinBtn::OnSpin)
+    EVT_SPIN(wxID_ANY, wxNotebookSpinBtn::OnSpin)
 END_EVENT_TABLE()
 
 // ============================================================================
 // implementation
 // ============================================================================
 
-IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
-IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
+IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxBookCtrlBase)
 
 // ----------------------------------------------------------------------------
 // wxNotebook creation
@@ -113,33 +140,36 @@ bool wxNotebook::Create(wxWindow *parent,
                         long style,
                         const wxString& name)
 {
+    if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
+        style |= wxBK_TOP;
+
     if ( !wxControl::Create(parent, id, pos, size, style,
                             wxDefaultValidator, name) )
-        return FALSE;
+        return false;
 
     m_sizePad = GetRenderer()->GetTabPadding();
 
-    SetBestSize(size);
+    SetInitialSize(size);
 
     CreateInputHandler(wxINP_HANDLER_NOTEBOOK);
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook page titles and images
 // ----------------------------------------------------------------------------
 
-wxString wxNotebook::GetPageText(int nPage) const
+wxString wxNotebook::GetPageText(size_t nPage) const
 {
-    wxCHECK_MSG( IS_VALID_PAGE(nPage), _T(""), _T("invalid notebook page") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, _T("invalid notebook page") );
 
     return m_titles[nPage];
 }
 
-bool wxNotebook::SetPageText(int nPage, const wxString& strText)
+bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 {
-    wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage), false, _T("invalid notebook page") );
 
     if ( strText != m_titles[nPage] )
     {
@@ -157,21 +187,21 @@ bool wxNotebook::SetPageText(int nPage, const wxString& strText)
         }
     }
 
-    return TRUE;
+    return true;
 }
 
-int wxNotebook::GetPageImage(int nPage) const
+int wxNotebook::GetPageImage(size_t nPage) const
 {
-    wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, _T("invalid notebook page") );
 
     return m_images[nPage];
 }
 
-bool wxNotebook::SetPageImage(int nPage, int nImage)
+bool wxNotebook::SetPageImage(size_t nPage, int nImage)
 {
-    wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage), false, _T("invalid notebook page") );
 
-    wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), FALSE,
+    wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), false,
                  _T("invalid image index in SetPageImage()") );
 
     if ( nImage != m_images[nPage] )
@@ -188,7 +218,7 @@ bool wxNotebook::SetPageImage(int nPage, int nImage)
             RefreshTab(nPage);
     }
 
-    return TRUE;
+    return true;
 }
 
 wxNotebook::~wxNotebook()
@@ -199,9 +229,9 @@ wxNotebook::~wxNotebook()
 // wxNotebook page switching
 // ----------------------------------------------------------------------------
 
-int wxNotebook::SetSelection(int nPage)
+int wxNotebook::DoSetSelection(size_t nPage, int flags)
 {
-    wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
+    wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, _T("invalid notebook page") );
 
     if ( (size_t)nPage == m_sel )
     {
@@ -209,15 +239,30 @@ int wxNotebook::SetSelection(int nPage)
         return m_sel;
     }
 
-    if ( m_sel != INVALID_PAGE )
+    if ( flags & SetSelection_SendEvent )
     {
-        RefreshTab(m_sel);
-
-        m_pages[m_sel]->Hide();
+        if ( !SendPageChangingEvent(nPage) )
+        {
+            // program doesn't allow the page change
+            return m_sel;
+        }
     }
 
+    // we need to change m_sel first, before calling RefreshTab() below as
+    // otherwise the previously selected tab wouldn't be redrawn properly under
+    // wxGTK which calls Refresh() immediately and not during the next event
+    // loop iteration as wxMSW does and as it should
+    size_t selOld = m_sel;
+
     m_sel = nPage;
 
+    if ( selOld != INVALID_PAGE )
+    {
+        RefreshTab(selOld, true /* this tab was selected */);
+
+        m_pages[selOld]->Hide();
+    }
+
     if ( m_sel != INVALID_PAGE ) // this is impossible - but test nevertheless
     {
         if ( HasSpinBtn() )
@@ -246,47 +291,27 @@ int wxNotebook::SetSelection(int nPage)
         m_pages[m_sel]->Show();
     }
 
-    return m_sel;
-}
-
-void wxNotebook::ChangePage(int nPage)
-{
-    wxCHECK_RET( IS_VALID_PAGE(nPage), _T("invalid notebook page") );
-
-    if ( (size_t)nPage == m_sel )
-    {
-        // nothing to do
-        return;
-    }
-
-    wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
-    event.SetSelection(nPage);
-    event.SetOldSelection(m_sel);
-    event.SetEventObject(this);
-    if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
+    if ( flags & SetSelection_SendEvent )
     {
-        // program doesn't allow the page change
-        return;
+        // event handling
+        SendPageChangedEvent(selOld);
     }
 
-    SetSelection(nPage);
-
-    event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
-    GetEventHandler()->ProcessEvent(event);
+    return selOld;
 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook pages adding/deleting
 // ----------------------------------------------------------------------------
 
-bool wxNotebook::InsertPage(int nPage,
+bool wxNotebook::InsertPage(size_t nPage,
                             wxNotebookPage *pPage,
                             const wxString& strText,
                             bool bSelect,
                             int imageId)
 {
-    int nPages = GetPageCount();
-    wxCHECK_MSG( nPage == nPages || IS_VALID_PAGE(nPage), FALSE,
+    size_t nPages = GetPageCount();
+    wxCHECK_MSG( nPage == nPages || IS_VALID_PAGE(nPage), false,
                  _T("invalid notebook page in InsertPage()") );
 
     // modify the data
@@ -318,9 +343,10 @@ bool wxNotebook::InsertPage(int nPage,
     if ( nPages == 0 )
     {
         // always select the first tab to have at least some selection
-        bSelect = TRUE;
+        bSelect = true;
 
         Relayout();
+        Refresh();
     }
     else // not the first tab
     {
@@ -336,13 +362,13 @@ bool wxNotebook::InsertPage(int nPage,
         pPage->Hide();
     }
 
-    return TRUE;
+    return true;
 }
 
 bool wxNotebook::DeleteAllPages()
 {
     if ( !wxNotebookBase::DeleteAllPages() )
-        return FALSE;
+        return false;
 
     // clear the other arrays as well
     m_titles.Clear();
@@ -358,10 +384,10 @@ bool wxNotebook::DeleteAllPages()
 
     Relayout();
 
-    return TRUE;
+    return true;
 }
 
-wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
+wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage)
 {
     wxCHECK_MSG( IS_VALID_PAGE(nPage), NULL, _T("invalid notebook page") );
 
@@ -373,12 +399,16 @@ wxNotebookPage *wxNotebook::DoRemovePage(int nPage)
     m_images.RemoveAt(nPage);
 
     // the spin button might not be needed any more
-    if ( HasSpinBtn() )
+    // 2002-08-12 'if' commented out by JACS on behalf
+    // of Hans Van Leemputten <Hansvl@softhome.net> who
+    // points out that UpdateSpinBtn should always be called,
+    // to ensure m_lastVisible is up to date.
+    // if ( HasSpinBtn() )
     {
         UpdateSpinBtn();
     }
 
-    int count = GetPageCount();
+    size_t count = GetPageCount();
     if ( count )
     {
         if ( m_sel == (size_t)nPage )
@@ -418,12 +448,12 @@ void wxNotebook::RefreshCurrent()
     }
 }
 
-void wxNotebook::RefreshTab(int page)
+void wxNotebook::RefreshTab(int page, bool forceSelected)
 {
     wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
 
     wxRect rect = GetTabRect(page);
-    if ( (size_t)page == m_sel )
+    if ( forceSelected || ((size_t)page == m_sel) )
     {
         const wxSize indent = GetRenderer()->GetTabIndent();
         rect.Inflate(indent.x, indent.y);
@@ -449,16 +479,19 @@ void wxNotebook::DoDrawTab(wxDC& dc, const wxRect& rect, size_t n)
     {
         int image = m_images[n];
 
-#ifdef __WXMSW__    // FIXME
+        // Not needed now that wxGenericImageList is being
+        // used for wxUniversal under MSW
+#if 0 // def __WXMSW__    // FIXME
         int w, h;
         m_imageList->GetSize(n, w, h);
         bmp.Create(w, h);
         wxMemoryDC dc;
         dc.SelectObject(bmp);
         dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
-        m_imageList->Draw(image, dc, 0, 0, wxIMAGELIST_DRAW_NORMAL, TRUE);
+        m_imageList->Draw(image, dc, 0, 0, wxIMAGELIST_DRAW_NORMAL, true);
+        dc.SelectObject(wxNullBitmap);
 #else
-        bmp = *m_imageList->GetBitmap(image);
+        bmp = m_imageList->GetBitmap(image);
 #endif
     }
 
@@ -502,10 +535,20 @@ void wxNotebook::DoDraw(wxControlRenderer *renderer)
         wxSize sizeSpinBtn = m_spinbtn->GetSize();
 
         if ( IsVertical() )
+        {
             rectTabs.height -= sizeSpinBtn.y;
+
+            // Allow for erasing the line under selected tab
+            rectTabs.width += 2;
+        }
         else
+        {
             rectTabs.width -= sizeSpinBtn.x;
 
+            // Allow for erasing the line under selected tab
+            rectTabs.height += 2;
+        }
+
         dc.SetClippingRegion(rectTabs);
     }
 
@@ -550,16 +593,21 @@ void wxNotebook::DoDraw(wxControlRenderer *renderer)
     {
         DoDrawTab(dc, rectSel, m_sel);
     }
+
+    dc.DestroyClippingRegion();
 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook geometry
 // ----------------------------------------------------------------------------
 
-int wxNotebook::HitTest(const wxPoint& pt) const
+int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
 {
+    if ( flags )
+        *flags = wxBK_HITTEST_NOWHERE;
+
     // first check that it is in this window at all
-    if ( !GetClientRect().Inside(pt) )
+    if ( !GetClientRect().Contains(pt) )
     {
         return -1;
     }
@@ -597,8 +645,16 @@ int wxNotebook::HitTest(const wxPoint& pt) const
     {
         GetTabSize(n, &rectTabs.width, &rectTabs.height);
 
-        if ( rectTabs.Inside(pt) )
+        if ( rectTabs.Contains(pt) )
+        {
+            if ( flags )
+            {
+                // TODO: be more precise
+                *flags = wxBK_HITTEST_ONITEM;
+            }
+
             return n;
+        }
 
         // move the rectTabs to the next tab
         if ( IsVertical() )
@@ -620,14 +676,14 @@ bool wxNotebook::IsVertical() const
 wxDirection wxNotebook::GetTabOrientation() const
 {
     long style = GetWindowStyle();
-    if ( style & wxNB_BOTTOM )
+    if ( style & wxBK_BOTTOM )
         return wxBOTTOM;
-    else if ( style & wxNB_RIGHT )
+    else if ( style & wxBK_RIGHT )
         return wxRIGHT;
-    else if ( style & wxNB_LEFT )
+    else if ( style & wxBK_LEFT )
         return wxLEFT;
 
-    // wxNB_TOP == 0 so we don't have to test for it
+    // wxBK_TOP == 0 so we don't have to test for it
     return wxTOP;
 }
 
@@ -707,8 +763,16 @@ wxRect wxNotebook::GetTabsPart() const
     const wxSize indent = GetRenderer()->GetTabIndent();
     if ( IsVertical() )
     {
-        rect.x += indent.y;
         rect.y += indent.x;
+        if ( dir == wxLEFT )
+        {
+            rect.x += indent.y;
+            rect.width -= indent.y;
+        }
+        else // wxRIGHT
+        {
+            rect.width -= indent.y;
+        }
     }
     else // horz
     {
@@ -795,7 +859,7 @@ void wxNotebook::ResizeTab(int page)
     wxSize sizeTab = CalcTabSize(page);
 
     // we only need full relayout if the page size changes
-    bool needsRelayout = FALSE;
+    bool needsRelayout = false;
 
     if ( IsVertical() )
     {
@@ -807,7 +871,7 @@ void wxNotebook::ResizeTab(int page)
 
     if ( sizeTab.y > m_heightTab )
     {
-        needsRelayout = TRUE;
+        needsRelayout = true;
 
         m_heightTab = sizeTab.y;
     }
@@ -933,7 +997,7 @@ void wxNotebook::SetPageSize(const wxSize& size)
     SetClientSize(GetSizeForPage(size));
 }
 
-wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage)
+wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
 {
     return AdjustSize(GetSizeForPage(sizePage));
 }
@@ -1033,7 +1097,7 @@ void wxNotebook::UpdateSpinBtn()
     {
         // this case is special, get rid of it immediately: everything is
         // visible and we don't need any spin buttons
-        allTabsShown = TRUE;
+        allTabsShown = true;
 
         // have to reset them manually as we don't call CalcLastVisibleTab()
         m_firstVisible =
@@ -1089,7 +1153,7 @@ void wxNotebook::UpdateSpinBtn()
     }
     else // all tabs are visible, we don't need spin button
     {
-        if ( m_spinbtn )
+        if ( m_spinbtn && m_spinbtn -> IsShown() )
         {
             m_spinbtn->Hide();
         }
@@ -1207,7 +1271,7 @@ void wxNotebook::ScrollLastTo(int page)
 wxSize wxNotebook::DoGetBestClientSize() const
 {
     // calculate the max page size
-    wxSize size(0, 0);
+    wxSize size;
 
     size_t count = GetPageCount();
     if ( count )
@@ -1244,9 +1308,14 @@ void wxNotebook::DoSetSize(int x, int y,
                            int width, int height,
                            int sizeFlags)
 {
+    wxSize old_client_size = GetClientSize();
+
     wxControl::DoSetSize(x, y, width, height, sizeFlags);
 
-    Relayout();
+    wxSize new_client_size = GetClientSize();
+
+    if (old_client_size != new_client_size)
+        Relayout();
 }
 
 // ----------------------------------------------------------------------------
@@ -1258,15 +1327,23 @@ bool wxNotebook::PerformAction(const wxControlAction& action,
                                const wxString& strArg)
 {
     if ( action == wxACTION_NOTEBOOK_NEXT )
-        ChangePage(GetNextPage(TRUE));
+        SetSelection(GetNextPage(true));
     else if ( action == wxACTION_NOTEBOOK_PREV )
-        ChangePage(GetNextPage(FALSE));
+        SetSelection(GetNextPage(false));
     else if ( action == wxACTION_NOTEBOOK_GOTO )
-        ChangePage((int)numArg);
+        SetSelection((int)numArg);
     else
         return wxControl::PerformAction(action, numArg, strArg);
 
-    return TRUE;
+    return true;
+}
+
+/* static */
+wxInputHandler *wxNotebook::GetStdInputHandler(wxInputHandler *handlerDef)
+{
+    static wxStdNotebookInputHandler s_handler(handlerDef);
+
+    return &s_handler;
 }
 
 // ----------------------------------------------------------------------------
@@ -1278,14 +1355,14 @@ wxStdNotebookInputHandler::wxStdNotebookInputHandler(wxInputHandler *inphand)
 {
 }
 
-bool wxStdNotebookInputHandler::HandleKey(wxControl *control,
+bool wxStdNotebookInputHandler::HandleKey(wxInputConsumer *consumer,
                                           const wxKeyEvent& event,
                                           bool pressed)
 {
     // ignore the key releases
     if ( pressed )
     {
-        wxNotebook *notebook = wxStaticCast(control, wxNotebook);
+        wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
 
         int page = 0;
         wxControlAction action;
@@ -1322,61 +1399,61 @@ bool wxStdNotebookInputHandler::HandleKey(wxControl *control,
                 break;
         }
 
-        if ( !!action )
+        if ( !action.IsEmpty() )
         {
-            return control->PerformAction(action, page);
+            return consumer->PerformAction(action, page);
         }
     }
 
-    return wxStdInputHandler::HandleKey(control, event, pressed);
+    return wxStdInputHandler::HandleKey(consumer, event, pressed);
 }
 
-bool wxStdNotebookInputHandler::HandleMouse(wxControl *control,
+bool wxStdNotebookInputHandler::HandleMouse(wxInputConsumer *consumer,
                                             const wxMouseEvent& event)
 {
     if ( event.ButtonDown(1) )
     {
-        wxNotebook *notebook = wxStaticCast(control, wxNotebook);
+        wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
         int page = notebook->HitTest(event.GetPosition());
         if ( page != -1 )
         {
-            control->PerformAction(wxACTION_NOTEBOOK_GOTO, page);
+            consumer->PerformAction(wxACTION_NOTEBOOK_GOTO, page);
 
-            return FALSE;
+            return false;
         }
     }
 
-    return wxStdInputHandler::HandleMouse(control, event);
+    return wxStdInputHandler::HandleMouse(consumer, event);
 }
 
-bool wxStdNotebookInputHandler::HandleMouseMove(wxControl *control,
+bool wxStdNotebookInputHandler::HandleMouseMove(wxInputConsumer *consumer,
                                                 const wxMouseEvent& event)
 {
-    return wxStdInputHandler::HandleMouseMove(control, event);
+    return wxStdInputHandler::HandleMouseMove(consumer, event);
 }
 
-bool wxStdNotebookInputHandler::HandleFocus(wxControl *control,
-                                            const wxFocusEvent& event)
+bool
+wxStdNotebookInputHandler::HandleFocus(wxInputConsumer *consumer,
+                                       const wxFocusEvent& WXUNUSED(event))
 {
-    HandleFocusChange(control);
+    HandleFocusChange(consumer);
 
-    return FALSE;
+    return false;
 }
 
-bool wxStdNotebookInputHandler::HandleActivation(wxControl *control,
+bool wxStdNotebookInputHandler::HandleActivation(wxInputConsumer *consumer,
                                                  bool WXUNUSED(activated))
 {
     // we react to the focus change in the same way as to the [de]activation
-    HandleFocusChange(control);
+    HandleFocusChange(consumer);
 
-    return FALSE;
+    return false;
 }
 
-void wxStdNotebookInputHandler::HandleFocusChange(wxControl *control)
+void wxStdNotebookInputHandler::HandleFocusChange(wxInputConsumer *consumer)
 {
-    wxNotebook *notebook = wxStaticCast(control, wxNotebook);
+    wxNotebook *notebook = wxStaticCast(consumer->GetInputWindow(), wxNotebook);
     notebook->RefreshCurrent();
 }
 
 #endif // wxUSE_NOTEBOOK
-