]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/notebook.cpp
readability cleanup
[wxWidgets.git] / src / generic / notebook.cpp
index 974ca1a29869860e2d8ec965f7e08a2bfdbc2238..6b6b84c79a9a62704f856ecf3274d880ec74e141 100644 (file)
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
-// 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
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Author:      Julian Smart
 // Modified by:
 // Created:     17/09/98
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
@@ -16,9 +16,6 @@
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "notebook.h"
-#endif
 
 #ifdef __VMS
 #pragma message disable unscomzer
 
 #ifdef __VMS
 #pragma message disable unscomzer
@@ -31,6 +28,8 @@
 #pragma hdrstop
 #endif
 
 #pragma hdrstop
 #endif
 
+#ifndef __WXPALMOS__
+
 #include  "wx/string.h"
 #include  "wx/log.h"
 #include  "wx/settings.h"
 #include  "wx/string.h"
 #include  "wx/log.h"
 #include  "wx/settings.h"
@@ -44,7 +43,7 @@
 // ----------------------------------------------------------------------------
 
 // check that the page index is valid
 // ----------------------------------------------------------------------------
 
 // 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
 
 // ----------------------------------------------------------------------------
 // event table
@@ -54,7 +53,7 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
 DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
 
 BEGIN_EVENT_TABLE(wxNotebook, wxControl)
 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_SIZE(wxNotebook::OnSize)
     EVT_PAINT(wxNotebook::OnPaint)
     EVT_MOUSE_EVENTS(wxNotebook::OnMouseEvent)
@@ -131,16 +130,16 @@ bool wxNotebook::Create(wxWindow *parent,
     // base init
     SetName(name);
 
     // base init
     SetName(name);
 
-    m_windowId = id == -1 ? NewControlId() : id;
+    m_windowId = id == wxID_ANY ? NewControlId() : id;
 
     if (!wxControl::Create(parent, id, pos, size, style|wxNO_BORDER, wxDefaultValidator, name))
 
     if (!wxControl::Create(parent, id, pos, size, style|wxNO_BORDER, wxDefaultValidator, name))
-        return FALSE;
+        return false;
 
     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 
     SetTabView(new wxNotebookTabView(this));
 
 
     SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 
     SetTabView(new wxNotebookTabView(this));
 
-    return TRUE;
+    return true;
 }
 
 // dtor
 }
 
 // dtor
@@ -191,10 +190,10 @@ bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
     {
         m_tabView->SetTabText((int) (long) page, strText);
         Refresh();
     {
         m_tabView->SetTabText((int) (long) page, strText);
         Refresh();
-        return TRUE;
+        return true;
     }
 
     }
 
-    return FALSE;
+    return false;
 }
 
 wxString wxNotebook::GetPageText(size_t nPage) const
 }
 
 wxString wxNotebook::GetPageText(size_t nPage) const
@@ -208,7 +207,7 @@ wxString wxNotebook::GetPageText(size_t nPage) const
         return wxEmptyString;
 }
 
         return wxEmptyString;
 }
 
-int wxNotebook::GetPageImage(size_t nPage) const
+int wxNotebook::GetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage)) const
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
@@ -216,28 +215,29 @@ int wxNotebook::GetPageImage(size_t nPage) const
     return 0;
 }
 
     return 0;
 }
 
-bool wxNotebook::SetPageImage(size_t nPage, int nImage)
+bool wxNotebook::SetPageImage(size_t WXUNUSED_UNLESS_DEBUG(nPage),
+                              int WXUNUSED(nImage))
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
     // TODO
 {
     wxASSERT( IS_VALID_PAGE(nPage) );
 
     // TODO
-    return FALSE;
+    return false;
 }
 
 // set the size (the same for all pages)
 }
 
 // set the size (the same for all pages)
-void wxNotebook::SetPageSize(const wxSize& size)
+void wxNotebook::SetPageSize(const wxSize& WXUNUSED(size))
 {
     // TODO
 }
 
 // set the padding between tabs (in pixels)
 {
     // TODO
 }
 
 // set the padding between tabs (in pixels)
