// Modified by:
// Created: 15.11.99
// RCS-ID: $Id$
-// Copyright: (c) wxWindows team
-// Licence: wxWindows license
+// Copyright: (c) wxWidgets team
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_FRAME_H_BASE_
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma interface "framebase.h"
-#endif
-
-#include "wx/window.h" // the base class
-#include "wx/icon.h" // for m_icon
+#include "wx/toplevel.h" // the base class
// the default names for various classs
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
-
-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxMenuBar;
-class WXDLLEXPORT wxStatusBar;
-class WXDLLEXPORT wxToolBar;
-
-// Styles for ShowFullScreen
-#define wxFULLSCREEN_NOMENUBAR 0x01
-#define wxFULLSCREEN_NOTOOLBAR 0x02
-#define wxFULLSCREEN_NOSTATUSBAR 0x04
-#define wxFULLSCREEN_NOBORDER 0x08
-#define wxFULLSCREEN_NOCAPTION 0x10
-#define wxFULLSCREEN_ALL (wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR | wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER | wxFULLSCREEN_NOCAPTION)
+extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusLineNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxToolBarNameStr[];
+
+class WXDLLIMPEXP_FWD_CORE wxFrame;
+class WXDLLIMPEXP_FWD_CORE wxMenuBar;
+class WXDLLIMPEXP_FWD_CORE wxMenuItem;
+class WXDLLIMPEXP_FWD_CORE wxStatusBar;
+class WXDLLIMPEXP_FWD_CORE wxToolBar;
+
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// wxFrame-specific (i.e. not for wxDialog) styles
+#define wxFRAME_NO_TASKBAR 0x0002 // No taskbar button (MSW only)
+#define wxFRAME_TOOL_WINDOW 0x0004 // No taskbar button, no system menu
+#define wxFRAME_FLOAT_ON_PARENT 0x0008 // Always above its parent
+#define wxFRAME_SHAPED 0x0010 // Create a window that is able to be shaped
// ----------------------------------------------------------------------------
// wxFrame is a top-level window with optional menubar, statusbar and toolbar
// CreateXXXBar() is called.
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxFrameBase : public wxWindow
+class WXDLLIMPEXP_CORE wxFrameBase : public wxTopLevelWindow
{
public:
// construction
wxFrameBase();
-#ifdef __WXMAC_X__
- virtual ~wxFrameBase() {} // Added min for Mac X
-#endif
+ virtual ~wxFrameBase();
wxFrame *New(wxWindow *parent,
- wxWindowID id,
+ wxWindowID winid,
const wxString& title,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
// frame state
// -----------
- // maximize = TRUE => maximize, otherwise - restore
- virtual void Maximize(bool maximize = TRUE) = 0;
-
- // undo Maximize() or Iconize()
- virtual void Restore() = 0;
-
- // iconize = TRUE => iconize, otherwise - restore
- virtual void Iconize(bool iconize = TRUE) = 0;
-
- // return TRUE if the frame is maximized
- virtual bool IsMaximized() const = 0;
-
- // return TRUE if the frame is iconized
- virtual bool IsIconized() const = 0;
-
- // get the frame icon
- const wxIcon& GetIcon() const { return m_icon; }
-
- // set the frame icon
- virtual void SetIcon(const wxIcon& icon) { m_icon = icon; }
-
- // make the window modal (all other windows unresponsive)
- virtual void MakeModal(bool modal = TRUE);
-
// get the origin of the client area (which may be different from (0, 0)
// if the frame has a toolbar) in client coordinates
virtual wxPoint GetClientAreaOrigin() const;
+
// menu bar functions
// ------------------
#if wxUSE_MENUS
- virtual void SetMenuBar(wxMenuBar *menubar) = 0;
+ virtual void SetMenuBar(wxMenuBar *menubar);
virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
-#endif // wxUSE_MENUS
- // call this to simulate a menu command
- bool Command(int id) { return ProcessCommand(id); }
-
- // process menu command: returns TRUE if processed
- bool ProcessCommand(int id);
+ // find the item by id in the frame menu bar: this is an internal function
+ // and exists mainly in order to be overridden in the MDI parent frame
+ // which also looks at its active child menu bar
+ virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;
+
+ // generate menu command corresponding to the given menu item
+ //
+ // returns true if processed
+ bool ProcessCommand(wxMenuItem *item);
+
+ // generate menu command corresponding to the given menu command id
+ //
+ // returns true if processed
+ bool ProcessCommand(int winid);
+#else
+ bool ProcessCommand(int WXUNUSED(winid)) { return false; }
+#endif // wxUSE_MENUS
// status bar functions
// --------------------
#if wxUSE_STATUSBAR
// create the main status bar by calling OnCreateStatusBar()
virtual wxStatusBar* CreateStatusBar(int number = 1,
- long style = wxST_SIZEGRIP,
- wxWindowID id = 0,
+ long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+ wxWindowID winid = 0,
const wxString& name =
wxStatusLineNameStr);
// return a new status bar
virtual wxStatusBar *OnCreateStatusBar(int number,
long style,
- wxWindowID id,
+ wxWindowID winid,
const wxString& name);
// get the main status bar
virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
// sets the main status bar
- void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
+ virtual void SetStatusBar(wxStatusBar *statBar);
// forward these to status bar
virtual void SetStatusText(const wxString &text, int number = 0);
virtual void SetStatusWidths(int n, const int widths_field[]);
+ void PushStatusText(const wxString &text, int number = 0);
+ void PopStatusText(int number = 0);
+
+ // set the status bar pane the help will be shown in
+ void SetStatusBarPane(int n) { m_statusBarPane = n; }
+ int GetStatusBarPane() const { return m_statusBarPane; }
#endif // wxUSE_STATUSBAR
// toolbar functions
// -----------------
+
#if wxUSE_TOOLBAR
// create main toolbar bycalling OnCreateToolBar()
- virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
- wxWindowID id = -1,
+ virtual wxToolBar* CreateToolBar(long style = -1,
+ wxWindowID winid = wxID_ANY,
const wxString& name = wxToolBarNameStr);
// return a new toolbar
virtual wxToolBar *OnCreateToolBar(long style,
- wxWindowID id,
+ wxWindowID winid,
const wxString& name );
// get/set the main toolbar
virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
- virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
+ virtual void SetToolBar(wxToolBar *toolbar);
#endif // wxUSE_TOOLBAR
- // old functions, use the new ones instead!
-#if WXWIN_COMPATIBILITY_2
- bool Iconized() const { return IsIconized(); }
-#endif // WXWIN_COMPATIBILITY_2
-
// implementation only from now on
// -------------------------------
- // override some base class virtuals
- virtual bool Destroy();
- virtual bool IsTopLevel() const { return TRUE; }
-
// event handlers
- void OnIdle(wxIdleEvent& event);
- void OnCloseWindow(wxCloseEvent& event);
+#if wxUSE_MENUS
+#if wxUSE_STATUSBAR
+ void OnMenuOpen(wxMenuEvent& event);
+ void OnMenuClose(wxMenuEvent& event);
void OnMenuHighlight(wxMenuEvent& event);
- void OnSize(wxSizeEvent& event);
-
- // this should go away, but for now it's called from docview.cpp,
- // so should be there for all platforms
- void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
+#endif // wxUSE_STATUSBAR
-#if wxUSE_MENUS
- // send wxUpdateUIEvents for all menu items (called from OnIdle())
- void DoMenuUpdates();
- void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
+ // send wxUpdateUIEvents for all menu items in the menubar,
+ // or just for menu if non-NULL
+ virtual void DoMenuUpdates(wxMenu* menu = NULL);
#endif // wxUSE_MENUS
+ // do the UI update processing for this window
+ virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
+
+ // Implement internal behaviour (menu updating on some platforms)
+ virtual void OnInternalIdle();
+
+ // if there is no real wxTopLevelWindow on this platform we have to define
+ // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
+ // old ports (wxMotif) which don't define them in wxFrame
+#ifndef wxTopLevelWindowNative
+ virtual bool ShowFullScreen(bool WXUNUSED(show),
+ long WXUNUSED(style) = wxFULLSCREEN_ALL)
+ { return false; }
+ virtual bool IsFullScreen() const
+ { return false; }
+#endif // no wxTopLevelWindowNative
+
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+ // show help text for the currently selected menu or toolbar item
+ // (typically in the status bar) or hide it and restore the status bar text
+ // originally shown before the menu was opened if show == false
+ virtual void DoGiveHelp(const wxString& text, bool show);
+#endif
+
+ virtual bool IsClientAreaChild(const wxWindow *child) const
+ {
+ return !IsOneOfBars(child) && wxTopLevelWindow::IsClientAreaChild(child);
+ }
+
protected:
// the frame main menu/status/tool bars
// ------------------------------------
// override to update menu bar position when the frame size changes
virtual void PositionMenuBar() { }
+ // override to do something special when the menu bar is being removed
+ // from the frame
+ virtual void DetachMenuBar();
+
+ // override to do something special when the menu bar is attached to the
+ // frame
+ virtual void AttachMenuBar(wxMenuBar *menubar);
+
wxMenuBar *m_frameMenuBar;
#endif // wxUSE_MENUS
+#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
+ // the saved status bar text overwritten by DoGiveHelp()
+ wxString m_oldStatusText;
+#endif
+
#if wxUSE_STATUSBAR
// override to update status bar position (or anything else) when
// something changes
virtual void PositionStatusBar() { }
- // show the help string for this menu item in the given status bar: the
- // status bar pointer can be NULL; return TRUE if help was shown
- bool ShowMenuHelp(wxStatusBar *statbar, int id);
+ // show the help string for the given menu item using DoGiveHelp() if the
+ // given item does have a help string (as determined by FindInMenuBar()),
+ // return false if there is no help for such item
+ bool ShowMenuHelp(int helpid);
wxStatusBar *m_frameStatusBar;
#endif // wxUSE_STATUSBAR
+
+ int m_statusBarPane;
+
#if wxUSE_TOOLBAR
// override to update status bar position (or anything else) when
// something changes
wxToolBar *m_frameToolBar;
#endif // wxUSE_TOOLBAR
- // the frame client to screen translation should take account of the
- // toolbar which may shift the origin of the client area
- virtual void DoClientToScreen(int *x, int *y) const;
- virtual void DoScreenToClient(int *x, int *y) const;
-
- // send the iconize event, return TRUE if processed
- bool SendIconizeEvent(bool iconized = TRUE);
-
- // the frame icon
- wxIcon m_icon;
-
+#if wxUSE_MENUS && wxUSE_STATUSBAR
DECLARE_EVENT_TABLE()
+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+
+ DECLARE_NO_COPY_CLASS(wxFrameBase)
};
// include the real class declaration
-#if defined(__WXMSW__)
- #include "wx/msw/frame.h"
- #ifndef __WXUNIVERSAL__
-
- class WXDLLEXPORT wxFrame : public wxFrameMSW
- {
- public:
- // construction
- wxFrame() { Init(); }
- wxFrame(wxWindow *parent,
- wxWindowID id,
- const wxString& title,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr)
- {
- Init();
- Create(parent, id, title, pos, size, style, name);
- }
- DECLARE_DYNAMIC_CLASS(wxFrame)
- };
-
- #endif
-#elif defined(__WXMOTIF__)
- #include "wx/motif/frame.h"
-#elif defined(__WXGTK__)
- #include "wx/gtk/frame.h"
- #ifndef __WXUNIVERSAL__
-
- class WXDLLEXPORT wxFrame : public wxFrameGTK
- {
- public:
- // construction
- wxFrame() { Init(); }
- wxFrame(wxWindow *parent,
- wxWindowID id,
- const wxString& title,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxDEFAULT_FRAME_STYLE,
- const wxString& name = wxFrameNameStr)
- {
- Init();
- Create(parent, id, title, pos, size, style, name);
- }
- DECLARE_DYNAMIC_CLASS(wxFrame)
- };
-
- #endif
-#elif defined(__WXMGL__)
- #include "wx/mgl/frame.h"
-#elif defined(__WXQT__)
- #include "wx/qt/frame.h"
-#elif defined(__WXMAC__)
- #include "wx/mac/frame.h"
-#elif defined(__WXPM__)
- #include "wx/os2/frame.h"
-#elif defined(__WXSTUBS__)
- #include "wx/stubs/frame.h"
-#endif
-
-#ifdef __WXUNIVERSAL__
+#if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
#include "wx/univ/frame.h"
+#else // !__WXUNIVERSAL__
+ #if defined(__WXPALMOS__)
+ #include "wx/palmos/frame.h"
+ #elif defined(__WXMSW__)
+ #include "wx/msw/frame.h"
+ #elif defined(__WXGTK20__)
+ #include "wx/gtk/frame.h"
+ #elif defined(__WXGTK__)
+ #include "wx/gtk1/frame.h"
+ #elif defined(__WXMOTIF__)
+ #include "wx/motif/frame.h"
+ #elif defined(__WXMAC__)
+ #include "wx/osx/frame.h"
+ #elif defined(__WXCOCOA__)
+ #include "wx/cocoa/frame.h"
+ #elif defined(__WXPM__)
+ #include "wx/os2/frame.h"
+ #endif
#endif
#endif
projects / wxWidgets.git / blobdiff