X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c86f1403c3737c07d58676a203f4707942684a01..ccdcde00d9ae27ca20ff6c3c9495918a0ec725aa:/src/msw/notebook.cpp diff --git a/src/msw/notebook.cpp b/src/msw/notebook.cpp index 538c053be0..36e50c706b 100644 --- a/src/msw/notebook.cpp +++ b/src/msw/notebook.cpp @@ -2,53 +2,54 @@ // 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 // Licence: wxWindows license /////////////////////////////////////////////////////////////////////////////// -// ============================================================================ -// declarations -// ============================================================================ - -// ---------------------------------------------------------------------------- -// headers -// ---------------------------------------------------------------------------- #ifdef __GNUG__ - #pragma implementation "notebook.h" +#pragma implementation "notebook.h" #endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_NOTEBOOK + // wxWindows #ifndef WX_PRECOMP - #include + #include "wx/string.h" #endif // WX_PRECOMP -#include -#include -#include +#include "wx/log.h" +#include "wx/imaglist.h" +#include "wx/event.h" +#include "wx/control.h" +#include "wx/notebook.h" -#include +#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 // for SetWindowFont -#ifdef __GNUWIN32__ - #include "wx/msw/gnuwin32/extra.h" -#else //!GnuWin32 - #include +#ifndef __TWIN32__ + #ifdef __GNUWIN32_OLD__ + #include "wx/msw/gnuwin32/extra.h" + #endif +#endif + +#if defined(__WIN95__) && !((defined(__GNUWIN32_OLD__) || defined(__TWIN32__)) && !defined(__CYGWIN10__)) + #include #endif // ---------------------------------------------------------------------------- @@ -61,22 +62,42 @@ // 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) +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_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 @@ -89,7 +110,7 @@ // common part of all ctors void wxNotebook::Init() { - m_pImageList = NULL; + m_imageList = NULL; m_nSelection = -1; } @@ -120,71 +141,59 @@ bool wxNotebook::Create(wxWindow *parent, long style, const wxString& name) { - // base init - SetName(name); - SetParent(parent); - - m_windowId = id == -1 ? NewControlId() : id; - - // colors and font - m_backgroundColour = wxColour(GetSysColor(COLOR_BTNFACE)); - m_foregroundColour = *wxBLACK ; - - m_defaultForegroundColour = *wxBLACK ; - m_defaultBackgroundColour = wxColour(GetSysColor(COLOR_BTNFACE)); - - // style - m_windowStyle = style; - - long tabStyle = WS_CHILD | WS_VISIBLE | WS_TABSTOP | TCS_TABS; - 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"); - return FALSE; - } + // base init + if ( !CreateControl(parent, id, pos, size, style, wxDefaultValidator, name) ) + return FALSE; - SetWindowFont((HWND)m_hwnd, ::GetStockObject(DEFAULT_GUI_FONT), 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); - - SubclassWin(m_hWnd); + SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE))); - 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 // ---------------------------------------------------------------------------- + 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 @@ -194,39 +203,29 @@ int wxNotebook::GetRowCount() const int wxNotebook::SetSelection(int nPage) { - wxASSERT( IS_VALID_PAGE(nPage) ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") ); ChangePage(m_nSelection, 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) { - wxASSERT( IS_VALID_PAGE(nPage) ); + 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 { - wxASSERT( IS_VALID_PAGE(nPage) ); + 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; @@ -241,7 +240,7 @@ wxString wxNotebook::GetPageText(int nPage) const int wxNotebook::GetPageImage(int nPage) const { - wxASSERT( IS_VALID_PAGE(nPage) ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") ); TC_ITEM tcItem; tcItem.mask = TCIF_IMAGE; @@ -251,7 +250,7 @@ int wxNotebook::GetPageImage(int nPage) const bool wxNotebook::SetPageImage(int nPage, int nImage) { - wxASSERT( IS_VALID_PAGE(nPage) ); + wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, wxT("notebook page out of range") ); TC_ITEM tcItem; tcItem.mask = TCIF_IMAGE; @@ -261,9 +260,44 @@ bool wxNotebook::SetPageImage(int nPage, int nImage) } 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. +void wxNotebook::SetTabSize(const wxSize& sz) +{ + ::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y)); } // ---------------------------------------------------------------------------- @@ -273,27 +307,60 @@ void wxNotebook::SetImageList(wxImageList* imageList) // remove one page from the notebook bool wxNotebook::DeletePage(int nPage) { - wxCHECK( IS_VALID_PAGE(nPage), FALSE ); + 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); + delete m_pages[nPage]; + m_pages.RemoveAt(nPage); + + if ( m_pages.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 +wxNotebookPage *wxNotebook::DoRemovePage(int nPage) +{ + wxNotebookPage *pageRemoved = wxNotebookBase::DoRemovePage(nPage); + if ( !pageRemoved ) + return NULL; + + TabCtrl_DeleteItem(m_hwnd, nPage); + + if ( m_pages.IsEmpty() ) + m_nSelection = -1; + else + m_nSelection = TabCtrl_GetCurSel(m_hwnd); + + return pageRemoved; +} + // remove all pages bool wxNotebook::DeleteAllPages() { - TabCtrl_DeleteAllItems(m_hwnd); - 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); + + m_nSelection = -1; return TRUE; } @@ -317,30 +384,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); + m_pages.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; } @@ -351,24 +453,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); - 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++ ) { - wxNotebookPage *pPage = m_aPages[nPage]; - pPage->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top); - if ( pPage->GetAutoLayout() ) - pPage->Layout(); + wxNotebookPage *pPage = m_pages[nPage]; + pPage->SetSize(rc.left, rc.top, width, height); } event.Skip(); @@ -378,7 +475,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_pages[sel]->Show(FALSE); + + sel = event.GetSelection(); + if ( sel != -1 ) + { + wxNotebookPage *pPage = m_pages[sel]; + pPage->Show(TRUE); + pPage->SetFocus(); + } + + m_nSelection = sel; + } // we want to give others a chance to process this message as well event.Skip(); @@ -386,26 +497,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_pages[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()->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); + } + } } - } } // ---------------------------------------------------------------------------- @@ -414,23 +570,33 @@ 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) +// ---------------------------------------------------------------------------- +// wxNotebook Windows message handlers +// ---------------------------------------------------------------------------- + +bool wxNotebook::MSWOnScroll(int orientation, WXWORD nSBCode, + WXWORD pos, WXHWND control) { - wxFAIL_MSG("wxNotebook::Command not implemented"); + // 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::MSWNotify(WXWPARAM wParam, WXLPARAM lParam) +bool wxNotebook::MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM* result) { wxNotebookEvent event(wxEVT_NULL, m_windowId); @@ -444,41 +610,58 @@ 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 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; + + wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId); + event.SetSelection(nSel); + event.SetOldSelection(nOldSel); + event.SetEventObject(this); + if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() ) + { + // program doesn't allow the page change + s_bInsideChangePage = FALSE; + return; + } - wxNotebookPage *pPage = m_aPages[nSel]; - pPage->Show(TRUE); - pPage->SetFocus(); + event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED); + GetEventHandler()->ProcessEvent(event); - m_nSelection = nSel; + s_bInsideChangePage = FALSE; } + +#endif // wxUSE_NOTEBOOK