send more page change events (patch 750521); document this behaviour

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 2fa2d92fece63024eb54cef43dec2fe361b80238..c7fc61217a95a11c5209bb9cbe95bf161cdf78b5 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
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_
@@ -16,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
     #pragma interface "framebase.h"
 #endif
 
@@ -44,22 +44,15 @@ class WXDLLEXPORT wxToolBar;
 // CreateXXXBar() is called.
 // ----------------------------------------------------------------------------
 
-// FIXME - temporary hack in absence of wxTLW !!
-#ifndef wxTopLevelWindowNative
-class WXDLLEXPORT wxFrameBase : public wxTopLevelWindowBase
-#else
 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
-#endif
 {
 public:
     // construction
     wxFrameBase();
-#ifdef __DARWIN__
-    virtual ~wxFrameBase() { }
-#endif
+    virtual ~wxFrameBase();
 
     wxFrame *New(wxWindow *parent,
-                 wxWindowID id,
+                 wxWindowID winid,
                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
@@ -73,6 +66,13 @@ public:
     // if the frame has a toolbar) in client coordinates
     virtual wxPoint GetClientAreaOrigin() const;
 
+    // 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
     // ------------------
 
@@ -81,11 +81,13 @@ public:
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 
+#ifdef WXWIN_COMPATIBILITY_2_2
     // call this to simulate a menu command
-    bool Command(int id) { return ProcessCommand(id); }
+    bool Command(int winid) { return ProcessCommand(winid); }
+#endif // WXWIN_COMPATIBILITY_2_2
 
     // process menu command: returns TRUE if processed
-    bool ProcessCommand(int id);
+    bool ProcessCommand(int winid);
 
     // status bar functions
     // --------------------
@@ -93,13 +95,13 @@ public:
     // 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,
-                                           wxWindowID id,
+                                           wxWindowID winid,
                                            const wxString& name);
     // get the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
@@ -110,6 +112,12 @@ public:
     // 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
@@ -117,11 +125,11 @@ public:
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
-                                     wxWindowID id = -1,
+                                     wxWindowID winid = -1,
                                      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
@@ -153,6 +161,10 @@ public:
         { 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);
+
 protected:
     // the frame main menu/status/tool bars
     // ------------------------------------
@@ -186,11 +198,14 @@ protected:
 
     // 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);
+    bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
 
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 
+
+    int m_statusBarPane;
+
 #if wxUSE_TOOLBAR
     // override to update status bar position (or anything else) when
     // something changes
@@ -200,6 +215,7 @@ protected:
 #endif // wxUSE_TOOLBAR
 
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxFrameBase)
 };
 
 // include the real class declaration
@@ -214,6 +230,8 @@ protected:
         #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