include/wx/msw/frame.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #include "wx/window.h"
  20 #include "wx/toolbar.h"
  21 #include "wx/msw/accel.h"
  22 #include "wx/icon.h"
  23
  24 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  25 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
  26 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
  27
  28 class WXDLLEXPORT wxMenuBar;
  29 class WXDLLEXPORT wxStatusBar;
  30
  31 class WXDLLEXPORT wxFrame : public wxWindow
  32 {
  33     DECLARE_DYNAMIC_CLASS(wxFrame)
  34
  35 public:
  36     wxFrame();
  37     wxFrame(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         Create(parent, id, title, pos, size, style, name);
  46     }
  47
  48     ~wxFrame();
  49
  50     bool Create(wxWindow *parent,
  51                 wxWindowID id,
  52                 const wxString& title,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = wxDEFAULT_FRAME_STYLE,
  56                 const wxString& name = wxFrameNameStr);
  57
  58     virtual bool Destroy();
  59
  60     virtual void ClientToScreen(int *x, int *y) const;
  61     virtual void ScreenToClient(int *x, int *y) const;
  62
  63     void OnSize(wxSizeEvent& event);
  64     void OnMenuHighlight(wxMenuEvent& event);
  65     void OnActivate(wxActivateEvent& event);
  66     void OnIdle(wxIdleEvent& event);
  67     void OnCloseWindow(wxCloseEvent& event);
  68
  69     bool Show(bool show);
  70
  71     void DetachMenuBar();
  72     // Set menu bar
  73     void SetMenuBar(wxMenuBar *menu_bar);
  74     virtual wxMenuBar *GetMenuBar() const;
  75
  76     // Call this to simulate a menu command
  77     bool Command(int id) { return ProcessCommand(id); }
  78
  79     // process menu command: returns TRUE if processed
  80     bool ProcessCommand(int id);
  81
  82     // make the window modal (all other windows unresponsive)
  83     virtual void MakeModal(bool modal = TRUE);
  84
  85     // Set icon
  86     virtual void SetIcon(const wxIcon& icon);
  87
  88     // Toolbar
  89 #if wxUSE_TOOLBAR
  90     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
  91                                      wxWindowID id = -1,
  92                                      const wxString& name = wxToolBarNameStr);
  93
  94     virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
  95
  96     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
  97     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
  98
  99     virtual void PositionToolBar();
 100 #endif // wxUSE_TOOLBAR
 101
 102 #if wxUSE_STATUSBAR
 103     // Status bar
 104     virtual wxStatusBar* CreateStatusBar(int number = 1,
 105                                          long style = wxST_SIZEGRIP,
 106                                          wxWindowID id = 0,
 107                                          const wxString& name = wxStatusLineNameStr);
 108
 109     wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 110     void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
 111
 112     virtual void PositionStatusBar();
 113     virtual wxStatusBar *OnCreateStatusBar(int number,
 114                                            long style,
 115                                            wxWindowID id,
 116                                            const wxString& name);
 117
 118     // Set status line text
 119     virtual void SetStatusText(const wxString& text, int number = 0);
 120
 121     // Set status line widths
 122     virtual void SetStatusWidths(int n, const int widths_field[]);
 123
 124     // Hint to tell framework which status bar to use
 125     // TODO: should this go into a wxFrameworkSettings class perhaps?
 126     static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
 127     static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
 128 #endif // wxUSE_STATUSBAR
 129
 130     // Iconize
 131     virtual void Iconize(bool iconize);
 132
 133     virtual bool IsIconized() const;
 134
 135     // Is it maximized?
 136     virtual bool IsMaximized() const;
 137
 138     // Compatibility
 139     bool Iconized() const { return IsIconized(); }
 140
 141     virtual void Maximize(bool maximize);
 142     //  virtual bool LoadAccelerators(const wxString& table);
 143
 144     // Responds to colour changes
 145     void OnSysColourChanged(wxSysColourChangedEvent& event);
 146
 147     // Query app for menu item updates (called from OnIdle)
 148     void DoMenuUpdates();
 149     void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
 150
 151     WXHMENU GetWinMenu() const { return m_hMenu; }
 152
 153     // Returns the origin of client area (may be different from (0,0) if the
 154     // frame has a toolbar)
 155     virtual wxPoint GetClientAreaOrigin() const;
 156
 157     // Implementation only from here
 158         // event handlers
 159     bool HandlePaint();
 160     bool HandleSize(int x, int y, WXUINT flag);
 161     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 162     bool HandleMenuSelect(WXWORD nItem, WXWORD nFlags, WXHMENU hMenu);
 163
 164     bool MSWCreate(int id, wxWindow *parent, const wxChar *wclass,
 165                    wxWindow *wx_win, const wxChar *title,
 166                    int x, int y, int width, int height, long style);
 167
 168   // tooltip management
 169 #if wxUSE_TOOLTIPS
 170     WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
 171     void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 172 #endif // tooltips
 173
 174 protected:
 175     // override base class virtuals
 176     virtual void DoGetClientSize(int *width, int *height) const;
 177     virtual void DoGetSize(int *width, int *height) const;
 178     virtual void DoGetPosition(int *x, int *y) const;
 179
 180     virtual void DoSetSize(int x, int y,
 181                            int width, int height,
 182                            int sizeFlags = wxSIZE_AUTO);
 183     virtual void DoSetClientSize(int width, int height);
 184
 185     // a plug in for MDI frame classes which need to do something special when
 186     // the menubar is set
 187     virtual void InternalSetMenuBar();
 188
 189     // propagate our state change to all child frames
 190     void IconizeChildFrames(bool bIconize);
 191
 192     // we add menu bar accel processing
 193     bool MSWTranslateMessage(WXMSG* pMsg);
 194
 195     // window proc for the frames
 196     long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 197
 198     wxMenuBar *           m_frameMenuBar;
 199     wxIcon                m_icon;
 200     bool                  m_iconized;
 201     WXHICON               m_defaultIcon;
 202
 203 #if wxUSE_STATUSBAR
 204     wxStatusBar *         m_frameStatusBar;
 205
 206     static bool           m_useNativeStatusBar;
 207 #endif // wxUSE_STATUSBAR
 208
 209 #if wxUSE_TOOLBAR
 210     wxToolBar *           m_frameToolBar;
 211 #endif // wxUSE_TOOLBAR
 212
 213 private:
 214 #if wxUSE_TOOLTIPS
 215     WXHWND                m_hwndToolTip;
 216 #endif // tooltips
 217
 218     DECLARE_EVENT_TABLE()
 219 };
 220
 221 #endif
 222     // _WX_FRAME_H_