]>
Commit | Line | Data |
---|---|---|
7c78e7c7 RR |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: notebook.h | |
3 | // Purpose: wxNotebook class | |
4 | // Author: Robert Roebling | |
5 | // Modified by: | |
6 | // RCS-ID: $Id$ | |
7 | // Copyright: (c) Julian Smart and Markus Holzem | |
8 | // Licence: wxWindows license | |
9 | ///////////////////////////////////////////////////////////////////////////// | |
10 | ||
11 | #ifndef __NOTEBOOKH__ | |
12 | #define __NOTEBOOKH__ | |
13 | ||
14 | #ifdef __GNUG__ | |
15 | #pragma interface "notebook.h" | |
16 | #endif | |
17 | ||
18 | #include "wx/defs.h" | |
19 | #include "wx/object.h" | |
20 | #include "wx/string.h" | |
21 | #include "wx/control.h" | |
22 | ||
23 | //----------------------------------------------------------------------------- | |
24 | // classes | |
25 | //----------------------------------------------------------------------------- | |
26 | ||
27 | class wxImageList; | |
28 | class wxNotebook; | |
29 | class wxNotebookPage; | |
30 | ||
31 | // ---------------------------------------------------------------------------- | |
32 | // notebook events | |
33 | // ---------------------------------------------------------------------------- | |
34 | ||
35 | class wxNotebookEvent : public wxCommandEvent | |
36 | { | |
37 | public: | |
38 | wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0, | |
39 | int nSel = -1, int nOldSel = -1) | |
40 | : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; } | |
41 | ||
42 | // accessors | |
43 | int GetSelection() const { return m_nSel; } | |
44 | int GetOldSelection() const { return m_nOldSel; } | |
45 | ||
46 | private: | |
47 | int m_nSel, // currently selected page | |
48 | m_nOldSel; // previously selected page | |
49 | ||
50 | DECLARE_DYNAMIC_CLASS(wxNotebookEvent) | |
51 | }; | |
52 | ||
53 | //----------------------------------------------------------------------------- | |
54 | // wxNotebook | |
55 | //----------------------------------------------------------------------------- | |
56 | ||
57 | class wxNotebook : public wxControl | |
58 | { | |
59 | public: | |
60 | // ctors | |
61 | // ----- | |
62 | // default for dynamic class | |
63 | wxNotebook(); | |
64 | // the same arguments as for wxControl (@@@ any special styles?) | |
65 | wxNotebook(wxWindow *parent, | |
66 | wxWindowID id, | |
67 | const wxPoint& pos = wxDefaultPosition, | |
68 | const wxSize& size = wxDefaultSize, | |
69 | long style = 0, | |
70 | const wxString& name = "notebook"); | |
71 | // Create() function | |
72 | bool Create(wxWindow *parent, | |
73 | wxWindowID id, | |
74 | const wxPoint& pos = wxDefaultPosition, | |
75 | const wxSize& size = wxDefaultSize, | |
76 | long style = 0, | |
77 | const wxString& name = "notebook"); | |
78 | // dtor | |
79 | ~wxNotebook(); | |
80 | ||
81 | // accessors | |
82 | // --------- | |
83 | // get number of pages in the dialog | |
84 | int GetPageCount() const; | |
85 | ||
86 | // set the currently selected page, return the index of the previously | |
87 | // selected one (or -1 on error) | |
88 | // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events | |
89 | int SetSelection(int nPage); | |
90 | // cycle thru the tabs | |
91 | void AdvanceSelection(bool bForward = TRUE); | |
92 | // get the currently selected page | |
93 | int GetSelection() const; | |
94 | ||
95 | // set/get the title of a page | |
96 | bool SetPageText(int nPage, const wxString& strText); | |
97 | wxString GetPageText(int nPage) const; | |
98 | ||
99 | // image list stuff: each page may have an image associated with it. All | |
100 | // the images belong to an image list, so you have to | |
101 | // 1) create an image list | |
102 | // 2) associate it with the notebook | |
103 | // 3) set for each page it's image | |
104 | // associate image list with a control | |
105 | void SetImageList(wxImageList* imageList); | |
106 | // get pointer (may be NULL) to the associated image list | |
107 | wxImageList* GetImageList() const { return m_imageList; } | |
108 | ||
109 | // sets/returns item's image index in the current image list | |
110 | int GetPageImage(int nPage) const; | |
111 | bool SetPageImage(int nPage, int nImage); | |
112 | ||
113 | // currently it's always 1 because wxGTK doesn't support multi-row | |
114 | // tab controls | |
115 | int GetRowCount() const; | |
116 | ||
117 | // control the appearance of the notebook pages | |
118 | // set the size (the same for all pages) | |
119 | void SetPageSize(const wxSize& size); | |
120 | // set the padding between tabs (in pixels) | |
121 | void SetPadding(const wxSize& padding); | |
122 | ||
123 | // operations | |
124 | // ---------- | |
125 | // remove one page from the notebook | |
126 | bool DeletePage(int nPage); | |
127 | // remove all pages | |
128 | bool DeleteAllPages(); | |
129 | // adds a new page to the notebook (it will be deleted ny the notebook, | |
130 | // don't delete it yourself). If bSelect, this page becomes active. | |
131 | bool AddPage(wxWindow *pPage, | |
132 | const wxString& strText, | |
133 | bool bSelect = FALSE, | |
134 | int imageId = -1); | |
135 | // @@@@ VZ: I don't know how to implement InsertPage() | |
136 | ||
137 | // get the panel which represents the given page | |
138 | wxWindow *GetPage(int nPage) const; | |
139 | ||
140 | // implementation | |
141 | // -------------- | |
142 | // base class virtuals | |
143 | virtual void AddChild(wxWindow *child); | |
144 | virtual void SetConstraintSizes(bool recurse); | |
145 | virtual bool DoPhase(int phase); | |
146 | ||
147 | private: | |
148 | // common part of all ctors | |
149 | void Init(); | |
150 | ||
151 | wxImageList* m_imageList; | |
152 | wxList m_pages; | |
153 | ||
154 | DECLARE_DYNAMIC_CLASS(wxNotebook) | |
155 | }; | |
156 | ||
157 | // ---------------------------------------------------------------------------- | |
158 | // event macros | |
159 | // ---------------------------------------------------------------------------- | |
160 | typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&); | |
161 | ||
162 | #define EVT_NOTEBOOK_PAGE_CHANGED(id, fn) \ | |
163 | { \ | |
164 | wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, \ | |
165 | id, \ | |
166 | -1, \ | |
167 | (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \ | |
168 | NULL \ | |
169 | }, | |
170 | ||
171 | #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn) \ | |
172 | { \ | |
173 | wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \ \ | |
174 | id, \ | |
175 | -1, \ | |
176 | (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn, \ | |
177 | NULL \ | |
178 | }, | |
179 | ||
180 | #endif | |
181 | // __NOTEBOOKH__ |