Removed the SaveBG hack. The real incompatibility is that the MemoryDC

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 831e1227059fd759ea34be3a70a392b9d2c81d46..e202679bb9b1a6800a9b265db0724479c06934f1 100644 (file)
--- a/include/wx/frame.h
+++ b/include/wx/frame.h
@@ -6,7 +6,7 @@
 // Created:     15.11.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
 // Created:     15.11.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_


@@ -16,18 +16,18 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "framebase.h"
 #endif
 
     #pragma interface "framebase.h"
 #endif
 

-#include "wx/window.h"      // the base class
-#include "wx/icon.h"        // for m_icon
+#include "wx/toplevel.h"      // the base class

 
 // the default names for various classs
 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
 
 
 // the default names for various classs
 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;
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxStatusBar;
 class WXDLLEXPORT wxToolBar;


@@ -44,14 +44,15 @@ class WXDLLEXPORT wxToolBar;
 // CreateXXXBar() is called.
 // ----------------------------------------------------------------------------
 
 // CreateXXXBar() is called.
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxFrameBase : public wxWindow
+class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow

 {
 public:
     // construction
     wxFrameBase();
 {
 public:
     // construction
     wxFrameBase();

+    virtual ~wxFrameBase();

 
     wxFrame *New(wxWindow *parent,
 
     wxFrame *New(wxWindow *parent,

-                 wxWindowID id,
+                 wxWindowID winid,

                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,


@@ -61,41 +62,27 @@ public:
     // frame state
     // -----------
 
     // frame state
     // -----------
 

-    // maximize = TRUE => maximize, otherwise - restore
-    virtual void Maximize(bool maximize = TRUE) = 0;
+    // 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;

 
 

-    // undo Maximize() or Iconize()
-    virtual void Restore() = 0;
-
-    // iconize = TRUE => iconize, otherwise - restore
-    virtual void Iconize(bool iconize = TRUE) = 0;
-
-    // return TRUE if the frame is maximized
-    virtual bool IsMaximized() const = 0;
-
-    // return TRUE if the frame is iconized
-    virtual bool IsIconized() const = 0;
-
-    // get the frame icon
-    const wxIcon& GetIcon() const { return m_icon; }
-
-    // set the frame icon
-    virtual void SetIcon(const wxIcon& icon) { m_icon = icon; }
-
-    // make the window modal (all other windows unresponsive)
-    virtual void MakeModal(bool modal = TRUE);
+    // sends a size event to the window using its current size -- this has an
+    // effect of refreshing the window layout
+    //
+    // currently it is only implemented under MSW but is declared here to make
+    // it possible to call it in portable code without using #ifdef's
+    virtual void SendSizeEvent() { }

 
     // 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; }

-
-    // call this to simulate a menu command
-    bool Command(int id) { return ProcessCommand(id); }
+#endif // wxUSE_MENUS

 
     // process menu command: returns TRUE if processed
 
     // process menu command: returns TRUE if processed

-    bool ProcessCommand(int id);
+    bool ProcessCommand(int winid);

 
     // status bar functions
     // --------------------
 
     // status bar functions
     // --------------------


@@ -103,13 +90,13 @@ public:
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,
                                          long style = wxST_SIZEGRIP,
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,
                                          long style = wxST_SIZEGRIP,

-                                         wxWindowID id = 0,
+                                         wxWindowID winid = 0,

                                          const wxString& name =
                                             wxStatusLineNameStr);
     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,
                                          const wxString& name =
                                             wxStatusLineNameStr);
     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,

-                                           wxWindowID id,
+                                           wxWindowID winid,

                                            const wxString& name);
     // get the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
                                            const wxString& name);
     // get the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }


@@ -120,18 +107,25 @@ public:
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);
     virtual void SetStatusWidths(int n, const int widths_field[]);
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);
     virtual void SetStatusWidths(int n, const int widths_field[]);

+    void PushStatusText(const wxString &text, int number = 0);
+    void PopStatusText(int number = 0);
+
+    // set the status bar pane the help will be shown in
+    void SetStatusBarPane(int n) { m_statusBarPane = n; }
+    int GetStatusBarPane() const { return m_statusBarPane; }

 #endif // wxUSE_STATUSBAR
 
     // toolbar functions
     // -----------------
 #endif // wxUSE_STATUSBAR
 
     // toolbar functions
     // -----------------

+

 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()

-    virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
-                                     wxWindowID id = -1,
+    virtual wxToolBar* CreateToolBar(long style = -1,
+                                     wxWindowID winid = -1,

                                      const wxString& name = wxToolBarNameStr);
     // return a new toolbar
     virtual wxToolBar *OnCreateToolBar(long style,
                                      const wxString& name = wxToolBarNameStr);
     // return a new toolbar
     virtual wxToolBar *OnCreateToolBar(long style,

-                                       wxWindowID id,
+                                       wxWindowID winid,

                                        const wxString& name );
 
     // get/set the main toolbar
                                        const wxString& name );
 
     // get/set the main toolbar


