]>
Commit | Line | Data |
---|---|---|
b5f2afe5 VZ |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: msw/notebook.h | |
3 | // Purpose: MSW/GTK compatible notebook (a.k.a. property sheet) | |
4 | // Author: Robert Roebling | |
5 | // Modified by: Vadim Zeitlin for Windows version | |
6 | // RCS-ID: $Id$ | |
371a5b4e JS |
7 | // Copyright: (c) Julian Smart |
8 | // Licence: wxWindows licence | |
b5f2afe5 VZ |
9 | ///////////////////////////////////////////////////////////////////////////// |
10 | ||
11 | #ifndef _NOTEBOOK_H | |
12 | #define _NOTEBOOK_H | |
13 | ||
14 | #ifdef __GNUG__ | |
15 | #pragma interface "notebook.h" | |
16 | #endif | |
17 | ||
1e6feb95 VZ |
18 | #if wxUSE_NOTEBOOK |
19 | ||
b5f2afe5 VZ |
20 | // ---------------------------------------------------------------------------- |
21 | // headers | |
22 | // ---------------------------------------------------------------------------- | |
74b31181 | 23 | |
7c0ea335 | 24 | #include "wx/control.h" |
b5f2afe5 | 25 | |
b5f2afe5 VZ |
26 | // ---------------------------------------------------------------------------- |
27 | // wxNotebook | |
28 | // ---------------------------------------------------------------------------- | |
29 | ||
1e6feb95 | 30 | class WXDLLEXPORT wxNotebook : public wxNotebookBase |
b5f2afe5 VZ |
31 | { |
32 | public: | |
33 | // ctors | |
34 | // ----- | |
35 | // default for dynamic class | |
36 | wxNotebook(); | |
37 | // the same arguments as for wxControl (@@@ any special styles?) | |
38 | wxNotebook(wxWindow *parent, | |
35eca07c | 39 | wxWindowID id, |
b5f2afe5 VZ |
40 | const wxPoint& pos = wxDefaultPosition, |
41 | const wxSize& size = wxDefaultSize, | |
debe6624 | 42 | long style = 0, |
2b5f62a0 | 43 | const wxString& name = wxNOTEBOOK_NAME); |
b5f2afe5 VZ |
44 | // Create() function |
45 | bool Create(wxWindow *parent, | |
35eca07c | 46 | wxWindowID id, |
b5f2afe5 VZ |
47 | const wxPoint& pos = wxDefaultPosition, |
48 | const wxSize& size = wxDefaultSize, | |
debe6624 | 49 | long style = 0, |
2b5f62a0 | 50 | const wxString& name = wxNOTEBOOK_NAME); |
b5f2afe5 VZ |
51 | |
52 | // accessors | |
53 | // --------- | |
54 | // get number of pages in the dialog | |
55 | int GetPageCount() const; | |
56 | ||
57 | // set the currently selected page, return the index of the previously | |
58 | // selected one (or -1 on error) | |
59 | // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events | |
60 | int SetSelection(int nPage); | |
b5f2afe5 VZ |
61 | // get the currently selected page |
62 | int GetSelection() const { return m_nSelection; } | |
63 | ||
64 | // set/get the title of a page | |
65 | bool SetPageText(int nPage, const wxString& strText); | |
66 | wxString GetPageText(int nPage) const; | |
67 | ||
68 | // image list stuff: each page may have an image associated with it. All | |
69 | // the images belong to an image list, so you have to | |
70 | // 1) create an image list | |
71 | // 2) associate it with the notebook | |
72 | // 3) set for each page it's image | |
73 | // associate image list with a control | |
74 | void SetImageList(wxImageList* imageList); | |
b5f2afe5 VZ |
75 | |
76 | // sets/returns item's image index in the current image list | |
77 | int GetPageImage(int nPage) const; | |
78 | bool SetPageImage(int nPage, int nImage); | |
79 | ||
b5f2afe5 VZ |
80 | // currently it's always 1 because wxGTK doesn't support multi-row |
81 | // tab controls | |
82 | int GetRowCount() const; | |
83 | ||
84 | // control the appearance of the notebook pages | |
85 | // set the size (the same for all pages) | |
86 | void SetPageSize(const wxSize& size); | |
87 | // set the padding between tabs (in pixels) | |
88 | void SetPadding(const wxSize& padding); | |
89 | ||
90 | // operations | |
91 | // ---------- | |
b5f2afe5 VZ |
92 | // remove all pages |
93 | bool DeleteAllPages(); | |
efa14cf2 | 94 | // inserts a new page to the notebook (it will be deleted ny the notebook, |
b5f2afe5 | 95 | // don't delete it yourself). If bSelect, this page becomes active. |
b5f2afe5 VZ |
96 | bool InsertPage(int nPage, |
97 | wxNotebookPage *pPage, | |
98 | const wxString& strText, | |
99 | bool bSelect = FALSE, | |
8a33ea62 | 100 | int imageId = -1); |
b5f2afe5 | 101 | |
58a8ab88 JS |
102 | // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH |
103 | // style. | |
104 | void SetTabSize(const wxSize& sz); | |
105 | ||
b5f2afe5 VZ |
106 | // callbacks |
107 | // --------- | |
9026ad85 | 108 | void OnSize(wxSizeEvent& event); |
b5f2afe5 | 109 | void OnSelChange(wxNotebookEvent& event); |
8a33ea62 VZ |
110 | void OnSetFocus(wxFocusEvent& event); |
111 | void OnNavigationKey(wxNavigationKeyEvent& event); | |
35eca07c | 112 | |
b5f2afe5 VZ |
113 | // base class virtuals |
114 | // ------------------- | |
0b481c72 | 115 | |
a23fd0e1 | 116 | virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); |
0df3fbd7 VZ |
117 | virtual bool MSWOnScroll(int orientation, WXWORD nSBCode, |
118 | WXWORD pos, WXHWND control); | |
0b481c72 VZ |
119 | |
120 | #if wxUSE_CONSTRAINTS | |
5475b960 VZ |
121 | virtual void SetConstraintSizes(bool recurse = TRUE); |
122 | virtual bool DoPhase(int nPhase); | |
0b481c72 | 123 | #endif // wxUSE_CONSTRAINTS |
b5f2afe5 VZ |
124 | |
125 | protected: | |
126 | // common part of all ctors | |
127 | void Init(); | |
128 | ||
0df3fbd7 VZ |
129 | // translate wxWin styles to the Windows ones |
130 | virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const; | |
131 | ||
1e6feb95 VZ |
132 | // remove one page from the notebook, without deleting |
133 | virtual wxNotebookPage *DoRemovePage(int nPage); | |
134 | ||
2015f2b3 VZ |
135 | // set the size of the given page to fit in the notebook |
136 | void AdjustPageSize(wxNotebookPage *page); | |
137 | ||
138 | ||
2b5f62a0 VZ |
139 | // the current selection (-1 if none) |
140 | int m_nSelection; | |
b5f2afe5 | 141 | |
2015f2b3 | 142 | |
b5f2afe5 VZ |
143 | DECLARE_DYNAMIC_CLASS(wxNotebook) |
144 | DECLARE_EVENT_TABLE() | |
145 | }; | |
146 | ||
1e6feb95 VZ |
147 | #endif // wxUSE_NOTEBOOK |
148 | ||
b5f2afe5 | 149 | #endif // _NOTEBOOK_H |