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 class WXDLLIMPEXP_CORE wxFrame : public wxFrameBase
  16 {
  17 public:
  18     // construction
  19     wxFrame() { Init(); }
  20     wxFrame(wxWindow *parent,
  21             wxWindowID id,
  22             const wxString& title,
  23             const wxPoint& pos = wxDefaultPosition,
  24             const wxSize& size = wxDefaultSize,
  25             long style = wxDEFAULT_FRAME_STYLE,
  26             const wxString& name = wxFrameNameStr)
  27     {
  28         Init();
  29
  30         Create(parent, id, title, pos, size, style, name);
  31     }
  32
  33     bool Create(wxWindow *parent,
  34                 wxWindowID id,
  35                 const wxString& title,
  36                 const wxPoint& pos = wxDefaultPosition,
  37                 const wxSize& size = wxDefaultSize,
  38                 long style = wxDEFAULT_FRAME_STYLE,
  39                 const wxString& name = wxFrameNameStr);
  40
  41     virtual ~wxFrame();
  42
  43     // implement base class pure virtuals
  44     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  45     virtual void Raise();
  46
  47     // implementation only from now on
  48     // -------------------------------
  49
  50     // event handlers
  51     void OnSysColourChanged(wxSysColourChangedEvent& event);
  52
  53     // Toolbar
  54 #if wxUSE_TOOLBAR
  55     virtual wxToolBar* CreateToolBar(long style = -1,
  56                                      wxWindowID id = wxID_ANY,
  57                                      const wxString& name = wxToolBarNameStr);
  58 #endif // wxUSE_TOOLBAR
  59
  60     // Status bar
  61 #if wxUSE_STATUSBAR
  62     virtual wxStatusBar* OnCreateStatusBar(int number = 1,
  63                                            long style = wxST_SIZEGRIP,
  64                                            wxWindowID id = 0,
  65                                            const wxString& name = wxStatusLineNameStr);
  66
  67     // Hint to tell framework which status bar to use: the default is to use
  68     // native one for the platforms which support it (Win32), the generic one
  69     // otherwise
  70
  71     // TODO: should this go into a wxFrameworkSettings class perhaps?
  72     static void UseNativeStatusBar(bool useNative)
  73         { m_useNativeStatusBar = useNative; }
  74     static bool UsesNativeStatusBar()
  75         { return m_useNativeStatusBar; }
  76 #endif // wxUSE_STATUSBAR
  77
  78     // event handlers
  79     bool HandleSize(int x, int y, WXUINT flag);
  80     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  81     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
  82     bool HandleMenuLoop(const wxEventType& evtType, WXWORD isPopup);
  83
  84     // tooltip management
  85 #if wxUSE_TOOLTIPS
  86     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
  87     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
  88 #endif // tooltips
  89
  90     // override the base class function to handle iconized/maximized frames
  91     virtual void SendSizeEvent(int flags = 0);
  92
  93     virtual wxPoint GetClientAreaOrigin() const;
  94
  95     // override base class version to add menu bar accel processing
  96     virtual bool MSWTranslateMessage(WXMSG *msg)
  97     {
  98         return MSWDoTranslateMessage(this, msg);
  99     }
 100
 101     // window proc for the frames
 102     virtual WXLRESULT MSWWindowProc(WXUINT message,
 103                                     WXWPARAM wParam,
 104                                     WXLPARAM lParam);
 105
 106 #if wxUSE_MENUS
 107     // get the currently active menu: this is the same as the frame menu for
 108     // normal frames but is overridden by wxMDIParentFrame
 109     virtual WXHMENU MSWGetActiveMenu() const { return m_hMenu; }
 110
 111     // find the item in our menu bar: this is again a hook for MDI frames
 112     virtual wxMenuItem *MSWFindMenuBarItem(WXWORD id);
 113 #endif // wxUSE_MENUS
 114
 115 protected:
 116     // common part of all ctors
 117     void Init();
 118
 119     // override base class virtuals
 120     virtual void DoGetClientSize(int *width, int *height) const;
 121     virtual void DoSetClientSize(int width, int height);
 122
 123 #if wxUSE_MENUS_NATIVE
 124     // perform MSW-specific action when menubar is changed
 125     virtual void AttachMenuBar(wxMenuBar *menubar);
 126
 127     // a plug in for MDI frame classes which need to do something special when
 128     // the menubar is set
 129     virtual void InternalSetMenuBar();
 130 #endif // wxUSE_MENUS_NATIVE
 131
 132     // propagate our state change to all child frames
 133     void IconizeChildFrames(bool bIconize);
 134
 135     // the real implementation of MSWTranslateMessage(), also used by
 136     // wxMDIChildFrame
 137     bool MSWDoTranslateMessage(wxFrame *frame, WXMSG *msg);
 138
 139     // handle WM_INITMENUPOPUP message to generate wxEVT_MENU_OPEN
 140     bool HandleInitMenuPopup(WXHMENU hMenu);
 141
 142     virtual bool IsMDIChild() const { return false; }
 143
 144     // get default (wxWidgets) icon for the frame
 145     virtual WXHICON GetDefaultIcon() const;
 146
 147 #if wxUSE_TOOLBAR
 148     virtual void PositionToolBar();
 149 #endif // wxUSE_TOOLBAR
 150
 151 #if wxUSE_STATUSBAR
 152     virtual void PositionStatusBar();
 153
 154     static bool           m_useNativeStatusBar;
 155 #endif // wxUSE_STATUSBAR
 156
 157 #if wxUSE_MENUS
 158     // frame menu, NULL if none
 159     WXHMENU m_hMenu;
 160 #endif // wxUSE_MENUS
 161
 162 private:
 163 #if wxUSE_TOOLTIPS
 164     WXHWND                m_hwndToolTip;
 165 #endif // tooltips
 166
 167     // used by IconizeChildFrames(), see comments there
 168     bool m_wasMinimized;
 169
 170     DECLARE_EVENT_TABLE()
 171     DECLARE_DYNAMIC_CLASS_NO_COPY(wxFrame)
 172 };
 173
 174 #endif
 175     // _WX_FRAME_H_