include/wx/motif/frame.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        frame.h
   3 // Purpose:     wxFrame class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  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/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();
  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();
  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();
  57
  58   void SetClientSize(int width, int height);
  59   void SetClientSize(const wxSize& size) { wxWindow::SetClientSize(size); }
  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   virtual void SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO)
  72     { wxWindow::SetSize(rect, sizeFlags); }
  73   virtual void SetSize(const wxSize& size) { wxWindow::SetSize(size); }
  74   virtual void SetSize(int width, int height) { SetSize(-1, -1, width, height, wxSIZE_USE_EXISTING); }
  75
  76   void ClientToScreen(int *x, int *y) const;
  77   wxPoint ClientToScreen(const wxPoint& pt) const { return wxWindow::ClientToScreen(pt); }
  78
  79   void ScreenToClient(int *x, int *y) const;
  80   wxPoint ScreenToClient(const wxPoint& pt) const { return wxWindow::ScreenToClient(pt); }
  81
  82   void OnSize(wxSizeEvent& event);
  83   void OnMenuHighlight(wxMenuEvent& event);
  84   void OnActivate(wxActivateEvent& event);
  85   void OnIdle(wxIdleEvent& event);
  86   void OnCloseWindow(wxCloseEvent& event);
  87
  88   bool Show(bool show);
  89
  90   // Set menu bar
  91   void SetMenuBar(wxMenuBar *menu_bar);
  92   virtual wxMenuBar *GetMenuBar() const ;
  93
  94   // Set title
  95   void SetTitle(const wxString& title);
  96   inline wxString GetTitle() const { return m_title; }
  97
  98   void Centre(int direction = wxBOTH);
  99
 100   // Call this to simulate a menu command
 101   virtual void Command(int id);
 102   virtual void ProcessCommand(int id);
 103
 104   // Set icon
 105   virtual void SetIcon(const wxIcon& icon);
 106
 107   // Create status line
 108   virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
 109     const wxString& name = "statusBar");
 110   inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 111   virtual void PositionStatusBar();
 112   virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
 113     const wxString& name);
 114
 115   // Create toolbar
 116 #if wxUSE_TOOLBAR
 117   virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL, wxWindowID id = -1, const wxString& name = wxToolBarNameStr);
 118   virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
 119   // If made known to the frame, the frame will manage it automatically.
 120   virtual void SetToolBar(wxToolBar *toolbar) ;
 121   virtual wxToolBar *GetToolBar() const ;
 122   virtual void PositionToolBar();
 123 #endif // wxUSE_TOOLBAR
 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() { return m_useNativeStatusBar; };
 135
 136   // Fit frame around subwindows
 137   virtual void Fit();
 138
 139   // Iconize
 140   virtual void Iconize(bool iconize);
 141
 142   virtual bool IsIconized() const ;
 143
 144   // Compatibility
 145   inline bool Iconized() const { return IsIconized(); }
 146
 147   // Is the frame maximized? Returns FALSE under Motif (but TRUE for
 148   // wxMDIChildFrame due to the tabbed implementation).
 149   virtual bool IsMaximized(void) const ;
 150
 151   virtual void Maximize(bool maximize);
 152
 153   // Responds to colour changes
 154   void OnSysColourChanged(wxSysColourChangedEvent& event);
 155
 156   // Query app for menu item updates (called from OnIdle)
 157   void DoMenuUpdates();
 158   void DoMenuUpdates(wxMenu* menu);
 159
 160   // Checks if there is a toolbar, and returns the first free client position
 161   virtual wxPoint GetClientAreaOrigin() const;
 162
 163   virtual void Raise();
 164   virtual void Lower();
 165
 166   virtual void CaptureMouse();
 167   virtual void ReleaseMouse();
 168
 169 // Implementation
 170   virtual void ChangeFont(bool keepOriginalSize = TRUE);
 171   virtual void ChangeBackgroundColour();
 172   virtual void ChangeForegroundColour();
 173   WXWidget GetMenuBarWidget() const ;
 174   inline WXWidget GetShellWidget() const { return m_frameShell; }
 175   inline WXWidget GetWorkAreaWidget() const { return m_workArea; }
 176   inline WXWidget GetClientAreaWidget() const { return m_clientArea; }
 177   inline WXWidget GetTopWidget() const { return m_frameShell; }
 178   inline WXWidget GetMainWindowWidget() const { return m_frameWidget; }
 179
 180   // The widget that can have children on it
 181   WXWidget GetClientWidget() const;
 182   bool GetVisibleStatus() const { return m_visibleStatus; }
 183
 184   bool PreResize();
 185
 186 protected:
 187   wxMenuBar *           m_frameMenuBar;
 188   wxStatusBar *         m_frameStatusBar;
 189   wxIcon                m_icon;
 190   bool                  m_iconized;
 191   static bool           m_useNativeStatusBar;
 192
 193 #if wxUSE_TOOLBAR
 194   wxToolBar *           m_frameToolBar ;
 195 #endif // wxUSE_TOOLBAR
 196
 197   //// Motif-specific
 198
 199   WXWidget              m_frameShell;
 200   WXWidget              m_frameWidget;
 201   WXWidget              m_workArea;
 202   WXWidget              m_clientArea;
 203 //  WXWidget              m_menuBarWidget;
 204   bool                  m_visibleStatus;
 205   wxString              m_title;
 206
 207   DECLARE_EVENT_TABLE()
 208 };
 209
 210 #endif
 211     // _WX_FRAME_H_