Tweaks to the announcement

[wxWidgets.git] / src / msw / notebook.cpp

diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp
index 43b70d1dbb39ec453423a8ba12b18e10c8b6060c..d8a82f48095f0a79b4616d22266046d0ea264323 100644 (file)
--- a/src/msw/notebook.cpp
+++ b/src/msw/notebook.cpp
@@ -17,9 +17,11 @@
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__

-#pragma hdrstop
+    #pragma hdrstop

 #endif
 
 #endif
 

+#if wxUSE_NOTEBOOK
+

 // wxWindows
 #ifndef WX_PRECOMP
   #include  "wx/string.h"
 // wxWindows
 #ifndef WX_PRECOMP
   #include  "wx/string.h"


@@ -41,15 +43,13 @@
 #include  <windowsx.h>  // for SetWindowFont
 
 #ifndef __TWIN32__
 #include  <windowsx.h>  // for SetWindowFont
 
 #ifndef __TWIN32__

-#ifdef __GNUWIN32__
-#ifndef wxUSE_NORLANDER_HEADERS
-  #include "wx/msw/gnuwin32/extra.h"
-#endif
-#endif
+    #ifdef __GNUWIN32_OLD__
+        #include "wx/msw/gnuwin32/extra.h"
+    #endif

 #endif
 
 #endif
 

-#if !defined(__GNUWIN32__) || defined(__TWIN32__) || defined(wxUSE_NORLANDER_HEADERS)
-  #include <commctrl.h>
+#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__))
+    #include <commctrl.h>

 #endif
 
 // ----------------------------------------------------------------------------
 #endif
 
 // ----------------------------------------------------------------------------


@@ -83,7 +83,10 @@
 // event table
 // ----------------------------------------------------------------------------
 
 // event table
 // ----------------------------------------------------------------------------
 

-  BEGIN_EVENT_TABLE(wxNotebook, wxControl)
+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_SIZE(wxNotebook::OnSize)
     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
 
     EVT_SIZE(wxNotebook::OnSize)


@@ -91,10 +94,10 @@
     EVT_SET_FOCUS(wxNotebook::OnSetFocus)
 
     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)
     EVT_SET_FOCUS(wxNotebook::OnSetFocus)
 
     EVT_NAVIGATION_KEY(wxNotebook::OnNavigationKey)

-  END_EVENT_TABLE()
+END_EVENT_TABLE()

 
 

-  IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
-  IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
+IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -107,7 +110,7 @@
 // common part of all ctors
 void wxNotebook::Init()
 {
 // common part of all ctors
 void wxNotebook::Init()
 {

-  m_pImageList = NULL;
+  m_imageList = NULL;

   m_nSelection = -1;
 }
 
   m_nSelection = -1;
 }
 


@@ -138,69 +141,59 @@ bool wxNotebook::Create(wxWindow *parent,
                         long style,
                         const wxString& name)
 {
                         long style,
                         const wxString& name)
 {

-  // base init
-  if ( !CreateBase(parent, id, pos, size, style, wxDefaultValidator, name) )
-      return FALSE;
-
-  // colors and font
-  m_backgroundColour = wxColour(GetSysColor(COLOR_BTNFACE));
-  m_foregroundColour = *wxBLACK ;
-
-  // style
-  m_windowStyle = style | wxTAB_TRAVERSAL;
-
-  long tabStyle = WS_CHILD | WS_VISIBLE | WS_TABSTOP | TCS_TABS;
-
-  if (m_windowStyle & wxCLIP_CHILDREN)
-    tabStyle |= WS_CLIPCHILDREN;
-  if ( m_windowStyle & wxTC_MULTILINE )
-    tabStyle |= TCS_MULTILINE;
-  if ( m_windowStyle & wxBORDER )
-    tabStyle &= WS_BORDER;
-  if (m_windowStyle & wxNB_FIXEDWIDTH)
-    tabStyle |= TCS_FIXEDWIDTH ;
-  if (m_windowStyle & wxNB_BOTTOM)
-    tabStyle |= TCS_RIGHT;
-  if (m_windowStyle & wxNB_LEFT)
-    tabStyle |= TCS_VERTICAL;
-  if (m_windowStyle & wxNB_RIGHT)
-    tabStyle |= TCS_VERTICAL|TCS_RIGHT;
-
-
-  if ( !MSWCreate(GetId(), GetParent(), WC_TABCONTROL,
-                  this, NULL, pos.x, pos.y, size.x, size.y,
-                  tabStyle, NULL, 0) )
-  {
-    return FALSE;
-  }
-
-  // Not all compilers recognise SetWindowFont
-  ::SendMessage(GetHwnd(), WM_SETFONT,
-                (WPARAM)::GetStockObject(DEFAULT_GUI_FONT), TRUE);
+    // base init
+    if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) )
+        return FALSE;

 
 

