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 #if wxUSE_MENUS
  79     WXHMENU GetWinMenu() const { return m_hMenu; }
  80 #endif // wxUSE_MENUS
  81
  82     // event handlers
  83     bool HandleSize(int x, int y, WXUINT flag);
  84     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  85     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
  86     bool HandleMenuLoop(const wxEventType& evtType, WXWORD isPopup);
  87
  88     // tooltip management
  89 #if wxUSE_TOOLTIPS
  90     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
  91     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
  92 #endif // tooltips
  93
  94     // override the base class function to handle iconized/maximized frames
  95     virtual void SendSizeEvent(int flags = 0);
  96
  97     virtual wxPoint GetClientAreaOrigin() const;
  98
  99     // override base class version to add menu bar accel processing
 100     virtual bool MSWTranslateMessage(WXMSG *msg)
 101     {
 102         return MSWDoTranslateMessage(this, msg);
 103     }
 104
 105     // window proc for the frames
 106     virtual WXLRESULT MSWWindowProc(WXUINT message,
 107                                     WXWPARAM wParam,
 108                                     WXLPARAM lParam);
 109
 110 protected:
 111     // common part of all ctors
 112     void Init();
 113
 114     // override base class virtuals
 115     virtual void DoGetClientSize(int *width, int *height) const;
 116     virtual void DoSetClientSize(int width, int height);
 117
 118 #if wxUSE_MENUS_NATIVE
 119     // perform MSW-specific action when menubar is changed
 120     virtual void AttachMenuBar(wxMenuBar *menubar);
 121
 122     // a plug in for MDI frame classes which need to do something special when
 123     // the menubar is set
 124     virtual void InternalSetMenuBar();
 125 #endif // wxUSE_MENUS_NATIVE
 126
 127     // propagate our state change to all child frames
 128     void IconizeChildFrames(bool bIconize);
 129
 130     // the real implementation of MSWTranslateMessage(), also used by
 131     // wxMDIChildFrame
 132     bool MSWDoTranslateMessage(wxFrame *frame, WXMSG *msg);
 133
 134     // handle WM_INITMENUPOPUP message to generate wxEVT_MENU_OPEN
 135     bool HandleInitMenuPopup(WXHMENU hMenu);
 136
 137     virtual bool IsMDIChild() const { return false; }
 138
 139     // get default (wxWidgets) icon for the frame
 140     virtual WXHICON GetDefaultIcon() const;
 141
 142 #if wxUSE_TOOLBAR
 143     virtual void PositionToolBar();
 144 #endif // wxUSE_TOOLBAR
 145
 146 #if wxUSE_STATUSBAR
 147     virtual void PositionStatusBar();
 148
 149     static bool           m_useNativeStatusBar;
 150 #endif // wxUSE_STATUSBAR
 151
 152 #if wxUSE_MENUS
 153     // frame menu, NULL if none
 154     WXHMENU m_hMenu;
 155 #endif // wxUSE_MENUS
 156
 157 private:
 158 #if wxUSE_TOOLTIPS
 159     WXHWND                m_hwndToolTip;
 160 #endif // tooltips
 161
 162     // used by IconizeChildFrames(), see comments there
 163     bool m_wasMinimized;
 164
 165     DECLARE_EVENT_TABLE()
 166     DECLARE_DYNAMIC_CLASS_NO_COPY(wxFrame)
 167 };
 168
 169 #endif
 170     // _WX_FRAME_H_