Added possibility of 2-step initialisation, and wxWIZARD_EX_HELPBUTTON style.

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 831e1227059fd759ea34be3a70a392b9d2c81d46..32a666b3643f3775254ef2ea4cae104756d88d67 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;
 
 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
 

+class WXDLLEXPORT wxFrame;

 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxStatusBar;
 class WXDLLEXPORT wxToolBar;
 
 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
 //
 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 //


@@ -49,6 +58,9 @@ class WXDLLEXPORT wxFrameBase : public wxWindow
 public:
     // construction
     wxFrameBase();
 public:
     // construction
     wxFrameBase();

+#ifdef __DARWIN__
+    virtual ~wxFrameBase() { }
+#endif

 
     wxFrame *New(wxWindow *parent,
                  wxWindowID id,
 
     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);
 
     // 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
     // ------------------
 
     // menu bar functions
     // ------------------
 

-    virtual void SetMenuBar(wxMenuBar *menubar) = 0;
+#if wxUSE_MENUS
+    virtual void SetMenuBar(wxMenuBar *menubar);

     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }

+#endif // wxUSE_MENUS

 
     // call this to simulate a menu command
     bool Command(int id) { return ProcessCommand(id); }
 
     // 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);
     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)) { }
 
     // 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);
     // 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
 
 protected:
     // the frame main menu/status/tool bars


@@ -172,13 +193,33 @@ protected:
     // main menubar, statusbar and toolbar (if any)
     void DeleteAllBars();
 
     // 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() { }
+
+    // override to do something special when the menu bar is being removed
+    // from the frame
+    virtual void DetachMenuBar();
+
+    // override to do something special when the menu bar is attached to the
+    // frame
+    virtual void AttachMenuBar(wxMenuBar *menubar);
+

     wxMenuBar *m_frameMenuBar;
     wxMenuBar *m_frameMenuBar;

+#endif // wxUSE_MENUS

 
 #if wxUSE_STATUSBAR
     // override to update status bar position (or anything else) when
     // something changes
     virtual void PositionStatusBar() { }
 
 
 #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
 
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 


@@ -190,6 +231,14 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
     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;
 
     // the frame icon
     wxIcon m_icon;
 


@@ -199,19 +248,48 @@ protected:
 // include the real class declaration
 #if defined(__WXMSW__)
     #include "wx/msw/frame.h"
 // include the real class declaration
 #if defined(__WXMSW__)
     #include "wx/msw/frame.h"

-#elif defined(__WXMOTIF__)
-    #include "wx/motif/frame.h"
+    #define wxFrameNative wxFrameMSW

 #elif defined(__WXGTK__)
     #include "wx/gtk/frame.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/frame.h"

-#elif defined(__WXQT__)
-    #include "wx/qt/frame.h"
+    #define wxFrameNative wxFrameGTK
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/frame.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/frame.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/frame.h"

+    #define wxFrameNative wxFrameMac
+#elif defined(__WXMGL__)
+    #include "wx/mgl/frame.h"
+    #define wxFrameNative wxFrameMGL

 #elif defined(__WXPM__)
     #include "wx/os2/frame.h"
 #elif defined(__WXPM__)
     #include "wx/os2/frame.h"

-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/frame.h"
+    #define wxFrameNative wxFrameOS2

 #endif
 
 #endif
 

+#ifdef __WXUNIVERSAL__
+    #include "wx/univ/frame.h"
+#else // !__WXUNIVERSAL__
+    #ifdef wxFrameNative
+        class WXDLLEXPORT wxFrame : public wxFrameNative
+        {
+        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 // wxFrameNative
+#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
+

 #endif
     // _WX_FRAME_H_BASE_
 #endif
     // _WX_FRAME_H_BASE_