]> git.saurik.com Git - wxWidgets.git/blob - include/wx/aui/tabmdi.h
Reserve the whole style byte for styles. See #14688
[wxWidgets.git] / include / wx / aui / tabmdi.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/aui/tabmdi.h
3 // Purpose: Generic MDI (Multiple Document Interface) classes
4 // Author: Hans Van Leemputten
5 // Modified by: Benjamin I. Williams / Kirix Corporation
6 // Created: 29/07/2002
7 // RCS-ID: $Id$
8 // Copyright: (c) Hans Van Leemputten
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_AUITABMDI_H_
13 #define _WX_AUITABMDI_H_
14
15 #if wxUSE_AUI
16
17 // ----------------------------------------------------------------------------
18 // headers
19 // ----------------------------------------------------------------------------
20
21 #include "wx/frame.h"
22 #include "wx/panel.h"
23 #include "wx/notebook.h"
24 #include "wx/icon.h"
25 #include "wx/aui/auibook.h"
26
27 //-----------------------------------------------------------------------------
28 // classes
29 //-----------------------------------------------------------------------------
30
31 class WXDLLIMPEXP_FWD_AUI wxAuiMDIParentFrame;
32 class WXDLLIMPEXP_FWD_AUI wxAuiMDIClientWindow;
33 class WXDLLIMPEXP_FWD_AUI wxAuiMDIChildFrame;
34
35 //-----------------------------------------------------------------------------
36 // wxAuiMDIParentFrame
37 //-----------------------------------------------------------------------------
38
39 class WXDLLIMPEXP_AUI wxAuiMDIParentFrame : public wxFrame
40 {
41 public:
42 wxAuiMDIParentFrame();
43 wxAuiMDIParentFrame(wxWindow *parent,
44 wxWindowID winid,
45 const wxString& title,
46 const wxPoint& pos = wxDefaultPosition,
47 const wxSize& size = wxDefaultSize,
48 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
49 const wxString& name = wxFrameNameStr);
50
51 ~wxAuiMDIParentFrame();
52
53 bool Create(wxWindow *parent,
54 wxWindowID winid,
55 const wxString& title,
56 const wxPoint& pos = wxDefaultPosition,
57 const wxSize& size = wxDefaultSize,
58 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
59 const wxString& name = wxFrameNameStr );
60
61 void SetArtProvider(wxAuiTabArt* provider);
62 wxAuiTabArt* GetArtProvider();
63 wxAuiNotebook* GetNotebook() const;
64
65 #if wxUSE_MENUS
66 wxMenu* GetWindowMenu() const { return m_pWindowMenu; }
67 void SetWindowMenu(wxMenu* pMenu);
68
69 virtual void SetMenuBar(wxMenuBar *pMenuBar);
70 #endif // wxUSE_MENUS
71
72 void SetChildMenuBar(wxAuiMDIChildFrame *pChild);
73
74 wxAuiMDIChildFrame *GetActiveChild() const;
75 void SetActiveChild(wxAuiMDIChildFrame* pChildFrame);
76
77 wxAuiMDIClientWindow *GetClientWindow() const;
78 virtual wxAuiMDIClientWindow *OnCreateClient();
79
80 virtual void Cascade() { /* Has no effect */ }
81 virtual void Tile(wxOrientation orient = wxHORIZONTAL);
82 virtual void ArrangeIcons() { /* Has no effect */ }
83 virtual void ActivateNext();
84 virtual void ActivatePrevious();
85
86 protected:
87 wxAuiMDIClientWindow* m_pClientWindow;
88 wxAuiMDIChildFrame* m_pActiveChild;
89 wxEvent* m_pLastEvt;
90
91 #if wxUSE_MENUS
92 wxMenu *m_pWindowMenu;
93 wxMenuBar *m_pMyMenuBar;
94 #endif // wxUSE_MENUS
95
96 protected:
97 void Init();
98
99 #if wxUSE_MENUS
100 void RemoveWindowMenu(wxMenuBar *pMenuBar);
101 void AddWindowMenu(wxMenuBar *pMenuBar);
102
103 void DoHandleMenu(wxCommandEvent &event);
104 void DoHandleUpdateUI(wxUpdateUIEvent &event);
105 #endif // wxUSE_MENUS
106
107 virtual bool ProcessEvent(wxEvent& event);
108
109 virtual void DoGetClientSize(int *width, int *height) const;
110
111 private:
112 DECLARE_EVENT_TABLE()
113 DECLARE_DYNAMIC_CLASS(wxAuiMDIParentFrame)
114 };
115
116 //-----------------------------------------------------------------------------
117 // wxAuiMDIChildFrame
118 //-----------------------------------------------------------------------------
119
120 class WXDLLIMPEXP_AUI wxAuiMDIChildFrame : public wxPanel
121 {
122 public:
123 wxAuiMDIChildFrame();
124 wxAuiMDIChildFrame(wxAuiMDIParentFrame *parent,
125 wxWindowID winid,
126 const wxString& title,
127 const wxPoint& pos = wxDefaultPosition,
128 const wxSize& size = wxDefaultSize,
129 long style = wxDEFAULT_FRAME_STYLE,
130 const wxString& name = wxFrameNameStr);
131
132 virtual ~wxAuiMDIChildFrame();
133 bool Create(wxAuiMDIParentFrame *parent,
134 wxWindowID winid,
135 const wxString& title,
136 const wxPoint& pos = wxDefaultPosition,
137 const wxSize& size = wxDefaultSize,
138 long style = wxDEFAULT_FRAME_STYLE,
139 const wxString& name = wxFrameNameStr);
140
141 #if wxUSE_MENUS
142 virtual void SetMenuBar(wxMenuBar *menuBar);
143 virtual wxMenuBar *GetMenuBar() const;
144 #endif // wxUSE_MENUS
145
146 virtual void SetTitle(const wxString& title);
147 virtual wxString GetTitle() const;
148
149 virtual void SetIcons(const wxIconBundle& icons);
150 virtual const wxIconBundle& GetIcons() const;
151
152 virtual void SetIcon(const wxIcon& icon);
153 virtual const wxIcon& GetIcon() const;
154
155 virtual void Activate();
156 virtual bool Destroy();
157
158 virtual bool Show(bool show = true);
159
160 #if wxUSE_STATUSBAR
161 // no status bars
162 virtual wxStatusBar* CreateStatusBar(int WXUNUSED(number) = 1,
163 long WXUNUSED(style) = 1,
164 wxWindowID WXUNUSED(winid) = 1,
165 const wxString& WXUNUSED(name) = wxEmptyString)
166 { return NULL; }
167
168 virtual wxStatusBar *GetStatusBar() const { return NULL; }
169 virtual void SetStatusText( const wxString &WXUNUSED(text), int WXUNUSED(number)=0 ) {}
170 virtual void SetStatusWidths( int WXUNUSED(n), const int WXUNUSED(widths_field)[] ) {}
171 #endif
172
173 #if wxUSE_TOOLBAR
174 // no toolbar bars
175 virtual wxToolBar* CreateToolBar(long WXUNUSED(style),
176 wxWindowID WXUNUSED(winid),
177 const wxString& WXUNUSED(name))
178 { return NULL; }
179 virtual wxToolBar *GetToolBar() const { return NULL; }
180 #endif
181
182
183 // no maximize etc
184 virtual void Maximize(bool WXUNUSED(maximize) = true) { /* Has no effect */ }
185 virtual void Restore() { /* Has no effect */ }
186 virtual void Iconize(bool WXUNUSED(iconize) = true) { /* Has no effect */ }
187 virtual bool IsMaximized() const { return true; }
188 virtual bool IsIconized() const { return false; }
189 virtual bool ShowFullScreen(bool WXUNUSED(show), long WXUNUSED(style)) { return false; }
190 virtual bool IsFullScreen() const { return false; }
191
192 virtual bool IsTopLevel() const { return false; }
193
194 void OnMenuHighlight(wxMenuEvent& evt);
195 void OnActivate(wxActivateEvent& evt);
196 void OnCloseWindow(wxCloseEvent& evt);
197
198 void SetMDIParentFrame(wxAuiMDIParentFrame* parent);
199 wxAuiMDIParentFrame* GetMDIParentFrame() const;
200
201 protected:
202 void Init();
203 virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
204 virtual void DoMoveWindow(int x, int y, int width, int height);
205
206 // no size hints
207 virtual void DoSetSizeHints(int WXUNUSED(minW), int WXUNUSED(minH),
208 int WXUNUSED(maxW), int WXUNUSED(maxH),
209 int WXUNUSED(incW), int WXUNUSED(incH)) {}
210 public:
211 // This function needs to be called when a size change is confirmed,
212 // we needed this function to prevent anybody from the outside
213 // changing the panel... it messes the UI layout when we would allow it.
214 void ApplyMDIChildFrameRect();
215 void DoShow(bool show);
216
217 protected:
218 wxAuiMDIParentFrame* m_pMDIParentFrame;
219 wxRect m_mdiNewRect;
220 wxRect m_mdiCurRect;
221 wxString m_title;
222 wxIcon m_icon;
223 wxIconBundle m_iconBundle;
224 bool m_activateOnCreate;
225
226 #if wxUSE_MENUS
227 wxMenuBar* m_pMenuBar;
228 #endif // wxUSE_MENUS
229
230
231
232 private:
233 DECLARE_DYNAMIC_CLASS(wxAuiMDIChildFrame)
234 DECLARE_EVENT_TABLE()
235
236 friend class wxAuiMDIClientWindow;
237 };
238
239 //-----------------------------------------------------------------------------
240 // wxAuiMDIClientWindow
241 //-----------------------------------------------------------------------------
242
243 class WXDLLIMPEXP_AUI wxAuiMDIClientWindow : public wxAuiNotebook
244 {
245 public:
246 wxAuiMDIClientWindow();
247 wxAuiMDIClientWindow(wxAuiMDIParentFrame *parent, long style = 0);
248
249 virtual bool CreateClient(wxAuiMDIParentFrame *parent,
250 long style = wxVSCROLL | wxHSCROLL);
251
252 virtual int SetSelection(size_t page);
253
254 protected:
255
256 void PageChanged(int oldSelection, int newSelection);
257 void OnPageClose(wxAuiNotebookEvent& evt);
258 void OnPageChanged(wxAuiNotebookEvent& evt);
259 void OnSize(wxSizeEvent& evt);
260
261 private:
262 DECLARE_DYNAMIC_CLASS(wxAuiMDIClientWindow)
263 DECLARE_EVENT_TABLE()
264 };
265 #endif // wxUSE_AUI
266
267 #endif // _WX_AUITABMDI_H_