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