-void wxNotebook::SetPadding(const wxSize& padding)
+void wxNotebook::SetPadding(const wxSize& WXUNUSED(padding))
 {
     // TODO
 }
 
 // set the size of the tabs for wxNB_FIXEDWIDTH controls
 {
     // TODO
 }
 
 // set the size of the tabs for wxNB_FIXEDWIDTH controls
-void wxNotebook::SetTabSize(const wxSize& sz)
+void wxNotebook::SetTabSize(const wxSize& WXUNUSED(sz))
 {
     // TODO
 }
 {
     // TODO
 }
@@ -249,11 +249,11 @@ void wxNotebook::SetTabSize(const wxSize& sz)
 // remove one page from the notebook and delete it
 bool wxNotebook::DeletePage(size_t nPage)
 {
 // remove one page from the notebook and delete it
 bool wxNotebook::DeletePage(size_t nPage)
 {
-    wxCHECK( IS_VALID_PAGE(nPage), FALSE );
+    wxCHECK( IS_VALID_PAGE(nPage), false );
 
     if (m_nSelection != -1)
     {
 
     if (m_nSelection != -1)
     {
-        m_pages[m_nSelection]->Show(FALSE);
+        m_pages[m_nSelection]->Show(false);
         m_pages[m_nSelection]->Lower();
     }
 
         m_pages[m_nSelection]->Lower();
     }
 
@@ -267,21 +267,21 @@ bool wxNotebook::DeletePage(size_t nPage)
     if (m_pages.GetCount() == 0)
     {
       m_nSelection = -1;
     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;
 
     }
     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);
     }
 
 
       if (m_nSelection != 0)
         ChangePage(-1, 0);
     }
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
 
-    return TRUE;
+    return true;
 }
 
 bool wxNotebook::DeletePage(wxNotebookPage* page)
 }
 
 bool wxNotebook::DeletePage(wxNotebookPage* page)
@@ -290,7 +290,7 @@ bool wxNotebook::DeletePage(wxNotebookPage* page)
     if (pagePos > -1)
         return DeletePage(pagePos);
     else
     if (pagePos > -1)
         return DeletePage(pagePos);
     else
-        return FALSE;
+        return false;
 }
 
 bool wxNotebook::RemovePage(size_t nPage)
 }
 
 bool wxNotebook::RemovePage(size_t nPage)
@@ -301,9 +301,9 @@ bool wxNotebook::RemovePage(size_t nPage)
 // remove one page from the notebook
 wxWindow* wxNotebook::DoRemovePage(size_t nPage)
 {
 // remove one page from the notebook
 wxWindow* wxNotebook::DoRemovePage(size_t nPage)
 {
-    wxCHECK( IS_VALID_PAGE(nPage), FALSE );
+    wxCHECK( IS_VALID_PAGE(nPage), NULL );
 
 
-    m_pages[nPage]->Show(FALSE);
+    m_pages[nPage]->Show(false);
     //    m_pages[nPage]->Lower();
 
     wxNotebookPage* pPage = GetPage(nPage);
     //    m_pages[nPage]->Lower();
 
     wxNotebookPage* pPage = GetPage(nPage);
@@ -315,7 +315,7 @@ wxWindow* wxNotebook::DoRemovePage(size_t nPage)
     if (m_pages.GetCount() == 0)
     {
       m_nSelection = -1;
     if (m_pages.GetCount() == 0)
     {
       m_nSelection = -1;
-      m_tabView->SetTabSelection(-1, TRUE);
+      m_tabView->SetTabSelection(-1, true);
     }
     else if (m_nSelection > -1)
     {
     }
     else if (m_nSelection > -1)
     {
@@ -325,11 +325,11 @@ wxWindow* wxNotebook::DoRemovePage(size_t nPage)
       {
          m_nSelection = -1;
          // Select the first tab. Generates a ChangePage.
       {
          m_nSelection = -1;
          // Select the first tab. Generates a ChangePage.
-         m_tabView->SetTabSelection(0, TRUE);
+         m_tabView->SetTabSelection(0, true);
       }
       else
       {
       }
       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 (size_t(m_nSelection) > nPage)
         // If greater than the page we deleted, it must be moved down
         // a notch.
         if (size_t(m_nSelection) > nPage)
@@ -337,7 +337,7 @@ wxWindow* wxNotebook::DoRemovePage(size_t nPage)
       }
     }
 
       }
     }
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
     return pPage;
 }
 
     return pPage;
 }
