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