]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/notebook.cpp
more backwards compatible kbd handling in wxScrolledWindow
[wxWidgets.git] / src / msw / notebook.cpp
index e58af84b52c93f4da71086dac1f295f222394aa7..63d108cf3288c7bca8c0aa5fb398a47f9d3111c0 100644 (file)
@@ -2,7 +2,7 @@
 // Name:        msw/notebook.cpp
 // Purpose:     implementation of wxNotebook
 // Author:      Vadim Zeitlin
-// Modified by: 
+// Modified by:
 // Created:     11.06.98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 
 // wxWindows
 #ifndef WX_PRECOMP
-  #include  <wx/string.h>
+  #include  "wx/string.h"
 #endif  // WX_PRECOMP
 
-#include  <wx/log.h>
-#include  <wx/imaglist.h>
-#include  <wx/notebook.h>
+#include  "wx/log.h"
+#include  "wx/imaglist.h"
+#include  "wx/event.h"
+#include  "wx/control.h"
+#include  "wx/notebook.h"
 
-#include  <wx/msw/private.h>
+#include  "wx/msw/private.h"
 
 // Windows standard headers
 #ifndef   __WIN95__
-  #error  "wxNotebook is not supported under Windows 3.1"
+  #error  "wxNotebook is only supported Windows 95 and above"
 #endif    //Win95
 
 #include  <windowsx.h>  // for SetWindowFont
 
+#ifndef __TWIN32__
 #ifdef __GNUWIN32__
+#ifndef wxUSE_NORLANDER_HEADERS
   #include "wx/msw/gnuwin32/extra.h"
-#else   //!GnuWin32
+#endif
+#endif
+#endif
+
+#if !defined(__GNUWIN32__) || defined(__TWIN32__) || defined(wxUSE_NORLANDER_HEADERS)
   #include <commctrl.h>
 #endif
 
 // hide the ugly cast
 #define m_hwnd    (HWND)GetHWND()
 
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// This is a work-around for missing defines in gcc-2.95 headers
+#ifndef TCS_RIGHT
+    #define TCS_RIGHT       0x0002
+#endif
+
+#ifndef TCS_VERTICAL
+    #define TCS_VERTICAL    0x0080
+#endif
+
+#ifndef TCS_BOTTOM
+    #define TCS_BOTTOM      TCS_RIGHT
+#endif
+
 // ----------------------------------------------------------------------------
 // event table
 // ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARIES
-  BEGIN_EVENT_TABLE(wxNotebook, wxControl)
+BEGIN_EVENT_TABLE(wxNotebook, wxControl)
     EVT_NOTEBOOK_PAGE_CHANGED(-1, wxNotebook::OnSelChange)
 
     EVT_SIZE(wxNotebook::OnSize)
-    EVT_ERASE_BACKGROUND(wxNotebook::OnEraseBackground)
+
     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, wxCommandEvent)
-#endif
+IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
 
 // ============================================================================
 // implementation
@@ -115,52 +139,49 @@ bool wxNotebook::Create(wxWindow *parent,
                         const wxString& name)
 {
   // base init
-  SetName(name);
-  SetParent(parent);
-
-  m_windowId = id == -1 ? NewControlId() : id;
+  if ( !CreateBase(parent, id, pos, size, style, wxDefaultValidator, name) )
+      return FALSE;
 
   // colors and font
   m_backgroundColour = wxColour(GetSysColor(COLOR_BTNFACE));
-  m_foregroundColour = *wxBLACK ;
+  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;
-
-  // create the tab control.
-  m_hWnd = (WXHWND)CreateWindowEx
-    (
-      0,                                      // extended style
-      WC_TABCONTROL,                          // class name for the tab control
-      "",                                     // no caption
-      tabStyle,                               // style
-      pos.x, pos.y, size.x, size.y,           // size and position
-      (HWND)parent->GetHWND(),                // parent window
-      (HMENU)m_windowId,                      // child id
-      wxGetInstance(),                        // current instance
-      NULL                                    // no class data
-    );
-
-  if ( m_hWnd == 0 ) {
-    wxLogSysError("Can't create the notebook control");
+  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
-//  SetWindowFont((HWND)m_hwnd, ::GetStockObject(DEFAULT_GUI_FONT), FALSE);
-  ::SendMessage((HWND) m_hwnd, WM_SETFONT,
-                  (WPARAM)::GetStockObject(DEFAULT_GUI_FONT),TRUE);
+  ::SendMessage(GetHwnd(), WM_SETFONT,
+                (WPARAM)::GetStockObject(DEFAULT_GUI_FONT), TRUE);
 
 
-  if ( parent != NULL ) 
+  if ( parent != NULL )
     parent->AddChild(this);
-  
+
   SubclassWin(m_hWnd);
 
   return TRUE;
@@ -189,7 +210,7 @@ int wxNotebook::GetRowCount() const
 
 int wxNotebook::SetSelection(int nPage)
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 
   ChangePage(m_nSelection, nPage);
 
@@ -208,20 +229,20 @@ void wxNotebook::AdvanceSelection(bool bForward)
 
 bool wxNotebook::SetPageText(int nPage, const wxString& strText)
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_TEXT;
-  tcItem.pszText = (char *)strText.c_str();
+  tcItem.pszText = (wxChar *)strText.c_str();
 
   return TabCtrl_SetItem(m_hwnd, nPage, &tcItem) != 0;
 }
 
 wxString wxNotebook::GetPageText(int nPage) const
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), "", "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), wxT(""), wxT("notebook page out of range") );
 
