]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/notebook.h
Force wide char environment version initialization in wxGetEnvMap().
[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 WXDLLIMPEXP_DATA_CORE(const char) wxNotebookNameStr[];
58
59#if wxUSE_EXTENDED_RTTI
60
61// ----------------------------------------------------------------------------
62// XTI accessor
63// ----------------------------------------------------------------------------
64
65class WXDLLEXPORT wxNotebookPageInfo : public wxObject
66{
67public:
68 wxNotebookPageInfo() { m_page = NULL; m_imageId = -1; m_selected = false; }
69 virtual ~wxNotebookPageInfo() { }
70
71 bool Create(wxNotebookPage *page,
72 const wxString& text,
73 bool selected,
74 int imageId)
75 {
76 m_page = page;
77 m_text = text;
78 m_selected = selected;
79 m_imageId = imageId;
80 return true;
81 }
82
83 wxNotebookPage* GetPage() const { return m_page; }
84 wxString GetText() const { return m_text; }
85 bool GetSelected() const { return m_selected; }
86 int GetImageId() const { return m_imageId; }
87
88private:
89 wxNotebookPage *m_page;
90 wxString m_text;
91 bool m_selected;
92 int m_imageId;
93
94 DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo)
95};
96
97WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
98
99#endif
100
101// ----------------------------------------------------------------------------
102// wxNotebookBase: define wxNotebook interface
103// ----------------------------------------------------------------------------
104
105class WXDLLIMPEXP_CORE wxNotebookBase : public wxBookCtrlBase
106{
107public:
108 // ctors
109 // -----
110
111 wxNotebookBase() { }
112
113 // wxNotebook-specific additions to wxBookCtrlBase interface
114 // ---------------------------------------------------------
115
116 // get the number of rows for a control with wxNB_MULTILINE style (not all
117 // versions support it - they will always return 1 then)
118 virtual int GetRowCount() const { return 1; }
119
120 // set the padding between tabs (in pixels)
121 virtual void SetPadding(const wxSize& padding) = 0;
122
123 // set the size of the tabs for wxNB_FIXEDWIDTH controls
124 virtual void SetTabSize(const wxSize& sz) = 0;
125
126
127
128 // implement some base class functions
129 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
130
131 // On platforms that support it, get the theme page background colour, else invalid colour
132 virtual wxColour GetThemeBackgroundColour() const { return wxNullColour; }
133
134
135 // send wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING/ED events
136
137 // returns false if the change to nPage is vetoed by the program
138 bool SendPageChangingEvent(int nPage);
139
140 // sends the event about page change from old to new (or GetSelection() if
141 // new is wxNOT_FOUND)
142 void SendPageChangedEvent(int nPageOld, int nPageNew = wxNOT_FOUND);
143
144 // wxBookCtrlBase overrides this method to return false but we do need
145 // focus because we have tabs
146 virtual bool AcceptsFocus() const { return wxControl::AcceptsFocus(); }
147
148#if wxUSE_EXTENDED_RTTI
149 // XTI accessors
150 virtual void AddPageInfo( wxNotebookPageInfo* info );
151 virtual const wxNotebookPageInfoList& GetPageInfos() const;
152#endif
153
154protected:
155#if wxUSE_EXTENDED_RTTI
156 wxNotebookPageInfoList m_pageInfos;
157#endif
158 wxDECLARE_NO_COPY_CLASS(wxNotebookBase);
159};
160
161// ----------------------------------------------------------------------------
162// notebook event class and related stuff
163// ----------------------------------------------------------------------------
164
165// wxNotebookEvent is obsolete and defined for compatibility only (notice that
166// we use #define and not typedef to also keep compatibility with the existing
167// code which forward declares it)
168#define wxNotebookEvent wxBookCtrlEvent
169typedef wxBookCtrlEventFunction wxNotebookEventFunction;
170#define wxNotebookEventHandler(func) wxBookCtrlEventHandler(func)
171
172wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, wxBookCtrlEvent );
173wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, wxBookCtrlEvent );
174
175#define EVT_NOTEBOOK_PAGE_CHANGED(winid, fn) \
176 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, winid, wxBookCtrlEventHandler(fn))
177
178#define EVT_NOTEBOOK_PAGE_CHANGING(winid, fn) \
179 wx__DECLARE_EVT1(wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, winid, wxBookCtrlEventHandler(fn))
180
181// ----------------------------------------------------------------------------
182// wxNotebook class itself
183// ----------------------------------------------------------------------------
184
185#if defined(__WXUNIVERSAL__)
186 #include "wx/univ/notebook.h"
187#elif defined(__WXMSW__)
188 #include "wx/msw/notebook.h"
189#elif defined(__WXMOTIF__)
190 #include "wx/generic/notebook.h"
191#elif defined(__WXGTK20__)
192 #include "wx/gtk/notebook.h"
193#elif defined(__WXGTK__)
194 #include "wx/gtk1/notebook.h"
195#elif defined(__WXMAC__)
196 #include "wx/osx/notebook.h"
197#elif defined(__WXCOCOA__)
198 #include "wx/cocoa/notebook.h"
199#elif defined(__WXPM__)
200 #include "wx/os2/notebook.h"
201#endif
202
203#endif // wxUSE_NOTEBOOK
204
205#endif
206 // _WX_NOTEBOOK_H_BASE_