Correct spelling, now use Indices

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index b3cbe59f7ce1221494d36effd113cdc0dd2e16e4..fe6694fbc746c13b0b5f7a1fc93f8762ef499b31 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) wxWidgets team
 // Created:     15.11.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWidgets team

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

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


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

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

 #include "wx/toplevel.h"      // the base class
 
 // the default names for various classs
 #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;
+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
 
 // ----------------------------------------------------------------------------
 // constants


@@ -54,7 +50,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


@@ -76,12 +72,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
     // ------------------


@@ -89,10 +79,24 @@ 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

 
 

-    // process menu command: returns TRUE if processed
+    // 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 const wxMenuItem *FindItemInMenuBar(int menuId) const;
+
+    // generate menu command corresponding to the given menu item
+    //
+    // returns true if processed
+    bool ProcessCommand(wxMenuItem *item);
+
+    // 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
     // --------------------
 
     // status bar functions
     // --------------------


@@ -112,8 +116,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; PositionStatusBar(); }
+    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);


@@ -132,7 +135,7 @@ public:
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
     virtual wxToolBar* CreateToolBar(long style = -1,
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
     virtual wxToolBar* CreateToolBar(long style = -1,

-                                     wxWindowID winid = -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,


@@ -141,7 +144,7 @@ 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
 #endif // wxUSE_TOOLBAR
 
     // implementation only from now on


@@ -157,7 +160,7 @@ public:
 
     // send wxUpdateUIEvents for all menu items in the menubar,
     // or just for menu if non-NULL
 
     // send wxUpdateUIEvents for all menu items in the menubar,
     // or just for menu if non-NULL

-    void DoMenuUpdates(wxMenu* menu = NULL);
+    virtual void DoMenuUpdates(wxMenu* menu = NULL);

 #endif // wxUSE_MENUS
 
     // do the UI update processing for this window
 #endif // wxUSE_MENUS
 
     // do the UI update processing for this window


@@ -172,19 +175,22 @@ public:
 #ifndef wxTopLevelWindowNative
     virtual bool ShowFullScreen(bool WXUNUSED(show),
                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
 #ifndef wxTopLevelWindowNative
     virtual bool ShowFullScreen(bool WXUNUSED(show),
                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)

-        { return FALSE; }
+        { return false; }

     virtual bool IsFullScreen() const
     virtual bool IsFullScreen() const

-        { return FALSE; }
+        { return false; }

 #endif // no wxTopLevelWindowNative
 
 #endif // no wxTopLevelWindowNative
 

-    // show help text (typically in the statusbar); show is FALSE
-    // if you are hiding the help, TRUE otherwise
+#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

 
 

-#if WXWIN_COMPATIBILITY_2_2
-    // call this to simulate a menu command
-    bool Command(int winid) { return ProcessCommand(winid); }
-#endif // WXWIN_COMPATIBILITY_2_2
+    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


@@ -210,21 +216,22 @@ protected:
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;

+#endif // wxUSE_MENUS

 
 

-#if wxUSE_STATUSBAR
+#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)

     // the saved status bar text overwritten by DoGiveHelp()
     wxString m_oldStatusText;
     // the saved status bar text overwritten by DoGiveHelp()
     wxString m_oldStatusText;

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


@@ -251,14 +258,18 @@ protected:
 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
     #include "wx/univ/frame.h"
 #else // !__WXUNIVERSAL__
 #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__)