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