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 #ifdef __DARWIN__
  58     virtual ~wxFrameBase() { }
  59 #endif
  60
  61     wxFrame *New(wxWindow *parent,
  62                  wxWindowID id,
  63                  const wxString& title,
  64                  const wxPoint& pos = wxDefaultPosition,
  65                  const wxSize& size = wxDefaultSize,
  66                  long style = wxDEFAULT_FRAME_STYLE,
  67                  const wxString& name = wxFrameNameStr);
  68
  69     // frame state
  70     // -----------
  71
  72     // get the origin of the client area (which may be different from (0, 0)
  73     // if the frame has a toolbar) in client coordinates
  74     virtual wxPoint GetClientAreaOrigin() const;
  75
  76     // menu bar functions
  77     // ------------------
  78
  79 #if wxUSE_MENUS
  80     virtual void SetMenuBar(wxMenuBar *menubar);
  81     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
  82 #endif // wxUSE_MENUS
  83
  84     // call this to simulate a menu command
  85     bool Command(int id) { return ProcessCommand(id); }
  86
  87     // process menu command: returns TRUE if processed
  88     bool ProcessCommand(int id);
  89
  90     // status bar functions
  91     // --------------------
  92 #if wxUSE_STATUSBAR
  93     // create the main status bar by calling OnCreateStatusBar()
  94     virtual wxStatusBar* CreateStatusBar(int number = 1,
  95                                          long style = wxST_SIZEGRIP,
  96                                          wxWindowID id = 0,
  97                                          const wxString& name =
  98                                             wxStatusLineNameStr);
  99     // return a new status bar
 100     virtual wxStatusBar *OnCreateStatusBar(int number,
 101                                            long style,
 102                                            wxWindowID id,
 103                                            const wxString& name);
 104     // get the main status bar
 105     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 106
 107     // sets the main status bar
 108     void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
 109
 110     // forward these to status bar
 111     virtual void SetStatusText(const wxString &text, int number = 0);
 112     virtual void SetStatusWidths(int n, const int widths_field[]);
 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 protected:
 146     // the frame main menu/status/tool bars
 147     // ------------------------------------
 148
 149     // this (non virtual!) function should be called from dtor to delete the
 150     // main menubar, statusbar and toolbar (if any)
 151     void DeleteAllBars();
 152
 153     // test whether this window makes part of the frame
 154     virtual bool IsOneOfBars(const wxWindow *win) const;
 155
 156 #if wxUSE_MENUS
 157     // override to update menu bar position when the frame size changes
 158     virtual void PositionMenuBar() { }
 159
 160     // override to do something special when the menu bar is being removed
 161     // from the frame
 162     virtual void DetachMenuBar();
 163
 164     // override to do something special when the menu bar is attached to the
 165     // frame
 166     virtual void AttachMenuBar(wxMenuBar *menubar);
 167
 168     wxMenuBar *m_frameMenuBar;
 169 #endif // wxUSE_MENUS
 170
 171 #if wxUSE_STATUSBAR
 172     // override to update status bar position (or anything else) when
 173     // something changes
 174     virtual void PositionStatusBar() { }
 175
 176     // show the help string for this menu item in the given status bar: the
 177     // status bar pointer can be NULL; return TRUE if help was shown
 178     bool ShowMenuHelp(wxStatusBar *statbar, int id);
 179
 180     wxStatusBar *m_frameStatusBar;
 181 #endif // wxUSE_STATUSBAR
 182
 183 #if wxUSE_TOOLBAR
 184     // override to update status bar position (or anything else) when
 185     // something changes
 186     virtual void PositionToolBar() { }
 187
 188     wxToolBar *m_frameToolBar;
 189 #endif // wxUSE_TOOLBAR
 190
 191     DECLARE_EVENT_TABLE()
 192 };
 193
 194 // include the real class declaration
 195 #ifdef __WXUNIVERSAL__
 196     #include "wx/univ/frame.h"
 197 #else // !__WXUNIVERSAL__
 198     #if defined(__WXMSW__)
 199         #include "wx/msw/frame.h"
 200     #elif defined(__WXGTK__)
 201         #include "wx/gtk/frame.h"
 202     #elif defined(__WXMOTIF__)
 203         #include "wx/motif/frame.h"
 204     #elif defined(__WXMAC__)
 205         #include "wx/mac/frame.h"
 206     #elif defined(__WXPM__)
 207         #include "wx/os2/frame.h"
 208     #endif
 209 #endif
 210
 211 #endif
 212     // _WX_FRAME_H_BASE_