]> git.saurik.com Git - wxWidgets.git/blob - include/wx/motif/frame.h
no message
[wxWidgets.git] / include / wx / motif / frame.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: frame.h
3 // Purpose: wxFrame class
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_FRAME_H_
13 #define _WX_FRAME_H_
14
15 #ifdef __GNUG__
16 #pragma interface "frame.h"
17 #endif
18
19 #include "wx/window.h"
20 #include "wx/toolbar.h"
21 #include "wx/accel.h"
22
23 WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
24 WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
25
26 class WXDLLEXPORT wxMenuBar;
27 class WXDLLEXPORT wxStatusBar;
28
29 class WXDLLEXPORT wxFrame: public wxWindow {
30
31 DECLARE_DYNAMIC_CLASS(wxFrame)
32
33 public:
34 wxFrame();
35 inline wxFrame(wxWindow *parent,
36 wxWindowID id,
37 const wxString& title,
38 const wxPoint& pos = wxDefaultPosition,
39 const wxSize& size = wxDefaultSize,
40 long style = wxDEFAULT_FRAME_STYLE,
41 const wxString& name = wxFrameNameStr)
42 {
43 Create(parent, id, title, pos, size, style, name);
44 }
45
46 ~wxFrame();
47
48 bool Create(wxWindow *parent,
49 wxWindowID id,
50 const wxString& title,
51 const wxPoint& pos = wxDefaultPosition,
52 const wxSize& size = wxDefaultSize,
53 long style = wxDEFAULT_FRAME_STYLE,
54 const wxString& name = wxFrameNameStr);
55
56 virtual bool Destroy();
57
58 void SetClientSize(int width, int height);
59 void SetClientSize(const wxSize& size) { wxWindow::SetClientSize(size); }
60
61 void GetClientSize(int *width, int *height) const;
62 wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
63
64 void GetSize(int *width, int *height) const ;
65 wxSize GetSize() const { return wxWindow::GetSize(); }
66
67 void GetPosition(int *x, int *y) const ;
68 wxPoint GetPosition() const { return wxWindow::GetPosition(); }
69
70 void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
71 virtual void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
72 { wxWindow::SetSize(rect, sizeFlags); }
73 virtual void SetSize(const wxSize& size) { wxWindow::SetSize(size); }
74
75 void ClientToScreen(int *x, int *y) const;
76 wxPoint ClientToScreen(const wxPoint& pt) const { return wxWindow::ClientToScreen(pt); }
77
78 void ScreenToClient(int *x, int *y) const;
79 wxPoint ScreenToClient(const wxPoint& pt) const { return wxWindow::ScreenToClient(pt); }
80
81 virtual bool OnClose();
82
83 void OnSize(wxSizeEvent& event);
84 void OnMenuHighlight(wxMenuEvent& event);
85 void OnActivate(wxActivateEvent& event);
86 void OnIdle(wxIdleEvent& event);
87 void OnCloseWindow(wxCloseEvent& event);
88
89 bool Show(bool show);
90
91 // Set menu bar
92 void SetMenuBar(wxMenuBar *menu_bar);
93 virtual wxMenuBar *GetMenuBar() const ;
94
95 // Set title
96 void SetTitle(const wxString& title);
97 inline wxString GetTitle() const { return m_title; }
98
99 void Centre(int direction = wxBOTH);
100
101 // Call this to simulate a menu command
102 virtual void Command(int id);
103 virtual void ProcessCommand(int id);
104
105 // Set icon
106 virtual void SetIcon(const wxIcon& icon);
107
108 // Create status line
109 virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
110 const wxString& name = "statusBar");
111 inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
112 virtual void PositionStatusBar();
113 virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
114 const wxString& name);
115
116 // Create toolbar
117 virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1, const wxString& name = wxToolBarNameStr);
118 virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
119 // If made known to the frame, the frame will manage it automatically.
120 virtual void SetToolBar(wxToolBar *toolbar) ;
121 virtual wxToolBar *GetToolBar() const ;
122 virtual void PositionToolBar();
123
124 // Set status line text
125 virtual void SetStatusText(const wxString& text, int number = 0);
126
127 // Set status line widths
128 virtual void SetStatusWidths(int n, const int widths_field[]);
129
130 // Hint to tell framework which status bar to use
131 // TODO: should this go into a wxFrameworkSettings class perhaps?
132 static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
133 static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
134
135 // Fit frame around subwindows
136 virtual void Fit();
137
138 // Iconize
139 virtual void Iconize(bool iconize);
140
141 virtual bool IsIconized() const ;
142
143 // Compatibility
144 inline bool Iconized() const { return IsIconized(); }
145
146 // Is the frame maximized? Returns FALSE under Motif (but TRUE for
147 // wxMDIChildFrame due to the tabbed implementation).
148 virtual bool IsMaximized(void) const ;
149
150 virtual void Maximize(bool maximize);
151
152 // Responds to colour changes
153 void OnSysColourChanged(wxSysColourChangedEvent& event);
154
155 // Query app for menu item updates (called from OnIdle)
156 void DoMenuUpdates();
157 void DoMenuUpdates(wxMenu* menu);
158
159 // Checks if there is a toolbar, and returns the first free client position
160 virtual wxPoint GetClientAreaOrigin() const;
161
162 virtual void Raise();
163 virtual void Lower();
164
165 virtual void CaptureMouse();
166 virtual void ReleaseMouse();
167
168 // Implementation
169 virtual void ChangeFont(bool keepOriginalSize = TRUE);
170 virtual void ChangeBackgroundColour();
171 virtual void ChangeForegroundColour();
172 WXWidget GetMenuBarWidget() const ;
173 inline WXWidget GetShellWidget() const { return m_frameShell; }
174 inline WXWidget GetWorkAreaWidget() const { return m_workArea; }
175 inline WXWidget GetClientAreaWidget() const { return m_clientArea; }
176 inline WXWidget GetTopWidget() const { return m_frameShell; }
177 inline WXWidget GetMainWindowWidget() const { return m_frameWidget; }
178
179 // The widget that can have children on it
180 WXWidget GetClientWidget() const;
181 bool GetVisibleStatus() const { return m_visibleStatus; }
182
183 bool PreResize();
184
185 protected:
186 wxMenuBar * m_frameMenuBar;
187 wxStatusBar * m_frameStatusBar;
188 wxIcon m_icon;
189 bool m_iconized;
190 static bool m_useNativeStatusBar;
191 wxToolBar * m_frameToolBar ;
192
193 //// Motif-specific
194
195 WXWidget m_frameShell;
196 WXWidget m_frameWidget;
197 WXWidget m_workArea;
198 WXWidget m_clientArea;
199 // WXWidget m_menuBarWidget;
200 bool m_visibleStatus;
201 wxString m_title;
202
203 DECLARE_EVENT_TABLE()
204 };
205
206 #endif
207 // _WX_FRAME_H_