Trying to hide evidence of my negative programming skills...

[wxWidgets.git] / include / wx / frame.h

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 831e1227059fd759ea34be3a70a392b9d2c81d46..4d68e8903213e8260cf0aed159de82be70fca20e 100644 (file)
--- a/include/wx/frame.h
+++ b/include/wx/frame.h
@@ -28,10 +28,19 @@ WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
 
+class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxStatusBar;
 class WXDLLEXPORT wxToolBar;
 
+// Styles for ShowFullScreen
+#define wxFULLSCREEN_NOMENUBAR      0x01
+#define wxFULLSCREEN_NOTOOLBAR      0x02
+#define wxFULLSCREEN_NOSTATUSBAR    0x04
+#define wxFULLSCREEN_NOBORDER       0x08
+#define wxFULLSCREEN_NOCAPTION      0x10
+#define wxFULLSCREEN_ALL            (wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR | wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER | wxFULLSCREEN_NOCAPTION)
+
 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 //
@@ -49,6 +58,9 @@ class WXDLLEXPORT wxFrameBase : public wxWindow
 public:
     // construction
     wxFrameBase();
+#ifdef __WXMAC_X__
+    virtual ~wxFrameBase() {}  // Added min for Mac X
+#endif
 
     wxFrame *New(wxWindow *parent,
                  wxWindowID id,
@@ -85,11 +97,17 @@ public:
     // make the window modal (all other windows unresponsive)
     virtual void MakeModal(bool modal = TRUE);
 
+    // get the origin of the client area (which may be different from (0, 0)
+    // if the frame has a toolbar) in client coordinates
+    virtual wxPoint GetClientAreaOrigin() const;
+
     // menu bar functions
     // ------------------
 
+#if wxUSE_MENUS
     virtual void SetMenuBar(wxMenuBar *menubar) = 0;
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
+#endif // wxUSE_MENUS
 
     // call this to simulate a menu command
     bool Command(int id) { return ProcessCommand(id); }
@@ -156,13 +174,16 @@ public:
     void OnCloseWindow(wxCloseEvent& event);
     void OnMenuHighlight(wxMenuEvent& event);
     void OnSize(wxSizeEvent& event);
+
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms
     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 
+#if wxUSE_MENUS
     // send wxUpdateUIEvents for all menu items (called from OnIdle())
     void DoMenuUpdates();
     void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
+#endif // wxUSE_MENUS
 
 protected:
     // the frame main menu/status/tool bars
@@ -172,13 +193,25 @@ protected:
     // main menubar, statusbar and toolbar (if any)
     void DeleteAllBars();
 
+    // test whether this window makes part of the frame
+    virtual bool IsOneOfBars(const wxWindow *win) const;
+
+#if wxUSE_MENUS
+    // override to update menu bar position when the frame size changes
+    virtual void PositionMenuBar() { }
+
     wxMenuBar *m_frameMenuBar;
+#endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR
     // override to update status bar position (or anything else) when
     // something changes
     virtual void PositionStatusBar() { }
 
+    // show the help string for this menu item in the given status bar: the
+    // status bar pointer can be NULL; return TRUE if help was shown
+    bool ShowMenuHelp(wxStatusBar *statbar, int id);
+
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 
@@ -190,6 +223,14 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
+    // the frame client to screen translation should take account of the
+    // toolbar which may shift the origin of the client area
+    virtual void DoClientToScreen(int *x, int *y) const;
+    virtual void DoScreenToClient(int *x, int *y) const;
+
+    // send the iconize event, return TRUE if processed
+    bool SendIconizeEvent(bool iconized = TRUE);
+
     // the frame icon
     wxIcon m_icon;
 
@@ -199,19 +240,113 @@ protected:
 // include the real class declaration
 #if defined(__WXMSW__)
     #include "wx/msw/frame.h"
+    #ifndef __WXUNIVERSAL__
+
+    class WXDLLEXPORT wxFrame : public wxFrameMSW
+    {
+    public:
+        // construction
+        wxFrame() { Init(); }
+        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)
+        {
+            Init();
+            Create(parent, id, title, pos, size, style, name);
+        }
+        DECLARE_DYNAMIC_CLASS(wxFrame)
+    };
+
+    #endif
 #elif defined(__WXMOTIF__)
     #include "wx/motif/frame.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/frame.h"
+    #ifndef __WXUNIVERSAL__
+
+    class WXDLLEXPORT wxFrame : public wxFrameGTK
+    {
+    public:
+        // construction
+        wxFrame() { Init(); }
+        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)
+        {
+            Init();
+            Create(parent, id, title, pos, size, style, name);
+        }
+        DECLARE_DYNAMIC_CLASS(wxFrame)
+    };
+
+    #endif
+#elif defined(__WXMGL__)
+    #include "wx/mgl/frame.h"
 #elif defined(__WXQT__)
     #include "wx/qt/frame.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/frame.h"
+    #ifndef __WXUNIVERSAL__
+
+    class WXDLLEXPORT wxFrame : public wxFrameMac
+    {
+    public:
+        // construction
+        wxFrame() { Init(); }
+        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)
+        {
+            Init();
+            Create(parent, id, title, pos, size, style, name);
+        }
+        DECLARE_DYNAMIC_CLASS(wxFrame)
+    };
+
+    #endif
 #elif defined(__WXPM__)
     #include "wx/os2/frame.h"
+    #ifndef __WXUNIVERSAL__
+
+    class WXDLLEXPORT wxFrame : public wxFrameOS2
+    {
+    public:
+        // construction
+        wxFrame() { Init(); }
+        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)
+        {
+            Init();
+            Create(parent, id, title, pos, size, style, name);
+        }
+        DECLARE_DYNAMIC_CLASS(wxFrame)
+    };
+    #endif
+
 #elif defined(__WXSTUBS__)
     #include "wx/stubs/frame.h"
 #endif
 
+#ifdef __WXUNIVERSAL__
+    #include "wx/univ/frame.h"
+#endif
+
 #endif
     // _WX_FRAME_H_BASE_