+    // notebook, so explicitly specify 0 as last parameter
+    if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size,
+                style | wxTAB_TRAVERSAL) )
+        return FALSE;

 
 

-  if ( parent != NULL )
-    parent->AddChild(this);
+    SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));

 
 

-  SubclassWin(m_hWnd);
-
-  return TRUE;
+    return TRUE;

 }
 
 }
 

-// dtor
-wxNotebook::~wxNotebook()
+WXDWORD wxNotebook::MSWGetStyle(long style, WXDWORD *exstyle) const

 {
 {

+    WXDWORD tabStyle = wxControl::MSWGetStyle(style, exstyle);
+
+    tabStyle |= WS_TABSTOP | TCS_TABS;
+
+    if ( style & wxTC_MULTILINE )
+        tabStyle |= TCS_MULTILINE;
+    if ( style & wxNB_FIXEDWIDTH )
+        tabStyle |= TCS_FIXEDWIDTH;
+
+    if ( style & wxNB_BOTTOM )
+        tabStyle |= TCS_RIGHT;
+    else if ( style & wxNB_LEFT )
+        tabStyle |= TCS_VERTICAL;
+    else if ( style & wxNB_RIGHT )
+        tabStyle |= TCS_VERTICAL | TCS_RIGHT;
+
+    // ex style
+    if ( exstyle )
+    {
+        // note that we never want to have the default WS_EX_CLIENTEDGE style
+        // as it looks too ugly for the notebooks
+        *exstyle = 0;
+    }
+
+    return tabStyle;

 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook accessors
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook accessors
 // ----------------------------------------------------------------------------

+

 int wxNotebook::GetPageCount() const
 {
   // consistency check
 int wxNotebook::GetPageCount() const
 {
   // consistency check

-  wxASSERT( (int)m_aPages.Count() == TabCtrl_GetItemCount(m_hwnd) );
+  wxASSERT( (int)m_pages.Count() == TabCtrl_GetItemCount(m_hwnd) );

 
 

-  return m_aPages.Count();
+  return m_pages.Count();

 }
 
 int wxNotebook::GetRowCount() const
 }
 
 int wxNotebook::GetRowCount() const


@@ -217,16 +210,6 @@ int wxNotebook::SetSelection(int nPage)
   return TabCtrl_SetCurSel(m_hwnd, nPage);
 }
 
   return TabCtrl_SetCurSel(m_hwnd, nPage);
 }
 

