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
  23 WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
  24 WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
  25 WXDLLEXPORT_DATA(extern const char*) wxStatusLineNameStr;
  26
  27 class WXDLLEXPORT wxMenuBar;
  28 class WXDLLEXPORT wxStatusBar;
  29
  30 class WXDLLEXPORT wxFrame : public wxWindow
  31 {
  32 DECLARE_DYNAMIC_CLASS(wxFrame)
  33
  34 public:
  35     wxFrame();
  36     wxFrame(wxWindow *parent,
  37         wxWindowID id,
  38         const wxString& title,
  39         const wxPoint& pos = wxDefaultPosition,
  40         const wxSize& size = wxDefaultSize,
  41         long style = wxDEFAULT_FRAME_STYLE,
  42         const wxString& name = wxFrameNameStr)
  43     {
  44         Create(parent, id, title, pos, size, style, name);
  45     }
  46
  47     ~wxFrame();
  48
  49     bool Create(wxWindow *parent,
  50                 wxWindowID id,
  51                 const wxString& title,
  52                 const wxPoint& pos = wxDefaultPosition,
  53                 const wxSize& size = wxDefaultSize,
  54                 long style = wxDEFAULT_FRAME_STYLE,
  55                 const wxString& name = wxFrameNameStr);
  56
  57     virtual bool Destroy();
  58
  59     void GetClientSize(int *width, int *height) const;
  60     void GetSize(int *width, int *height) const ;
  61     void GetPosition(int *x, int *y) const ;
  62
  63     virtual void ClientToScreen(int *x, int *y) const;
  64
  65     virtual void ScreenToClient(int *x, int *y) const;
  66
  67     void OnSize(wxSizeEvent& event);
  68     void OnMenuHighlight(wxMenuEvent& event);
  69     void OnActivate(wxActivateEvent& event);
  70     void OnIdle(wxIdleEvent& event);
  71     void OnCloseWindow(wxCloseEvent& event);
  72
  73     bool Show(bool show);
  74
  75     // Set menu bar
  76     void SetMenuBar(wxMenuBar *menu_bar);
  77     virtual wxMenuBar *GetMenuBar() const ;
  78
  79     // Set title
  80     void SetTitle(const wxString& title);
  81     wxString GetTitle() const ;
  82
  83     void Centre(int direction = wxBOTH);
  84
  85     // Call this to simulate a menu command
  86     virtual void Command(int id);
  87     virtual void ProcessCommand(int id);
  88
  89     // Set icon
  90     virtual void SetIcon(const wxIcon& icon);
  91
  92     // Toolbar
  93     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
  94                                      wxWindowID id = -1,
  95                                      const wxString& name = wxToolBarNameStr);
  96
  97     virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
  98
  99     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
 100     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 101
 102     virtual void PositionToolBar();
 103
 104     // Status bar
 105     virtual wxStatusBar* CreateStatusBar(int number = 1,
 106                                          long style = wxST_SIZEGRIP,
 107                                          wxWindowID id = 0,
 108                                          const wxString& name = wxStatusLineNameStr);
 109
 110     wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 111     void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
 112
 113     virtual void PositionStatusBar();
 114     virtual wxStatusBar *OnCreateStatusBar(int number,
 115                                            long style,
 116                                            wxWindowID id,
 117                                            const wxString& name);
 118
 119     // Set status line text
 120     virtual void SetStatusText(const wxString& text, int number = 0);
 121
 122     // Set status line widths
 123     virtual void SetStatusWidths(int n, const int widths_field[]);
 124
 125     // Hint to tell framework which status bar to use
 126     // TODO: should this go into a wxFrameworkSettings class perhaps?
 127     static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
 128     static bool UsesNativeStatusBar() { return m_useNativeStatusBar; };
 129
 130     // Fit frame around subwindows
 131     virtual void Fit();
 132
 133     // Iconize
 134     virtual void Iconize(bool iconize);
 135
 136     virtual bool IsIconized() const ;
 137
 138     // Is it maximized?
 139     virtual bool IsMaximized() const ;
 140
 141     // Compatibility
 142     bool Iconized() const { return IsIconized(); }
 143
 144     virtual void Maximize(bool maximize);
 145     //  virtual bool LoadAccelerators(const wxString& table);
 146
 147     // Responds to colour changes
 148     void OnSysColourChanged(wxSysColourChangedEvent& event);
 149
 150     // Query app for menu item updates (called from OnIdle)
 151     void DoMenuUpdates();
 152     void DoMenuUpdates(wxMenu* menu);
 153
 154     WXHMENU GetWinMenu() const ;
 155
 156     // Returns the origin of client area (may be different from (0,0) if the
 157     // frame has a toolbar)
 158     virtual wxPoint GetClientAreaOrigin() const;
 159
 160     // Implementation only from here
 161         // event handlers
 162     bool MSWOnPaint();
 163     WXHICON MSWOnQueryDragIcon();
 164     void MSWOnSize(int x, int y, WXUINT flag);
 165     bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
 166     bool MSWOnClose();
 167     void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
 168     bool MSWProcessMessage(WXMSG *msg);
 169     bool MSWTranslateMessage(WXMSG *msg);
 170     void MSWCreate(int id, wxWindow *parent, const char *wclass,
 171                    wxWindow *wx_win, const char *title,
 172                    int x, int y, int width, int height, long style);
 173
 174   // tooltip management
 175 #if wxUSE_TOOLTIPS
 176   WXHWND GetToolTipCtrl() const { return m_hwndToolTip; }
 177   void SetToolTipCtrl(WXHWND hwndTT) { m_hwndToolTip = hwndTT; }
 178 #endif // tooltips
 179
 180 protected:
 181     // propagate our state change to all child frames
 182     void IconizeChildFrames(bool bIconize);
 183
 184     wxMenuBar *           m_frameMenuBar;
 185     wxStatusBar *         m_frameStatusBar;
 186     wxIcon                m_icon;
 187     bool                  m_iconized;
 188     WXHICON               m_defaultIcon;
 189     wxToolBar *           m_frameToolBar ;
 190
 191     static bool           m_useNativeStatusBar;
 192
 193 #if wxUSE_TOOLTIPS
 194     WXHWND                m_hwndToolTip;
 195 #endif // tooltips
 196
 197     virtual void DoSetSize(int x, int y,
 198                            int width, int height,
 199                            int sizeFlags = wxSIZE_AUTO);
 200     virtual void DoSetClientSize(int width, int height);
 201
 202 private:
 203     DECLARE_EVENT_TABLE()
 204 };
 205
 206 #endif
 207     // _WX_FRAME_H_