include/wx/frame.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/frame.h
   3 // Purpose:     wxFrame class interface
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     15.11.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) wxWindows team
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAME_H_BASE_
  13 #define _WX_FRAME_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "framebase.h"
  21 #endif
  22
  23 #include "wx/toplevel.h"      // the base class
  24
  25 // the default names for various classs
  26 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  27 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
  28 WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
  29
  30 class WXDLLEXPORT wxFrame;
  31 class WXDLLEXPORT wxMenuBar;
  32 class WXDLLEXPORT wxStatusBar;
  33 class WXDLLEXPORT wxToolBar;
  34
  35 // ----------------------------------------------------------------------------
  36 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
  37 //
  38 // For each of *bars, a frame may have several of them, but only one is
  39 // managed by the frame, i.e. resized/moved when the frame is and whose size
  40 // is accounted for in client size calculations - all others should be taken
  41 // care of manually. The CreateXXXBar() functions create this, main, XXXBar,
  42 // but the actual creation is done in OnCreateXXXBar() functions which may be
  43 // overridden to create custom objects instead of standard ones when
  44 // CreateXXXBar() is called.
  45 // ----------------------------------------------------------------------------
  46
  47 // FIXME - temporary hack in absence of wxTLW !!
  48 #ifndef wxTopLevelWindowNative
  49 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindowBase
  50 #else
  51 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
  52 #endif
  53 {
  54 public:
  55     // construction
  56     wxFrameBase();
  57     virtual ~wxFrameBase();
  58
  59     wxFrame *New(wxWindow *parent,
  60                  wxWindowID id,
  61                  const wxString& title,
  62                  const wxPoint& pos = wxDefaultPosition,
  63                  const wxSize& size = wxDefaultSize,
  64                  long style = wxDEFAULT_FRAME_STYLE,
  65                  const wxString& name = wxFrameNameStr);
  66
  67     // frame state
  68     // -----------
  69
  70     // get the origin of the client area (which may be different from (0, 0)
  71     // if the frame has a toolbar) in client coordinates
  72     virtual wxPoint GetClientAreaOrigin() const;
  73
  74     // menu bar functions
  75     // ------------------
  76
  77 #if wxUSE_MENUS
  78     virtual void SetMenuBar(wxMenuBar *menubar);
  79     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
  80 #endif // wxUSE_MENUS
  81
  82     // call this to simulate a menu command
  83     bool Command(int id) { return ProcessCommand(id); }
  84
  85     // process menu command: returns TRUE if processed
  86     bool ProcessCommand(int id);
  87
  88     // status bar functions
  89     // --------------------
  90 #if wxUSE_STATUSBAR
  91     // create the main status bar by calling OnCreateStatusBar()
  92     virtual wxStatusBar* CreateStatusBar(int number = 1,
  93                                          long style = wxST_SIZEGRIP,
  94                                          wxWindowID id = 0,
  95                                          const wxString& name =
  96                                             wxStatusLineNameStr);
  97     // return a new status bar
  98     virtual wxStatusBar *OnCreateStatusBar(int number,
  99                                            long style,
 100                                            wxWindowID id,
 101                                            const wxString& name);
 102     // get the main status bar
 103     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 104
 105     // sets the main status bar
 106     void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
 107
 108     // forward these to status bar
 109     virtual void SetStatusText(const wxString &text, int number = 0);
 110     virtual void SetStatusWidths(int n, const int widths_field[]);
 111 #endif // wxUSE_STATUSBAR
 112
 113     // toolbar functions
 114     // -----------------
 115 #if wxUSE_TOOLBAR
 116     // create main toolbar bycalling OnCreateToolBar()
 117     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
 118                                      wxWindowID id = -1,
 119                                      const wxString& name = wxToolBarNameStr);
 120     // return a new toolbar
 121     virtual wxToolBar *OnCreateToolBar(long style,
 122                                        wxWindowID id,
 123                                        const wxString& name );
 124
 125     // get/set the main toolbar
 126     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 127     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
 128 #endif // wxUSE_TOOLBAR
 129
 130     // implementation only from now on
 131     // -------------------------------
 132
 133     // event handlers
 134     void OnIdle(wxIdleEvent& event);
 135     void OnMenuHighlight(wxMenuEvent& event);
 136
 137 #if wxUSE_MENUS
 138     // send wxUpdateUIEvents for all menu items (called from OnIdle())
 139     void DoMenuUpdates();
 140     void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
 141 #endif // wxUSE_MENUS
 142
 143     // if there is no real wxTopLevelWindow on this platform we have to define
 144     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
 145     // old ports (wxMotif) which don't define them in wxFrame
 146 #ifndef wxTopLevelWindowNative
 147     virtual bool ShowFullScreen(bool WXUNUSED(show),
 148                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
 149         { return FALSE; }
 150     virtual bool IsFullScreen() const
 151         { return FALSE; }
 152 #endif // no wxTopLevelWindowNative
 153
 154 protected:
 155     // the frame main menu/status/tool bars
 156     // ------------------------------------
 157
 158     // this (non virtual!) function should be called from dtor to delete the
 159     // main menubar, statusbar and toolbar (if any)
 160     void DeleteAllBars();
 161
 162     // test whether this window makes part of the frame
 163     virtual bool IsOneOfBars(const wxWindow *win) const;
 164
 165 #if wxUSE_MENUS
 166     // override to update menu bar position when the frame size changes
 167     virtual void PositionMenuBar() { }
 168
 169     // override to do something special when the menu bar is being removed
 170     // from the frame
 171     virtual void DetachMenuBar();
 172
 173     // override to do something special when the menu bar is attached to the
 174     // frame
 175     virtual void AttachMenuBar(wxMenuBar *menubar);
 176
 177     wxMenuBar *m_frameMenuBar;
 178 #endif // wxUSE_MENUS
 179
 180 #if wxUSE_STATUSBAR
 181     // override to update status bar position (or anything else) when
 182     // something changes
 183     virtual void PositionStatusBar() { }
 184
 185     // show the help string for this menu item in the given status bar: the
 186     // status bar pointer can be NULL; return TRUE if help was shown
 187     bool ShowMenuHelp(wxStatusBar *statbar, int id);
 188
 189     wxStatusBar *m_frameStatusBar;
 190 #endif // wxUSE_STATUSBAR
 191
 192 #if wxUSE_TOOLBAR
 193     // override to update status bar position (or anything else) when
 194     // something changes
 195     virtual void PositionToolBar() { }
 196
 197     wxToolBar *m_frameToolBar;
 198 #endif // wxUSE_TOOLBAR
 199
 200     DECLARE_EVENT_TABLE()
 201 };
 202
 203 // include the real class declaration
 204 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
 205     #include "wx/univ/frame.h"
 206 #else // !__WXUNIVERSAL__
 207     #if defined(__WXMSW__)
 208         #include "wx/msw/frame.h"
 209     #elif defined(__WXGTK__)
 210         #include "wx/gtk/frame.h"
 211     #elif defined(__WXMOTIF__)
 212         #include "wx/motif/frame.h"
 213     #elif defined(__WXMAC__)
 214         #include "wx/mac/frame.h"
 215     #elif defined(__WXPM__)
 216         #include "wx/os2/frame.h"
 217     #endif
 218 #endif
 219
 220 #endif
 221     // _WX_FRAME_H_BASE_