-void wxNotebook::AdvanceSelection(bool bForward)
-{
-  int nSel = GetSelection();
-  int nMax = GetPageCount() - 1;
-  if ( bForward )
-    SetSelection(nSel == nMax ? 0 : nSel + 1);
-  else
-    SetSelection(nSel == 0 ? nMax : nSel - 1);
-}
-

 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 {
   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 {
   wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );


@@ -278,10 +261,37 @@ bool wxNotebook::SetPageImage(int nPage, int nImage)
 
 void wxNotebook::SetImageList(wxImageList* imageList)
 {
 
 void wxNotebook::SetImageList(wxImageList* imageList)
 {

-  m_pImageList = imageList;
-  TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
+  wxNotebookBase::SetImageList(imageList);
+
+  if ( imageList )
+  {
+    TabCtrl_SetImageList(m_hwnd, (HIMAGELIST)imageList->GetHIMAGELIST());
+  }

 }
 
 }
 

+// ----------------------------------------------------------------------------
+// wxNotebook size settings
+// ----------------------------------------------------------------------------
+
+void wxNotebook::SetPageSize(const wxSize& size)
+{
+    // transform the page size into the notebook size
+    RECT rc;
+    rc.left =
+    rc.top = 0;
+    rc.right = size.x;
+    rc.bottom = size.y;
+
+    TabCtrl_AdjustRect(GetHwnd(), TRUE, &rc);
+
+    // and now set it
+    SetSize(rc.right - rc.left, rc.bottom - rc.top);
+}
+
+void wxNotebook::SetPadding(const wxSize& padding)
+{
+    TabCtrl_SetPadding(GetHwnd(), padding.x, padding.y);
+}

 
 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 // style.
 
 // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 // style.


@@ -294,48 +304,55 @@ void wxNotebook::SetTabSize(const wxSize& sz)
 // wxNotebook operations
 // ----------------------------------------------------------------------------
 
 // wxNotebook operations
 // ----------------------------------------------------------------------------
 

-// remove one page from the notebook
-bool wxNotebook::DeletePage(int nPage)
-{
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
-
-  if ( m_nSelection == nPage ) {
-      // advance selection backwards - the page being deleted shouldn't be left
-      // selected
-      AdvanceSelection(FALSE);
-  }
-
-  TabCtrl_DeleteItem(m_hwnd, nPage);
-
-  delete m_aPages[nPage];
-  m_aPages.Remove(nPage);
-
-  if ( m_aPages.IsEmpty() ) {
-      // no selection if the notebook became empty
-      m_nSelection = -1;
-  }
-  else
-      m_nSelection = TabCtrl_GetCurSel(m_hwnd);
-
-
-  return TRUE;
-}
-

 // remove one page from the notebook, without deleting
 // remove one page from the notebook, without deleting

-bool wxNotebook::RemovePage(int nPage)
+wxNotebookPage *wxNotebook::DoRemovePage(int nPage)

 {
 {

-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
+    wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage);
+    if ( !pageRemoved )
+        return NULL;

 
 

-  TabCtrl_DeleteItem(m_hwnd, nPage);
+    TabCtrl_DeleteItem(m_hwnd, nPage);

 
 

-  m_aPages.Remove(nPage);
-
-  if ( m_aPages.IsEmpty() )
-      m_nSelection = -1;
-    else
-      m_nSelection = TabCtrl_GetCurSel(m_hwnd);
+    if ( m_pages.IsEmpty() )
+    {
+        // no selection any more, the notebook becamse empty
+        m_nSelection = -1;
+    }
+    else // notebook still not empty
+    {
+        // change the selected page if it was deleted or became invalid
+        int selNew;
+        if ( m_nSelection == GetPageCount() )
+        {
+            // last page deleted, make the new last page the new selection
+            selNew = m_nSelection - 1;
+        }
+        else if ( nPage <= m_nSelection )
+        {
+            // we must show another page, even if it has the same index
+            selNew = m_nSelection;
+        }
+        else // nothing changes for the currently selected page
+        {
+            selNew = -1;
+
+            // we still must refresh the current page: this needs to be done
+            // for some unknown reason if the tab control shows the up-down
+            // control (i.e. when there are too many pages) -- otherwise after
+            // deleting a page nothing at all is shown
+            m_pages[m_nSelection]->Refresh();
+        }
+
+        if ( selNew != -1 )
+        {
+            // m_nSelection must be always valid so reset it before calling
+            // SetSelection()
+            m_nSelection = -1;
+            SetSelection(selNew);
+        }
+    }

 
 

-  return TRUE;
+    return pageRemoved;

 }
 
 // remove all pages
 }
 
 // remove all pages


@@ -344,9 +361,9 @@ bool wxNotebook::DeleteAllPages()
   int nPageCount = GetPageCount();
   int nPage;
   for ( nPage = 0; nPage < nPageCount; nPage++ )
   int nPageCount = GetPageCount();
   int nPage;
   for ( nPage = 0; nPage < nPageCount; nPage++ )

