/////////////////////////////////////////////////////////////////////////////
-// Name: univ/notebook.cpp
+// Name: src/univ/notebook.cpp
// Purpose: wxNotebook implementation
// Author: Vadim Zeitlin
// Modified by:
// Created: 01.02.01
-// RCS-ID: $Id$
// Copyright: (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
-// Licence: wxWidgets licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "univnotebook.h"
-#endif
-
-#ifdef __VMS
-#pragma message disable unscomzer
-#endif
-
#include "wx/wxprec.h"
#ifdef __BORLANDC__
#if wxUSE_NOTEBOOK
-#include "wx/imaglist.h"
#include "wx/notebook.h"
+
+#ifndef WX_PRECOMP
+ #include "wx/dcmemory.h"
+#endif
+
+#include "wx/imaglist.h"
#include "wx/spinbutt.h"
-#include "wx/dcmemory.h"
#include "wx/univ/renderer.h"
+// ----------------------------------------------------------------------------
+// wxStdNotebookInputHandler: translates SPACE and ENTER keys and the left mouse
+// click into button press/release actions
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxStdNotebookInputHandler : public wxStdInputHandler
+{
+public:
+ wxStdNotebookInputHandler(wxInputHandler *inphand);
+
+ virtual bool HandleKey(wxInputConsumer *consumer,
+ const wxKeyEvent& event,
+ bool pressed);
+ virtual bool HandleMouse(wxInputConsumer *consumer,
+ const wxMouseEvent& event);
+ virtual bool HandleMouseMove(wxInputConsumer *consumer, const wxMouseEvent& event);
+ virtual bool HandleFocus(wxInputConsumer *consumer, const wxFocusEvent& event);
+ virtual bool HandleActivation(wxInputConsumer *consumer, bool activated);
+
+protected:
+ void HandleFocusChange(wxInputConsumer *consumer);
+};
+
// ----------------------------------------------------------------------------
// macros
// ----------------------------------------------------------------------------
// due to unsigned type nPage is always >= 0
#define IS_VALID_PAGE(nPage) (((nPage) >= 0) && ((size_t(nPage)) < GetPageCount()))
#else
-#define IS_VALID_PAGE(nPage) ((size_t(nPage)) < GetPageCount())
+#define IS_VALID_PAGE(nPage) (((size_t)nPage) < GetPageCount())
#endif
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-static const size_t INVALID_PAGE = (size_t)-1;
-
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED)
-DEFINE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING)
-
// ----------------------------------------------------------------------------
// private classes
// ----------------------------------------------------------------------------
{
public:
wxNotebookSpinBtn(wxNotebook *nb)
- : wxSpinButton(nb, -1,
+ : wxSpinButton(nb, wxID_ANY,
wxDefaultPosition, wxDefaultSize,
nb->IsVertical() ? wxSP_VERTICAL : wxSP_HORIZONTAL)
{
};
BEGIN_EVENT_TABLE(wxNotebookSpinBtn, wxSpinButton)
- EVT_SPIN(-1, wxNotebookSpinBtn::OnSpin)
+ EVT_SPIN(wxID_ANY, wxNotebookSpinBtn::OnSpin)
END_EVENT_TABLE()
// ============================================================================
// implementation
// ============================================================================
-IMPLEMENT_DYNAMIC_CLASS(wxNotebook, wxControl)
-IMPLEMENT_DYNAMIC_CLASS(wxNotebookEvent, wxCommandEvent)
-
// ----------------------------------------------------------------------------
// wxNotebook creation
// ----------------------------------------------------------------------------
void wxNotebook::Init()
{
- m_sel = INVALID_PAGE;
-
m_heightTab =
m_widthMax = 0;
long style,
const wxString& name)
{
+ if ( (style & wxBK_ALIGN_MASK) == wxBK_DEFAULT )
+ style |= wxBK_TOP;
+
if ( !wxControl::Create(parent, id, pos, size, style,
wxDefaultValidator, name) )
- return FALSE;
+ return false;
m_sizePad = GetRenderer()->GetTabPadding();
- SetBestSize(size);
+ SetInitialSize(size);
CreateInputHandler(wxINP_HANDLER_NOTEBOOK);
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
wxString wxNotebook::GetPageText(size_t nPage) const
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), _T(""), _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), wxEmptyString, wxT("invalid notebook page") );
return m_titles[nPage];
}
bool wxNotebook::SetPageText(size_t nPage, const wxString& strText)
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("invalid notebook page") );
if ( strText != m_titles[nPage] )
{
}
}
- return TRUE;
+ return true;
}
int wxNotebook::GetPageImage(size_t nPage) const
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("invalid notebook page") );
return m_images[nPage];
}
bool wxNotebook::SetPageImage(size_t nPage, int nImage)
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), FALSE, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), false, wxT("invalid notebook page") );
- wxCHECK_MSG( m_imageList && nImage < m_imageList->GetImageCount(), FALSE,
- _T("invalid image index in SetPageImage()") );
+ wxCHECK_MSG( HasImageList() && nImage < GetImageList()->GetImageCount(),
+ false, wxT("invalid image index in SetPageImage()") );
if ( nImage != m_images[nPage] )
{
RefreshTab(nPage);
}
- return TRUE;
+ return true;
}
wxNotebook::~wxNotebook()
// wxNotebook page switching
// ----------------------------------------------------------------------------
-int wxNotebook::SetSelection(size_t nPage)
+int wxNotebook::DoSetSelection(size_t nPage, int flags)
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), -1, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), wxNOT_FOUND, wxT("invalid notebook page") );
- if ( (size_t)nPage == m_sel )
+ if ( (int)nPage == m_selection )
{
// don't do anything if there is nothing to do
- return m_sel;
+ return m_selection;
}
- // event handling
- wxNotebookEvent event(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, m_windowId);
- event.SetSelection(nPage);
- event.SetOldSelection(m_sel);
- event.SetEventObject(this);
- if ( GetEventHandler()->ProcessEvent(event) && !event.IsAllowed() )
+ if ( flags & SetSelection_SendEvent )
{
- // program doesn't allow the page change
- return m_sel;
+ if ( !SendPageChangingEvent(nPage) )
+ {
+ // program doesn't allow the page change
+ return m_selection;
+ }
}
- // we need to change m_sel first, before calling RefreshTab() below as
+ // we need to change m_selection first, before calling RefreshTab() below as
// otherwise the previously selected tab wouldn't be redrawn properly under
// wxGTK which calls Refresh() immediately and not during the next event
// loop iteration as wxMSW does and as it should
- size_t selOld = m_sel;
+ int selOld = m_selection;
- m_sel = nPage;
+ m_selection = nPage;
- if ( selOld != INVALID_PAGE )
+ if ( selOld != wxNOT_FOUND )
{
- RefreshTab(selOld, TRUE /* this tab was selected */);
+ RefreshTab(selOld, true /* this tab was selected */);
m_pages[selOld]->Hide();
}
- if ( m_sel != INVALID_PAGE ) // this is impossible - but test nevertheless
+ if ( m_selection != wxNOT_FOUND ) // this is impossible - but test nevertheless
{
if ( HasSpinBtn() )
{
// keep it in sync
- m_spinbtn->SetValue(m_sel);
+ m_spinbtn->SetValue(m_selection);
}
- if ( m_sel < m_firstVisible )
+ if ( nPage < m_firstVisible )
{
// selection is to the left of visible part of tabs
- ScrollTo(m_sel);
+ ScrollTo(nPage);
}
- else if ( m_sel > m_lastFullyVisible )
+ else if ( nPage > m_lastFullyVisible )
{
// selection is to the right of visible part of tabs
- ScrollLastTo(m_sel);
+ ScrollLastTo(nPage);
}
else // we already see this tab
{
// no need to scroll
- RefreshTab(m_sel);
+ RefreshTab(nPage);
}
- m_pages[m_sel]->SetSize(GetPageRect());
- m_pages[m_sel]->Show();
+ m_pages[nPage]->SetSize(GetPageRect());
+ m_pages[nPage]->Show();
}
- // event handling
- event.SetEventType(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED);
- GetEventHandler()->ProcessEvent(event);
+ if ( flags & SetSelection_SendEvent )
+ {
+ // event handling
+ SendPageChangedEvent(selOld);
+ }
return selOld;
}
int imageId)
{
size_t nPages = GetPageCount();
- wxCHECK_MSG( nPage == nPages || IS_VALID_PAGE(nPage), FALSE,
- _T("invalid notebook page in InsertPage()") );
+ wxCHECK_MSG( nPage == nPages || IS_VALID_PAGE(nPage), false,
+ wxT("invalid notebook page in InsertPage()") );
// modify the data
m_pages.Insert(pPage, nPage);
if ( nPages == 0 )
{
// always select the first tab to have at least some selection
- bSelect = TRUE;
+ bSelect = true;
Relayout();
Refresh();
pPage->Hide();
}
- return TRUE;
+ return true;
}
bool wxNotebook::DeleteAllPages()
{
if ( !wxNotebookBase::DeleteAllPages() )
- return FALSE;
+ return false;
// clear the other arrays as well
m_titles.Clear();
m_accels.Clear();
m_widths.Clear();
- // it is not valid any longer
- m_sel = INVALID_PAGE;
-
// spin button is not needed any more
UpdateSpinBtn();
Relayout();
- return TRUE;
+ return true;
}
wxNotebookPage *wxNotebook::DoRemovePage(size_t nPage)
{
- wxCHECK_MSG( IS_VALID_PAGE(nPage), NULL, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(nPage), NULL, wxT("invalid notebook page") );
wxNotebookPage *page = m_pages[nPage];
m_pages.RemoveAt(nPage);
size_t count = GetPageCount();
if ( count )
{
- if ( m_sel == (size_t)nPage )
+ wxASSERT_MSG( m_selection != wxNOT_FOUND, "should have selection" );
+
+ if ( (size_t)m_selection == nPage )
{
// avoid sending event to this page which doesn't exist in the
// notebook any more
- m_sel = INVALID_PAGE;
+ m_selection = wxNOT_FOUND;
SetSelection(nPage == count ? nPage - 1 : nPage);
}
- else if ( m_sel > (size_t)nPage )
+ else if ( (size_t)m_selection > nPage )
{
// no need to change selection, just adjust the index
- m_sel--;
+ m_selection--;
}
}
else // no more tabs left
{
- m_sel = INVALID_PAGE;
+ m_selection = wxNOT_FOUND;
}
// have to refresh everything
void wxNotebook::RefreshCurrent()
{
- if ( m_sel != INVALID_PAGE )
+ if ( m_selection != wxNOT_FOUND )
{
- RefreshTab(m_sel);
+ RefreshTab(m_selection);
}
}
void wxNotebook::RefreshTab(int page, bool forceSelected)
{
- wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
+ wxCHECK_RET( IS_VALID_PAGE(page), wxT("invalid notebook page") );
wxRect rect = GetTabRect(page);
- if ( forceSelected || ((size_t)page == m_sel) )
+ if ( forceSelected || (page == m_selection) )
{
const wxSize indent = GetRenderer()->GetTabIndent();
rect.Inflate(indent.x, indent.y);
// used for wxUniversal under MSW
#if 0 // def __WXMSW__ // FIXME
int w, h;
- m_imageList->GetSize(n, w, h);
+ GetImageList()->GetSize(n, w, h);
bmp.Create(w, h);
wxMemoryDC dc;
dc.SelectObject(bmp);
dc.SetBackground(wxBrush(GetBackgroundColour(), wxSOLID));
- m_imageList->Draw(image, dc, 0, 0, wxIMAGELIST_DRAW_NORMAL, TRUE);
+ GetImageList()->Draw(image, dc, 0, 0, wxIMAGELIST_DRAW_NORMAL, true);
dc.SelectObject(wxNullBitmap);
#else
- bmp = *m_imageList->GetBitmap(image);
+ bmp = GetImageList()->GetBitmap(image);
#endif
}
int flags = 0;
- if ( n == m_sel )
+ if ( (int)n == m_selection )
{
flags |= wxCONTROL_SELECTED;
{
GetTabSize(n, &rect.width, &rect.height);
- if ( n == m_sel )
+ if ( (int)n == m_selection )
{
// don't redraw it now as this tab has to be drawn over the other
// ones as it takes more place and spills over to them
// now redraw the selected tab
if ( rectSel.width )
{
- DoDrawTab(dc, rectSel, m_sel);
+ DoDrawTab(dc, rectSel, m_selection);
}
dc.DestroyClippingRegion();
int wxNotebook::HitTest(const wxPoint& pt, long *flags) const
{
if ( flags )
- *flags = wxNB_HITTEST_NOWHERE;
+ *flags = wxBK_HITTEST_NOWHERE;
// first check that it is in this window at all
- if ( !GetClientRect().Inside(pt) )
+ if ( !GetClientRect().Contains(pt) )
{
return -1;
}
switch ( GetTabOrientation() )
{
default:
- wxFAIL_MSG(_T("unknown tab orientation"));
+ wxFAIL_MSG(wxT("unknown tab orientation"));
// fall through
case wxTOP:
{
GetTabSize(n, &rectTabs.width, &rectTabs.height);
- if ( rectTabs.Inside(pt) )
+ if ( rectTabs.Contains(pt) )
{
if ( flags )
{
// TODO: be more precise
- *flags = wxNB_HITTEST_ONITEM;
+ *flags = wxBK_HITTEST_ONITEM;
}
return n;
wxDirection wxNotebook::GetTabOrientation() const
{
long style = GetWindowStyle();
- if ( style & wxNB_BOTTOM )
+ if ( style & wxBK_BOTTOM )
return wxBOTTOM;
- else if ( style & wxNB_RIGHT )
+ else if ( style & wxBK_RIGHT )
return wxRIGHT;
- else if ( style & wxNB_LEFT )
+ else if ( style & wxBK_LEFT )
return wxLEFT;
- // wxNB_TOP == 0 so we don't have to test for it
+ // wxBK_TOP == 0 so we don't have to test for it
return wxTOP;
}
wxRect wxNotebook::GetTabRect(int page) const
{
wxRect rect;
- wxCHECK_MSG( IS_VALID_PAGE(page), rect, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(page), rect, wxT("invalid notebook page") );
// calc the size of this tab and of the preceding ones
wxCoord widthThis, widthBefore;
const wxSize indent = GetRenderer()->GetTabIndent();
if ( IsVertical() )
{
- rect.x += indent.y;
rect.y += indent.x;
+ if ( dir == wxLEFT )
+ {
+ rect.x += indent.y;
+ rect.width -= indent.y;
+ }
+ else // wxRIGHT
+ {
+ rect.width -= indent.y;
+ }
}
else // horz
{
void wxNotebook::GetTabSize(int page, wxCoord *w, wxCoord *h) const
{
- wxCHECK_RET( w && h, _T("NULL pointer in GetTabSize") );
+ wxCHECK_RET( w && h, wxT("NULL pointer in GetTabSize") );
if ( IsVertical() )
{
void wxNotebook::SetTabSize(const wxSize& sz)
{
- wxCHECK_RET( FixedSizeTabs(), _T("SetTabSize() ignored") );
+ wxCHECK_RET( FixedSizeTabs(), wxT("SetTabSize() ignored") );
if ( IsVertical() )
{
wxSize size;
- wxCHECK_MSG( IS_VALID_PAGE(page), size, _T("invalid notebook page") );
+ wxCHECK_MSG( IS_VALID_PAGE(page), size, wxT("invalid notebook page") );
GetTextExtent(m_titles[page], &size.x, &size.y);
if ( HasImage(page) )
{
wxSize sizeImage;
- m_imageList->GetSize(m_images[page], sizeImage.x, sizeImage.y);
+ GetImageList()->GetSize(m_images[page], sizeImage.x, sizeImage.y);
size.x += sizeImage.x + 5; // FIXME: hard coded margin
wxSize sizeTab = CalcTabSize(page);
// we only need full relayout if the page size changes
- bool needsRelayout = FALSE;
+ bool needsRelayout = false;
if ( IsVertical() )
{
if ( sizeTab.y > m_heightTab )
{
- needsRelayout = TRUE;
+ needsRelayout = true;
m_heightTab = sizeTab.y;
}
UpdateSpinBtn();
- if ( m_sel != INVALID_PAGE )
+ if ( m_selection != wxNOT_FOUND )
{
// resize the currently shown page
wxRect rectPage = GetPageRect();
- m_pages[m_sel]->SetSize(rectPage);
+ m_pages[m_selection]->SetSize(rectPage);
// also scroll it into view if needed (note that m_lastVisible
// was updated by the call to UpdateSpinBtn() above, this is why it
// is needed here)
if ( HasSpinBtn() )
{
- if ( m_sel < m_firstVisible )
+ const size_t selection = m_selection;
+ if ( selection < m_firstVisible )
{
// selection is to the left of visible part of tabs
- ScrollTo(m_sel);
+ ScrollTo(selection);
}
- else if ( m_sel > m_lastFullyVisible )
+ else if ( selection > m_lastFullyVisible )
{
// selection is to the right of visible part of tabs
- ScrollLastTo(m_sel);
+ ScrollLastTo(selection);
}
}
}
{
// this case is special, get rid of it immediately: everything is
// visible and we don't need any spin buttons
- allTabsShown = TRUE;
+ allTabsShown = true;
// have to reset them manually as we don't call CalcLastVisibleTab()
m_firstVisible =
m_spinbtn = new wxNotebookSpinBtn(this);
// set the correct value to keep it in sync
- m_spinbtn->SetValue(m_sel);
+ m_spinbtn->SetValue(m_selection);
}
// position it correctly
}
else // all tabs are visible, we don't need spin button
{
- if ( m_spinbtn )
+ if ( m_spinbtn && m_spinbtn -> IsShown() )
{
m_spinbtn->Hide();
}
switch ( GetTabOrientation() )
{
default:
- wxFAIL_MSG(_T("unknown tab orientation"));
+ wxFAIL_MSG(wxT("unknown tab orientation"));
// fall through
case wxTOP:
// wxNotebook scrolling
// ----------------------------------------------------------------------------
-void wxNotebook::ScrollTo(int page)
+void wxNotebook::ScrollTo(size_t page)
{
- wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
+ wxCHECK_RET( IS_VALID_PAGE(page), wxT("invalid notebook page") );
// set the first visible tab and offset (easy)
- m_firstVisible = (size_t)page;
+ m_firstVisible = page;
m_offset = 0;
for ( size_t n = 0; n < m_firstVisible; n++ )
{
RefreshAllTabs();
}
-void wxNotebook::ScrollLastTo(int page)
+void wxNotebook::ScrollLastTo(size_t page)
{
- wxCHECK_RET( IS_VALID_PAGE(page), _T("invalid notebook page") );
+ wxCHECK_RET( IS_VALID_PAGE(page), wxT("invalid notebook page") );
// go backwards until we find the first tab which can be made visible
// without hiding the given one
ScrollTo(m_firstVisible);
// consitency check: the page we were asked to show should be shown
- wxASSERT_MSG( (size_t)page < m_lastVisible, _T("bug in ScrollLastTo") );
+ wxASSERT_MSG( (size_t)page < m_lastVisible, wxT("bug in ScrollLastTo") );
}
// ----------------------------------------------------------------------------
// wxNotebook sizing/moving
// ----------------------------------------------------------------------------
-wxSize wxNotebook::DoGetBestClientSize() const
-{
- // calculate the max page size
- wxSize size(0, 0);
-
- size_t count = GetPageCount();
- if ( count )
- {
- for ( size_t n = 0; n < count; n++ )
- {
- wxSize sizePage = m_pages[n]->GetSize();
-
- if ( size.x < sizePage.x )
- size.x = sizePage.x;
- if ( size.y < sizePage.y )
- size.y = sizePage.y;
- }
- }
- else // no pages
- {
- // use some arbitrary default size
- size.x =
- size.y = 100;
- }
-
- return GetSizeForPage(size);
-}
-
void wxNotebook::DoMoveWindow(int x, int y, int width, int height)
{
wxControl::DoMoveWindow(x, y, width, height);
wxSize old_client_size = GetClientSize();
wxControl::DoSetSize(x, y, width, height, sizeFlags);
-
+
wxSize new_client_size = GetClientSize();
-
+
if (old_client_size != new_client_size)
Relayout();
}
const wxString& strArg)
{
if ( action == wxACTION_NOTEBOOK_NEXT )
- SetSelection(GetNextPage(TRUE));
+ SetSelection(GetNextPage(true));
else if ( action == wxACTION_NOTEBOOK_PREV )
- SetSelection(GetNextPage(FALSE));
+ SetSelection(GetNextPage(false));
else if ( action == wxACTION_NOTEBOOK_GOTO )
SetSelection((int)numArg);
else
return wxControl::PerformAction(action, numArg, strArg);
- return TRUE;
+ return true;
+}
+
+/* static */
+wxInputHandler *wxNotebook::GetStdInputHandler(wxInputHandler *handlerDef)
+{
+ static wxStdNotebookInputHandler s_handler(handlerDef);
+
+ return &s_handler;
}
// ----------------------------------------------------------------------------
break;
}
- if ( !!action )
+ if ( !action.IsEmpty() )
{
return consumer->PerformAction(action, page);
}
{
consumer->PerformAction(wxACTION_NOTEBOOK_GOTO, page);
- return FALSE;
+ return false;
}
}
{
HandleFocusChange(consumer);
- return FALSE;
+ return false;
}
bool wxStdNotebookInputHandler::HandleActivation(wxInputConsumer *consumer,
// we react to the focus change in the same way as to the [de]activation
HandleFocusChange(consumer);
- return FALSE;
+ return false;
}
void wxStdNotebookInputHandler::HandleFocusChange(wxInputConsumer *consumer)
}
#endif // wxUSE_NOTEBOOK
-