1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
/////////////////////////////////////////////////////////////////////////////
// Name: notebook.h
// Purpose: interface of wxNotebook
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
enum
{
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
};
#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
#define wxNB_FIXEDWIDTH 0x0100
#define wxNB_MULTILINE 0x0200
#define wxNB_NOPAGETHEME 0x0400
#define wxNB_FLAT 0x0800
wxEventType wxEVT_NOTEBOOK_PAGE_CHANGED;
wxEventType wxEVT_NOTEBOOK_PAGE_CHANGING;
/**
@class wxNotebook
This class represents a notebook control, which manages multiple windows with
associated tabs.
To use the class, create a wxNotebook object and call wxNotebook::AddPage
or wxNotebook::InsertPage, passing a window to be used as the page.
Do not explicitly delete the window for a page that is currently managed by
wxNotebook.
@b wxNotebookPage is a typedef for wxWindow.
@beginStyleTable
@style{wxNB_TOP}
Place tabs on the top side.
@style{wxNB_LEFT}
Place tabs on the left side.
@style{wxNB_RIGHT}
Place tabs on the right side.
@style{wxNB_BOTTOM}
Place tabs under instead of above the notebook pages.
@style{wxNB_FIXEDWIDTH}
(Windows only) All tabs will have same width.
@style{wxNB_MULTILINE}
(Windows only) There can be several rows of tabs.
@style{wxNB_NOPAGETHEME}
(Windows only) Display a solid colour on notebook pages, and not a
gradient, which can reduce performance.
@style{wxNB_FLAT}
(Windows CE only) Show tabs in a flat style.
@endStyleTable
The styles wxNB_LEFT, RIGHT and BOTTOM are not supported under
Microsoft Windows XP when using visual themes.
@beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_NOTEBOOK_PAGE_CHANGED(id, func)}
The page selection was changed.
Processes a @c wxEVT_NOTEBOOK_PAGE_CHANGED event.
@event{EVT_NOTEBOOK_PAGE_CHANGING(id, func)}
The page selection is about to be changed.
Processes a @c wxEVT_NOTEBOOK_PAGE_CHANGING event.
This event can be vetoed.
@endEventTable
@section notebook_bg Page backgrounds
On Windows XP, the default theme paints a gradient on the notebook's pages.
If you wish to suppress this theme, for aesthetic or performance reasons,
there are three ways of doing it.
You can use @c wxNB_NOPAGETHEME to disable themed drawing for a particular
notebook, you can call wxSystemOptions::SetOption to disable it for the
whole application, or you can disable it for individual pages by using
SetBackgroundColour().
To disable themed pages globally:
@code
wxSystemOptions::SetOption("msw.notebook.themed-background", 0);
@endcode
Set the value to 1 to enable it again.
To give a single page a solid background that more or less fits in with the
overall theme, use:
@code
wxColour col = notebook->GetThemeBackgroundColour();
if (col.IsOk())
{
page->SetBackgroundColour(col);
}
@endcode
On platforms other than Windows, or if the application is not using Windows
themes, GetThemeBackgroundColour() will return an uninitialised colour object,
and the above code will therefore work on all platforms.
@library{wxcore}
@category{bookctrl}
@appearance{notebook}
@see wxBookCtrl, wxBookCtrlEvent, wxImageList, @ref page_samples_notebook
*/
class wxNotebook : public wxBookCtrlBase
{
public:
/**
Constructs a notebook control.
*/
wxNotebook();
/**
Constructs a notebook control.
Note that sometimes you can reduce flicker by passing the wxCLIP_CHILDREN
window style.
@param parent
The parent window. Must be non-@NULL.
@param id
The window identifier.
@param pos
The window position.
@param size
The window size.
@param style
The window style. See wxNotebook.
@param name
The name of the control.
*/
wxNotebook(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxNotebookNameStr);
/**
Destroys the wxNotebook object.
*/
virtual ~wxNotebook();
/**
Creates a notebook control.
See wxNotebook() for a description of the parameters.
*/
bool Create(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxNotebookNameStr);
/**
Returns the number of rows in the notebook control.
*/
virtual int GetRowCount() const;
/**
If running under Windows and themes are enabled for the application, this
function returns a suitable colour for painting the background of a notebook
page, and can be passed to SetBackgroundColour().
Otherwise, an uninitialised colour will be returned.
*/
virtual wxColour GetThemeBackgroundColour() const;
/**
An event handler function, called when the page selection is changed.
@see wxBookCtrlEvent
*/
void OnSelChange(wxBookCtrlEvent& event);
/**
Sets the amount of space around each page's icon and label, in pixels.
@note The vertical padding cannot be changed in wxGTK.
*/
virtual void SetPadding(const wxSize& padding);
// implementations of pure virtuals
virtual int GetPageImage(size_t nPage) const;
virtual bool SetPageImage(size_t page, int image);
virtual wxString GetPageText(size_t nPage) const;
virtual bool SetPageText(size_t page, const wxString& text);
virtual int GetSelection() const;
virtual int SetSelection(size_t page);
virtual int ChangeSelection(size_t page);
virtual bool InsertPage(size_t index, wxWindow * page, const wxString & text,
bool select = false, int imageId = NO_IMAGE);
};
|
