]> git.saurik.com Git - wxWidgets.git/blame - include/wx/stubs/notebook.h
new wxTreeCtrl files
[wxWidgets.git] / include / wx / stubs / notebook.h
CommitLineData
7c23a0b0
JS
1/////////////////////////////////////////////////////////////////////////////
2// Name: notebook.h
3// Purpose: MSW/GTK compatible notebook (a.k.a. property sheet)
4// Author: AUTHOR
5// Modified by:
6// RCS-ID: $Id$
7// Copyright: (c) AUTHOR
8// Licence: wxWindows licence
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_NOTEBOOK_H_
12#define _WX_NOTEBOOK_H_
13
14#ifdef __GNUG__
15#pragma interface "notebook.h"
16#endif
17
18// ----------------------------------------------------------------------------
19// headers
20// ----------------------------------------------------------------------------
34138703
JS
21#include "wx/dynarray.h"
22#include "wx/event.h"
23#include "wx/control.h"
7c23a0b0
JS
24
25// ----------------------------------------------------------------------------
26// types
27// ----------------------------------------------------------------------------
28
29// fwd declarations
30class WXDLLEXPORT wxImageList;
31class WXDLLEXPORT wxWindow;
32
33// array of notebook pages
34typedef wxWindow wxNotebookPage; // so far, any window can be a page
35WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
36
37// ----------------------------------------------------------------------------
38// notebook events
39// ----------------------------------------------------------------------------
40class WXDLLEXPORT wxNotebookEvent : public wxCommandEvent
41{
42public:
43 wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
44 int nSel = -1, int nOldSel = -1)
45 : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }
46
47 // accessors
48 int GetSelection() const { return m_nSel; }
49 int GetOldSelection() const { return m_nOldSel; }
50
51private:
52 int m_nSel, // currently selected page
53 m_nOldSel; // previously selected page
54
55 DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
56};
57
58// ----------------------------------------------------------------------------
59// wxNotebook
60// ----------------------------------------------------------------------------
61
62// @@@ this class should really derive from wxTabCtrl, but the interface is not
63// exactly the same, so I can't do it right now and instead we reimplement
64// part of wxTabCtrl here
65class wxNotebook : public wxControl
66{
67public:
68 // ctors
69 // -----
70 // default for dynamic class
71 wxNotebook();
72 // the same arguments as for wxControl (@@@ any special styles?)
73 wxNotebook(wxWindow *parent,
74 wxWindowID id,
75 const wxPoint& pos = wxDefaultPosition,
76 const wxSize& size = wxDefaultSize,
77 long style = 0,
78 const wxString& name = "notebook");
79 // Create() function
80 bool Create(wxWindow *parent,
81 wxWindowID id,
82 const wxPoint& pos = wxDefaultPosition,
83 const wxSize& size = wxDefaultSize,
84 long style = 0,
85 const wxString& name = "notebook");
86 // dtor
87 ~wxNotebook();
88
89 // accessors
90 // ---------
91 // get number of pages in the dialog
92 int GetPageCount() const;
93
94 // set the currently selected page, return the index of the previously
95 // selected one (or -1 on error)
96 // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
97 int SetSelection(int nPage);
98 // cycle thru the tabs
99 void AdvanceSelection(bool bForward = TRUE);
100 // get the currently selected page
101 int GetSelection() const { return m_nSelection; }
102
103 // set/get the title of a page
104 bool SetPageText(int nPage, const wxString& strText);
105 wxString GetPageText(int nPage) const;
106
107 // image list stuff: each page may have an image associated with it. All
108 // the images belong to an image list, so you have to
109 // 1) create an image list
110 // 2) associate it with the notebook
111 // 3) set for each page it's image
112 // associate image list with a control
113 void SetImageList(wxImageList* imageList);
114 // get pointer (may be NULL) to the associated image list
115 wxImageList* GetImageList() const { return m_pImageList; }
116
117 // sets/returns item's image index in the current image list
118 int GetPageImage(int nPage) const;
119 bool SetPageImage(int nPage, int nImage);
120
121 // currently it's always 1 because wxGTK doesn't support multi-row
122 // tab controls
123 int GetRowCount() const;
124
125 // control the appearance of the notebook pages
126 // set the size (the same for all pages)
127 void SetPageSize(const wxSize& size);
128 // set the padding between tabs (in pixels)
129 void SetPadding(const wxSize& padding);
130
131 // operations
132 // ----------
133 // remove one page from the notebook
134 bool DeletePage(int nPage);
135 // remove all pages
136 bool DeleteAllPages();
137 // adds a new page to the notebook (it will be deleted ny the notebook,
138 // don't delete it yourself). If bSelect, this page becomes active.
139 bool AddPage(wxNotebookPage *pPage,
140 const wxString& strText,
141 bool bSelect = FALSE,
142 int imageId = -1);
143 // the same as AddPage(), but adds it at the specified position
144 bool InsertPage(int nPage,
145 wxNotebookPage *pPage,
146 const wxString& strText,
147 bool bSelect = FALSE,
148 int imageId = -1);
149 // get the panel which represents the given page
150 wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
151
152 // callbacks
153 // ---------
154 void OnSize(wxSizeEvent& event);
155 void OnSelChange(wxNotebookEvent& event);
156 void OnSetFocus(wxFocusEvent& event);
157 void OnNavigationKey(wxNavigationKeyEvent& event);
158
159 // base class virtuals
160 // -------------------
161 virtual void Command(wxCommandEvent& event);
162 virtual void SetConstraintSizes(bool recurse = TRUE);
163 virtual bool DoPhase(int nPhase);
164
165protected:
166 // common part of all ctors
167 void Init();
168
169 // helper functions
170 void ChangePage(int nOldSel, int nSel); // change pages
171
172 wxImageList *m_pImageList; // we can have an associated image list
173 wxArrayPages m_aPages; // array of pages
174
175 int m_nSelection; // the current selection (-1 if none)
176
177 DECLARE_DYNAMIC_CLASS(wxNotebook)
178 DECLARE_EVENT_TABLE()
179};
180
181// ----------------------------------------------------------------------------
182// event macros
183// ----------------------------------------------------------------------------
184typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
185
186#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \
187 { \
188 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \
189 id, \
190 -1, \
191 (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
192 NULL \
193 },
194
195#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \
196 { \
197 wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \ \
198 id, \
199 -1, \
200 (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \
201 NULL \
202 },
203
204#endif // _WX_NOTEBOOK_H_