]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/notebook.cpp
using new API (no visual difference)
[wxWidgets.git] / src / generic / notebook.cpp
index dca667945642c328344569540d31558e591e292d..6b6b84c79a9a62704f856ecf3274d880ec74e141 100644 (file)
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        notebook.cpp
-// Purpose:     implementation of wxNotebook
+// Name:        src/generic/notebook.cpp
+// Purpose:     generic implementation of wxNotebook
 // Author:      Julian Smart
 // Modified by:
 // Created:     17/09/98
@@ -16,8 +16,9 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
-#ifdef __GNUG__
-#pragma implementation "notebook.h"
+
+#ifdef __VMS
+#pragma message disable unscomzer
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #pragma hdrstop
 #endif
 
-#include  <wx/string.h>
-#include  <wx/log.h>
-#include  <wx/imaglist.h>
-#include  <wx/generic/notebook.h>
-#include  <wx/dcclient.h>
+#ifndef __WXPALMOS__
+
+#include  "wx/string.h"
+#include  "wx/log.h"
+#include  "wx/settings.h"
+#include  "wx/generic/imaglist.h"
+#include  "wx/notebook.h"
+#include  "wx/dcclient.h"
+#include  "wx/generic/tabg.h"
 
 // ----------------------------------------------------------------------------
 // macros
 // ----------------------------------------------------------------------------
 
 // check that the page index is valid
-#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((nPage) < GetPageCount()))
+#define IS_VALID_PAGE(nPage) ((nPage) < GetPageCount())
 
 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARIES
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
+
 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
-    EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
+    EVT_NOTEBOOK_PAGE_CHANGED(wxID_ANY, wxNotebook::OnSelChange)
     EVT_SIZE(wxNotebook::OnSize)
     EVT_PAINT(wxNotebook::OnPaint)
     EVT_MOUSE_EVENTS(wxNotebook::OnMouseEvent)
     EVT_SET_FOCUS(wxNotebook::OnSetFocus)
     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
-//    EVT_IDLE(wxNotebook::OnIdle)
 END_EVENT_TABLE()
 
 IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
 IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
-#endif
 
 // ============================================================================
 // implementation
 // ============================================================================
 
+// ============================================================================
+// Private class
+// ============================================================================
+
+// This reuses wxTabView to draw the tabs.
+class WXDLLEXPORT wxNotebookTabView: public wxTabView
+{
+DECLARE_DYNAMIC_CLASS(wxNotebookTabView)
+public:
+  wxNotebookTabView(wxNotebook* notebook, long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
+  ~wxNotebookTabView(void);
+
+  // Called when a tab is activated
+  virtual void OnTabActivate(int activateId, int deactivateId);
+  // Allows vetoing
+  virtual bool OnTabPreActivate(int activateId, int deactivateId);
+
+protected:
+   wxNotebook*      m_notebook;
+};
+
 // ----------------------------------------------------------------------------
 // wxNotebook construction
 // ----------------------------------------------------------------------------
@@ -71,7 +97,6 @@ IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
 void wxNotebook::Init()
 {
     m_tabView = (wxNotebookTabView*) NULL;
-    m_pImageList = NULL;
     m_nSelection = -1;
 }
 
@@ -105,17 +130,16 @@ bool wxNotebook::Create(wxWindow *parent,
     // base init
     SetName(name);
 
-    m_windowId = id == -1 ? NewControlId() : id;
+    m_windowId = id == wxID_ANY ? NewControlId() : id;
 
-    // It's like a normal window...
-    if (!wxWindow::Create(parent, id, pos, size, style|wxNO_BORDER, name))
-        return FALSE;
+    if (!wxControl::Create(parent, id, pos, size, style|wxNO_BORDER, wxDefaultValidator, name))
+        return false;
 
-    SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
+    SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 
     SetTabView(new wxNotebookTabView(this));
 
-    return TRUE;
+    return true;
 }
 
 // dtor
@@ -127,22 +151,14 @@ wxNotebook::~wxNotebook()
 // ----------------------------------------------------------------------------
 // wxNotebook accessors
 // ----------------------------------------------------------------------------
-int wxNotebook::GetPageCount() const
-{
-    return m_aPages.Count();
-}
-
 int wxNotebook::GetRowCount() const
 {
     // TODO
     return 0;
 }
 
-int wxNotebook::SetSelection(int nPage)
+int wxNotebook::SetSelection(size_t nPage)
 {
-    if (nPage == -1)
-      return 0;
-
     wxASSERT( IS_VALID_PAGE(nPage) );
 
     wxNotebookPage* pPage = GetPage(nPage);
@@ -153,6 +169,7 @@ int wxNotebook::SetSelection(int nPage)
     return 0;
 }
 
+#if 0
 void wxNotebook::AdvanceSelection(bool bForward)
 {
     int nSel = GetSelection();
@@ -162,8 +179,9 @@ void wxNotebook::AdvanceSelection(bool bForward)
     else
         SetSelection(nSel == 0 ? nMax : nSel - 1);
 }
+#endif
 
-bool wxNotebook::SetPageText(int nPage, const wxString& strText)
+bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
@@ -172,13 +190,13 @@ bool wxNotebook::SetPageText(int nPage, const wxString& strText)
     {
         m_tabView->SetTabText((int) (long) page, strText);
         Refresh();
-        return TRUE;
+        return true;
     }
 
-    return FALSE;
+    return false;
 }
 
