Header Cosmetics

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index ac7e48f61c5036e0cadbd20df82c25fb197dfa87..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,7 +16,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

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

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


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

-// FIXME - temporary hack in absence of wxTLW !!
-#ifndef wxTopLevelWindowNative
-class WXDLLEXPORT wxFrameBase : public wxTopLevelWindowBase
-#else

 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow

-#endif

 {
 public:
     // construction
 {
 public:
     // construction


@@ -57,7 +52,7 @@ public:
     virtual ~wxFrameBase();
 
     wxFrame *New(wxWindow *parent,
     virtual ~wxFrameBase();
 
     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,


@@ -71,6 +66,13 @@ public:
     // if the frame has a toolbar) in client coordinates
     virtual wxPoint GetClientAreaOrigin() const;
 
     // 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
     // ------------------
 
     // menu bar functions
     // ------------------
 


@@ -79,11 +81,8 @@ public:
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 

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

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


@@ -91,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; }


@@ -108,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


@@ -131,15 +137,24 @@ public:
     // -------------------------------
 
     // event handlers
     // -------------------------------
 
     // event handlers

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

     void OnMenuHighlight(wxMenuEvent& event);
     void OnMenuHighlight(wxMenuEvent& event);

+#endif // wxUSE_STATUSBAR

 
 

-#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 in the menubar,
+    // or just for menu if non-NULL
+    void DoMenuUpdates(wxMenu* menu = NULL);

 #endif // wxUSE_MENUS
 
 #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
     // 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


@@ -151,6 +166,15 @@ public:
         { return FALSE; }
 #endif // no wxTopLevelWindowNative
 
         { 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
     // ------------------------------------


@@ -175,6 +199,11 @@ protected:
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     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
 #endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR


@@ -184,11 +213,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
 
     // 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
 
 
     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


@@ -197,7 +229,11 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 

+#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


@@ -212,6 +248,8 @@ protected:
         #include "wx/motif/frame.h"
     #elif defined(__WXMAC__)
         #include "wx/mac/frame.h"
         #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
     #elif defined(__WXPM__)
         #include "wx/os2/frame.h"
     #endif