]> git.saurik.com Git - wxWidgets.git/blame - include/wx/bookctrl.h
wxLaunchDefaultBrowser() now supports wxBROWSER_NEW_WINDOW flag (and it actually...
[wxWidgets.git] / include / wx / bookctrl.h
CommitLineData
15aad3b9
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/bookctrl.h
61c083e7 3// Purpose: wxBookCtrlBase: common base class for wxList/Tree/Notebook
15aad3b9
VZ
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 19.08.03
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
65571936 9// Licence: wxWindows licence
15aad3b9
VZ
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_BOOKCTRL_H_
13#define _WX_BOOKCTRL_H_
14
15aad3b9
VZ
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#include "wx/defs.h"
20
21#if wxUSE_BOOKCTRL
22
23#include "wx/control.h"
24#include "wx/dynarray.h"
25
d5d29b8a 26WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
15aad3b9
VZ
27
28class WXDLLEXPORT wxImageList;
29
30// ----------------------------------------------------------------------------
61c083e7 31// wxBookCtrlBase
15aad3b9
VZ
32// ----------------------------------------------------------------------------
33
61c083e7 34class WXDLLEXPORT wxBookCtrlBase : public wxControl
15aad3b9
VZ
35{
36public:
37 // construction
38 // ------------
39
61c083e7 40 wxBookCtrlBase()
6463b9f5
JS
41 {
42 Init();
43 }
15aad3b9 44
61c083e7
WS
45 wxBookCtrlBase(wxWindow *parent,
46 wxWindowID winid,
47 const wxPoint& pos = wxDefaultPosition,
48 const wxSize& size = wxDefaultSize,
49 long style = 0,
50 const wxString& name = wxEmptyString)
6463b9f5
JS
51 {
52 Init();
53
54 (void)Create(parent, winid, pos, size, style, name);
55 }
15aad3b9
VZ
56
57 // quasi ctor
58 bool Create(wxWindow *parent,
aa6f64c7 59 wxWindowID winid,
15aad3b9
VZ
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = 0,
63 const wxString& name = wxEmptyString);
64
65 // dtor
61c083e7 66 virtual ~wxBookCtrlBase();
15aad3b9
VZ
67
68
69 // accessors
70 // ---------
71
72 // get number of pages in the dialog
73 virtual size_t GetPageCount() const { return m_pages.size(); }
74
75 // get the panel which represents the given page
76 virtual wxWindow *GetPage(size_t n) { return m_pages[n]; }
77
21db32c1
VZ
78 // get the current page or NULL if none
79 wxWindow *GetCurrentPage() const
80 {
81 int n = GetSelection();
82 return n == wxNOT_FOUND ? NULL
61c083e7 83 : wx_const_cast(wxBookCtrlBase *, this)->GetPage(n);
21db32c1
VZ
84 }
85
15aad3b9
VZ
86 // get the currently selected page or wxNOT_FOUND if none
87 virtual int GetSelection() const = 0;
88
89 // set/get the title of a page
90 virtual bool SetPageText(size_t n, const wxString& strText) = 0;
91 virtual wxString GetPageText(size_t n) const = 0;
92
93
94 // image list stuff: each page may have an image associated with it (all
95 // images belong to the same image list)
96 // ---------------------------------------------------------------------
97
98 // sets the image list to use, it is *not* deleted by the control
99 virtual void SetImageList(wxImageList *imageList);
100
101 // as SetImageList() but we will delete the image list ourselves
102 void AssignImageList(wxImageList *imageList);
103
104 // get pointer (may be NULL) to the associated image list
105 wxImageList* GetImageList() const { return m_imageList; }
106
107 // sets/returns item's image index in the current image list
108 virtual int GetPageImage(size_t n) const = 0;
109 virtual bool SetPageImage(size_t n, int imageId) = 0;
110
111
112 // geometry
113 // --------
114
115 // resize the notebook so that all pages will have the specified size
116 virtual void SetPageSize(const wxSize& size);
117
118 // calculate the size of the control from the size of its page
119 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0;
120
121
122 // operations
123 // ----------
124
125 // remove one page from the control and delete it
126 virtual bool DeletePage(size_t n);
127
128 // remove one page from the notebook, without deleting it
37144cf0
RD
129 virtual bool RemovePage(size_t n)
130 {
131 InvalidateBestSize();
132 return DoRemovePage(n) != NULL;
133 }
15aad3b9
VZ
134
135 // remove all pages and delete them
37144cf0
RD
136 virtual bool DeleteAllPages()
137 {
138 InvalidateBestSize();
139 WX_CLEAR_ARRAY(m_pages);
140 return true;
141 }
15aad3b9
VZ
142
143 // adds a new page to the control
144 virtual bool AddPage(wxWindow *page,
145 const wxString& text,
146 bool bSelect = false,
147 int imageId = -1)
148 {
37144cf0 149 InvalidateBestSize();
15aad3b9
VZ
150 return InsertPage(GetPageCount(), page, text, bSelect, imageId);
151 }
152
153 // the same as AddPage(), but adds the page at the specified position
154 virtual bool InsertPage(size_t n,
155 wxWindow *page,
156 const wxString& text,
157 bool bSelect = false,
158 int imageId = -1) = 0;
159
160 // set the currently selected page, return the index of the previously
161 // selected one (or -1 on error)
162 //
1f30c176 163 // NB: this function will generate PAGE_CHANGING/ED events
15aad3b9
VZ
164 virtual int SetSelection(size_t n) = 0;
165
166
167 // cycle thru the pages
168 void AdvanceSelection(bool forward = true)
169 {
170 int nPage = GetNextPage(forward);
171 if ( nPage != -1 )
172 {
173 // cast is safe because of the check above
174 SetSelection((size_t)nPage);
175 }
176 }
177
178protected:
179 // remove the page and return a pointer to it
180 virtual wxWindow *DoRemovePage(size_t page) = 0;
181
182 // our best size is the size which fits all our pages
183 virtual wxSize DoGetBestSize() const;
184
185 // helper: get the next page wrapping if we reached the end
186 int GetNextPage(bool forward) const;
187
188 // common part of all ctors
189 void Init();
190
6457949e
RD
191 // Always rely on GetBestSize, which will look at all the pages
192 virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { }
15aad3b9
VZ
193
194 // the array of all pages of this control
195 wxArrayPages m_pages;
196
197 // the associated image list or NULL
198 wxImageList *m_imageList;
199
200 // true if we must delete m_imageList
201 bool m_ownsImageList;
202
203
61c083e7 204 DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
15aad3b9
VZ
205};
206
207// ----------------------------------------------------------------------------
61c083e7 208// wxBookCtrlBaseEvent: page changing events generated by derived classes
15aad3b9
VZ
209// ----------------------------------------------------------------------------
210
61c083e7 211class WXDLLEXPORT wxBookCtrlBaseEvent : public wxNotifyEvent
15aad3b9
VZ
212{
213public:
61c083e7
WS
214 wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0,
215 int nSel = -1, int nOldSel = -1)
aa6f64c7 216 : wxNotifyEvent(commandType, winid)
15aad3b9
VZ
217 {
218 m_nSel = nSel;
219 m_nOldSel = nOldSel;
220 }
221
222 // accessors
223 // the currently selected page (-1 if none)
224 int GetSelection() const { return m_nSel; }
225 void SetSelection(int nSel) { m_nSel = nSel; }
226 // the page that was selected before the change (-1 if none)
227 int GetOldSelection() const { return m_nOldSel; }
228 void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
229
230private:
231 int m_nSel, // currently selected page
232 m_nOldSel; // previously selected page
233};
234
61c083e7 235// make a default book control for given platform
311131d3
WS
236#if wxUSE_NOTEBOOK
237 // dedicated to majority of desktops
36b79d44 238 #include "wx/notebook.h"
61c083e7
WS
239 #define wxBookCtrl wxNotebook
240 #define wxBookCtrlEvent wxNotebookEvent
241 #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
242 #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
243 #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn) EVT_NOTEBOOK_PAGE_CHANGED(id, fn)
244 #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn) EVT_NOTEBOOK_PAGE_CHANGING(id, fn)
1af34108
WS
245 #define wxBC_TOP wxNB_TOP
246 #define wxBC_BOTTOM wxNB_BOTTOM
247 #define wxBC_LEFT wxNB_LEFT
248 #define wxBC_RIGHT wxNB_RIGHT
249 #define wxBC_DEFAULT wxNB_DEFAULT
311131d3
WS
250#else
251 // dedicated to Smartphones
252 #include "wx/choicebk.h"
253 #define wxBookCtrl wxChoicebook
254 #define wxBookCtrlEvent wxChoicebookEvent
255 #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
256 #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
257 #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn) EVT_CHOICEBOOK_PAGE_CHANGED(id, fn)
258 #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn) EVT_CHOICEBOOK_PAGE_CHANGING(id, fn)
259 #define wxBC_TOP wxCHB_TOP
260 #define wxBC_BOTTOM wxCHB_BOTTOM
261 #define wxBC_LEFT wxCHB_LEFT
262 #define wxBC_RIGHT wxCHB_RIGHT
263 #define wxBC_DEFAULT wxCHB_DEFAULT
61c083e7
WS
264#endif
265
15aad3b9
VZ
266#endif // wxUSE_BOOKCTRL
267
268#endif // _WX_BOOKCTRL_H_