-wxString wxNotebook::GetPageText(int nPage) const
+wxString wxNotebook::GetPageText(size_t nPage) const
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
@@ -189,7 +207,7 @@ wxString wxNotebook::GetPageText(int nPage) const
         return wxEmptyString;
 }
 
-int wxNotebook::GetPageImage(int nPage) const
+int wxNotebook::GetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage)) const
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
@@ -197,17 +215,30 @@ int wxNotebook::GetPageImage(int nPage) const
     return 0;
 }
 
-bool wxNotebook::SetPageImage(int nPage, int nImage)
+bool wxNotebook::SetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage),
+                              int WXUNUSED(nImage))
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
     // TODO
-    return FALSE;
+    return false;
+}
+
+// set the size (the same for all pages)
+void wxNotebook::SetPageSize(const wxSize& WXUNUSED(size))
+{
+    // TODO
+}
+
+// set the padding between tabs (in pixels)
+void wxNotebook::SetPadding(const wxSize& WXUNUSED(padding))
+{
+    // TODO
 }
 
-void wxNotebook::SetImageList(wxImageList* imageList)
-{ 
-    m_pImageList = imageList;
+// set the size of the tabs for wxNB_FIXEDWIDTH controls
+void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
+{
     // TODO
 }
 
@@ -216,38 +247,41 @@ void wxNotebook::SetImageList(wxImageList* imageList)
 // ----------------------------------------------------------------------------
 
 // remove one page from the notebook and delete it
-bool wxNotebook::DeletePage(int nPage)
+bool wxNotebook::DeletePage(size_t nPage)
 {
-    wxCHECK( IS_VALID_PAGE(nPage), FALSE );
+    wxCHECK( IS_VALID_PAGE(nPage), false );
 
     if (m_nSelection != -1)
     {
-        m_aPages[m_nSelection]->Show(FALSE);
-        m_aPages[m_nSelection]->Lower();
+        m_pages[m_nSelection]->Show(false);
+        m_pages[m_nSelection]->Lower();
     }
 
     wxNotebookPage* pPage = GetPage(nPage);
+
     m_tabView->RemoveTab((int) (long) pPage);
 
-    delete m_aPages[nPage];
-    m_aPages.Remove(nPage);
+    m_pages.Remove(pPage);
+    delete pPage;
 
-    if (m_aPages.GetCount() == 0)
+    if (m_pages.GetCount() == 0)
     {
       m_nSelection = -1;
-      m_tabView->SetTabSelection(-1, FALSE);
+      m_tabView->SetTabSelection(-1, false);
     }
     else if (m_nSelection > -1)
     {
       m_nSelection = -1;
-      m_tabView->SetTabSelection((int) (long) GetPage(0), FALSE);
+
+      m_tabView->SetTabSelection((int) (long) GetPage(0), false);
+
       if (m_nSelection != 0)
         ChangePage(-1, 0);
     }
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
-    return TRUE;
+    return true;
 }
 
 bool wxNotebook::DeletePage(wxNotebookPage* page)
@@ -256,50 +290,56 @@ bool wxNotebook::DeletePage(wxNotebookPage* page)
     if (pagePos > -1)
         return DeletePage(pagePos);
     else
-        return FALSE;
+        return false;
+}
+
+bool wxNotebook::RemovePage(size_t nPage)
+{
+    return DoRemovePage(nPage) != NULL;
 }
 
 // remove one page from the notebook
