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