]> git.saurik.com Git - wxWidgets.git/blame - include/wx/notebook.h
Not all implementations of wxMDIChildFrame derive from wxFrame
[wxWidgets.git] / include / wx / notebook.h
CommitLineData
1e6feb95
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/notebook.h
3// Purpose: wxNotebook interface
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 01.02.01
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) 1996-2000 wxWidgets team
65571936 9// Licence: wxWindows licence
1e6feb95
VZ
10///////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_NOTEBOOK_H_BASE_
13#define _WX_NOTEBOOK_H_BASE_
53b28675 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
07b8d7ec
VZ
16 #pragma interface "notebookbase.h"
17#endif
18
4d0f3cd6
VZ
19// ----------------------------------------------------------------------------
20// headers
21// ----------------------------------------------------------------------------
22
1e6feb95
VZ
23#include "wx/defs.h"
24
25#if wxUSE_NOTEBOOK
26
15aad3b9 27#include "wx/bookctrl.h"
1e6feb95 28
e450aa69
VZ
29// ----------------------------------------------------------------------------
30// constants
31// ----------------------------------------------------------------------------
32
33// wxNotebook hit results
34enum
35{
36 wxNB_HITTEST_NOWHERE = 1, // not on tab
37 wxNB_HITTEST_ONICON = 2, // on icon
38 wxNB_HITTEST_ONLABEL = 4, // on label
39 wxNB_HITTEST_ONITEM = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL
40};
41
1e6feb95
VZ
42typedef wxWindow wxNotebookPage; // so far, any window can be a page
43
16cba29d 44extern WXDLLEXPORT_DATA(const wxChar*) wxNotebookNameStr;
630ad6c6
WS
45
46#if WXWIN_COMPATIBILITY_2_4
47 #define wxNOTEBOOK_NAME wxNotebookNameStr
48#endif
1e6feb95
VZ
49
50// ----------------------------------------------------------------------------
51// wxNotebookBase: define wxNotebook interface
52// ----------------------------------------------------------------------------
53
61c083e7 54class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
1e6feb95
VZ
55{
56public:
15aad3b9
VZ
57 // ctors
58 // -----
59
6463b9f5 60 wxNotebookBase() { }
15aad3b9
VZ
61
62 wxNotebookBase(wxWindow *parent,
aa6f64c7 63 wxWindowID winid,
15aad3b9
VZ
64 const wxPoint& pos = wxDefaultPosition,
65 const wxSize& size = wxDefaultSize,
66 long style = 0,
630ad6c6 67 const wxString& name = wxNotebookNameStr) ;
1e6feb95 68
61c083e7
WS
69 // wxNotebook-specific additions to wxBookCtrlBase interface
70 // ---------------------------------------------------------
1e6feb95
VZ
71
72 // get the number of rows for a control with wxNB_MULTILINE style (not all
73 // versions support it - they will always return 1 then)
74 virtual int GetRowCount() const { return 1; }
75
1e6feb95
VZ
76 // set the padding between tabs (in pixels)
77 virtual void SetPadding(const wxSize& padding) = 0;
78
79 // set the size of the tabs for wxNB_FIXEDWIDTH controls
80 virtual void SetTabSize(const wxSize& sz) = 0;
81
e450aa69
VZ
82 // hit test, returns which tab is hit and, optionally, where (icon, label)
83 // (not implemented on all platforms)
fc7a2a60
VZ
84 virtual int HitTest(const wxPoint& WXUNUSED(pt),
85 long * WXUNUSED(flags) = NULL) const
e450aa69
VZ
86 {
87 return wxNOT_FOUND;
88 }
89
1e6feb95 90
15aad3b9
VZ
91 // implement some base class functions
92 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
22f3361e 93
25057aba
JS
94 // On platforms that support it, get the theme page background colour, else invalid colour
95 virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
96
15aad3b9 97protected:
22f3361e 98 DECLARE_NO_COPY_CLASS(wxNotebookBase)
1e6feb95 99};
4d0f3cd6
VZ
100
101// ----------------------------------------------------------------------------
15aad3b9 102// notebook event class and related stuff
4d0f3cd6
VZ
103// ----------------------------------------------------------------------------
104
61c083e7 105class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
4d0f3cd6
VZ
106{
107public:
aa6f64c7 108 wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
4d0f3cd6 109 int nSel = -1, int nOldSel = -1)
61c083e7 110 : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
15aad3b9
VZ
111 {
112 }
4d0f3cd6
VZ
113
114private:
fc7a2a60 115 DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebookEvent)
4d0f3cd6
VZ
116};
117
2e4df4bf
VZ
118BEGIN_DECLARE_EVENT_TYPES()
119 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
120 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
121END_DECLARE_EVENT_TYPES()
122
4d0f3cd6
VZ
123typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
124
7fa03f04 125#define wxNotebookEventHandler(func) \
8bc3ec1f 126 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
7fa03f04
VZ
127
128#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
129 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
130
131#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
132 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
4d0f3cd6
VZ
133
134// ----------------------------------------------------------------------------
135// wxNotebook class itself
136// ----------------------------------------------------------------------------
137
1e6feb95
VZ
138#if defined(__WXUNIVERSAL__)
139 #include "wx/univ/notebook.h"
140#elif defined(__WXMSW__)
aaace873 141 #include "wx/msw/notebook.h"
2049ba38 142#elif defined(__WXMOTIF__)
1e6feb95 143 #include "wx/generic/notebook.h"
2049ba38 144#elif defined(__WXGTK__)
1e6feb95 145 #include "wx/gtk/notebook.h"
34138703 146#elif defined(__WXMAC__)
1e6feb95 147 #include "wx/mac/notebook.h"
0201182b 148#elif defined(__WXCOCOA__)
0754a4b3 149 #include "wx/cocoa/notebook.h"
1777b9bb 150#elif defined(__WXPM__)
1e6feb95 151 #include "wx/os2/notebook.h"
53b28675
RR
152#endif
153
1e6feb95
VZ
154#endif // wxUSE_NOTEBOOK
155
53b28675 156#endif
34138703 157 // _WX_NOTEBOOK_H_BASE_