-bool wxNotebook::RemovePage(int nPage)
+wxWindow* wxNotebook::DoRemovePage(size_t nPage)
 {
-    wxCHECK( IS_VALID_PAGE(nPage), FALSE );
+    wxCHECK( IS_VALID_PAGE(nPage), NULL );
 
-    m_aPages[nPage]->Show(FALSE);
-    //    m_aPages[nPage]->Lower();
+    m_pages[nPage]->Show(false);
+    //    m_pages[nPage]->Lower();
 
     wxNotebookPage* pPage = GetPage(nPage);
+
     m_tabView->RemoveTab((int) (long) pPage);
 
-    m_aPages.Remove(nPage);
+    m_pages.Remove(pPage);
 
-    if (m_aPages.GetCount() == 0)
+    if (m_pages.GetCount() == 0)
     {
       m_nSelection = -1;
-      m_tabView->SetTabSelection(-1, TRUE);
+      m_tabView->SetTabSelection(-1, true);
     }
     else if (m_nSelection > -1)
     {
       // Only change the selection if the page we
       // deleted was the selection.
-      if (nPage == m_nSelection)
+      if (nPage == (size_t)m_nSelection)
       {
          m_nSelection = -1;
          // Select the first tab. Generates a ChangePage.
-         m_tabView->SetTabSelection((int) (long) GetPage(0), TRUE);
+         m_tabView->SetTabSelection(0, true);
       }
       else
       {
-       // We must adjust which tab we think is selected.
+        // We must adjust which tab we think is selected.
         // If greater than the page we deleted, it must be moved down
         // a notch.
-        if (m_nSelection > nPage)
+        if (size_t(m_nSelection) > nPage)
           m_nSelection -- ;
       }
     }
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
-    return TRUE;
+    return pPage;
 }
 
 bool wxNotebook::RemovePage(wxNotebookPage* page)
@@ -308,16 +348,16 @@ bool wxNotebook::RemovePage(wxNotebookPage* page)
     if (pagePos > -1)
         return RemovePage(pagePos);
     else
-        return FALSE;
+        return false;
 }
 
 // Find the position of the wxNotebookPage, -1 if not found.
 int wxNotebook::FindPagePosition(wxNotebookPage* page) const
 {
-    int nPageCount = GetPageCount();
-    int nPage;
+    size_t nPageCount = GetPageCount();
+    size_t nPage;
     for ( nPage = 0; nPage < nPageCount; nPage++ )
-        if (m_aPages[nPage] == page)
+        if (m_pages[nPage] == page)
             return nPage;
     return -1;
 }
@@ -325,48 +365,41 @@ int wxNotebook::FindPagePosition(wxNotebookPage* page) const
 // remove all pages
 bool wxNotebook::DeleteAllPages()
 {
-    m_tabView->ClearTabs(TRUE);
+    m_tabView->ClearTabs(true);
 
-    int nPageCount = GetPageCount();
-    int nPage;
+    size_t nPageCount = GetPageCount();
+    size_t nPage;
     for ( nPage = 0; nPage < nPageCount; nPage++ )
-        delete m_aPages[nPage];
-
-    m_aPages.Clear();
+        delete m_pages[nPage];
 
-    return TRUE;
-}
+    m_pages.Clear();
 
-// add a page to the notebook
-bool wxNotebook::AddPage(wxNotebookPage *pPage,
-                         const wxString& strText,
-                         bool bSelect,
-                         int imageId)
-{
-    return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
+    return true;
 }
 
 // same as AddPage() but does it at given position
-bool wxNotebook::InsertPage(int nPage,
+bool wxNotebook::InsertPage(size_t nPage,
                             wxNotebookPage *pPage,
                             const wxString& strText,
                             bool bSelect,
-                            int imageId)
+                            int WXUNUSED(imageId))
 {
     wxASSERT( pPage != NULL );
-    wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE );
+    wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), false );
 
     m_tabView->AddTab((int) (long) pPage, strText);
