Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 02f03cc71d02b29e30a60e08249e1214dc93d2d6..e39c17f22e3fd531e041860fd0830537c7a07cf3 100644 (file)
--- a/include/wx/frame.h
+++ b/include/wx/frame.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -16,21 +16,30 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "framebase.h"
-#endif
-

 #include "wx/toplevel.h"      // the base class
 #include "wx/toplevel.h"      // the base class

+#include "wx/statusbr.h"

 
 // the default names for various classs
 
 // the default names for various classs

-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusLineNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxToolBarNameStr[];

 
 

-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-class WXDLLEXPORT wxToolBar;
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxMenuBar;
+class WXDLLIMPEXP_FWD_CORE wxMenuItem;
+class WXDLLIMPEXP_FWD_CORE wxStatusBar;
+class WXDLLIMPEXP_FWD_CORE wxToolBar;
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// wxFrame-specific (i.e. not for wxDialog) styles
+//
+// Also see the bit summary table in wx/toplevel.h.
+#define wxFRAME_NO_TASKBAR      0x0002  // No taskbar button (MSW only)
+#define wxFRAME_TOOL_WINDOW     0x0004  // No taskbar button, no system menu
+#define wxFRAME_FLOAT_ON_PARENT 0x0008  // Always above its parent
+#define wxFRAME_SHAPED          0x0010  // Create a window that is able to be shaped

 
 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 
 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar


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

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

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


@@ -66,12 +75,6 @@ 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,25 +82,33 @@ public:
 #if wxUSE_MENUS
     virtual void SetMenuBar(wxMenuBar *menubar);
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #if wxUSE_MENUS
     virtual void SetMenuBar(wxMenuBar *menubar);
     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 winid) { return ProcessCommand(winid); }
-#endif // WXWIN_COMPATIBILITY_2_2
+    // find the item by id in the frame menu bar: this is an internal function
+    // and exists mainly in order to be overridden in the MDI parent frame
+    // which also looks at its active child menu bar
+    virtual wxMenuItem *FindItemInMenuBar(int menuId) const;
+
+    // generate menu command corresponding to the given menu item
+    //
+    // returns true if processed
+    bool ProcessCommand(wxMenuItem *item);

 
 

-    // process menu command: returns TRUE if processed
+    // generate menu command corresponding to the given menu command id
+    //
+    // returns true if processed

     bool ProcessCommand(int winid);
     bool ProcessCommand(int winid);

+#else
+    bool ProcessCommand(int WXUNUSED(winid)) { return false; }
+#endif // wxUSE_MENUS

 
     // status bar functions
     // --------------------
 #if wxUSE_STATUSBAR
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,
 
     // status bar functions
     // --------------------
 #if wxUSE_STATUSBAR
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,

-                                         long style = wxST_SIZEGRIP,
+                                         long style = wxSTB_DEFAULT_STYLE,

                                          wxWindowID winid = 0,
                                          wxWindowID winid = 0,

-                                         const wxString& name =
-                                            wxStatusLineNameStr);
+                                         const wxString& name = wxStatusLineNameStr);

     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,
     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,


@@ -107,7 +118,7 @@ public:
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 
     // sets the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 
     // sets the main status bar

-    void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
+    virtual void SetStatusBar(wxStatusBar *statBar);

 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);
 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);


@@ -122,10 +133,11 @@ public:
 
     // toolbar functions
     // -----------------
 
     // 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 winid = -1,
+    virtual wxToolBar* CreateToolBar(long style = -1,
+                                     wxWindowID winid = wxID_ANY,

                                      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,


@@ -134,37 +146,42 @@ public:
 
     // get/set the main toolbar
     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 
     // get/set the main toolbar
     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }

-    virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
+    virtual void SetToolBar(wxToolBar *toolbar);

 #endif // wxUSE_TOOLBAR
 
     // implementation only from now on
     // -------------------------------
 
     // event handlers
 #endif // wxUSE_TOOLBAR
 
     // implementation only from now on
     // -------------------------------
 
     // event handlers

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

     void OnMenuOpen(wxMenuEvent& event);
     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
+    virtual void DoMenuUpdates(wxMenu* menu = NULL);

 #endif // wxUSE_MENUS
 
 #endif // wxUSE_MENUS
 

-    // 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
+    // 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 wxUSE_MENUS || wxUSE_TOOLBAR
+    // show help text for the currently selected menu or toolbar item
+    // (typically in the status bar) or hide it and restore the status bar text
+    // originally shown before the menu was opened if show == false

     virtual void DoGiveHelp(const wxString& text, bool show);
     virtual void DoGiveHelp(const wxString& text, bool show);

+#endif
+
+    virtual bool IsClientAreaChild(const wxWindow *child) const
+    {
+        return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child);
+    }

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


@@ -192,14 +209,23 @@ protected:
     wxMenuBar *m_frameMenuBar;
 #endif // wxUSE_MENUS
 
     wxMenuBar *m_frameMenuBar;
 #endif // wxUSE_MENUS
 

+#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
+    // the saved status bar text overwritten by DoGiveHelp()
+    wxString m_oldStatusText;
+
+    // the last help string we have shown in the status bar
+    wxString m_lastHelpShown;
+#endif
+

 #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);
+    // show the help string for the given menu item using DoGiveHelp() if the
+    // given item does have a help string (as determined by FindInMenuBar()),
+    // return false if there is no help for such item
+    bool ShowMenuHelp(int helpid);

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


@@ -215,22 +241,29 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 

+#if wxUSE_MENUS && wxUSE_STATUSBAR

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

-    DECLARE_NO_COPY_CLASS(wxFrameBase)
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
+    wxDECLARE_NO_COPY_CLASS(wxFrameBase);

 };
 
 // include the real class declaration
 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
     #include "wx/univ/frame.h"
 #else // !__WXUNIVERSAL__
 };
 
 // include the real class declaration
 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
     #include "wx/univ/frame.h"
 #else // !__WXUNIVERSAL__

-    #if defined(__WXMSW__)
+    #if defined(__WXPALMOS__)
+        #include "wx/palmos/frame.h"
+    #elif defined(__WXMSW__)

         #include "wx/msw/frame.h"
         #include "wx/msw/frame.h"

-    #elif defined(__WXGTK__)
+    #elif defined(__WXGTK20__)

         #include "wx/gtk/frame.h"
         #include "wx/gtk/frame.h"

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

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

-        #include "wx/mac/frame.h"
+        #include "wx/osx/frame.h"

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