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     void PushStatusText(const wxString &text, int number = 0);
 112     void PopStatusText(int number = 0);
 113 #endif // wxUSE_STATUSBAR
 114
 115     // toolbar functions
 116     // -----------------
 117 #if wxUSE_TOOLBAR
 118     // create main toolbar bycalling OnCreateToolBar()
 119     virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
 120                                      wxWindowID id = -1,
 121                                      const wxString& name = wxToolBarNameStr);
 122     // return a new toolbar
 123     virtual wxToolBar *OnCreateToolBar(long style,
 124                                        wxWindowID id,
 125                                        const wxString& name );
 126
 127     // get/set the main toolbar
 128     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 129     virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
 130 #endif // wxUSE_TOOLBAR
 131
 132     // implementation only from now on
 133     // -------------------------------
 134
 135     // event handlers
 136     void OnIdle(wxIdleEvent& event);
 137     void OnMenuHighlight(wxMenuEvent& event);
 138
 139 #if wxUSE_MENUS
 140     // send wxUpdateUIEvents for all menu items (called from OnIdle())
 141     void DoMenuUpdates();
 142     void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
 143 #endif // wxUSE_MENUS
 144
 145     // if there is no real wxTopLevelWindow on this platform we have to define
 146     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
 147     // old ports (wxMotif) which don't define them in wxFrame
 148 #ifndef wxTopLevelWindowNative
 149     virtual bool ShowFullScreen(bool WXUNUSED(show),
 150                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
 151         { return FALSE; }
 152     virtual bool IsFullScreen() const
 153         { return FALSE; }
 154 #endif // no wxTopLevelWindowNative
 155
 156     // show help text (typically in the statusbar); show is FALSE
 157     // if you are hiding the help, TRUE otherwise
 158     virtual void DoGiveHelp(const wxString& text, bool show);
 159
 160 protected:
 161     // the frame main menu/status/tool bars
 162     // ------------------------------------
 163
 164     // this (non virtual!) function should be called from dtor to delete the
 165     // main menubar, statusbar and toolbar (if any)
 166     void DeleteAllBars();
 167
 168     // test whether this window makes part of the frame
 169     virtual bool IsOneOfBars(const wxWindow *win) const;
 170
 171 #if wxUSE_MENUS
 172     // override to update menu bar position when the frame size changes
 173     virtual void PositionMenuBar() { }
 174
 175     // override to do something special when the menu bar is being removed
 176     // from the frame
 177     virtual void DetachMenuBar();
 178
 179     // override to do something special when the menu bar is attached to the
 180     // frame
 181     virtual void AttachMenuBar(wxMenuBar *menubar);
 182
 183     wxMenuBar *m_frameMenuBar;
 184 #endif // wxUSE_MENUS
 185
 186 #if wxUSE_STATUSBAR
 187     // override to update status bar position (or anything else) when
 188     // something changes
 189     virtual void PositionStatusBar() { }
 190
 191     // show the help string for this menu item in the given status bar: the
 192     // status bar pointer can be NULL; return TRUE if help was shown
 193     bool ShowMenuHelp(wxStatusBar *statbar, int id);
 194
 195     wxStatusBar *m_frameStatusBar;
 196 #endif // wxUSE_STATUSBAR
 197
 198     // set the status bar pane the help will be shown in
 199     void SetStatusBarPane(int n) { m_statusBarPane = n; }
 200     int GetStatusBarPane() const { return m_statusBarPane; }
 201
 202     int m_statusBarPane;
 203
 204 #if wxUSE_TOOLBAR
 205     // override to update status bar position (or anything else) when
 206     // something changes
 207     virtual void PositionToolBar() { }
 208
 209     wxToolBar *m_frameToolBar;
 210 #endif // wxUSE_TOOLBAR
 211
 212     DECLARE_EVENT_TABLE()
 213 };
 214
 215 // include the real class declaration
 216 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
 217     #include "wx/univ/frame.h"
 218 #else // !__WXUNIVERSAL__
 219     #if defined(__WXMSW__)
 220         #include "wx/msw/frame.h"
 221     #elif defined(__WXGTK__)
 222         #include "wx/gtk/frame.h"
 223     #elif defined(__WXMOTIF__)
 224         #include "wx/motif/frame.h"
 225     #elif defined(__WXMAC__)
 226         #include "wx/mac/frame.h"
 227     #elif defined(__WXPM__)
 228         #include "wx/os2/frame.h"
 229     #endif
 230 #endif
 231
 232 #endif
 233     // _WX_FRAME_H_BASE_