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*) wxFrameNameStr;
  23 extern WXDLLEXPORT_DATA(const wxChar*) wxStatusLineNameStr;
  24 extern WXDLLEXPORT_DATA(const wxChar*) wxToolBarNameStr;
  25
  26 class WXDLLEXPORT wxFrame;
  27 class WXDLLEXPORT wxMenuBar;
  28 class WXDLLEXPORT wxStatusBar;
  29 class WXDLLEXPORT 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 WXDLLEXPORT 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 #endif // wxUSE_MENUS
  86
  87     // process menu command: returns true if processed
  88     bool ProcessCommand(int winid);
  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|wxFULL_REPAINT_ON_RESIZE,
  96                                          wxWindowID winid = 0,
  97                                          const wxString& name =
  98                                             wxStatusLineNameStr);
  99     // return a new status bar
 100     virtual wxStatusBar *OnCreateStatusBar(int number,
 101                                            long style,
 102                                            wxWindowID winid,
 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     virtual void SetStatusBar(wxStatusBar *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     void PushStatusText(const wxString &text, int number = 0);
 114     void PopStatusText(int number = 0);
 115
 116     // set the status bar pane the help will be shown in
 117     void SetStatusBarPane(int n) { m_statusBarPane = n; }
 118     int GetStatusBarPane() const { return m_statusBarPane; }
 119 #endif // wxUSE_STATUSBAR
 120
 121     // toolbar functions
 122     // -----------------
 123
 124 #if wxUSE_TOOLBAR
 125     // create main toolbar bycalling OnCreateToolBar()
 126     virtual wxToolBar* CreateToolBar(long style = -1,
 127                                      wxWindowID winid = wxID_ANY,
 128                                      const wxString& name = wxToolBarNameStr);
 129     // return a new toolbar
 130     virtual wxToolBar *OnCreateToolBar(long style,
 131                                        wxWindowID winid,
 132                                        const wxString& name );
 133
 134     // get/set the main toolbar
 135     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
 136     virtual void SetToolBar(wxToolBar *toolbar);
 137 #endif // wxUSE_TOOLBAR
 138
 139     // implementation only from now on
 140     // -------------------------------
 141
 142     // event handlers
 143 #if wxUSE_MENUS
 144 #if wxUSE_STATUSBAR
 145     void OnMenuOpen(wxMenuEvent& event);
 146     void OnMenuClose(wxMenuEvent& event);
 147     void OnMenuHighlight(wxMenuEvent& event);
 148 #endif // wxUSE_STATUSBAR
 149
 150     // send wxUpdateUIEvents for all menu items in the menubar,
 151     // or just for menu if non-NULL
 152     virtual void DoMenuUpdates(wxMenu* menu = NULL);
 153 #endif // wxUSE_MENUS
 154
 155     // do the UI update processing for this window
 156     virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
 157
 158     // Implement internal behaviour (menu updating on some platforms)
 159     virtual void OnInternalIdle();
 160
 161     // if there is no real wxTopLevelWindow on this platform we have to define
 162     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
 163     // old ports (wxMotif) which don't define them in wxFrame
 164 #ifndef wxTopLevelWindowNative
 165     virtual bool ShowFullScreen(bool WXUNUSED(show),
 166                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
 167         { return false; }
 168     virtual bool IsFullScreen() const
 169         { return false; }
 170 #endif // no wxTopLevelWindowNative
 171
 172     // show help text (typically in the statusbar); show is false
 173     // if you are hiding the help, true otherwise
 174     virtual void DoGiveHelp(const wxString& text, bool show);
 175
 176 #if WXWIN_COMPATIBILITY_2_2
 177     // call this to simulate a menu command
 178     wxDEPRECATED( bool Command(int winid) );
 179 #endif // WXWIN_COMPATIBILITY_2_2
 180
 181 protected:
 182     // the frame main menu/status/tool bars
 183     // ------------------------------------
 184
 185     // this (non virtual!) function should be called from dtor to delete the
 186     // main menubar, statusbar and toolbar (if any)
 187     void DeleteAllBars();
 188
 189     // test whether this window makes part of the frame
 190     virtual bool IsOneOfBars(const wxWindow *win) const;
 191
 192 #if wxUSE_MENUS
 193     // override to update menu bar position when the frame size changes
 194     virtual void PositionMenuBar() { }
 195
 196     // override to do something special when the menu bar is being removed
 197     // from the frame
 198     virtual void DetachMenuBar();
 199
 200     // override to do something special when the menu bar is attached to the
 201     // frame
 202     virtual void AttachMenuBar(wxMenuBar *menubar);
 203
 204     wxMenuBar *m_frameMenuBar;
 205
 206 #if wxUSE_STATUSBAR
 207     // the saved status bar text overwritten by DoGiveHelp()
 208     wxString m_oldStatusText;
 209 #endif // wxUSE_STATUSBAR
 210 #endif // wxUSE_MENUS
 211
 212 #if wxUSE_STATUSBAR
 213     // override to update status bar position (or anything else) when
 214     // something changes
 215     virtual void PositionStatusBar() { }
 216
 217     // show the help string for this menu item in the given status bar: the
 218     // status bar pointer can be NULL; return true if help was shown
 219     bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
 220
 221     wxStatusBar *m_frameStatusBar;
 222 #endif // wxUSE_STATUSBAR
 223
 224
 225     int m_statusBarPane;
 226
 227 #if wxUSE_TOOLBAR
 228     // override to update status bar position (or anything else) when
 229     // something changes
 230     virtual void PositionToolBar() { }
 231
 232     wxToolBar *m_frameToolBar;
 233 #endif // wxUSE_TOOLBAR
 234
 235 #if wxUSE_MENUS && wxUSE_STATUSBAR
 236     DECLARE_EVENT_TABLE()
 237 #endif // wxUSE_MENUS && wxUSE_STATUSBAR
 238
 239     DECLARE_NO_COPY_CLASS(wxFrameBase)
 240 };
 241
 242 // include the real class declaration
 243 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
 244     #include "wx/univ/frame.h"
 245 #else // !__WXUNIVERSAL__
 246     #if defined(__WXPALMOS__)
 247         #include "wx/palmos/frame.h"
 248     #elif defined(__WXMSW__)
 249         #include "wx/msw/frame.h"
 250     #elif defined(__WXGTK__)
 251         #include "wx/gtk/frame.h"
 252     #elif defined(__WXMOTIF__)
 253         #include "wx/motif/frame.h"
 254     #elif defined(__WXMAC__)
 255         #include "wx/mac/frame.h"
 256     #elif defined(__WXCOCOA__)
 257         #include "wx/cocoa/frame.h"
 258     #elif defined(__WXPM__)
 259         #include "wx/os2/frame.h"
 260     #endif
 261 #endif
 262
 263 #endif
 264     // _WX_FRAME_H_BASE_