-  char buf[256];
+  wxChar buf[256];
   TC_ITEM tcItem;
   tcItem.mask = TCIF_TEXT;
   tcItem.pszText = buf;
@@ -236,7 +257,7 @@ wxString wxNotebook::GetPageText(int nPage) const
 
 int wxNotebook::GetPageImage(int nPage) const
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_IMAGE;
@@ -246,7 +267,7 @@ int wxNotebook::GetPageImage(int nPage) const
 
 bool wxNotebook::SetPageImage(int nPage, int nImage)
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 
   TC_ITEM tcItem;
   tcItem.mask = TCIF_IMAGE;
@@ -256,11 +277,42 @@ bool wxNotebook::SetPageImage(int nPage, int nImage)
 }
 
 void wxNotebook::SetImageList(wxImageList* imageList)
-{ 
+{
   m_pImageList = 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.
+void wxNotebook::SetTabSize(const wxSize& sz)
+{
+    ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
+}
+
 // ----------------------------------------------------------------------------
 // wxNotebook operations
 // ----------------------------------------------------------------------------
@@ -268,33 +320,50 @@ void wxNotebook::SetImageList(wxImageList* imageList)
 // remove one page from the notebook
 bool wxNotebook::DeletePage(int nPage)
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, "notebook page out of range" );
+  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
 bool wxNotebook::RemovePage(int nPage)
 {
-  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, "notebook page out of range" );
+  wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") );
 
   TabCtrl_DeleteItem(m_hwnd, nPage);
 
   m_aPages.Remove(nPage);
 
+  if ( m_aPages.IsEmpty() )
+      m_nSelection = -1;
+    else
+      m_nSelection = TabCtrl_GetCurSel(m_hwnd);
+
   return TRUE;
 }
 
 // remove all pages
 bool wxNotebook::DeleteAllPages()
 {
-  TabCtrl_DeleteAllItems(m_hwnd);
-
   int nPageCount = GetPageCount();
   int nPage;
   for ( nPage = 0; nPage < nPageCount; nPage++ )
@@ -302,6 +371,10 @@ bool wxNotebook::DeleteAllPages()
 
   m_aPages.Clear();
 
+  TabCtrl_DeleteAllItems(m_hwnd);
+
+  m_nSelection = -1;
+
   return TRUE;
 }
 
@@ -324,30 +397,65 @@ bool wxNotebook::InsertPage(int nPage,
   wxASSERT( pPage != NULL );
   wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE );
 
-  // add the tab to the control
+  // do add the tab to the control
+
+  // init all fields to 0
   TC_ITEM tcItem;
-  tcItem.mask    = TCIF_TEXT | TCIF_IMAGE;
-  tcItem.pszText = (char *)strText.c_str();
-  tcItem.iImage  = imageId;
+  memset(&tcItem, 0, sizeof(tcItem));
+
+  if ( imageId != -1 )
+  {
+    tcItem.mask |= TCIF_IMAGE;
+    tcItem.iImage  = imageId;
+  }
+
+  if ( !strText.IsEmpty() )
+  {
+    tcItem.mask |= TCIF_TEXT;
+    tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
+  }
 
   if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
-    wxLogError("Can't create the notebook page '%s'.", strText.c_str());
+    wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
+
     return FALSE;
   }
 
+  // if the inserted page is before the selected one, we must update the
+  // index of the selected page
+  if ( nPage <= m_nSelection )
+  {
+    // one extra page added
+    m_nSelection++;
+  }
+
   // save the pointer to the page
   m_aPages.Insert(pPage, nPage);
 
-  // some page must be selected: either this one or the first one if there is 
+  // don't show pages by default (we'll need to adjust their size first)
+  HWND hwnd = GetWinHwnd(pPage);
+  SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
+
+  // this updates internal flag too - otherwise it will get out of sync
+  pPage->Show(FALSE);
+
+  // fit the notebook page to the tab control's display area
+  RECT rc;
+  rc.left = rc.top = 0;
+  GetSize((int *)&rc.right, (int *)&rc.bottom);
+  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;
   if ( bSelect )
-    m_nSelection = nPage;
+    selNew = nPage;
   else if ( m_nSelection == -1 )
-    m_nSelection = 0;
+    selNew = 0;
 
-  // don't show pages by default (we'll need to adjust their size first)
-  HWND hwnd = (HWND)pPage->GetHWND();
-  SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
+  if ( selNew != -1 )
+    SetSelection(selNew);
 
   return TRUE;
 }
