Applied slightly-modified patch 1826540 from Gareth Simpson.

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

diff --git a/include/wx/msw/frame.h b/include/wx/msw/frame.h
index d039be9de4cfc2fdb0f370b8670738b48f9720df..7b2e01632bac8e91da49b71b6cf97649b090655c 100644 (file)
--- a/include/wx/msw/frame.h
+++ b/include/wx/msw/frame.h
@@ -1,51 +1,35 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        frame.h
+// Name:        wx/msw/frame.h

 // Purpose:     wxFrame class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxFrame class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_
 #define _WX_FRAME_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_
 #define _WX_FRAME_H_
 

-#ifdef __GNUG__
-#pragma interface "frame.h"
-#endif
-
-#include "wx/window.h"
-#include "wx/toolbar.h"
-#include "wx/msw/accel.h"
-
-WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
-WXDLLEXPORT_DATA(extern const char*) wxStatusLineNameStr;
-
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-
-class WXDLLEXPORT wxFrame : public wxWindow
+class WXDLLEXPORT wxFrame : public wxFrameBase

 {
 {

-DECLARE_DYNAMIC_CLASS(wxFrame)
-

 public:
 public:

-    wxFrame();
+    // construction
+    wxFrame() { Init(); }

     wxFrame(wxWindow *parent,
     wxFrame(wxWindow *parent,

-        wxWindowID id,
-        const wxString& title,
-        const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize,
-        long style = wxDEFAULT_FRAME_STYLE,
-        const wxString& name = wxFrameNameStr)
+            wxWindowID id,
+            const wxString& title,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            long style = wxDEFAULT_FRAME_STYLE,
+            const wxString& name = wxFrameNameStr)

     {
     {

+        Init();
+

         Create(parent, id, title, pos, size, style, name);
     }
         Create(parent, id, title, pos, size, style, name);
     }

-    
-    ~wxFrame();
-    
+

     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxString& title,
     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxString& title,


@@ -53,161 +37,135 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);

-    
-    virtual bool Destroy();
-    
-    void SetClientSize(int width, int height);
-    void SetClientSize(const wxSize& sz) { wxWindow::SetClientSize(sz); }
-    
-    void GetClientSize(int *width, int *height) const;
-    wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
-    
-    void GetSize(int *width, int *height) const ;
-    wxSize GetSize() const { return wxWindow::GetSize(); }
-    
-    void GetPosition(int *x, int *y) const ;
-    wxPoint GetPosition() const { return wxWindow::GetPosition(); }
-    
-    virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-    
-    virtual void ClientToScreen(int *x, int *y) const;
-    
-    virtual void ScreenToClient(int *x, int *y) const;
-    
-    virtual bool OnClose();
-    
-    void OnSize(wxSizeEvent& event);
-    void OnMenuHighlight(wxMenuEvent& event);
-    void OnActivate(wxActivateEvent& event);
-    void OnIdle(wxIdleEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
-    
-    bool Show(bool show);
-    
-    // Set menu bar
-    void SetMenuBar(wxMenuBar *menu_bar);
-    virtual wxMenuBar *GetMenuBar() const ;
-    
-    // Set title
-    void SetTitle(const wxString& title);
-    wxString GetTitle() const ;
-    
-    void Centre(int direction = wxBOTH);
-    
-    // Call this to simulate a menu command
-    virtual void Command(int id);
-    virtual void ProcessCommand(int id);
-    
-    // Set icon
-    virtual void SetIcon(const wxIcon& icon);
-    
-    // Toolbar
-    virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
-                                     wxWindowID id = -1,
-                                     const wxString& name = wxToolBarNameStr);

 
 

-    virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
+    virtual ~wxFrame();

 
 

-    virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
-    virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
+    // implement base class pure virtuals
+    virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
+    virtual void Raise();
+
+    // implementation only from now on
+    // -------------------------------
+
+    // event handlers
+    void OnSysColourChanged(wxSysColourChangedEvent& event);
+
+    // Toolbar
+#if wxUSE_TOOLBAR
+    virtual wxToolBar* CreateToolBar(long style = -1,
+                                     wxWindowID id = wxID_ANY,
+                                     const wxString& name = wxToolBarNameStr);
+#endif // wxUSE_TOOLBAR

 
 

-    virtual void PositionToolBar();
-    

     // Status bar
     // Status bar

-    virtual wxStatusBar* CreateStatusBar(int number = 1,
-                                         long style = wxST_SIZEGRIP,
-                                         wxWindowID id = 0,
-                                         const wxString& name = wxStatusLineNameStr);
+#if wxUSE_STATUSBAR
+    virtual wxStatusBar* OnCreateStatusBar(int number = 1,
+                                           long style = wxST_SIZEGRIP,
+                                           wxWindowID id = 0,
+                                           const wxString& name = wxStatusLineNameStr);

 
 

-    wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
-    void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
+    // Hint to tell framework which status bar to use: the default is to use
+    // native one for the platforms which support it (Win32), the generic one
+    // otherwise

 
 

-    virtual void PositionStatusBar();
-    virtual wxStatusBar *OnCreateStatusBar(int number,
-                                           long style,
-                                           wxWindowID id,
-                                           const wxString& name);
-    
-    // Set status line text
-    virtual void SetStatusText(const wxString& text, int number = 0);
-    
-    // Set status line widths
-    virtual void SetStatusWidths(int n, const int widths_field[]);
-    
-    // Hint to tell framework which status bar to use

     // TODO: should this go into a wxFrameworkSettings class perhaps?
     // TODO: should this go into a wxFrameworkSettings class perhaps?

-    static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
-    static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
-    
-    // Fit frame around subwindows
-    virtual void Fit();
-    
-    // Iconize
-    virtual void Iconize(bool iconize);
-    
-    virtual bool IsIconized() const ;
-    
-    // Is it maximized?
-    virtual bool IsMaximized() const ;
-    
-    // Compatibility
-    bool Iconized() const { return IsIconized(); }
-    
-    virtual void Maximize(bool maximize);
-    //  virtual bool LoadAccelerators(const wxString& table);
-    
-    // Responds to colour changes
-    void OnSysColourChanged(wxSysColourChangedEvent& event);
-    
-    // Query app for menu item updates (called from OnIdle)
-    void DoMenuUpdates();
-    void DoMenuUpdates(wxMenu* menu);
-    
-    WXHMENU GetWinMenu() const ;
-    
-    // Returns the origin of client area (may be different from (0,0) if the
-    // frame has a toolbar)
-    virtual wxPoint GetClientAreaOrigin() const;
-    
-    // Implementation only from here
-        // event handlers
-    bool MSWOnPaint();
-    WXHICON MSWOnQueryDragIcon();
-    void MSWOnSize(int x, int y, WXUINT flag);
-    bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
-    bool MSWOnClose();
-    void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
-    bool MSWProcessMessage(WXMSG *msg);
-    bool MSWTranslateMessage(WXMSG *msg);
-    void MSWCreate(int id, wxWindow *parent, const char *wclass,
-                   wxWindow *wx_win, const char *title,
-                   int x, int y, int width, int height, long style);
-
-        // tooltip management
+    static void UseNativeStatusBar(bool useNative)
+        { m_useNativeStatusBar = useNative; }
+    static bool UsesNativeStatusBar()
+        { return m_useNativeStatusBar; }
+#endif // wxUSE_STATUSBAR
+
+#if wxUSE_MENUS
+    WXHMENU GetWinMenu() const { return m_hMenu; }
+#endif // wxUSE_MENUS
+
+    // event handlers
+    bool HandlePaint();
+    bool HandleSize(int x, int y, WXUINT flag);
+    bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
+    bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
+    bool HandleMenuLoop(const wxEventType& evtType, WXWORD isPopup);
+
+    // tooltip management

 #if wxUSE_TOOLTIPS
     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 #endif // tooltips
 
 #if wxUSE_TOOLTIPS
     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 #endif // tooltips
 

+    // a MSW only function which sends a size event to the window using its
+    // current size - this has an effect of refreshing the window layout
+    virtual void SendSizeEvent();
+
+    virtual wxPoint GetClientAreaOrigin() const;
+
+    // override base class version to add menu bar accel processing
+    virtual bool MSWTranslateMessage(WXMSG *msg)
+    {
+        return MSWDoTranslateMessage(this, msg);
+    }
+
+    // window proc for the frames
+    virtual WXLRESULT MSWWindowProc(WXUINT message,
+                                    WXWPARAM wParam,
+                                    WXLPARAM lParam);
+

 protected:
 protected:

+    // common part of all ctors
+    void Init();
+
+    // override base class virtuals
+    virtual void DoGetClientSize(int *width, int *height) const;
+    virtual void DoSetClientSize(int width, int height);
+
+#if wxUSE_MENUS_NATIVE
+    // perform MSW-specific action when menubar is changed
+    virtual void AttachMenuBar(wxMenuBar *menubar);
+
+    // a plug in for MDI frame classes which need to do something special when
+    // the menubar is set
+    virtual void InternalSetMenuBar();
+#endif // wxUSE_MENUS_NATIVE
+

     // propagate our state change to all child frames
     void IconizeChildFrames(bool bIconize);
     // propagate our state change to all child frames
     void IconizeChildFrames(bool bIconize);

-    
-    wxMenuBar *           m_frameMenuBar;
-    wxStatusBar *         m_frameStatusBar;
-    wxIcon                m_icon;
-    bool                  m_iconized;
-    WXHICON               m_defaultIcon;
-    wxToolBar *           m_frameToolBar ;
+
+    // the real implementation of MSWTranslateMessage(), also used by
+    // wxMDIChildFrame
+    bool MSWDoTranslateMessage(wxFrame *frame, WXMSG *msg);
+
+    // handle WM_INITMENUPOPUP message to generate wxEVT_MENU_OPEN
+    bool HandleInitMenuPopup(WXHMENU hMenu);
+
+    virtual bool IsMDIChild() const { return false; }
+
+    // get default (wxWidgets) icon for the frame
+    virtual WXHICON GetDefaultIcon() const;
+
+#if wxUSE_TOOLBAR
+    virtual void PositionToolBar();
+#endif // wxUSE_TOOLBAR
+
+#if wxUSE_STATUSBAR
+    virtual void PositionStatusBar();

 
     static bool           m_useNativeStatusBar;
 
     static bool           m_useNativeStatusBar;

+#endif // wxUSE_STATUSBAR
+
+#if wxUSE_MENUS
+    // frame menu, NULL if none
+    WXHMENU m_hMenu;
+#endif // wxUSE_MENUS

 
 

+private:

 #if wxUSE_TOOLTIPS
     WXHWND                m_hwndToolTip;
 #endif // tooltips
 
 #if wxUSE_TOOLTIPS
     WXHWND                m_hwndToolTip;
 #endif // tooltips
 

-private:
+    // used by IconizeChildFrames(), see comments there
+    bool m_wasMinimized;
+

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxFrame)

 };
 
 #endif
 };
 
 #endif