@@ -348,7 +348,7 @@ bool wxNotebook::RemovePage(wxNotebookPage* page)
     if (pagePos > -1)
         return RemovePage(pagePos);
     else
     if (pagePos > -1)
         return RemovePage(pagePos);
     else
-        return FALSE;
+        return false;
 }
 
 // Find the position of the wxNotebookPage, -1 if not found.
 }
 
 // Find the position of the wxNotebookPage, -1 if not found.
@@ -365,7 +365,7 @@ int wxNotebook::FindPagePosition(wxNotebookPage* page) const
 // remove all pages
 bool wxNotebook::DeleteAllPages()
 {
 // remove all pages
 bool wxNotebook::DeleteAllPages()
 {
-    m_tabView->ClearTabs(TRUE);
+    m_tabView->ClearTabs(true);
 
     size_t nPageCount = GetPageCount();
     size_t nPage;
 
     size_t nPageCount = GetPageCount();
     size_t nPage;
@@ -374,7 +374,7 @@ bool wxNotebook::DeleteAllPages()
 
     m_pages.Clear();
 
 
     m_pages.Clear();
 
-    return TRUE;
+    return true;
 }
 
 // same as AddPage() but does it at given position
 }
 
 // same as AddPage() but does it at given position
@@ -382,15 +382,15 @@ bool wxNotebook::InsertPage(size_t nPage,
                             wxNotebookPage *pPage,
                             const wxString& strText,
                             bool bSelect,
                             wxNotebookPage *pPage,
                             const wxString& strText,
                             bool bSelect,
-                            int imageId)
+                            int WXUNUSED(imageId))
 {
     wxASSERT( pPage != NULL );
 {
     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)
 
     m_tabView->AddTab((int) (long) pPage, strText);
 
     if (!bSelect)
-      pPage->Show(FALSE);
+      pPage->Show(false);
 
     // save the pointer to the page
     m_pages.Insert(pPage, nPage);
 
     // save the pointer to the page
     m_pages.Insert(pPage, nPage);
@@ -399,7 +399,7 @@ bool wxNotebook::InsertPage(size_t nPage,
     {
         // This will cause ChangePage to be called, via OnSelPage
 
     {
         // 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
     }
 
     // some page must be selected: either this one or the first one if there is
@@ -407,9 +407,9 @@ bool wxNotebook::InsertPage(size_t nPage,
     if ( m_nSelection == -1 )
       ChangePage(-1, 0);
 
     if ( m_nSelection == -1 )
       ChangePage(-1, 0);
 
-    RefreshLayout(FALSE);
+    RefreshLayout(false);
 
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------
@@ -420,10 +420,10 @@ bool wxNotebook::InsertPage(size_t nPage,
 //     time because doing it in ::Create() doesn't work (for unknown reasons)
 void wxNotebook::OnSize(wxSizeEvent& event)
 {
 //     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.
     if ( s_bFirstTime ) {
         // TODO: any first-time-size processing.
-        s_bFirstTime = FALSE;
+        s_bFirstTime = false;
     }
 
     RefreshLayout();
     }
 
     RefreshLayout();
@@ -439,8 +439,8 @@ void wxNotebook::OnInternalIdle()
 {
     wxWindow::OnInternalIdle();
 
 {
     wxWindow::OnInternalIdle();
 
-#if 0    
-    static bool s_bFirstTime = TRUE;
+#if 0
+    static bool s_bFirstTime = true;
     if ( s_bFirstTime ) {
       /*
       wxSize sz(GetSize());
     if ( s_bFirstTime ) {
       /*
       wxSize sz(GetSize());
@@ -457,7 +457,7 @@ void wxNotebook::OnInternalIdle()
       GetEventHandler()->ProcessEvent(sizeEvent);
       Refresh();
       */
       GetEventHandler()->ProcessEvent(sizeEvent);
       Refresh();
       */
-      s_bFirstTime = FALSE;
+      s_bFirstTime = false;
     }
 #endif
 }
     }
 #endif
 }
@@ -498,7 +498,7 @@ bool wxNotebook::RefreshLayout(bool force)
         m_tabView->LayoutTabs();
 
         if (!force && (rect == oldRect))
         m_tabView->LayoutTabs();
 
         if (!force && (rect == oldRect))
-          return FALSE;
+          return false;
 
         // fit the notebook page to the tab control's display area
 
 
         // fit the notebook page to the tab control's display area
 
@@ -515,7 +515,7 @@ bool wxNotebook::RefreshLayout(bool force)
         }
         Refresh();
     }
         }
         Refresh();
     }