@@ -358,24 +466,19 @@ bool wxNotebook::InsertPage(int nPage,
 
 void wxNotebook::OnSize(wxSizeEvent& event)
 {
-  // emulate page change (it's esp. important to do it first time because
-  // otherwise our page would stay invisible)
-  int nSel = m_nSelection;
-  m_nSelection = -1;
-  SetSelection(nSel);
-
   // fit the notebook page to the tab control's display area
   RECT rc;
   rc.left = rc.top = 0;
   GetSize((int *)&rc.right, (int *)&rc.bottom);
 
   TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
+
+  int width = rc.right - rc.left,
+      height = rc.bottom - rc.top;
   size_t nCount = m_aPages.Count();
   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);
-    if ( pPage->GetAutoLayout() )
-      pPage->Layout();
+    pPage->SetSize(rc.left, rc.top, width, height);
   }
 
   event.Skip();
@@ -385,7 +488,21 @@ void wxNotebook::OnSelChange(wxNotebookEvent& event)
 {
   // is it our tab control?
   if ( event.GetEventObject() == this )
-    ChangePage(event.GetOldSelection(), event.GetSelection());
+  {
+      int sel = event.GetOldSelection();
+      if ( sel != -1 )
+        m_aPages[sel]->Show(FALSE);
+
+      sel = event.GetSelection();
+      if ( sel != -1 )
+      {
+        wxNotebookPage *pPage = m_aPages[sel];
+        pPage->Show(TRUE);
+        pPage->SetFocus();
+      }
+
+      m_nSelection = sel;
+  }
 
   // we want to give others a chance to process this message as well
   event.Skip();
@@ -393,26 +510,71 @@ void wxNotebook::OnSelChange(wxNotebookEvent& 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_aPages[m_nSelection]->SetFocus();
+
+    event.Skip();
 }
 
 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_aPages[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);
+            }
+        }
     }
-  }
 }
 
 // ----------------------------------------------------------------------------
@@ -421,23 +583,18 @@ void wxNotebook::OnNavigationKey(wxNavigationKeyEvent& event)
 
 // 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);
 }
 
-bool wxNotebook::DoPhase(int /* nPhase */)
+bool wxNotebook::DoPhase(int WXUNUSED(nPhase))
 {
   return TRUE;
 }
 
-void wxNotebook::Command(wxCommandEvent& event)
-{
-  wxFAIL_MSG("wxNotebook::Command not implemented");
-}
-
-bool wxNotebook::MSWNotify(WXWPARAM wParam, WXLPARAM lParam)
+bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result)
 {
   wxNotebookEvent event(wxEVT_NULL, m_windowId);
 
@@ -451,47 +608,56 @@ bool wxNotebook::MSWNotify(WXWPARAM wParam, WXLPARAM lParam)
       event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING);
       break;
 
-      // prevent this msg from being passed to wxControl::MSWNotify which would
-      // retrun FALSE disabling the change of page
-    case UDN_DELTAPOS:
-      return TRUE;
-
-    default :
-      return wxControl::MSWNotify(wParam, lParam);
+    default:
+      return wxControl::MSWOnNotify(idCtrl, lParam, result);
   }
 
   event.SetSelection(TabCtrl_GetCurSel(m_hwnd));
   event.SetOldSelection(m_nSelection);
   event.SetEventObject(this);
-  event.SetInt(LOWORD(wParam));
+  event.SetInt(idCtrl);
 
-  return GetEventHandler()->ProcessEvent(event);
+  bool processed = GetEventHandler()->ProcessEvent(event);
+  *result = !event.IsAllowed();
+  return processed;
 }
 
 // ----------------------------------------------------------------------------
 // wxNotebook helper functions
 // ----------------------------------------------------------------------------
 
-// hide the currently active panel and show the new one
+// generate the page changing and changed events, hide the currently active
+// panel and show the new one
 void wxNotebook::ChangePage(int nOldSel, int nSel)
 {
+  // MT-FIXME should use a real semaphore
+  static bool s_bInsideChangePage = FALSE;
+
+  // when we call ProcessEvent(), our own OnSelChange() is called which calls
+  // this function - break the infinite loop
+  if ( s_bInsideChangePage )
+    return;
+
   // it's not an error (the message may be generated by the tab control itself)
   // and it may happen - just do nothing
   if ( nSel == nOldSel )
     return;
 
-  if ( nOldSel != -1 )
-    m_aPages[nOldSel]->Show(FALSE);
+  s_bInsideChangePage = TRUE;
 
-  wxNotebookPage *pPage = m_aPages[nSel];
-  pPage->Show(TRUE);
-  pPage->SetFocus();
+  wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
+  event.SetSelection(nSel);
+  event.SetOldSelection(nOldSel);
+  event.SetEventObject(this);
+  if ( ProcessEvent(event) && !event.IsAllowed() )
+  {
+    // program doesn't allow the page change
+    s_bInsideChangePage = FALSE;
+    return;
+  }
 
-  m_nSelection = nSel;
-}
+  event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
+  ProcessEvent(event);
 
-void wxNotebook::OnEraseBackground(wxEraseEvent& event)
-{
-    Default();
+  s_bInsideChangePage = FALSE;
 }
-