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 bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  49     virtual void Raise();
  50
  51     // implementation only from now on
  52     // -------------------------------
  53
  54     // event handlers
  55     void OnActivate(wxActivateEvent& event);
  56     void OnSysColourChanged(wxSysColourChangedEvent& event);
  57
  58     // Toolbar
  59 #if wxUSE_TOOLBAR
  60     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
  61                                      wxWindowID id = -1,
  62                                      const wxString& name = wxToolBarNameStr);
  63
  64     virtual void PositionToolBar();
  65 #endif // wxUSE_TOOLBAR
  66
  67     // Status bar
  68 #if wxUSE_STATUSBAR
  69     virtual wxStatusBar* OnCreateStatusBar(int number = 1,
  70                                            long style = wxST_SIZEGRIP,
  71                                            wxWindowID id = 0,
  72                                            const wxString& name = wxStatusLineNameStr);
  73
  74     virtual void PositionStatusBar();
  75
  76     // Hint to tell framework which status bar to use: the default is to use
  77     // native one for the platforms which support it (Win32), the generic one
  78     // otherwise
  79
  80     // TODO: should this go into a wxFrameworkSettings class perhaps?
  81     static void UseNativeStatusBar(bool useNative)
  82         { m_useNativeStatusBar = useNative; };
  83     static bool UsesNativeStatusBar()
  84         { return m_useNativeStatusBar; };
  85 #endif // wxUSE_STATUSBAR
  86
  87     WXHMENU GetWinMenu() const { return m_hMenu; }
  88
  89     // event handlers
  90     bool HandlePaint();
  91     bool HandleSize(int x, int y, WXUINT flag);
  92     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  93     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
  94
  95     // tooltip management
  96 #if wxUSE_TOOLTIPS
  97     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
  98     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
  99 #endif // tooltips
 100
 101     // a MSW only function which sends a size event to the window using its
 102     // current size - this has an effect of refreshing the window layout
 103     void SendSizeEvent();
 104
 105     // called by wxWindow whenever it gets focus
 106     void SetLastFocus(wxWindow *win) { m_winLastFocused = win; }
 107     wxWindow *GetLastFocus() const { return m_winLastFocused; }
 108
 109 protected:
 110     // common part of all ctors
 111     void Init();
 112
 113     // override base class virtuals
 114     virtual void DoGetClientSize(int *width, int *height) const;
 115     virtual void DoSetClientSize(int width, int height);
 116
 117 #if wxUSE_MENUS_NATIVE
 118     // perform MSW-specific action when menubar is changed
 119     virtual void AttachMenuBar(wxMenuBar *menubar);
 120
 121     // a plug in for MDI frame classes which need to do something special when
 122     // the menubar is set
 123     virtual void InternalSetMenuBar();
 124 #endif // wxUSE_MENUS_NATIVE
 125
 126     // propagate our state change to all child frames
 127     void IconizeChildFrames(bool bIconize);
 128
 129     // we add menu bar accel processing
 130     bool MSWTranslateMessage(WXMSG* pMsg);
 131
 132     // window proc for the frames
 133     long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 134
 135     virtual bool IsMDIChild() const { return FALSE; }
 136
 137     // get default (wxWindows) icon for the frame
 138     virtual WXHICON GetDefaultIcon() const;
 139
 140 #if wxUSE_STATUSBAR
 141     static bool           m_useNativeStatusBar;
 142 #endif // wxUSE_STATUSBAR
 143
 144     // the last focused child: we restore focus to it on activation
 145     wxWindow             *m_winLastFocused;
 146
 147     // Data to save/restore when calling ShowFullScreen
 148     int                   m_fsStatusBarFields; // 0 for no status bar
 149     int                   m_fsStatusBarHeight;
 150     int                   m_fsToolBarHeight;
 151 //    WXHMENU               m_fsMenu;
 152
 153 private:
 154 #if wxUSE_TOOLTIPS
 155     WXHWND                m_hwndToolTip;
 156 #endif // tooltips
 157
 158     // used by IconizeChildFrames(), see comments there
 159     bool m_wasMinimized;
 160
 161     DECLARE_EVENT_TABLE()
 162     DECLARE_DYNAMIC_CLASS(wxFrame)
 163 };
 164
 165 #endif
 166     // _WX_FRAME_H_