-    delete m_aPages[nPage];
+    delete m_pages[nPage];

 
 

-  m_aPages.Clear();
+  m_pages.Clear();

 
   TabCtrl_DeleteAllItems(m_hwnd);
 
 
   TabCtrl_DeleteAllItems(m_hwnd);
 


@@ -407,7 +424,7 @@ bool wxNotebook::InsertPage(int nPage,
   }
 
   // save the pointer to the page
   }
 
   // save the pointer to the page

-  m_aPages.Insert(pPage, nPage);
+  m_pages.Insert(pPage, nPage);

 
   // don't show pages by default (we'll need to adjust their size first)
   HWND hwnd = GetWinHwnd(pPage);
 
   // don't show pages by default (we'll need to adjust their size first)
   HWND hwnd = GetWinHwnd(pPage);


@@ -423,7 +440,6 @@ bool wxNotebook::InsertPage(int nPage,
   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
   pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 
   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
   pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 

-

   // some page should be selected: either this one or the first one if there is
   // still no selection
   int selNew = -1;
   // some page should be selected: either this one or the first one if there is
   // still no selection
   int selNew = -1;


@@ -450,10 +466,13 @@ void wxNotebook::OnSize(wxSizeEvent& event)
   GetSize((int *)&rc.right, (int *)&rc.bottom);
 
   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
   GetSize((int *)&rc.right, (int *)&rc.bottom);
 
   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);

-  size_t nCount = m_aPages.Count();
+
+  int width = rc.right - rc.left,
+      height = rc.bottom - rc.top;
+  size_t nCount = m_pages.Count();

   for ( size_t nPage = 0; nPage < nCount; nPage++ ) {
   for ( size_t nPage = 0; nPage < nCount; nPage++ ) {

-    wxNotebookPage *pPage = m_aPages[nPage];
-    pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
+    wxNotebookPage *pPage = m_pages[nPage];
+    pPage->SetSize(rc.left, rc.top, width, height);

   }
 
   event.Skip();
   }
 
   event.Skip();


