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