]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/frame.h
rename wxFileList to wxFileListCtrl
[wxWidgets.git] / include / wx / frame.h
index bb19f5a4da893ca7644661354a6ea668b04676fb..15bbfd7c35dc1d8a95c53f2762e8f43fedfd2628 100644 (file)
@@ -5,8 +5,8 @@
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-    #pragma interface "framebase.h"
-#endif
-
 #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 WXDLLEXPORT_DATA(const wxChar) wxStatusLineNameStr[];
+extern WXDLLEXPORT_DATA(const wxChar) wxToolBarNameStr[];
+
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxMenuBar;
+class WXDLLIMPEXP_FWD_CORE wxStatusBar;
+class WXDLLIMPEXP_FWD_CORE wxToolBar;
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-class WXDLLEXPORT wxToolBar;
+// wxFrame-specific (i.e. not for wxDialog) styles
+#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
@@ -44,12 +49,7 @@ 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
@@ -57,7 +57,7 @@ public:
     virtual ~wxFrameBase();
 
     wxFrame *New(wxWindow *parent,
-                 wxWindowID id,
+                 wxWindowID winid,
                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
@@ -73,10 +73,7 @@ public:
 
     // 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() { }
+    virtual void SendSizeEvent();
 
     // menu bar functions
     // ------------------
@@ -84,33 +81,35 @@ public:
 #if wxUSE_MENUS
     virtual void SetMenuBar(wxMenuBar *menubar);
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
-#endif // wxUSE_MENUS
 
-    // call this to simulate a menu command
-    bool Command(int id) { return ProcessCommand(id); }
+    // 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;
+#endif // wxUSE_MENUS
 
-    // process menu command: returns TRUE if processed
-    bool ProcessCommand(int id);
+    // process menu command: returns true if processed
+    bool ProcessCommand(int winid);
 
     // status bar functions
     // --------------------
 #if wxUSE_STATUSBAR
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,
-                                         long style = wxST_SIZEGRIP,
-                                         wxWindowID id = 0,
+                                         long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+                                         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; }
 
     // 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);
@@ -125,48 +124,61 @@ public:
 
     // toolbar functions
     // -----------------
+
 #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 = wxID_ANY,
                                      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
     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
-    void OnIdle(wxIdleEvent& event);
+#if wxUSE_MENUS
+#if wxUSE_STATUSBAR
+    void OnMenuOpen(wxMenuEvent& event);
+    void OnMenuClose(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
 
+    // 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; }
+        { return false; }
     virtual bool IsFullScreen() const
-        { return FALSE; }
+        { return false; }
 #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);
+#endif
 
 protected:
     // the frame main menu/status/tool bars
@@ -178,6 +190,10 @@ protected:
 
     // test whether this window makes part of the frame
     virtual bool IsOneOfBars(const wxWindow *win) const;
+    virtual bool IsClientAreaChild(const wxWindow *child) const
+    {
+        return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child);
+    }
 
 #if wxUSE_MENUS
     // override to update menu bar position when the frame size changes
@@ -194,14 +210,20 @@ protected:
     wxMenuBar *m_frameMenuBar;
 #endif // wxUSE_MENUS
 
+#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
+    // the saved status bar text overwritten by DoGiveHelp()
+    wxString m_oldStatusText;
+#endif
+
 #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 id);
+    // 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
@@ -217,21 +239,31 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
+#if wxUSE_MENUS && wxUSE_STATUSBAR
     DECLARE_EVENT_TABLE()
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
+    DECLARE_NO_COPY_CLASS(wxFrameBase)
 };
 
 // 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"
-    #elif defined(__WXGTK__)
+    #elif defined(__WXGTK20__)
         #include "wx/gtk/frame.h"
+    #elif defined(__WXGTK__)
+        #include "wx/gtk1/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