minor refactoring of OnEraseBackground()

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

diff --git a/include/wx/msw/frame.h b/include/wx/msw/frame.h
index 5ccba3701c738b304d40bdba6eba642d889628af..caff90d67d2320944732a2ed42bb1b10331c8454 100644 (file)
--- a/include/wx/msw/frame.h
+++ b/include/wx/msw/frame.h
@@ -1,150 +1,172 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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 __FRAMEH__
-#define __FRAMEH__
-
-#ifdef __GNUG__
-#pragma interface "frame.h"
-#endif
-
-#include "wx/window.h"
-
-WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
-
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-
-class WXDLLEXPORT wxFrame: public wxWindow {
-
-  DECLARE_DYNAMIC_CLASS(wxFrame)
+#ifndef _WX_FRAME_H_
+#define _WX_FRAME_H_

 
 

+class WXDLLEXPORT wxFrame : public wxFrameBase
+{

 public:
 public:

-  wxFrame(void);
-  inline 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)
-  {
-      Create(parent, id, title, pos, size, style, name);
-  }
-
-  ~wxFrame(void);
-
-  bool Create(wxWindow *parent,
-           wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           long style = wxDEFAULT_FRAME_STYLE,
-           const wxString& name = wxFrameNameStr);
-
-  virtual bool Destroy(void);
-  void SetClientSize(int width, int height);
-  void GetClientSize(int *width, int *height) const;
+    // construction
+    wxFrame() { Init(); }
+    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)
+    {
+        Init();
+
+        Create(parent, id, title, pos, size, style, name);
+    }
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr);
+
+    virtual ~wxFrame();
+
+    // 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
+
+    // Status bar
+#if wxUSE_STATUSBAR
+    virtual wxStatusBar* OnCreateStatusBar(int number = 1,
+                                           long style = wxST_SIZEGRIP,
+                                           wxWindowID id = 0,
+                                           const wxString& name = wxStatusLineNameStr);
+
+    // 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
+
+    // TODO: should this go into a wxFrameworkSettings class perhaps?
+    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
+
+    // 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);

 
 

-  void GetSize(int *width, int *height) const ;
-  void GetPosition(int *x, int *y) const ;
-  void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
-
-  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(void) const ;
-
-  // Set title
-  void SetTitle(const wxString& title);
-  wxString GetTitle(void) 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);
+protected:
+    // common part of all ctors
+    void Init();

 
 

-  // Create status line
-  virtual bool CreateStatusBar(int number=1);
-  inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
+    // override base class virtuals
+    virtual void DoGetClientSize(int *width, int *height) const;
+    virtual void DoSetClientSize(int width, int height);

 
 

-  // Set status line text
-  virtual void SetStatusText(const wxString& text, int number = 0);
+#if wxUSE_MENUS_NATIVE
+    // perform MSW-specific action when menubar is changed
+    virtual void AttachMenuBar(wxMenuBar *menubar);

 
 

-  // Set status line widths
-  virtual void SetStatusWidths(int n, int *widths_field);
+    // 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

 
 

-  // Hint to tell framework which status bar to use
-  // TODO: should this go into a wxFrameworkSettings class perhaps?
-  static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
-  static bool UsesNativeStatusBar(void) { return m_useNativeStatusBar; };
+    // propagate our state change to all child frames
+    void IconizeChildFrames(bool bIconize);

 
 

-  // Fit frame around subwindows
-  virtual void Fit(void);
+    // the real implementation of MSWTranslateMessage(), also used by
+    // wxMDIChildFrame
+    bool MSWDoTranslateMessage(wxFrame *frame, WXMSG *msg);

 
 

-  // Iconize
-  virtual void Iconize(bool iconize);
+    // handle WM_INITMENUPOPUP message to generate wxEVT_MENU_OPEN
+    bool HandleInitMenuPopup(WXHMENU hMenu);

 
 

-  virtual bool IsIconized(void) const ;
+    virtual bool IsMDIChild() const { return false; }

 
 

-  // Compatibility
-  inline bool Iconized(void) const { return IsIconized(); }
+    // get default (wxWidgets) icon for the frame
+    virtual WXHICON GetDefaultIcon() const;

 
 

-  virtual void Maximize(bool maximize);
-  virtual bool LoadAccelerators(const wxString& table);
+#if wxUSE_TOOLBAR
+    virtual void PositionToolBar();
+#endif // wxUSE_TOOLBAR

 
 

-  virtual void PositionStatusBar(void);
-  virtual wxStatusBar *OnCreateStatusBar(int number);
+#if wxUSE_STATUSBAR
+    virtual void PositionStatusBar();

 
 

-  // Query app for menu item updates (called from OnIdle)
-  void DoMenuUpdates(void);
-  void DoMenuUpdates(wxMenu* menu);
+    static bool           m_useNativeStatusBar;
+#endif // wxUSE_STATUSBAR

 
 

-  WXHMENU GetWinMenu(void) const ;
+#if wxUSE_MENUS
+    // frame menu, NULL if none
+    WXHMENU m_hMenu;
+#endif // wxUSE_MENUS

 
 

-  // Responds to colour changes
-  void OnSysColourChanged(wxSysColourChangedEvent& event);
+private:
+#if wxUSE_TOOLTIPS
+    WXHWND                m_hwndToolTip;
+#endif // tooltips

 
 

-  // Handlers
-  bool MSWOnPaint(void);
-  WXHICON MSWOnQueryDragIcon(void);
-  void MSWOnSize(int x, int y, WXUINT flag);
-  bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
-  bool MSWOnClose(void);
-  void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
-  bool MSWProcessMessage(WXMSG *msg);
-  void MSWCreate(int id, wxWindow *parent, const char *WXUNUSED(wclass), wxWindow *wx_win, const char *title,
-                   int x, int y, int width, int height, long style);
+    // used by IconizeChildFrames(), see comments there
+    bool m_wasMinimized;

 
 

-protected:
-  wxMenuBar *           m_frameMenuBar;
-  wxStatusBar *         m_frameStatusBar;
-  wxIcon                m_icon;
-  bool                  m_iconized;
-  WXHICON               m_defaultIcon;
-  static bool           m_useNativeStatusBar;
-
-  DECLARE_EVENT_TABLE()
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxFrame)

 };
 
 #endif
 };
 
 #endif

-    // __FRAMEH__
+    // _WX_FRAME_H_