// Author: Robert Roebling
// Modified by: Vadim Zeitlin for Windows version
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _NOTEBOOK_H
#define _NOTEBOOK_H
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "notebook.h"
#endif
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-#ifndef _DYNARRAY_H
- #include <wx/dynarray.h>
-#endif //_DYNARRAY_H
-
-// ----------------------------------------------------------------------------
-// types
-// ----------------------------------------------------------------------------
-
-// fwd declarations
-class wxImageList;
-class wxWindow;
-
-// array of notebook pages
-typedef wxWindow wxNotebookPage; // so far, any window can be a page
-WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
+#if wxUSE_NOTEBOOK
// ----------------------------------------------------------------------------
-// notebook events
+// headers
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxNotebookEvent : public wxCommandEvent
-{
-public:
- wxNotebookEvent(WXTYPE commandType = wxEVT_NULL, int id = 0,
- int nSel = -1, int nOldSel = -1)
- : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }
- // accessors
- int GetSelection() const { return m_nSel; }
- int GetOldSelection() const { return m_nOldSel; }
-
-private:
- int m_nSel, // currently selected page
- m_nOldSel; // previously selected page
-
- DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
-};
+#include "wx/control.h"
// ----------------------------------------------------------------------------
// wxNotebook
// ----------------------------------------------------------------------------
-// @@@ this class should really derive from wxTabCtrl, but the interface is not
-// exactly the same, so I can't do it right now and instead we reimplement
-// part of wxTabCtrl here
-class wxNotebook : public wxControl
+class WXDLLEXPORT wxNotebook : public wxNotebookBase
{
public:
// ctors
wxNotebook();
// the same arguments as for wxControl (@@@ any special styles?)
wxNotebook(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = "notebook");
+ const wxString& name = wxNOTEBOOK_NAME);
// Create() function
bool Create(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = "notebook");
- // dtor
- ~wxNotebook();
+ const wxString& name = wxNOTEBOOK_NAME);
// accessors
// ---------
// selected one (or -1 on error)
// NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
int SetSelection(int nPage);
- // cycle thru the tabs
- void AdvanceSelection(bool bForward = TRUE);
// get the currently selected page
int GetSelection() const { return m_nSelection; }
// 3) set for each page it's image
// associate image list with a control
void SetImageList(wxImageList* imageList);
- // get pointer (may be NULL) to the associated image list
- wxImageList* GetImageList() const { return m_pImageList; }
// sets/returns item's image index in the current image list
int GetPageImage(int nPage) const;
bool SetPageImage(int nPage, int nImage);
- // each page can have some user-defined data associated with it:
- // set/retrieve this pointer
- bool SetPageData(int nPage, void* data);
- void* GetPageData(int nPage) const;
-
// currently it's always 1 because wxGTK doesn't support multi-row
// tab controls
int GetRowCount() const;
// set the padding between tabs (in pixels)
void SetPadding(const wxSize& padding);
+ // Windows only: attempts to get colour for UX theme page background
+ wxColour GetThemeBackgroundColour();
+
// operations
// ----------
- // remove one page from the notebook
- bool DeletePage(int nPage);
// remove all pages
bool DeleteAllPages();
- // adds a new page to the notebook (it will be deleted ny the notebook,
+
+ // inserts a new page to the notebook (it will be deleted ny the notebook,
// don't delete it yourself). If bSelect, this page becomes active.
- bool AddPage(wxNotebookPage *pPage,
- const wxString& strText,
- bool bSelect = FALSE,
- int imageId = -1,
- void* data = NULL);
- // the same as AddPage(), but adds it at the specified position
bool InsertPage(int nPage,
wxNotebookPage *pPage,
const wxString& strText,
bool bSelect = FALSE,
- int imageId = -1,
- void* data = NULL);
- // get the panel which represents the given page
- wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
+ int imageId = -1);
+
+ // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
+ // style.
+ void SetTabSize(const wxSize& sz);
+
+ // Windows only: attempts to apply the UX theme page background to this page
+ void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
+
+ // hit test
+ virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
+
+ // calculate the size of the notebook from the size of its page
+ virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
// callbacks
// ---------
void OnSize(wxSizeEvent& event);
void OnSelChange(wxNotebookEvent& event);
-
+ void OnSetFocus(wxFocusEvent& event);
+ void OnNavigationKey(wxNavigationKeyEvent& event);
+
// base class virtuals
// -------------------
- virtual void Command(wxCommandEvent& event);
- virtual bool MSWNotify(WXWPARAM wParam, WXLPARAM lParam);
+
+ virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+ virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
+ WXWORD pos, WXHWND control);
+
+#if wxUSE_CONSTRAINTS
+ virtual void SetConstraintSizes(bool recurse = TRUE);
+ virtual bool DoPhase(int nPhase);
+#endif // wxUSE_CONSTRAINTS
protected:
// common part of all ctors
void Init();
- // helper functions
- void ChangePage(int nOldSel, int nSel); // change pages
- void FitPage(wxNotebookPage *pPage); // fit a page in the tab control
+ // translate wxWin styles to the Windows ones
+ virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
+
+ // remove one page from the notebook, without deleting
+ virtual wxNotebookPage *DoRemovePage(int nPage);
+
+ // set the size of the given page to fit in the notebook
+ void AdjustPageSize(wxNotebookPage *page);
- wxImageList *m_pImageList; // we can have an associated image list
- wxArrayPages m_aPages; // array of pages
+ // override WndProc
+ virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
- int m_nSelection; // the current selection (-1 if none)
+ // the current selection (-1 if none)
+ int m_nSelection;
- DECLARE_DYNAMIC_CLASS(wxNotebook)
+
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebook)
DECLARE_EVENT_TABLE()
};
-// ----------------------------------------------------------------------------
-// event macros
-// ----------------------------------------------------------------------------
-typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
-
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \
- { \
- wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- },
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \
- { \
- wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \ \
- id, \
- -1, \
- (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
- NULL \
- },
+#endif // wxUSE_NOTEBOOK
#endif // _NOTEBOOK_H
projects / wxWidgets.git / blobdiff