// Created: 11.06.98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifdef __GNUG__
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
+#if wxUSE_NOTEBOOK
+
// wxWindows
#ifndef WX_PRECOMP
#include "wx/string.h"
#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
-#if !defined(__GNUWIN32__) || defined(__TWIN32__) || defined(wxUSE_NORLANDER_HEADERS)
- #include <commctrl.h>
+#if defined(__WIN95__) && !(defined(__GNUWIN32_OLD__) && !defined(__CYGWIN10__))
+ #include <commctrl.h>
#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, wxNotifyEvent)
-#endif
+IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxNotifyEvent)
// ============================================================================
// implementation
// common part of all ctors
void wxNotebook::Init()
{
- m_pImageList = NULL;
+ m_imageList = NULL;
m_nSelection = -1;
}
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;
- }
+ // base init
+ if ( !CreateControl(parent, id, pos, size, style | wxTAB_TRAVERSAL,
+ wxDefaultValidator, name) )
+ return FALSE;
- // Not all compilers recognise SetWindowFont
- ::SendMessage(GetHwnd(), WM_SETFONT,
- (WPARAM)::GetStockObject(DEFAULT_GUI_FONT), TRUE);
+ if ( !MSWCreateControl(WC_TABCONTROL, _T(""), pos, size) )
+ return FALSE;
+ SetBackgroundColour(wxColour(::GetSysColor(COLOR_BTNFACE)));
- if ( parent != NULL )
- parent->AddChild(this);
-
- 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 & wxNB_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
{
wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, wxT("notebook page out of range") );
- ChangePage(m_nSelection, nPage);
+ if ( nPage != m_nSelection )
+ {
+ wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
+ event.SetSelection(nPage);
+ event.SetOldSelection(m_nSelection);
+ event.SetEventObject(this);
+ if ( !GetEventHandler()->ProcessEvent(event) || event.IsAllowed() )
+ {
+ // program allows the page change
+ event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
+ (void)GetEventHandler()->ProcessEvent(event);
- return TabCtrl_SetCurSel(m_hwnd, nPage);
-}
+ 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);
+ return m_nSelection;
}
bool wxNotebook::SetPageText(int nPage, const wxString& strText)
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.
::SendMessage(GetHwnd(), TCM_SETITEMSIZE, 0, MAKELPARAM(sz.x, sz.y));
}
-// ----------------------------------------------------------------------------
-// wxNotebook operations
-// ----------------------------------------------------------------------------
-
-// remove one page from the notebook
-bool wxNotebook::DeletePage(int nPage)
+void wxNotebook::AdjustPageSize(wxNotebookPage *page)
{
- 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);
+ wxCHECK_RET( page, _T("NULL page in wxNotebook::AdjustPageSize") );
- delete m_aPages[nPage];
- m_aPages.Remove(nPage);
+ RECT rc;
+ rc.left =
+ rc.top = 0;
- if ( m_aPages.IsEmpty() ) {
- // no selection if the notebook became empty
- m_nSelection = -1;
- }
+ // get the page size from the notebook size
+ GetSize((int *)&rc.right, (int *)&rc.bottom);
+ TabCtrl_AdjustRect(m_hwnd, FALSE, &rc);
- return TRUE;
+ page->SetSize(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
}
+// ----------------------------------------------------------------------------
+// wxNotebook operations
+// ----------------------------------------------------------------------------
+
// 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;
+ 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
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);
return TRUE;
}
-// 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);
-}
-
// same as AddPage() but does it at given position
bool wxNotebook::InsertPage(int nPage,
wxNotebookPage *pPage,
bool bSelect,
int imageId)
{
- wxASSERT( pPage != NULL );
- wxCHECK( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE );
+ wxCHECK_MSG( pPage != NULL, FALSE, _T("NULL page in wxNotebook::InsertPage") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage) || nPage == GetPageCount(), FALSE,
+ _T("invalid index in wxNotebook::InsertPage") );
- // do add the tab to the control
+ wxASSERT_MSG( pPage->GetParent() == this,
+ _T("notebook pages must have notebook as parent") );
- // init all fields to 0
- TC_ITEM tcItem;
- memset(&tcItem, 0, sizeof(tcItem));
+ // add a new tab to the control
+ // ----------------------------
- if ( imageId != -1 )
- {
- tcItem.mask |= TCIF_IMAGE;
- tcItem.iImage = imageId;
- }
+ // init all fields to 0
+ TC_ITEM tcItem;
+ wxZeroMemory(tcItem);
- if ( !strText.IsEmpty() )
- {
- tcItem.mask |= TCIF_TEXT;
- tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
- }
+ // set the image, if any
+ if ( imageId != -1 )
+ {
+ tcItem.mask |= TCIF_IMAGE;
+ tcItem.iImage = imageId;
+ }
- if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 ) {
- wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
+ // and the text
+ if ( !strText.IsEmpty() )
+ {
+ tcItem.mask |= TCIF_TEXT;
+ tcItem.pszText = (wxChar *)strText.c_str(); // const_cast
+ }
- return FALSE;
- }
+ // fit the notebook page to the tab control's display area: this should be
+ // done before adding it to the notebook or TabCtrl_InsertItem() will
+ // change the notebooks size itself!
+ AdjustPageSize(pPage);
- // 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++;
- }
+ // finally do insert it
+ if ( TabCtrl_InsertItem(m_hwnd, nPage, &tcItem) == -1 )
+ {
+ wxLogError(wxT("Can't create the notebook page '%s'."), strText.c_str());
+
+ return FALSE;
+ }
- // save the pointer to the page
- m_aPages.Insert(pPage, nPage);
+ // succeeded: save the pointer to the page
+ m_pages.Insert(pPage, nPage);
- // 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);
+ // for the first page (only) we need to adjust the size again because the
+ // notebook size changed: the tabs which hadn't been there before are now
+ // shown
+ if ( m_pages.GetCount() == 1 )
+ {
+ AdjustPageSize(pPage);
+ }
- // this updates internal flag too - otherwise it will get out of sync
- pPage->Show(FALSE);
+ // hide the page: unless it is selected, it shouldn't be shown (and if it
+ // is selected it will be shown later)
+ HWND hwnd = GetWinHwnd(pPage);
+ SetWindowLong(hwnd, GWL_STYLE, GetWindowLong(hwnd, GWL_STYLE) & ~WS_VISIBLE);
- // 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);
+ // this updates internal flag too -- otherwise it would get out of sync
+ // with the real state
+ pPage->Show(FALSE);
- // some page should be selected: either this one or the first one if there is
- // still no selection
- int selNew = -1;
- if ( bSelect )
- selNew = nPage;
- else if ( m_nSelection == -1 )
- selNew = 0;
+ // now deal with the selection
+ // ---------------------------
- if ( selNew != -1 )
- SetSelection(selNew);
+ // 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++;
+ }
- return TRUE;
+ // some page should be selected: either this one or the first one if there
+ // is still no selection
+ int selNew = -1;
+ if ( bSelect )
+ selNew = nPage;
+ else if ( m_nSelection == -1 )
+ selNew = 0;
+
+ if ( selNew != -1 )
+ SetSelection(selNew);
+
+ return TRUE;
}
// ----------------------------------------------------------------------------
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);
+ wxNotebookPage *pPage = m_pages[nPage];
+ pPage->SetSize(rc.left, rc.top, width, height);
}
event.Skip();
{
int sel = event.GetOldSelection();
if ( sel != -1 )
- m_aPages[sel]->Show(FALSE);
+ m_pages[sel]->Show(FALSE);
sel = event.GetSelection();
if ( sel != -1 )
{
- wxNotebookPage *pPage = m_aPages[sel];
+ wxNotebookPage *pPage = m_pages[sel];
pPage->Show(TRUE);
pPage->SetFocus();
}
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()->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);
+ }
+ }
}
- }
}
// ----------------------------------------------------------------------------
// wxNotebook base class virtuals
// ----------------------------------------------------------------------------
+#if wxUSE_CONSTRAINTS
+
// 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;
}
+#endif // wxUSE_CONSTRAINTS
+
+// ----------------------------------------------------------------------------
+// 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);
return processed;
}
-// ----------------------------------------------------------------------------
-// wxNotebook helper functions
-// ----------------------------------------------------------------------------
-
-// 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;
-
- s_bInsideChangePage = TRUE;
-
- 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;
- }
-
- event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
- ProcessEvent(event);
-
- s_bInsideChangePage = FALSE;
-}
+#endif // wxUSE_NOTEBOOK
projects / wxWidgets.git / blobdiff