// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_FRAME_H_
#define _WX_FRAME_H_
#ifdef __GNUG__
-#pragma interface "frame.h"
+ #pragma interface "frame.h"
#endif
#include "wx/window.h"
#include "wx/toolbar.h"
#include "wx/msw/accel.h"
+#include "wx/icon.h"
-WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
class WXDLLEXPORT wxMenuBar;
class WXDLLEXPORT wxStatusBar;
-class WXDLLEXPORT wxFrame: public wxWindow {
-
- DECLARE_DYNAMIC_CLASS(wxFrame)
+class WXDLLEXPORT wxFrame : public wxWindow
+{
+ DECLARE_DYNAMIC_CLASS(wxFrame)
public:
- wxFrame(void);
- inline wxFrame(wxWindow *parent,
- wxWindowID id,
- const wxString& title,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr)
- {
- Create(parent, id, title, pos, size, style, name);
- }
-
- ~wxFrame(void);
+ wxFrame();
+ wxFrame(wxWindow *parent,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr)
+ {
+ Create(parent, id, title, pos, size, style, name);
+ }
- bool Create(wxWindow *parent,
- wxWindowID id,
- const wxString& title,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr);
+ ~wxFrame();
- virtual bool Destroy(void);
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr);
- void SetClientSize(int width, int height);
- void SetClientSize(const wxSize& sz) { wxWindow::SetClientSize(sz); }
+ virtual bool Destroy();
- void GetClientSize(int *width, int *height) const;
- wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
+ virtual void ClientToScreen(int *x, int *y) const;
+ virtual void ScreenToClient(int *x, int *y) const;
- void GetSize(int *width, int *height) const ;
- wxSize GetSize() const { return wxWindow::GetSize(); }
+ void OnSize(wxSizeEvent& event);
+ void OnMenuHighlight(wxMenuEvent& event);
+ void OnActivate(wxActivateEvent& event);
+ void OnIdle(wxIdleEvent& event);
+ void OnCloseWindow(wxCloseEvent& event);
- void GetPosition(int *x, int *y) const ;
- wxPoint GetPosition() const { return wxWindow::GetPosition(); }
+ bool Show(bool show);
- virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
+ void DetachMenuBar();
+ // Set menu bar
+ void SetMenuBar(wxMenuBar *menu_bar);
+ virtual wxMenuBar *GetMenuBar() const;
- virtual void ClientToScreen(int *x, int *y) const;
+ // Call this to simulate a menu command
+ bool Command(int id) { return ProcessCommand(id); }
- virtual void ScreenToClient(int *x, int *y) const;
+ // process menu command: returns TRUE if processed
+ bool ProcessCommand(int id);
- virtual bool OnClose(void);
+ // make the window modal (all other windows unresponsive)
+ virtual void MakeModal(bool modal = TRUE);
- void OnSize(wxSizeEvent& event);
- void OnMenuHighlight(wxMenuEvent& event);
- void OnActivate(wxActivateEvent& event);
- void OnIdle(wxIdleEvent& event);
- void OnCloseWindow(wxCloseEvent& event);
+ // Set icon
+ virtual void SetIcon(const wxIcon& icon);
- bool Show(bool show);
+ // Toolbar
+#if wxUSE_TOOLBAR
+ virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
+ wxWindowID id = -1,
+ const wxString& name = wxToolBarNameStr);
- // Set menu bar
- void SetMenuBar(wxMenuBar *menu_bar);
- virtual wxMenuBar *GetMenuBar(void) const ;
+ virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
- // Set title
- void SetTitle(const wxString& title);
- wxString GetTitle(void) const ;
+ virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
+ virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
- void Centre(int direction = wxBOTH);
+ virtual void PositionToolBar();
+#endif // wxUSE_TOOLBAR
- // Call this to simulate a menu command
- virtual void Command(int id);
- virtual void ProcessCommand(int id);
+#if wxUSE_STATUSBAR
+ // Status bar
+ virtual wxStatusBar* CreateStatusBar(int number = 1,
+ long style = wxST_SIZEGRIP,
+ wxWindowID id = 0,
+ const wxString& name = wxStatusLineNameStr);
- // Set icon
- virtual void SetIcon(const wxIcon& icon);
+ wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
+ void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
- // Create status line
- virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
- const wxString& name = "statusBar");
- inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
- inline void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
- virtual void PositionStatusBar(void);
- virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
- const wxString& name);
+ virtual void PositionStatusBar();
+ virtual wxStatusBar *OnCreateStatusBar(int number,
+ long style,
+ wxWindowID id,
+ const wxString& name);
- // Create toolbar
- virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
- wxWindowID id = -1,
- const wxString& name = wxToolBarNameStr);
- virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
- // If made known to the frame, the frame will manage it automatically.
- virtual inline void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
- virtual inline wxToolBar *GetToolBar(void) const { return m_frameToolBar; }
- virtual void PositionToolBar(void);
+ // Set status line text
+ virtual void SetStatusText(const wxString& text, int number = 0);
- // Set status line text
- virtual void SetStatusText(const wxString& text, int number = 0);
+ // Set status line widths
+ virtual void SetStatusWidths(int n, const int widths_field[]);
- // Set status line widths
- virtual void SetStatusWidths(int n, const int widths_field[]);
+ // Hint to tell framework which status bar to use
+ // TODO: should this go into a wxFrameworkSettings class perhaps?
+ static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
+ static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
+#endif // wxUSE_STATUSBAR
- // Hint to tell framework which status bar to use
- // TODO: should this go into a wxFrameworkSettings class perhaps?
- static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
- static bool UsesNativeStatusBar(void) { return m_useNativeStatusBar; };
+ // Iconize
+ virtual void Iconize(bool iconize);
- // Fit frame around subwindows
- virtual void Fit(void);
+ virtual bool IsIconized() const;
- // Iconize
- virtual void Iconize(bool iconize);
+ // Is it maximized?
+ virtual bool IsMaximized() const;
- virtual bool IsIconized(void) const ;
+ // Compatibility
+ bool Iconized() const { return IsIconized(); }
- // Is it maximized?
- virtual bool IsMaximized(void) const ;
+ virtual void Maximize(bool maximize);
+ // virtual bool LoadAccelerators(const wxString& table);
- // Compatibility
- inline bool Iconized(void) const { return IsIconized(); }
+ // Responds to colour changes
+ void OnSysColourChanged(wxSysColourChangedEvent& event);
- virtual void Maximize(bool maximize);
-// virtual bool LoadAccelerators(const wxString& table);
+ // Query app for menu item updates (called from OnIdle)
+ void DoMenuUpdates();
+ void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
- // Responds to colour changes
- void OnSysColourChanged(wxSysColourChangedEvent& event);
+ WXHMENU GetWinMenu() const { return m_hMenu; }
- // Query app for menu item updates (called from OnIdle)
- void DoMenuUpdates(void);
- void DoMenuUpdates(wxMenu* menu);
+ // Returns the origin of client area (may be different from (0,0) if the
+ // frame has a toolbar)
+ virtual wxPoint GetClientAreaOrigin() const;
- WXHMENU GetWinMenu(void) const ;
+ // Implementation only from here
+ // event handlers
+ bool HandlePaint();
+ bool HandleSize(int x, int y, WXUINT flag);
+ bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
+ bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
- // Checks if there is a toolbar, and returns the first free client position
- virtual wxPoint GetClientAreaOrigin() const;
-
- // Handlers
- bool MSWOnPaint(void);
- WXHICON MSWOnQueryDragIcon(void);
- void MSWOnSize(int x, int y, WXUINT flag);
- bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
- bool MSWOnClose(void);
- void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
- bool MSWProcessMessage(WXMSG *msg);
- bool MSWTranslateMessage(WXMSG *msg);
- void MSWCreate(int id, wxWindow *parent, const char *WXUNUSED(wclass), wxWindow *wx_win, const char *title,
+ bool MSWCreate(int id, wxWindow *parent, const wxChar *wclass,
+ wxWindow *wx_win, const wxChar *title,
int x, int y, int width, int height, long style);
+ // tooltip management
+#if wxUSE_TOOLTIPS
+ WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
+ void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
+#endif // tooltips
+
protected:
- // propagate our state change to all child frames
- void IconizeChildFrames(bool bIconize);
-
- wxMenuBar * m_frameMenuBar;
- wxStatusBar * m_frameStatusBar;
- wxIcon m_icon;
- bool m_iconized;
- WXHICON m_defaultIcon;
- static bool m_useNativeStatusBar;
- wxToolBar * m_frameToolBar ;
-
- DECLARE_EVENT_TABLE()
+ // override base class virtuals
+ virtual void DoGetClientSize(int *width, int *height) const;
+ virtual void DoGetSize(int *width, int *height) const;
+ virtual void DoGetPosition(int *x, int *y) const;
+
+ virtual void DoSetClientSize(int width, int height);
+
+ // a plug in for MDI frame classes which need to do something special when
+ // the menubar is set
+ virtual void InternalSetMenuBar();
+
+ // propagate our state change to all child frames
+ void IconizeChildFrames(bool bIconize);
+
+ // we add menu bar accel processing
+ bool MSWTranslateMessage(WXMSG* pMsg);
+
+ // window proc for the frames
+ long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+
+ wxMenuBar * m_frameMenuBar;
+ wxIcon m_icon;
+ bool m_iconized;
+ WXHICON m_defaultIcon;
+
+#if wxUSE_STATUSBAR
+ wxStatusBar * m_frameStatusBar;
+
+ static bool m_useNativeStatusBar;
+#endif // wxUSE_STATUSBAR
+
+#if wxUSE_TOOLBAR
+ wxToolBar * m_frameToolBar;
+#endif // wxUSE_TOOLBAR
+
+private:
+#if wxUSE_TOOLTIPS
+ WXHWND m_hwndToolTip;
+#endif // tooltips
+
+ DECLARE_EVENT_TABLE()
};
#endif
projects / wxWidgets.git / blobdiff