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 and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAME_H_
  13 #define _WX_FRAME_H_
  14
  15 #ifdef __GNUG__
  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 void Maximize(bool maximize = TRUE);
  49     virtual bool IsMaximized() const;
  50     virtual void Iconize(bool iconize = TRUE);
  51     virtual bool IsIconized() const;
  52     virtual void Restore();
  53     virtual void SetMenuBar(wxMenuBar *menubar);
  54     virtual void SetIcon(const wxIcon& icon);
  55
  56     // implementation only from now on
  57     // -------------------------------
  58
  59     // override some more virtuals
  60     virtual bool Show(bool show = TRUE);
  61
  62     // event handlers
  63     void OnActivate(wxActivateEvent& event);
  64     void OnSysColourChanged(wxSysColourChangedEvent& event);
  65
  66     // Toolbar
  67 #if wxUSE_TOOLBAR
  68     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
  69                                      wxWindowID id = -1,
  70                                      const wxString& name = wxToolBarNameStr);
  71
  72     virtual void PositionToolBar();
  73 #endif // wxUSE_TOOLBAR
  74
  75     // Status bar
  76 #if wxUSE_STATUSBAR
  77     virtual wxStatusBar* OnCreateStatusBar(int number = 1,
  78                                            long style = wxST_SIZEGRIP,
  79                                            wxWindowID id = 0,
  80                                            const wxString& name = wxStatusLineNameStr);
  81
  82     virtual void PositionStatusBar();
  83
  84     // Hint to tell framework which status bar to use: the default is to use
  85     // native one for the platforms which support it (Win32), the generic one
  86     // otherwise
  87
  88     // TODO: should this go into a wxFrameworkSettings class perhaps?
  89     static void UseNativeStatusBar(bool useNative)
  90         { m_useNativeStatusBar = useNative; };
  91     static bool UsesNativeStatusBar()
  92         { return m_useNativeStatusBar; };
  93 #endif // wxUSE_STATUSBAR
  94
  95     WXHMENU GetWinMenu() const { return m_hMenu; }
  96
  97     // Returns the origin of client area (may be different from (0,0) if the
  98     // frame has a toolbar)
  99     virtual wxPoint GetClientAreaOrigin() const;
 100
 101     // event handlers
 102     bool HandlePaint();
 103     bool HandleSize(int x, int y, WXUINT flag);
 104     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 105     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
 106
 107     bool MSWCreate(int id, wxWindow *parent, const wxChar *wclass,
 108                    wxWindow *wx_win, const wxChar *title,
 109                    int x, int y, int width, int height, long style);
 110
 111     // tooltip management
 112 #if wxUSE_TOOLTIPS
 113     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
 114     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 115 #endif // tooltips
 116
 117 protected:
 118     // common part of all ctors
 119     void Init();
 120
 121     // common part of Iconize(), Maximize() and Restore()
 122     void DoShowWindow(int nShowCmd);
 123
 124     // override base class virtuals
 125     virtual void DoGetClientSize(int *width, int *height) const;
 126     virtual void DoGetSize(int *width, int *height) const;
 127     virtual void DoGetPosition(int *x, int *y) const;
 128
 129     virtual void DoSetClientSize(int width, int height);
 130
 131     virtual void DoClientToScreen(int *x, int *y) const;
 132     virtual void DoScreenToClient(int *x, int *y) const;
 133
 134     // helper
 135     void DetachMenuBar();
 136
 137     // a plug in for MDI frame classes which need to do something special when
 138     // the menubar is set
 139     virtual void InternalSetMenuBar();
 140
 141     // propagate our state change to all child frames
 142     void IconizeChildFrames(bool bIconize);
 143
 144     // we add menu bar accel processing
 145     bool MSWTranslateMessage(WXMSG* pMsg);
 146
 147     // window proc for the frames
 148     long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 149
 150     bool                  m_iconized;
 151     WXHICON               m_defaultIcon;
 152
 153 #if wxUSE_STATUSBAR
 154     static bool           m_useNativeStatusBar;
 155 #endif // wxUSE_STATUSBAR
 156
 157 private:
 158 #if wxUSE_TOOLTIPS
 159     WXHWND                m_hwndToolTip;
 160 #endif // tooltips
 161
 162     DECLARE_EVENT_TABLE()
 163     DECLARE_DYNAMIC_CLASS(wxFrame)
 164 };
 165
 166 #endif
 167     // _WX_FRAME_H_