+
     if (!bSelect)
-      pPage->Show(FALSE);
+      pPage->Show(false);
 
     // save the pointer to the page
-    m_aPages.Insert(pPage, nPage);
+    m_pages.Insert(pPage, nPage);
 
     if (bSelect)
     {
         // This will cause ChangePage to be called, via OnSelPage
-        m_tabView->SetTabSelection((int) (long) pPage, TRUE);
+
+        m_tabView->SetTabSelection((int) (long) pPage, true);
     }
 
     // some page must be selected: either this one or the first one if there is
@@ -374,9 +407,9 @@ bool wxNotebook::InsertPage(int nPage,
     if ( m_nSelection == -1 )
       ChangePage(-1, 0);
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
@@ -387,10 +420,10 @@ bool wxNotebook::InsertPage(int nPage,
 //     time because doing it in ::Create() doesn't work (for unknown reasons)
 void wxNotebook::OnSize(wxSizeEvent& event)
 {
-    static bool s_bFirstTime = TRUE;
+    static bool s_bFirstTime = true;
     if ( s_bFirstTime ) {
         // TODO: any first-time-size processing.
-        s_bFirstTime = FALSE;
+        s_bFirstTime = false;
     }
 
     RefreshLayout();
@@ -402,9 +435,12 @@ void wxNotebook::OnSize(wxSizeEvent& event)
 // This was supposed to cure the non-display of the notebook
 // until the user resizes the window.
 // What's going on?
-void wxNotebook::OnIdle(wxIdleEvent& event)
+void wxNotebook::OnInternalIdle()
 {
-    static bool s_bFirstTime = TRUE;
+    wxWindow::OnInternalIdle();
+
+#if 0
+    static bool s_bFirstTime = true;
     if ( s_bFirstTime ) {
       /*
       wxSize sz(GetSize());
@@ -421,9 +457,9 @@ void wxNotebook::OnIdle(wxIdleEvent& event)
       GetEventHandler()->ProcessEvent(sizeEvent);
       Refresh();
       */
-      s_bFirstTime = FALSE;
+      s_bFirstTime = false;
     }
-    event.Skip();
+#endif
 }
 
 // Implementation: calculate the layout of the view rect
@@ -443,10 +479,10 @@ bool wxNotebook::RefreshLayout(bool force)
         rect.y = tabHeight + 4;
         rect.width = cw - 8;
         rect.height = ch - 4 - rect.y ;
-  
+
         m_tabView->SetViewRect(rect);
 
-        m_tabView->Layout();
+        m_tabView->LayoutTabs();
 
         // Need to do it a 2nd time to get the tab height with
         // the new view width, since changing the view width changes the
@@ -456,22 +492,22 @@ bool wxNotebook::RefreshLayout(bool force)
         rect.y = tabHeight + 4;
         rect.width = cw - 8;
         rect.height = ch - 4 - rect.y ;
-  
+
         m_tabView->SetViewRect(rect);
 
-        m_tabView->Layout();
+        m_tabView->LayoutTabs();
 
         if (!force && (rect == oldRect))
-          return FALSE;
+          return false;
 
         // fit the notebook page to the tab control's display area
 
-        unsigned int nCount = m_aPages.Count();
-        for ( unsigned int nPage = 0; nPage < nCount; nPage++ ) {
-            wxNotebookPage *pPage = m_aPages[nPage];
+        size_t nCount = m_pages.Count();
+        for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
+            wxNotebookPage *pPage = m_pages[nPage];
+            wxRect clientRect = GetAvailableClientSize();
             if (pPage->IsShown())
             {
-                wxRect clientRect = GetAvailableClientSize();
                 pPage->SetSize(clientRect.x, clientRect.y, clientRect.width, clientRect.height);
                 if ( pPage->GetAutoLayout() )
                    pPage->Layout();
@@ -479,7 +515,7 @@ bool wxNotebook::RefreshLayout(bool force)
         }
         Refresh();
     }
-    return TRUE;
+    return true;
 }
 
 void wxNotebook::OnSelChange(wxNotebookEvent& event)
@@ -499,7 +535,7 @@ void wxNotebook::OnSetFocus(wxFocusEvent& event)
 {
     // set focus to the currently selected page if any
     if ( m_nSelection != -1 )
-        m_aPages[m_nSelection]->SetFocus();
+        m_pages[m_nSelection]->SetFocus();
 
     event.Skip();
 }
@@ -528,17 +564,17 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 void wxNotebook::SetConstraintSizes(bool /* recurse */)
 {
     // don't set the sizes of the pages - their correct size is not yet known
-    wxControl::SetConstraintSizes(FALSE);
+    wxControl::SetConstraintSizes(false);
 }
 
 bool wxNotebook::DoPhase(int /* nPhase */)
 {
-    return TRUE;
+    return true;
 }
 
-void wxNotebook::Command(wxCommandEvent& event)
+void wxNotebook::Command(wxCommandEvent& WXUNUSED(event))
 {
-    wxFAIL_MSG("wxNotebook::Command not implemented");
+    wxFAIL_MSG(wxT("wxNotebook::Command not implemented"));
 }
 
 // ----------------------------------------------------------------------------
@@ -552,21 +588,21 @@ void wxNotebook::ChangePage(int nOldSel, int nSel)
     wxASSERT( nOldSel != nSel ); // impossible
 
     if ( nOldSel != -1 ) {
-        m_aPages[nOldSel]->Show(FALSE);
-        m_aPages[nOldSel]->Lower();
+        m_pages[nOldSel]->Show(false);
+        m_pages[nOldSel]->Lower();
     }
 
-    wxNotebookPage *pPage = m_aPages[nSel];
+    wxNotebookPage *pPage = m_pages[nSel];
 
     wxRect clientRect = GetAvailableClientSize();
     pPage->SetSize(clientRect.x, clientRect.y, clientRect.width, clientRect.height);
 
-    pPage->Show(TRUE);
+    Refresh();
+
+    pPage->Show(true);
     pPage->Raise();
     pPage->SetFocus();
 
-    Refresh();
-
     m_nSelection = nSel;
 }
 
@@ -583,6 +619,17 @@ void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event) )
         m_tabView->Draw(dc);
 }
 
