Just a teeny change -- addition of wxFrame::IsMaximized. For wxMDIChildFrame
[wxWidgets.git] / include / wx / motif / mdi.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: mdi.h
3 // Purpose: MDI (Multiple Document Interface) classes.
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 17/09/98
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_MDI_H_
13 #define _WX_MDI_H_
14
15 #ifdef __GNUG__
16 #pragma interface "mdi.h"
17 #endif
18
19 /*
20 New MDI scheme using tabs. We can use a wxNotebook to implement the client
21 window. wxMDIChildFrame can be implemented as an XmMainWindow widget
22 as before, and is a child of the notebook _and_ of the parent frame...
23 but wxMDIChildFrame::GetParent should return the parent frame.
24
25 */
26
27 #include "wx/frame.h"
28 #include "wx/notebook.h"
29
30 WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
31 WXDLLEXPORT_DATA(extern const char*) wxStatusLineNameStr;
32
33 class WXDLLEXPORT wxMDIClientWindow;
34 class WXDLLEXPORT wxMDIChildFrame;
35
36 class WXDLLEXPORT wxMDIParentFrame: public wxFrame
37 {
38 DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
39
40 friend class WXDLLEXPORT wxMDIChildFrame;
41 public:
42
43 wxMDIParentFrame();
44 inline wxMDIParentFrame(wxWindow *parent,
45 wxWindowID id,
46 const wxString& title,
47 const wxPoint& pos = wxDefaultPosition,
48 const wxSize& size = wxDefaultSize,
49 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL, // Scrolling refers to client window
50 const wxString& name = wxFrameNameStr)
51 {
52 Create(parent, id, title, pos, size, style, name);
53 }
54
55 ~wxMDIParentFrame();
56
57 bool Create(wxWindow *parent,
58 wxWindowID id,
59 const wxString& title,
60 const wxPoint& pos = wxDefaultPosition,
61 const wxSize& size = wxDefaultSize,
62 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
63 const wxString& name = wxFrameNameStr);
64
65 void OnSize(wxSizeEvent& event);
66 void OnActivate(wxActivateEvent& event);
67 void OnSysColourChanged(wxSysColourChangedEvent& event);
68
69 void SetMenuBar(wxMenuBar *menu_bar);
70
71 // Gets the size available for subwindows after menu size, toolbar size
72 // and status bar size have been subtracted. If you want to manage your own
73 // toolbar(s), don't call SetToolBar.
74 void GetClientSize(int *width, int *height) const;
75 wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
76
77 // Get the active MDI child window
78 wxMDIChildFrame *GetActiveChild() const ;
79
80 // Get the client window
81 inline wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; };
82
83 // Create the client window class (don't Create the window,
84 // just return a new class)
85 virtual wxMDIClientWindow *OnCreateClient() ;
86
87 // MDI operations
88 virtual void Cascade();
89 virtual void Tile();
90 virtual void ArrangeIcons();
91 virtual void ActivateNext();
92 virtual void ActivatePrevious();
93
94 // Implementation
95
96 // Set the active child
97 inline void SetActiveChild(wxMDIChildFrame* child) { m_activeChild = child; }
98
99 // Set the child's menubar into the parent frame
100 void SetChildMenuBar(wxMDIChildFrame* frame);
101
102 inline wxMenuBar* GetActiveMenuBar() const { return m_activeMenuBar; }
103
104 // Redirect events to active child first
105 virtual bool ProcessEvent(wxEvent& event);
106
107
108 protected:
109
110 wxMDIClientWindow* m_clientWindow;
111 wxMDIChildFrame* m_activeChild;
112 wxMenuBar* m_activeMenuBar;
113
114 DECLARE_EVENT_TABLE()
115 };
116
117 class WXDLLEXPORT wxMDIChildFrame: public wxFrame
118 {
119 DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
120 public:
121
122 wxMDIChildFrame();
123 inline wxMDIChildFrame(wxMDIParentFrame *parent,
124 wxWindowID id,
125 const wxString& title,
126 const wxPoint& pos = wxDefaultPosition,
127 const wxSize& size = wxDefaultSize,
128 long style = wxDEFAULT_FRAME_STYLE,
129 const wxString& name = wxFrameNameStr)
130 {
131 Create(parent, id, title, pos, size, style, name);
132 }
133
134 ~wxMDIChildFrame();
135
136 bool Create(wxMDIParentFrame *parent,
137 wxWindowID id,
138 const wxString& title,
139 const wxPoint& pos = wxDefaultPosition,
140 const wxSize& size = wxDefaultSize,
141 long style = wxDEFAULT_FRAME_STYLE,
142 const wxString& name = wxFrameNameStr);
143
144 // Set menu bar
145 void SetMenuBar(wxMenuBar *menu_bar);
146 void SetTitle(const wxString& title);
147
148 void SetClientSize(int width, int height);
149 void SetClientSize(const wxSize& size) { wxWindow::SetClientSize(size); }
150
151 void GetClientSize(int *width, int *height) const;
152 wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
153
154 void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
155 virtual void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
156 { wxWindow::SetSize(rect, sizeFlags); }
157 virtual void SetSize(const wxSize& size) { wxWindow::SetSize(size); }
158
159 void GetSize(int *width, int *height) const;
160 wxSize GetSize() const { return wxWindow::GetSize(); }
161
162 void GetPosition(int *x, int *y) const ;
163 wxPoint GetPosition() const { return wxWindow::GetPosition(); }
164
165 // Set icon
166 virtual void SetIcon(const wxIcon& icon);
167
168 // Override wxFrame operations
169 void CaptureMouse();
170 void ReleaseMouse();
171 void Raise();
172 void Lower(void);
173 void SetSizeHints(int minW = -1, int minH = -1, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1);
174
175 // MDI operations
176 virtual void Maximize();
177 inline void Minimize() { Iconize(TRUE); };
178 virtual void Iconize(bool iconize);
179 virtual void Restore();
180 virtual void Activate();
181 virtual bool IsIconized() const ;
182
183 // Is the frame maximized? Returns TRUE for
184 // wxMDIChildFrame due to the tabbed implementation.
185 virtual bool IsMaximized(void) const ;
186
187 bool Show(bool show);
188
189 inline WXWidget GetMainWidget() const { return m_mainWidget; };
190 inline WXWidget GetTopWidget() const { return m_mainWidget; };
191 inline WXWidget GetClientWidget() const { return m_mainWidget; };
192
193 /*
194 virtual void OnRaise();
195 virtual void OnLower();
196 */
197
198 inline void SetMDIParentFrame(wxMDIParentFrame* parentFrame) { m_mdiParentFrame = parentFrame; }
199 inline wxMDIParentFrame* GetMDIParentFrame() const { return m_mdiParentFrame; }
200
201 protected:
202 wxMDIParentFrame* m_mdiParentFrame;
203 };
204
205 /* The client window is a child of the parent MDI frame, and itself
206 * contains the child MDI frames.
207 * However, you create the MDI children as children of the MDI parent:
208 * only in the implementation does the client window become the parent
209 * of the children. Phew! So the children are sort of 'adopted'...
210 */
211
212 class WXDLLEXPORT wxMDIClientWindow: public wxNotebook
213 {
214 DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
215 public:
216
217 wxMDIClientWindow() ;
218 inline wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
219 {
220 CreateClient(parent, style);
221 }
222
223 ~wxMDIClientWindow();
224
225 void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
226 void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
227 { wxWindow::SetSize(rect, sizeFlags); }
228 void SetSize(const wxSize& size) { wxWindow::SetSize(size); }
229
230 void SetClientSize(int width, int height);
231 void SetClientSize(const wxSize& size) { wxWindow::SetClientSize(size); }
232
233 void GetClientSize(int *width, int *height) const;
234 wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
235
236 void GetSize(int *width, int *height) const ;
237 wxSize GetSize() const { return wxWindow::GetSize(); }
238
239 void GetPosition(int *x, int *y) const ;
240 wxPoint GetPosition() const { return wxWindow::GetPosition(); }
241
242 // Note: this is virtual, to allow overridden behaviour.
243 virtual bool CreateClient(wxMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL);
244
245 // Explicitly call default scroll behaviour
246 void OnScroll(wxScrollEvent& event);
247
248 // Implementation
249 void OnPageChanged(wxNotebookEvent& event);
250
251 protected:
252
253 DECLARE_EVENT_TABLE()
254 };
255
256 #endif
257 // _WX_MDI_H_