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 __FRAMEH__
  13 #define __FRAMEH__
  14
  15 #ifdef __GNUG__
  16 #pragma interface "frame.h"
  17 #endif
  18
  19 #include "wx/window.h"
  20
  21 WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
  22
  23 class WXDLLEXPORT wxMenuBar;
  24 class WXDLLEXPORT wxStatusBar;
  25
  26 class WXDLLEXPORT wxFrame: public wxWindow {
  27
  28   DECLARE_DYNAMIC_CLASS(wxFrame)
  29
  30 public:
  31   wxFrame(void);
  32   inline wxFrame(wxWindow *parent,
  33            wxWindowID id,
  34            const wxString& title,
  35            const wxPoint& pos = wxDefaultPosition,
  36            const wxSize& size = wxDefaultSize,
  37            long style = wxDEFAULT_FRAME_STYLE,
  38            const wxString& name = wxFrameNameStr)
  39   {
  40       Create(parent, id, title, pos, size, style, name);
  41   }
  42
  43   ~wxFrame(void);
  44
  45   bool Create(wxWindow *parent,
  46            wxWindowID id,
  47            const wxString& title,
  48            const wxPoint& pos = wxDefaultPosition,
  49            const wxSize& size = wxDefaultSize,
  50            long style = wxDEFAULT_FRAME_STYLE,
  51            const wxString& name = wxFrameNameStr);
  52
  53   virtual bool Destroy(void);
  54   void SetClientSize(int width, int height);
  55   void GetClientSize(int *width, int *height) const;
  56
  57   void GetSize(int *width, int *height) const ;
  58   void GetPosition(int *x, int *y) const ;
  59   void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
  60
  61   virtual bool OnClose(void);
  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(void) const ;
  74
  75   // Set title
  76   void SetTitle(const wxString& title);
  77   wxString GetTitle(void) const ;
  78
  79   void Centre(int direction = wxBOTH);
  80
  81   // Call this to simulate a menu command
  82   virtual void Command(int id);
  83   virtual void ProcessCommand(int id);
  84
  85   // Set icon
  86   virtual void SetIcon(const wxIcon& icon);
  87
  88   // Create status line
  89   virtual bool CreateStatusBar(int number=1);
  90   inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
  91
  92   // Set status line text
  93   virtual void SetStatusText(const wxString& text, int number = 0);
  94
  95   // Set status line widths
  96   virtual void SetStatusWidths(int n, const int widths_field[]);
  97
  98   // Hint to tell framework which status bar to use
  99   // TODO: should this go into a wxFrameworkSettings class perhaps?
 100   static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
 101   static bool UsesNativeStatusBar(void) { return m_useNativeStatusBar; };
 102
 103   // Fit frame around subwindows
 104   virtual void Fit(void);
 105
 106   // Iconize
 107   virtual void Iconize(bool iconize);
 108
 109   virtual bool IsIconized(void) const ;
 110
 111   // Compatibility
 112   inline bool Iconized(void) const { return IsIconized(); }
 113
 114   virtual void Maximize(bool maximize);
 115   virtual bool LoadAccelerators(const wxString& table);
 116
 117   virtual void PositionStatusBar(void);
 118   virtual wxStatusBar *OnCreateStatusBar(int number);
 119
 120   // Query app for menu item updates (called from OnIdle)
 121   void DoMenuUpdates(void);
 122   void DoMenuUpdates(wxMenu* menu);
 123
 124   WXHMENU GetWinMenu(void) const ;
 125
 126   // Responds to colour changes
 127   void OnSysColourChanged(wxSysColourChangedEvent& event);
 128
 129   // Handlers
 130   bool MSWOnPaint(void);
 131   WXHICON MSWOnQueryDragIcon(void);
 132   void MSWOnSize(int x, int y, WXUINT flag);
 133   bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
 134   bool MSWOnClose(void);
 135   void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
 136   bool MSWProcessMessage(WXMSG *msg);
 137   void MSWCreate(int id, wxWindow *parent, const char *WXUNUSED(wclass), wxWindow *wx_win, const char *title,
 138                    int x, int y, int width, int height, long style);
 139
 140 protected:
 141   wxMenuBar *           m_frameMenuBar;
 142   wxStatusBar *         m_frameStatusBar;
 143   wxIcon                m_icon;
 144   bool                  m_iconized;
 145   WXHICON               m_defaultIcon;
 146   static bool           m_useNativeStatusBar;
 147
 148   DECLARE_EVENT_TABLE()
 149 };
 150
 151 #endif
 152     // __FRAMEH__