@@ -139,30 +133,47 @@ public:
     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
 #endif // wxUSE_TOOLBAR
 
     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
 #endif // wxUSE_TOOLBAR
 

-    // old functions, use the new ones instead!
-#if WXWIN_COMPATIBILITY_2
-    bool Iconized() const { return IsIconized(); }
-#endif // WXWIN_COMPATIBILITY_2
-

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 

-    // override some base class virtuals
-    virtual bool Destroy();
-    virtual bool IsTopLevel() const { return TRUE; }
-

     // event handlers
     // event handlers

-    void OnIdle(wxIdleEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+#if wxUSE_MENUS
+#if wxUSE_STATUSBAR
+    void OnMenuOpen(wxMenuEvent& event);
+    void OnMenuClose(wxMenuEvent& event);

     void OnMenuHighlight(wxMenuEvent& 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)) { }
+#endif // wxUSE_STATUSBAR

 
 

-    // send wxUpdateUIEvents for all menu items (called from OnIdle())
-    void DoMenuUpdates();
-    void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
+    // send wxUpdateUIEvents for all menu items in the menubar,
+    // or just for menu if non-NULL
+    void DoMenuUpdates(wxMenu* menu = NULL);
+#endif // wxUSE_MENUS
+
+    // do the UI update processing for this window
+    virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
+
+    // Implement internal behaviour (menu updating on some platforms)
+    virtual void OnInternalIdle();
+
+    // if there is no real wxTopLevelWindow on this platform we have to define
+    // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
+    // old ports (wxMotif) which don't define them in wxFrame
+#ifndef wxTopLevelWindowNative
+    virtual bool ShowFullScreen(bool WXUNUSED(show),
+                                long WXUNUSED(style) = wxFULLSCREEN_ALL)
+        { return FALSE; }
+    virtual bool IsFullScreen() const
+        { return FALSE; }
+#endif // no wxTopLevelWindowNative
+
+    // show help text (typically in the statusbar); show is FALSE
+    // if you are hiding the help, TRUE otherwise
+    virtual void DoGiveHelp(const wxString& text, bool show);
+
+#if WXWIN_COMPATIBILITY_2_2
+    // call this to simulate a menu command
+    bool Command(int winid) { return ProcessCommand(winid); }
+#endif // WXWIN_COMPATIBILITY_2_2

 
 protected:
     // the frame main menu/status/tool bars
 
 protected:
     // the frame main menu/status/tool bars


@@ -172,16 +183,44 @@ 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;
 

+#if wxUSE_STATUSBAR
+    // the saved status bar text overwritten by DoGiveHelp()
+    wxString m_oldStatusText;
+#endif // wxUSE_STATUSBAR
+#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 helpid);
+

     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 

+
+    int m_statusBarPane;
+

 #if wxUSE_TOOLBAR
     // override to update status bar position (or anything else) when
     // something changes
 #if wxUSE_TOOLBAR
     // override to update status bar position (or anything else) when
     // something changes


@@ -190,27 +229,30 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 

-    // the frame icon
-    wxIcon m_icon;
-
+#if wxUSE_MENUS && wxUSE_STATUSBAR

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
+    DECLARE_NO_COPY_CLASS(wxFrameBase)

 };
 
 // include the real class declaration
 };
 
 // include the real class declaration

-#if defined(__WXMSW__)
-    #include "wx/msw/frame.h"
-#elif defined(__WXMOTIF__)
-    #include "wx/motif/frame.h"
-#elif defined(__WXGTK__)
-    #include "wx/gtk/frame.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/frame.h"
-#elif defined(__WXMAC__)
-    #include "wx/mac/frame.h"
-#elif defined(__WXPM__)
-    #include "wx/os2/frame.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/frame.h"
+#if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
+    #include "wx/univ/frame.h"
+#else // !__WXUNIVERSAL__
+    #if defined(__WXMSW__)
+        #include "wx/msw/frame.h"
+    #elif defined(__WXGTK__)
+        #include "wx/gtk/frame.h"
+    #elif defined(__WXMOTIF__)
+        #include "wx/motif/frame.h"
+    #elif defined(__WXMAC__)
+        #include "wx/mac/frame.h"
+    #elif defined(__WXCOCOA__)
+        #include "wx/cocoa/frame.h"
+    #elif defined(__WXPM__)
+        #include "wx/os2/frame.h"
+    #endif

 #endif
 
 #endif
 #endif
 
 #endif