+wxSize wxNotebook::CalcSizeFromPage(const wxSize& sizePage) const
+{
+    // MBN: since the total tab height is really a function of the
+    // width, this should really call
+    // GetTotalTabHeightPretendingWidthIs(), but the current
+    // implementation will suffice, provided the wxNotebook has been
+    // created with a sensible initial width.
+    return wxSize( sizePage.x + 12,
+                   sizePage.y + m_tabView->GetTotalTabHeight() + 6 + 4 );
+}
+
 wxRect wxNotebook::GetAvailableClientSize()
 {
     int cw, ch;
@@ -603,7 +650,7 @@ wxRect wxNotebook::GetAvailableClientSize()
 /*
  * wxNotebookTabView
  */
+
 IMPLEMENT_CLASS(wxNotebookTabView, wxTabView)
 
 wxNotebookTabView::wxNotebookTabView(wxNotebook *notebook, long style): wxTabView(style)
@@ -641,4 +688,32 @@ void wxNotebookTabView::OnTabActivate(int activateId, int deactivateId)
   m_notebook->GetEventHandler()->ProcessEvent(event);
 }
 
+// Allows Vetoing
+bool wxNotebookTabView::OnTabPreActivate(int activateId, int deactivateId)
+{
+  bool retval = true;
+
+  if (m_notebook)
+  {
+    wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_notebook->GetId());
+
+    // Translate from wxTabView's ids (which aren't position-dependent)
+    // to wxNotebook's (which are).
+    wxNotebookPage* pActive = (wxNotebookPage*) activateId;
+    wxNotebookPage* pDeactive = (wxNotebookPage*) deactivateId;
+
+    int activatePos = m_notebook->FindPagePosition(pActive);
+    int deactivatePos = m_notebook->FindPagePosition(pDeactive);
+
+    event.SetEventObject(m_notebook);
+    event.SetSelection(activatePos);
+    event.SetOldSelection(deactivatePos);
+    if (m_notebook->GetEventHandler()->ProcessEvent(event))
+    {
+      retval = event.IsAllowed();
+    }
+  }
+  return retval;
+}
 
+#endif // __WXPALMOS__