no changes, just remove #if'd out code
[wxWidgets.git] / include / wx / gtk1 / notebook.h
CommitLineData
53b28675 1/////////////////////////////////////////////////////////////////////////////
8ef94bfc 2// Name: wx/gtk1/notebook.h
716b7364 3// Purpose: wxNotebook class
53b28675
RR
4// Author: Robert Roebling
5// Modified by:
6// RCS-ID: $Id$
b2b3ccc5 7// Copyright: (c) Julian Smart and Robert Roebling
65571936 8// Licence: wxWindows licence
53b28675
RR
9/////////////////////////////////////////////////////////////////////////////
10
6ca41e57
RR
11#ifndef __GTKNOTEBOOKH__
12#define __GTKNOTEBOOKH__
53b28675 13
80a58c99
RR
14//-----------------------------------------------------------------------------
15// internal class
16//-----------------------------------------------------------------------------
17
b5dbe15d 18class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;
53b28675 19
07b8d7ec
VZ
20#include "wx/list.h"
21WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
22
53b28675 23//-----------------------------------------------------------------------------
ff829f3f 24// wxNotebook
53b28675
RR
25//-----------------------------------------------------------------------------
26
20123d49 27class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
53b28675 28{
ff829f3f 29public:
8253c7fd
RR
30 // default for dynamic class
31 wxNotebook();
32 // the same arguments as for wxControl
33 wxNotebook(wxWindow *parent,
debe6624 34 wxWindowID id,
ff829f3f
VZ
35 const wxPoint& pos = wxDefaultPosition,
36 const wxSize& size = wxDefaultSize,
debe6624 37 long style = 0,
630ad6c6 38 const wxString& name = wxNotebookNameStr);
8253c7fd
RR
39 // Create() function
40 bool Create(wxWindow *parent,
debe6624 41 wxWindowID id,
ff829f3f
VZ
42 const wxPoint& pos = wxDefaultPosition,
43 const wxSize& size = wxDefaultSize,
debe6624 44 long style = 0,
630ad6c6 45 const wxString& name = wxNotebookNameStr);
8253c7fd 46 // dtor
07b8d7ec 47 virtual ~wxNotebook();
ff829f3f
VZ
48
49 // accessors
50 // ---------
ff829f3f
VZ
51
52 // set the currently selected page, return the index of the previously
53 // selected one (or -1 on error)
54 // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
1d6fcbcc 55 int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }
ff829f3f 56 // get the currently selected page
1d6fcbcc
VZ
57 int GetSelection() const;
58
59 // changes selected page without sending events
60 int ChangeSelection(size_t nPage) { return DoSetSelection(nPage); }
ff829f3f
VZ
61
62 // set/get the title of a page
15aad3b9
VZ
63 bool SetPageText(size_t nPage, const wxString& strText);
64 wxString GetPageText(size_t nPage) const;
ff829f3f 65
ff829f3f 66 // sets/returns item's image index in the current image list
15aad3b9
VZ
67 int GetPageImage(size_t nPage) const;
68 bool SetPageImage(size_t nPage, int nImage);
ff829f3f 69
ff829f3f
VZ
70 // control the appearance of the notebook pages
71 // set the size (the same for all pages)
72 void SetPageSize(const wxSize& size);
73 // set the padding between tabs (in pixels)
74 void SetPadding(const wxSize& padding);
d8f2439c 75 // sets the size of the tabs (assumes all tabs are the same size)
ca8b28f2
JS
76 void SetTabSize(const wxSize& sz);
77
279b5e2e
VZ
78 virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
79
ff829f3f
VZ
80 // operations
81 // ----------
ff829f3f
VZ
82 // remove all pages
83 bool DeleteAllPages();
1e6feb95 84
90e572f1 85 // adds a new page to the notebook (it will be deleted by the notebook,
ff829f3f 86 // don't delete it yourself). If bSelect, this page becomes active.
587ce561 87 // the same as AddPage(), but adds it at the specified position
789d0a3d 88 bool InsertPage( size_t position,
80a58c99
RR
89 wxNotebookPage *win,
90 const wxString& strText,
630ad6c6 91 bool bSelect = false,
80a58c99 92 int imageId = -1 );
ff829f3f 93
8253c7fd
RR
94 // handler for tab navigation
95 // --------------------------
96 void OnNavigationKey(wxNavigationKeyEvent& event);
ed58dbea 97
9d522606
RD
98
99 static wxVisualAttributes
100 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
630ad6c6 101
db434467
RR
102 // implementation
103 // --------------
d8f2439c 104
93d38175 105#if wxUSE_CONSTRAINTS
db434467
RR
106 void SetConstraintSizes(bool recurse);
107 bool DoPhase(int phase);
93d38175
VS
108#endif
109
718e35a6 110 // set all page's attributes
f40fdaa3 111 void DoApplyWidgetStyle(GtkRcStyle *style);
ff829f3f 112
1e6feb95 113 // report if window belongs to notebook
db434467 114 bool IsOwnGtkWindow( GdkWindow *window );
58d1c1ae 115
db434467
RR
116 // common part of all ctors
117 void Init();
ff829f3f 118
db434467 119 // helper function
80a58c99 120 wxGtkNotebookPage* GetNotebookPage(int page) const;
ff829f3f 121
07b8d7ec
VZ
122 // the additional page data (the pages themselves are in m_pages array)
123 wxGtkNotebookPagesList m_pagesData;
36202885
VZ
124
125 // for reasons explained in gtk/notebook.cpp we store the current
126 // selection internally instead of querying the notebook for it
07b8d7ec 127 int m_selection;
53b28675 128
630ad6c6 129 // flag set to true while we're inside "switch_page" callback
2b5f62a0
VZ
130 bool m_inSwitchPage;
131
1d6fcbcc
VZ
132 // flag set to true when the switch-page signal has been programatically generated
133 bool m_skipNextPageChangeEvent;
134
1e6feb95
VZ
135protected:
136 // remove one page from the notebook but do not destroy it
15aad3b9 137 virtual wxNotebookPage *DoRemovePage(size_t nPage);
1e6feb95 138
1d6fcbcc
VZ
139 int DoSetSelection(size_t nPage, int flags = 0);
140
db434467 141private:
2b5f62a0 142 // the padding set by SetPadding()
b318dc42
JS
143 int m_padding;
144
db434467
RR
145 DECLARE_DYNAMIC_CLASS(wxNotebook)
146 DECLARE_EVENT_TABLE()
53b28675
RR
147};
148
53b28675 149#endif
6ca41e57 150 // __GTKNOTEBOOKH__