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