X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/53b28675492e387711489760dbfe08ba5086ce73..259c43f679ca655362b5a439e11c87fc0666d663:/include/wx/notebook.h diff --git a/include/wx/notebook.h b/include/wx/notebook.h index 56d91a911f..74fcc220cc 100644 --- a/include/wx/notebook.h +++ b/include/wx/notebook.h @@ -1,11 +1,161 @@ -#ifndef __NOTEBOOKH_BASE__ -#define __NOTEBOOKH_BASE__ +/////////////////////////////////////////////////////////////////////////////// +// Name: wx/notebook.h +// Purpose: wxNotebook interface +// Author: Vadim Zeitlin +// Modified by: +// Created: 01.02.01 +// RCS-ID: $Id$ +// Copyright: (c) 1996-2000 Vadim Zeitlin +// Licence: wxWindows licence +/////////////////////////////////////////////////////////////////////////////// -#if defined(__WINDOWS__) -#elif defined(__MOTIF__) -#elif defined(__GTK__) - #include "wx/gtk/notebook.h" +#ifndef _WX_NOTEBOOK_H_BASE_ +#define _WX_NOTEBOOK_H_BASE_ + +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + +#include "wx/defs.h" + +#if wxUSE_NOTEBOOK + +#include "wx/bookctrl.h" + +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + +// wxNotebook hit results +enum +{ + wxNB_HITTEST_NOWHERE = 1, // not on tab + wxNB_HITTEST_ONICON = 2, // on icon + wxNB_HITTEST_ONLABEL = 4, // on label + wxNB_HITTEST_ONITEM = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL +}; + +typedef wxWindow wxNotebookPage; // so far, any window can be a page + +extern WXDLLEXPORT_DATA(const wxChar*) wxNotebookNameStr; + +#if WXWIN_COMPATIBILITY_2_4 + #define wxNOTEBOOK_NAME wxNotebookNameStr +#endif + +// ---------------------------------------------------------------------------- +// wxNotebookBase: define wxNotebook interface +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase +{ +public: + // ctors + // ----- + + wxNotebookBase() { } + + wxNotebookBase(wxWindow *parent, + wxWindowID winid, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxString& name = wxNotebookNameStr) ; + + // 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 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; + + // hit test, returns which tab is hit and, optionally, where (icon, label) + // (not implemented on all platforms) + virtual int HitTest(const wxPoint& WXUNUSED(pt), + long * WXUNUSED(flags) = NULL) const + { + return wxNOT_FOUND; + } + + + // implement some base class functions + virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const; + + // On platforms that support it, get the theme page background colour, else invalid colour + virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; } + + + // Reserved for future use + virtual void ReservedNotebookFunc1() {} + virtual void ReservedNotebookFunc2() {} + virtual void ReservedNotebookFunc3() {} + virtual void ReservedNotebookFunc4() {} + virtual void ReservedNotebookFunc5() {} + +protected: + DECLARE_NO_COPY_CLASS(wxNotebookBase) +}; + +// ---------------------------------------------------------------------------- +// notebook event class and related stuff +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent +{ +public: + wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, + int nSel = -1, int nOldSel = -1) + : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel) + { + } + +private: + DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent) +}; + +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&); + +#define wxNotebookEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func) + +#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \ + wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn)) + +#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \ + wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn)) + +// ---------------------------------------------------------------------------- +// wxNotebook class itself +// ---------------------------------------------------------------------------- + +#if defined(__WXUNIVERSAL__) + #include "wx/univ/notebook.h" +#elif defined(__WXMSW__) + #include "wx/msw/notebook.h" +#elif defined(__WXMOTIF__) + #include "wx/generic/notebook.h" +#elif defined(__WXGTK__) + #include "wx/gtk/notebook.h" +#elif defined(__WXMAC__) + #include "wx/mac/notebook.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/notebook.h" +#elif defined(__WXPM__) + #include "wx/os2/notebook.h" #endif +#endif // wxUSE_NOTEBOOK + #endif - // __NOTEBOOKH_BASE__ + // _WX_NOTEBOOK_H_BASE_