-    return TRUE;
+    return true;
 }
 
 void wxNotebook::OnSelChange(wxNotebookEvent& event)
 }
 
 void wxNotebook::OnSelChange(wxNotebookEvent& event)
@@ -564,12 +564,12 @@ 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
 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 */)
 {
 }
 
 bool wxNotebook::DoPhase(int /* nPhase */)
 {
-    return TRUE;
+    return true;
 }
 
 void wxNotebook::Command(wxCommandEvent& WXUNUSED(event))
 }
 
 void wxNotebook::Command(wxCommandEvent& WXUNUSED(event))
@@ -588,7 +588,7 @@ void wxNotebook::ChangePage(int nOldSel, int nSel)
     wxASSERT( nOldSel != nSel ); // impossible
 
     if ( nOldSel != -1 ) {
     wxASSERT( nOldSel != nSel ); // impossible
 
     if ( nOldSel != -1 ) {
-        m_pages[nOldSel]->Show(FALSE);
+        m_pages[nOldSel]->Show(false);
         m_pages[nOldSel]->Lower();
     }
 
         m_pages[nOldSel]->Lower();
     }
 
@@ -599,7 +599,7 @@ void wxNotebook::ChangePage(int nOldSel, int nSel)
 
     Refresh();
 
 
     Refresh();
 
-    pPage->Show(TRUE);
+    pPage->Show(true);
     pPage->Raise();
     pPage->SetFocus();
 
     pPage->Raise();
     pPage->SetFocus();
 
@@ -619,6 +619,17 @@ void wxNotebook::OnPaint(wxPaintEvent& WXUNUSED(event) )
         m_tabView->Draw(dc);
 }
 
         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;
 wxRect wxNotebook::GetAvailableClientSize()
 {
     int cw, ch;
@@ -680,8 +691,8 @@ void wxNotebookTabView::OnTabActivate(int activateId, int deactivateId)
 // Allows Vetoing
 bool wxNotebookTabView::OnTabPreActivate(int activateId, int deactivateId)
 {
 // Allows Vetoing
 bool wxNotebookTabView::OnTabPreActivate(int activateId, int deactivateId)
 {
-  bool retval = TRUE;
-  
+  bool retval = true;
+
   if (m_notebook)
   {
     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_notebook->GetId());
   if (m_notebook)
   {
     wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_notebook->GetId());
@@ -703,5 +714,6 @@ bool wxNotebookTabView::OnTabPreActivate(int activateId, int deactivateId)
     }
   }
   return retval;
     }
   }
   return retval;
-} 
+}
 
 
+#endif // __WXPALMOS__