@@ -466,12 +485,12 @@ void wxNotebook::OnSelChange(wxNotebookEvent& event)
   {
       int sel = event.GetOldSelection();
       if ( sel != -1 )
   {
       int sel = event.GetOldSelection();
       if ( sel != -1 )

-        m_aPages[sel]->Show(FALSE);
+        m_pages[sel]->Show(FALSE);

 
       sel = event.GetSelection();
       if ( sel != -1 )
       {
 
       sel = event.GetSelection();
       if ( sel != -1 )
       {

-        wxNotebookPage *pPage = m_aPages[sel];
+        wxNotebookPage *pPage = m_pages[sel];

         pPage->Show(TRUE);
         pPage->SetFocus();
       }
         pPage->Show(TRUE);
         pPage->SetFocus();
       }


@@ -485,26 +504,71 @@ void wxNotebook::OnSelChange(wxNotebookEvent& event)
 
 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 {
 
 void wxNotebook::OnSetFocus(wxFocusEvent& event)
 {

-  // set focus to the currently selected page if any
-  if ( m_nSelection != -1 )
-    m_aPages[m_nSelection]->SetFocus();
+    // this function is only called when the focus is explicitly set (i.e. from
+    // the program) to the notebook - in this case we don't need the
+    // complicated OnNavigationKey() logic because the programmer knows better
+    // what [s]he wants

 
 

-  event.Skip();
+    // set focus to the currently selected page if any
+    if ( m_nSelection != -1 )
+        m_pages[m_nSelection]->SetFocus();
+
+    event.Skip();

 }
 
 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 {
 }
 
 void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 {

-  if ( event.IsWindowChange() ) {
-    // change pages
-    AdvanceSelection(event.GetDirection());
-  }
-  else {
-    // pass to the parent
-    if ( GetParent() ) {
-      event.SetCurrentFocus(this);
-      GetParent()->GetEventHandler()->ProcessEvent(event);
+    if ( event.IsWindowChange() ) {
+        // change pages
+        AdvanceSelection(event.GetDirection());
+    }
+    else {
+        // we get this event in 2 cases
+        //
+        // a) one of our pages might have generated it because the user TABbed
+        // out from it in which case we should propagate the event upwards and
+        // our parent will take care of setting the focus to prev/next sibling
+        //
+        // or
+        //
+        // b) the parent panel wants to give the focus to us so that we
+        // forward it to our selected page. We can't deal with this in
+        // OnSetFocus() because we don't know which direction the focus came
+        // from in this case and so can't choose between setting the focus to
+        // first or last panel child
+
+        wxWindow *parent = GetParent();
+        if ( event.GetEventObject() == parent )
+        {
+            // no, it doesn't come from child, case (b): forward to a page
+            if ( m_nSelection != -1 )
+            {
+                // so that the page knows that the event comes from it's parent
+                // and is being propagated downwards
+                event.SetEventObject(this);
+
+                wxWindow *page = m_pages[m_nSelection];
+                if ( !page->GetEventHandler()->ProcessEvent(event) )
+                {
+                    page->SetFocus();
+                }
+                //else: page manages focus inside it itself
+            }
+            else
+            {
+                // we have no pages - still have to give focus to _something_
+                SetFocus();
+            }
+        }
+        else
+        {
+            // it comes from our child, case (a), pass to the parent
+            if ( parent ) {
+                event.SetCurrentFocus(this);
+                parent->GetEventHandler()->ProcessEvent(event);
+            }
+        }

     }
     }

-  }

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


@@ -513,17 +577,32 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 
 // override these 2 functions to do nothing: everything is done in OnSize
 
 
 // override these 2 functions to do nothing: everything is done in OnSize
 

-void wxNotebook::SetConstraintSizes(bool /* recurse */)
+void wxNotebook::SetConstraintSizes(bool WXUNUSED(recurse))

 {
   // don't set the sizes of the pages - their correct size is not yet known
   wxControl::SetConstraintSizes(FALSE);
 }
 
 {
   // don't set the sizes of the pages - their correct size is not yet known
   wxControl::SetConstraintSizes(FALSE);
 }
 

-bool wxNotebook::DoPhase(int /* nPhase */)
+bool wxNotebook::DoPhase(int WXUNUSED(nPhase))

 {
   return TRUE;
 }
 
 {
   return TRUE;
 }
 

+// ----------------------------------------------------------------------------
+// wxNotebook Windows message handlers
+// ----------------------------------------------------------------------------
+
+bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode,
+                             WXWORD pos, WXHWND control)
+{
+    // don't generate EVT_SCROLLWIN events for the WM_SCROLLs coming from the
+    // up-down control
+    if ( control )
+        return FALSE;
+
+    return wxNotebookBase::MSWOnScroll(orientation, nSBCode, pos, control);
+}
+

 bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 {
   wxNotebookEvent event(wxEVT_NULL, m_windowId);
 bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 {
   wxNotebookEvent event(wxEVT_NULL, m_windowId);


@@ -579,7 +658,7 @@ void wxNotebook::ChangePage(int nOldSel, int nSel)
   event.SetSelection(nSel);
   event.SetOldSelection(nOldSel);
   event.SetEventObject(this);
   event.SetSelection(nSel);
   event.SetOldSelection(nOldSel);
   event.SetEventObject(this);

-  if ( ProcessEvent(event) && !event.IsAllowed() )
+  if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )

   {
     // program doesn't allow the page change
     s_bInsideChangePage = FALSE;
   {
     // program doesn't allow the page change
     s_bInsideChangePage = FALSE;


@@ -587,7 +666,9 @@ void wxNotebook::ChangePage(int nOldSel, int nSel)
   }
 
   event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
   }
 
   event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);

-  ProcessEvent(event);
+  GetEventHandler()->ProcessEvent(event);

 
   s_bInsideChangePage = FALSE;
 }
 
   s_bInsideChangePage = FALSE;
 }

+
+#endif // wxUSE_NOTEBOOK