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