include/wx/msw/frame.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/frame.h
   3 // Purpose:     wxFrame class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAME_H_
  13 #define _WX_FRAME_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "frame.h"
  17 #endif
  18
  19 class WXDLLEXPORT wxFrame : public wxFrameBase
  20 {
  21 public:
  22     // construction
  23     wxFrame() { Init(); }
  24     wxFrame(wxWindow *parent,
  25                wxWindowID id,
  26                const wxString& title,
  27                const wxPoint& pos = wxDefaultPosition,
  28                const wxSize& size = wxDefaultSize,
  29                long style = wxDEFAULT_FRAME_STYLE,
  30                const wxString& name = wxFrameNameStr)
  31     {
  32         Init();
  33
  34         Create(parent, id, title, pos, size, style, name);
  35     }
  36
  37     bool Create(wxWindow *parent,
  38                 wxWindowID id,
  39                 const wxString& title,
  40                 const wxPoint& pos = wxDefaultPosition,
  41                 const wxSize& size = wxDefaultSize,
  42                 long style = wxDEFAULT_FRAME_STYLE,
  43                 const wxString& name = wxFrameNameStr);
  44
  45     virtual ~wxFrame();
  46
  47     // implement base class pure virtuals
  48     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  49     virtual void Raise();
  50
  51     // implementation only from now on
  52     // -------------------------------
  53
  54     // event handlers
  55     void OnSysColourChanged(wxSysColourChangedEvent& event);
  56
  57     // Toolbar
  58 #if wxUSE_TOOLBAR
  59     virtual wxToolBar* CreateToolBar(long style = -1,
  60                                      wxWindowID id = wxID_ANY,
  61                                      const wxString& name = wxToolBarNameStr);
  62
  63     virtual void PositionToolBar();
  64 #endif // wxUSE_TOOLBAR
  65
  66     // Status bar
  67 #if wxUSE_STATUSBAR
  68     virtual wxStatusBar* OnCreateStatusBar(int number = 1,
  69                                            long style = wxST_SIZEGRIP,
  70                                            wxWindowID id = 0,
  71                                            const wxString& name = wxStatusLineNameStr);
  72
  73     virtual void PositionStatusBar();
  74
  75     // Hint to tell framework which status bar to use: the default is to use
  76     // native one for the platforms which support it (Win32), the generic one
  77     // otherwise
  78
  79     // TODO: should this go into a wxFrameworkSettings class perhaps?
  80     static void UseNativeStatusBar(bool useNative)
  81         { m_useNativeStatusBar = useNative; };
  82     static bool UsesNativeStatusBar()
  83         { return m_useNativeStatusBar; };
  84 #endif // wxUSE_STATUSBAR
  85
  86 #if wxUSE_MENUS
  87     WXHMENU GetWinMenu() const { return m_hMenu; }
  88 #endif // wxUSE_MENUS
  89
  90     // event handlers
  91     bool HandlePaint();
  92     bool HandleSize(int x, int y, WXUINT flag);
  93     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  94     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
  95     bool HandleMenuLoop(const wxEventType& evtType, WXWORD isPopup);
  96
  97     // tooltip management
  98 #if wxUSE_TOOLTIPS
  99     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
 100     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 101 #endif // tooltips
 102
 103     // a MSW only function which sends a size event to the window using its
 104     // current size - this has an effect of refreshing the window layout
 105     virtual void SendSizeEvent();
 106
 107     virtual wxPoint GetClientAreaOrigin() const;
 108
 109 protected:
 110     // common part of all ctors
 111     void Init();
 112
 113     // override base class virtuals
 114     virtual void DoGetClientSize(int *width, int *height) const;
 115     virtual void DoSetClientSize(int width, int height);
 116
 117 #if wxUSE_MENUS_NATIVE
 118     // perform MSW-specific action when menubar is changed
 119     virtual void AttachMenuBar(wxMenuBar *menubar);
 120
 121     // a plug in for MDI frame classes which need to do something special when
 122     // the menubar is set
 123     virtual void InternalSetMenuBar();
 124 #endif // wxUSE_MENUS_NATIVE
 125
 126     // propagate our state change to all child frames
 127     void IconizeChildFrames(bool bIconize);
 128
 129     // we add menu bar accel processing
 130     bool MSWTranslateMessage(WXMSG* pMsg);
 131
 132     // window proc for the frames
 133     WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 134
 135     // handle WM_INITMENUPOPUP message
 136     bool HandleInitMenuPopup(WXHMENU hMenu);
 137
 138     virtual bool IsMDIChild() const { return false; }
 139
 140     // get default (wxWidgets) icon for the frame
 141     virtual WXHICON GetDefaultIcon() const;
 142
 143 #if wxUSE_STATUSBAR
 144     static bool           m_useNativeStatusBar;
 145 #endif // wxUSE_STATUSBAR
 146
 147 #if wxUSE_MENUS
 148     // frame menu, NULL if none
 149     WXHMENU m_hMenu;
 150 #endif // wxUSE_MENUS
 151
 152 private:
 153 #if wxUSE_TOOLTIPS
 154     WXHWND                m_hwndToolTip;
 155 #endif // tooltips
 156
 157     // used by IconizeChildFrames(), see comments there
 158     bool m_wasMinimized;
 159
 160     DECLARE_EVENT_TABLE()
 161     DECLARE_DYNAMIC_CLASS_NO_COPY(wxFrame)
 162 };
 163
 164 #endif
 165     // _WX_FRAME_H_