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) wxWidgets team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_FRAME_H_BASE_
  13 #define _WX_FRAME_H_BASE_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/toplevel.h"      // the base class
  20
  21 // the default names for various classs
  22 extern WXDLLEXPORT_DATA(const wxChar) wxStatusLineNameStr[];
  23 extern WXDLLEXPORT_DATA(const wxChar) wxToolBarNameStr[];
  24
  25 class WXDLLIMPEXP_FWD_CORE wxFrame;
  26 class WXDLLIMPEXP_FWD_CORE wxMenuBar;
  27 class WXDLLIMPEXP_FWD_CORE wxStatusBar;
  28 class WXDLLIMPEXP_FWD_CORE wxToolBar;
  29
  30 // ----------------------------------------------------------------------------
  31 // constants
  32 // ----------------------------------------------------------------------------
  33
  34 // wxFrame-specific (i.e. not for wxDialog) styles
  35 #define wxFRAME_NO_TASKBAR      0x0002  // No taskbar button (MSW only)
  36 #define wxFRAME_TOOL_WINDOW     0x0004  // No taskbar button, no system menu
  37 #define wxFRAME_FLOAT_ON_PARENT 0x0008  // Always above its parent
  38 #define wxFRAME_SHAPED          0x0010  // Create a window that is able to be shaped
  39
  40 // ----------------------------------------------------------------------------
  41 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
  42 //
  43 // For each of *bars, a frame may have several of them, but only one is
  44 // managed by the frame, i.e. resized/moved when the frame is and whose size
  45 // is accounted for in client size calculations - all others should be taken
  46 // care of manually. The CreateXXXBar() functions create this, main, XXXBar,
  47 // but the actual creation is done in OnCreateXXXBar() functions which may be
  48 // overridden to create custom objects instead of standard ones when
  49 // CreateXXXBar() is called.
  50 // ----------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow
  53 {
  54 public:
  55     // construction
  56     wxFrameBase();
  57     virtual ~wxFrameBase();
  58
  59     wxFrame *New(wxWindow *parent,
  60                  wxWindowID winid,
  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     // sends a size event to the window using its current size -- this has an
  75     // effect of refreshing the window layout
  76     virtual void SendSizeEvent();
  77
  78     // menu bar functions
  79     // ------------------
  80
  81 #if wxUSE_MENUS
  82     virtual void SetMenuBar(wxMenuBar *menubar);
  83     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
  84
  85     // find the item by id in the frame menu bar: this is an internal function
  86     // and exists mainly in order to be overridden in the MDI parent frame
  87     // which also looks at its active child menu bar
  88     virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;
  89 #endif // wxUSE_MENUS
  90
  91     // process menu command: returns true if processed
  92     bool ProcessCommand(int winid);
  93
  94     // status bar functions
  95     // --------------------
  96 #if wxUSE_STATUSBAR
  97     // create the main status bar by calling OnCreateStatusBar()
  98     virtual wxStatusBar* CreateStatusBar(int number = 1,
  99                                          long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
 100                                          wxWindowID winid = 0,
 101                                          const wxString& name =
 102                                             wxStatusLineNameStr);
 103     // return a new status bar
 104     virtual wxStatusBar *OnCreateStatusBar(int number,
 105                                            long style,
 106                                            wxWindowID winid,
 107                                            const wxString& name);
 108     // get the main status bar
 109     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 110
 111     // sets the main status bar
 112     virtual void SetStatusBar(wxStatusBar *statBar);
 113
 114     // forward these to status bar
 115     virtual void SetStatusText(const wxString &text, int number = 0);
 116     virtual void SetStatusWidths(int n, const int widths_field[]);
 117     void PushStatusText(const wxString &text, int number = 0);
 118     void PopStatusText(int number = 0);
 119
 120     // set the status bar pane the help will be shown in
 121     void SetStatusBarPane(int n) { m_statusBarPane = n; }
 122     int GetStatusBarPane() const { return m_statusBarPane; }
 123 #endif // wxUSE_STATUSBAR
 124
 125     // toolbar functions
 126     // -----------------
 127
 128 #if wxUSE_TOOLBAR
 129     // create main toolbar bycalling OnCreateToolBar()
 130     virtual wxToolBar* CreateToolBar(long style = -1,
 131                                      wxWindowID winid = wxID_ANY,
 132                                      const wxString& name = wxToolBarNameStr);
 133     // return a new toolbar
 134     virtual wxToolBar *OnCreateToolBar(long style,
 135                                        wxWindowID winid,
 136                                        const wxString& name );
 137
 138     // get/set the main toolbar
 139     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 140     virtual void SetToolBar(wxToolBar *toolbar);
 141 #endif // wxUSE_TOOLBAR
 142
 143     // implementation only from now on
 144     // -------------------------------
 145
 146     // event handlers
 147 #if wxUSE_MENUS
 148 #if wxUSE_STATUSBAR
 149     void OnMenuOpen(wxMenuEvent& event);
 150     void OnMenuClose(wxMenuEvent& event);
 151     void OnMenuHighlight(wxMenuEvent& event);
 152 #endif // wxUSE_STATUSBAR
 153
 154     // send wxUpdateUIEvents for all menu items in the menubar,
 155     // or just for menu if non-NULL
 156     virtual void DoMenuUpdates(wxMenu* menu = NULL);
 157 #endif // wxUSE_MENUS
 158
 159     // do the UI update processing for this window
 160     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
 161
 162     // Implement internal behaviour (menu updating on some platforms)
 163     virtual void OnInternalIdle();
 164
 165     // if there is no real wxTopLevelWindow on this platform we have to define
 166     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
 167     // old ports (wxMotif) which don't define them in wxFrame
 168 #ifndef wxTopLevelWindowNative
 169     virtual bool ShowFullScreen(bool WXUNUSED(show),
 170                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
 171         { return false; }
 172     virtual bool IsFullScreen() const
 173         { return false; }
 174 #endif // no wxTopLevelWindowNative
 175
 176 #if wxUSE_MENUS || wxUSE_TOOLBAR
 177     // show help text for the currently selected menu or toolbar item
 178     // (typically in the status bar) or hide it and restore the status bar text
 179     // originally shown before the menu was opened if show == false
 180     virtual void DoGiveHelp(const wxString& text, bool show);
 181 #endif
 182
 183     virtual bool IsClientAreaChild(const wxWindow *child) const
 184     {
 185         return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child);
 186     }
 187
 188 protected:
 189     // the frame main menu/status/tool bars
 190     // ------------------------------------
 191
 192     // this (non virtual!) function should be called from dtor to delete the
 193     // main menubar, statusbar and toolbar (if any)
 194     void DeleteAllBars();
 195
 196     // test whether this window makes part of the frame
 197     virtual bool IsOneOfBars(const wxWindow *win) const;
 198
 199 #if wxUSE_MENUS
 200     // override to update menu bar position when the frame size changes
 201     virtual void PositionMenuBar() { }
 202
 203     // override to do something special when the menu bar is being removed
 204     // from the frame
 205     virtual void DetachMenuBar();
 206
 207     // override to do something special when the menu bar is attached to the
 208     // frame
 209     virtual void AttachMenuBar(wxMenuBar *menubar);
 210
 211     wxMenuBar *m_frameMenuBar;
 212 #endif // wxUSE_MENUS
 213
 214 #if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
 215     // the saved status bar text overwritten by DoGiveHelp()
 216     wxString m_oldStatusText;
 217 #endif
 218
 219 #if wxUSE_STATUSBAR
 220     // override to update status bar position (or anything else) when
 221     // something changes
 222     virtual void PositionStatusBar() { }
 223
 224     // show the help string for the given menu item using DoGiveHelp() if the
 225     // given item does have a help string (as determined by FindInMenuBar()),
 226     // return false if there is no help for such item
 227     bool ShowMenuHelp(int helpid);
 228
 229     wxStatusBar *m_frameStatusBar;
 230 #endif // wxUSE_STATUSBAR
 231
 232
 233     int m_statusBarPane;
 234
 235 #if wxUSE_TOOLBAR
 236     // override to update status bar position (or anything else) when
 237     // something changes
 238     virtual void PositionToolBar() { }
 239
 240     wxToolBar *m_frameToolBar;
 241 #endif // wxUSE_TOOLBAR
 242
 243 #if wxUSE_MENUS && wxUSE_STATUSBAR
 244     DECLARE_EVENT_TABLE()
 245 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
 246
 247     DECLARE_NO_COPY_CLASS(wxFrameBase)
 248 };
 249
 250 // include the real class declaration
 251 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
 252     #include "wx/univ/frame.h"
 253 #else // !__WXUNIVERSAL__
 254     #if defined(__WXPALMOS__)
 255         #include "wx/palmos/frame.h"
 256     #elif defined(__WXMSW__)
 257         #include "wx/msw/frame.h"
 258     #elif defined(__WXGTK20__)
 259         #include "wx/gtk/frame.h"
 260     #elif defined(__WXGTK__)
 261         #include "wx/gtk1/frame.h"
 262     #elif defined(__WXMOTIF__)
 263         #include "wx/motif/frame.h"
 264     #elif defined(__WXMAC__)
 265         #include "wx/mac/frame.h"
 266     #elif defined(__WXCOCOA__)
 267         #include "wx/cocoa/frame.h"
 268     #elif defined(__WXPM__)
 269         #include "wx/os2/frame.h"
 270     #endif
 271 #endif
 272
 273 #endif
 274     // _WX_FRAME_H_BASE_