]> git.saurik.com Git - wxWidgets.git/blob - include/wx/stubs/frame.h
no message
[wxWidgets.git] / include / wx / stubs / frame.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: frame.h
3 // Purpose: wxFrame class
4 // Author: AUTHOR
5 // Modified by:
6 // Created: ??/??/98
7 // RCS-ID: $Id$
8 // Copyright: (c) AUTHOR
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 void SetClientSize(int width, int height);
58 void GetClientSize(int *width, int *height) const;
59
60 void GetSize(int *width, int *height) const ;
61 void GetPosition(int *x, int *y) const ;
62 void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
63 void ClientToScreen(int *x, int *y) const;
64 void ScreenToClient(int *x, int *y) const;
65
66 virtual bool OnClose();
67
68 void OnSize(wxSizeEvent& event);
69 void OnMenuHighlight(wxMenuEvent& event);
70 void OnActivate(wxActivateEvent& event);
71 void OnIdle(wxIdleEvent& event);
72 void OnCloseWindow(wxCloseEvent& event);
73
74 bool Show(bool show);
75
76 // Set menu bar
77 void SetMenuBar(wxMenuBar *menu_bar);
78 virtual wxMenuBar *GetMenuBar() const ;
79
80 // Set title
81 void SetTitle(const wxString& title);
82 wxString GetTitle() const ;
83
84 void Centre(int direction = wxBOTH);
85
86 // Call this to simulate a menu command
87 virtual void Command(int id);
88 virtual void ProcessCommand(int id);
89
90 // Set icon
91 virtual void SetIcon(const wxIcon& icon);
92
93 // Create status line
94 virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
95 const wxString& name = "statusBar");
96 inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
97 virtual void PositionStatusBar();
98 virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
99 const wxString& name);
100
101 // Create toolbar
102 virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1, const wxString& name = wxToolBarNameStr);
103 virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
104 // If made known to the frame, the frame will manage it automatically.
105 virtual inline void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
106 virtual inline wxToolBar *GetToolBar() const { return m_frameToolBar; }
107 virtual void PositionToolBar();
108
109 // Set status line text
110 virtual void SetStatusText(const wxString& text, int number = 0);
111
112 // Set status line widths
113 virtual void SetStatusWidths(int n, const int widths_field[]);
114
115 // Hint to tell framework which status bar to use
116 // TODO: should this go into a wxFrameworkSettings class perhaps?
117 static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
118 static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
119
120 // Fit frame around subwindows
121 virtual void Fit();
122
123 // Iconize
124 virtual void Iconize(bool iconize);
125
126 virtual bool IsIconized() const ;
127
128 // Compatibility
129 inline bool Iconized() const { return IsIconized(); }
130
131 // Is the frame maximized?
132 virtual bool IsMaximized(void) const ;
133
134 virtual void Maximize(bool maximize);
135
136 // Responds to colour changes
137 void OnSysColourChanged(wxSysColourChangedEvent& event);
138
139 // Query app for menu item updates (called from OnIdle)
140 void DoMenuUpdates();
141 void DoMenuUpdates(wxMenu* menu);
142
143 // Checks if there is a toolbar, and returns the first free client position
144 virtual wxPoint GetClientAreaOrigin() const;
145
146 protected:
147 wxMenuBar * m_frameMenuBar;
148 wxStatusBar * m_frameStatusBar;
149 wxIcon m_icon;
150 bool m_iconized;
151 static bool m_useNativeStatusBar;
152 wxToolBar * m_frameToolBar ;
153
154 DECLARE_EVENT_TABLE()
155 };
156
157 #endif
158 // _WX_FRAME_H_