]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/notebook.h
remove wxWINT_T_IS_TYPEDEF as it seems wint_t is always a typedef (although it can...
[wxWidgets.git] / include / wx / notebook.h
... / ...
CommitLineData
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$
8// Copyright: (c) 1996-2000 Vadim Zeitlin
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_NOTEBOOK_H_BASE_
13#define _WX_NOTEBOOK_H_BASE_
14
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#include "wx/defs.h"
20
21#if wxUSE_NOTEBOOK
22
23#include "wx/bookctrl.h"
24
25// ----------------------------------------------------------------------------
26// constants
27// ----------------------------------------------------------------------------
28
29// wxNotebook hit results, use wxBK_HITTEST so other book controls can share them
30// if wxUSE_NOTEBOOK is disabled
31enum
32{
33 wxNB_HITTEST_NOWHERE = wxBK_HITTEST_NOWHERE,
34 wxNB_HITTEST_ONICON = wxBK_HITTEST_ONICON,
35 wxNB_HITTEST_ONLABEL = wxBK_HITTEST_ONLABEL,
36 wxNB_HITTEST_ONITEM = wxBK_HITTEST_ONITEM,
37 wxNB_HITTEST_ONPAGE = wxBK_HITTEST_ONPAGE
38};
39
40// wxNotebook flags
41
42// use common book wxBK_* flags for describing alignment
43#define wxNB_DEFAULT wxBK_DEFAULT
44#define wxNB_TOP wxBK_TOP
45#define wxNB_BOTTOM wxBK_BOTTOM
46#define wxNB_LEFT wxBK_LEFT
47#define wxNB_RIGHT wxBK_RIGHT
48
49#define wxNB_FIXEDWIDTH 0x0100
50#define wxNB_MULTILINE 0x0200
51#define wxNB_NOPAGETHEME 0x0400
52#define wxNB_FLAT 0x0800
53
54
55typedef wxWindow wxNotebookPage; // so far, any window can be a page
56
57extern WXDLLEXPORT_DATA(const wxChar) wxNotebookNameStr[];
58
59// ----------------------------------------------------------------------------
60// wxNotebookBase: define wxNotebook interface
61// ----------------------------------------------------------------------------
62
63class WXDLLEXPORT wxNotebookBase : public wxBookCtrlBase
64{
65public:
66 // ctors
67 // -----
68
69 wxNotebookBase() { }
70
71 wxNotebookBase(wxWindow *parent,
72 wxWindowID winid,
73 const wxPoint& pos = wxDefaultPosition,
74 const wxSize& size = wxDefaultSize,
75 long style = 0,
76 const wxString& name = wxNotebookNameStr) ;
77
78 // wxNotebook-specific additions to wxBookCtrlBase interface
79 // ---------------------------------------------------------
80
81 // get the number of rows for a control with wxNB_MULTILINE style (not all
82 // versions support it - they will always return 1 then)
83 virtual int GetRowCount() const { return 1; }
84
85 // set the padding between tabs (in pixels)
86 virtual void SetPadding(const wxSize& padding) = 0;
87
88 // set the size of the tabs for wxNB_FIXEDWIDTH controls
89 virtual void SetTabSize(const wxSize& sz) = 0;
90
91
92
93 // implement some base class functions
94 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
95
96 // On platforms that support it, get the theme page background colour, else invalid colour
97 virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
98
99
100 // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events
101
102 // returns false if the change to nPage is vetoed by the program
103 bool SendPageChangingEvent(int nPage);
104
105 // sends the event about page change from old to new (or GetSelection() if
106 // new is -1)
107 void SendPageChangedEvent(int nPageOld, int nPageNew = -1);
108
109
110protected:
111 DECLARE_NO_COPY_CLASS(wxNotebookBase)
112};
113
114// ----------------------------------------------------------------------------
115// notebook event class and related stuff
116// ----------------------------------------------------------------------------
117
118class WXDLLEXPORT wxNotebookEvent : public wxBookCtrlBaseEvent
119{
120public:
121 wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
122 int nSel = -1, int nOldSel = -1)
123 : wxBookCtrlBaseEvent(commandType, winid, nSel, nOldSel)
124 {
125 }
126
127 wxNotebookEvent(const wxNotebookEvent& event)
128 : wxBookCtrlBaseEvent(event)
129 {
130 }
131
132 virtual wxEvent *Clone() const { return new wxNotebookEvent(*this); }
133
134private:
135 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxNotebookEvent)
136};
137
138BEGIN_DECLARE_EVENT_TYPES()
139 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 802)
140 DECLARE_EVENT_TYPE(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 803)
141END_DECLARE_EVENT_TYPES()
142
143typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
144
145#define wxNotebookEventHandler(func) \
146 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxNotebookEventFunction, &func)
147
148#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
149 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxNotebookEventHandler(fn))
150
151#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
152 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxNotebookEventHandler(fn))
153
154// ----------------------------------------------------------------------------
155// wxNotebook class itself
156// ----------------------------------------------------------------------------
157
158#if defined(__WXUNIVERSAL__)
159 #include "wx/univ/notebook.h"
160#elif defined(__WXMSW__)
161 #include "wx/msw/notebook.h"
162#elif defined(__WXMOTIF__)
163 #include "wx/generic/notebook.h"
164#elif defined(__WXGTK20__)
165 #include "wx/gtk/notebook.h"
166#elif defined(__WXGTK__)
167 #include "wx/gtk1/notebook.h"
168#elif defined(__WXMAC__)
169 #include "wx/mac/notebook.h"
170#elif defined(__WXCOCOA__)
171 #include "wx/cocoa/notebook.h"
172#elif defined(__WXPM__)
173 #include "wx/os2/notebook.h"
174#endif
175
176#endif // wxUSE_NOTEBOOK
177
178#endif
179 // _WX_NOTEBOOK_H_BASE_