// Modified by:
// Created: 01.02.01
// RCS-ID: $Id$
-// Copyright: (c) 1996-2000 wxWindows team
+// Copyright: (c) 1996-2000 Vadim Zeitlin
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _WX_NOTEBOOK_H_BASE_
#define _WX_NOTEBOOK_H_BASE_
-#ifdef __GNUG__
- #pragma interface "notebookbase.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
#if wxUSE_NOTEBOOK
-#include "wx/control.h"
-#include "wx/dynarray.h"
-
-class WXDLLEXPORT wxImageList;
-
-// ----------------------------------------------------------------------------
-// types
-// ----------------------------------------------------------------------------
-
-// array of notebook pages
-typedef wxWindow wxNotebookPage; // so far, any window can be a page
-
-WX_DEFINE_EXPORTED_ARRAY(wxNotebookPage *, wxArrayPages);
-
-#define wxNOTEBOOK_NAME _T("notebook")
+#include "wx/bookctrl.h"
// ----------------------------------------------------------------------------
-// wxNotebookBase: define wxNotebook interface
+// constants
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxNotebookBase : public wxControl
+// wxNotebook hit results, use wxBK_HITTEST so other book controls can share them
+// if wxUSE_NOTEBOOK is disabled
+enum
{
-public:
- // ctor
- wxNotebookBase()
- {
- Init();
- }
-
- // quasi ctor
- bool Create(wxWindow *parent,
- wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = 0,
- const wxString& name = wxNOTEBOOK_NAME);
+ wxNB_HITTEST_NOWHERE = wxBK_HITTEST_NOWHERE,
+ wxNB_HITTEST_ONICON = wxBK_HITTEST_ONICON,
+ wxNB_HITTEST_ONLABEL = wxBK_HITTEST_ONLABEL,
+ wxNB_HITTEST_ONITEM = wxBK_HITTEST_ONITEM,
+ wxNB_HITTEST_ONPAGE = wxBK_HITTEST_ONPAGE
+};
- // dtor
- virtual ~wxNotebookBase();
+// wxNotebook flags
- // accessors
- // ---------
+// use common book wxBK_* flags for describing alignment
+#define wxNB_DEFAULT wxBK_DEFAULT
+#define wxNB_TOP wxBK_TOP
+#define wxNB_BOTTOM wxBK_BOTTOM
+#define wxNB_LEFT wxBK_LEFT
+#define wxNB_RIGHT wxBK_RIGHT
- // get number of pages in the dialog
- int GetPageCount() const { return m_pages.GetCount(); }
+#define wxNB_FIXEDWIDTH 0x0100
+#define wxNB_MULTILINE 0x0200
+#define wxNB_NOPAGETHEME 0x0400
+#define wxNB_FLAT 0x0800
- // get the panel which represents the given page
- wxNotebookPage *GetPage(int nPage) { return m_pages[nPage]; }
- // get the currently selected page
- virtual int GetSelection() const = 0;
+typedef wxWindow wxNotebookPage; // so far, any window can be a page
- // set/get the title of a page
- virtual bool SetPageText(int nPage, const wxString& strText) = 0;
- virtual wxString GetPageText(int nPage) const = 0;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxNotebookNameStr[];
- // image list stuff: each page may have an image associated with it (all
- // images belong to the same image list)
- virtual void SetImageList(wxImageList* imageList);
+// ----------------------------------------------------------------------------
+// wxNotebookBase: define wxNotebook interface
+// ----------------------------------------------------------------------------
- // as SetImageList() but we will delete the image list ourselves
- void AssignImageList(wxImageList* imageList);
+class WXDLLIMPEXP_CORE wxNotebookBase : public wxBookCtrlBase
+{
+public:
+ // ctors
+ // -----
- // get pointer (may be NULL) to the associated image list
- wxImageList* GetImageList() const { return m_imageList; }
+ wxNotebookBase() { }
- // sets/returns item's image index in the current image list
- virtual int GetPageImage(int nPage) const = 0;
- virtual bool SetPageImage(int nPage, int nImage) = 0;
+ // wxNotebook-specific additions to wxBookCtrlBase interface
+ // ---------------------------------------------------------
// get the number of rows for a control with wxNB_MULTILINE style (not all
// versions support it - they will always return 1 then)
virtual int GetRowCount() const { return 1; }
- // set the size (the same for all pages)
- virtual void SetPageSize(const wxSize& size) = 0;
-
// set the padding between tabs (in pixels)
virtual void SetPadding(const wxSize& padding) = 0;
// set the size of the tabs for wxNB_FIXEDWIDTH controls
virtual void SetTabSize(const wxSize& sz) = 0;
- // calculate the size of the notebook from the size of its page
- virtual wxSize CalcSizeFromPage(const wxSize& sizePage);
-
- // operations
- // ----------
-
- // remove one page from the notebook and delete it
- virtual bool DeletePage(int nPage);
-
- // remove one page from the notebook, without deleting it
- virtual bool RemovePage(int nPage) { return DoRemovePage(nPage) != NULL; }
-
- // remove all pages and delete them
- virtual bool DeleteAllPages() { WX_CLEAR_ARRAY(m_pages); return TRUE; }
-
- // adds a new page to the notebook (it will be deleted by the notebook,
- // don't delete it yourself) and make it the current one if bSelect
- virtual bool AddPage(wxNotebookPage *pPage,
- const wxString& strText,
- bool bSelect = FALSE,
- int imageId = -1)
- {
- return InsertPage(GetPageCount(), pPage, strText, bSelect, imageId);
- }
-
- // the same as AddPage(), but adds the page at the specified position
- virtual bool InsertPage(int nPage,
- wxNotebookPage *pPage,
- const wxString& strText,
- bool bSelect = FALSE,
- int imageId = -1) = 0;
-
- // set the currently selected page, return the index of the previously
- // selected one (or -1 on error)
- //
- // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
- virtual int SetSelection(int nPage) = 0;
-
- // cycle thru the tabs
- void AdvanceSelection(bool forward = TRUE)
- {
- int nPage = GetNextPage(forward);
- if ( nPage != -1 )
- SetSelection(nPage);
- }
-protected:
- // remove the page and return a pointer to it
- virtual wxNotebookPage *DoRemovePage(int page);
- // common part of all ctors
- void Init();
+ // implement some base class functions
+ virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
- // get the next page wrapping if we reached the end
- int GetNextPage(bool forward) const;
+ // On platforms that support it, get the theme page background colour, else invalid colour
+ virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
- wxArrayPages m_pages; // array of pages
- wxImageList *m_imageList; // we can have an associated image list
- bool m_ownsImageList; // true if we must delete m_imageList
-};
-// ----------------------------------------------------------------------------
-// notebook event class (used by NOTEBOOK_PAGE_CHANGED/ING events)
-// ----------------------------------------------------------------------------
+ // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events
-class WXDLLEXPORT wxNotebookEvent : public wxNotifyEvent
-{
-public:
- wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
- int nSel = -1, int nOldSel = -1)
- : wxNotifyEvent(commandType, id)
- {
- m_nSel = nSel;
- m_nOldSel = nOldSel;
- }
-
- // accessors
- // the currently selected page (-1 if none)
- int GetSelection() const { return m_nSel; }
- void SetSelection(int nSel) { m_nSel = nSel; }
- // the page that was selected before the change (-1 if none)
- int GetOldSelection() const { return m_nOldSel; }
- void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
-
-private:
- int m_nSel, // currently selected page
- m_nOldSel; // previously selected page
-
- DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
+ // returns false if the change to nPage is vetoed by the program
+ bool SendPageChangingEvent(int nPage);
+
+ // sends the event about page change from old to new (or GetSelection() if
+ // new is -1)
+ void SendPageChangedEvent(int nPageOld, int nPageNew = -1);
+
+ // wxBookCtrlBase overrides this method to return false but we do need
+ // focus because we have tabs
+ virtual bool AcceptsFocus() const { return wxControl::AcceptsFocus(); }
+
+protected:
+ wxDECLARE_NO_COPY_CLASS(wxNotebookBase);
};
// ----------------------------------------------------------------------------
-// event types and macros for them
+// notebook event class and related stuff
// ----------------------------------------------------------------------------
-#if defined(__BORLANDC__) && defined(__WIN16__)
- // For 16-bit BC++, these 2 would be identical otherwise (truncated)
- #define wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED wxEVT_COMMAND_NB_PAGE_CHANGED
- #define wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING wxEVT_COMMAND_NB_PAGE_CHANGING
-#endif
+// wxNotebookEvent is obsolete and defined for compatibility only (notice that
+// we use #define and not typedef to also keep compatibility with the existing
+// code which forward declares it)
+#define wxNotebookEvent wxBookCtrlEvent
+typedef wxBookCtrlEventFunction wxNotebookEventFunction;
+#define wxNotebookEventHandler(func) wxBookCtrlEventHandler(func)
-BEGIN_DECLARE_EVENT_TYPES()
- DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
- DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
-END_DECLARE_EVENT_TYPES()
-
-typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
-
-// Truncation in 16-bit BC++ means we need to define these differently
-#if defined(__BORLANDC__) && defined(__WIN16__)
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \
- DECLARE_EVENT_TABLE_ENTRY( \
- wxEVT_COMMAND_NB_PAGE_CHANGED, \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- ),
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \
- DECLARE_EVENT_TABLE_ENTRY( \
- wxEVT_COMMAND_NB_PAGE_CHANGING, \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- ),
-
-#else
-
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \
- DECLARE_EVENT_TABLE_ENTRY( \
- wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- ),
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \
- DECLARE_EVENT_TABLE_ENTRY( \
- wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- ),
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, wxBookCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, wxBookCtrlEvent );
-#endif
+#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
+ wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))
+
+#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
+ wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))
// ----------------------------------------------------------------------------
// wxNotebook class itself
#if defined(__WXUNIVERSAL__)
#include "wx/univ/notebook.h"
#elif defined(__WXMSW__)
- #ifdef __WIN16__
- #include "wx/generic/notebook.h"
- #else
- #include "wx/msw/notebook.h"
- #endif
+ #include "wx/msw/notebook.h"
#elif defined(__WXMOTIF__)
#include "wx/generic/notebook.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
#include "wx/gtk/notebook.h"
+#elif defined(__WXGTK__)
+ #include "wx/gtk1/notebook.h"
#elif defined(__WXMAC__)
- #include "wx/mac/notebook.h"
+ #include "wx/osx/notebook.h"
+#elif defined(__WXCOCOA__)
+ #include "wx/cocoa/notebook.h"
#elif defined(__WXPM__)
#include "wx/os2/notebook.h"
-#elif defined(__WXSTUBS__)
- #include "wx/stubs/notebook.h"
#endif
#endif // wxUSE_NOTEBOOK
projects / wxWidgets.git / blobdiff