X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..f6669958924c3c3833e2932b65598b06073d2e65:/include/wx/frame.h diff --git a/include/wx/frame.h b/include/wx/frame.h index 4228ea0c10..d4624663b4 100644 --- a/include/wx/frame.h +++ b/include/wx/frame.h @@ -5,8 +5,8 @@ // 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_ @@ -16,21 +16,29 @@ // headers // ---------------------------------------------------------------------------- -#if defined(__GNUG__) && !defined(__APPLE__) - #pragma interface "framebase.h" -#endif - #include "wx/toplevel.h" // the base class +#include "wx/statusbr.h" // the default names for various classs -WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr; -WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr; -WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr; +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 +// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxFrame; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxStatusBar; -class WXDLLEXPORT wxToolBar; +// wxFrame-specific (i.e. not for wxDialog) styles +// +// Also see the bit summary table in wx/toplevel.h. +#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 // ---------------------------------------------------------------------------- // wxFrame is a top-level window with optional menubar, statusbar and toolbar @@ -44,12 +52,7 @@ class WXDLLEXPORT wxToolBar; // CreateXXXBar() is called. // ---------------------------------------------------------------------------- -// FIXME - temporary hack in absence of wxTLW !! -#ifndef wxTopLevelWindowNative -class WXDLLEXPORT wxFrameBase : public wxTopLevelWindowBase -#else -class WXDLLEXPORT wxFrameBase : public wxTopLevelWindow -#endif +class WXDLLIMPEXP_CORE wxFrameBase : public wxTopLevelWindow { public: // construction @@ -57,7 +60,7 @@ public: virtual ~wxFrameBase(); wxFrame *New(wxWindow *parent, - wxWindowID id, + wxWindowID winid, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -71,12 +74,6 @@ public: // if the frame has a toolbar) in client coordinates virtual wxPoint GetClientAreaOrigin() const; - // sends a size event to the window using its current size -- this has an - // effect of refreshing the window layout - // - // currently it is only implemented under MSW but is declared here to make - // it possible to call it in portable code without using #ifdef's - virtual void SendSizeEvent() { } // menu bar functions // ------------------ @@ -84,35 +81,43 @@ public: #if wxUSE_MENUS virtual void SetMenuBar(wxMenuBar *menubar); virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; } -#endif // wxUSE_MENUS -#ifdef WXWIN_COMPATIBILITY_2_2 - // call this to simulate a menu command - bool Command(int id) { return ProcessCommand(id); } -#endif // WXWIN_COMPATIBILITY_2_2 + // 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 wxMenuItem *FindItemInMenuBar(int menuId) const; + + // generate menu command corresponding to the given menu item + // + // returns true if processed + bool ProcessCommand(wxMenuItem *item); - // process menu command: returns TRUE if processed - bool ProcessCommand(int id); + // 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, - const wxString& name = - wxStatusLineNameStr); + long style = wxSTB_DEFAULT_STYLE, + 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); @@ -127,48 +132,55 @@ public: // 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 // implementation only from now on // ------------------------------- // event handlers - void OnIdle(wxIdleEvent& event); +#if wxUSE_MENUS +#if wxUSE_STATUSBAR + void OnMenuOpen(wxMenuEvent& event); + void OnMenuClose(wxMenuEvent& event); void OnMenuHighlight(wxMenuEvent& 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 - // 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 - - // show help text (typically in the statusbar); show is FALSE - // if you are hiding the help, TRUE otherwise + // 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 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 @@ -193,17 +205,30 @@ protected: // frame virtual void AttachMenuBar(wxMenuBar *menubar); + // Return true if we should update the menu item state from idle event + // handler or false if we should delay it until the menu is opened. + static bool ShouldUpdateMenuFromIdle(); + wxMenuBar *m_frameMenuBar; #endif // wxUSE_MENUS +#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR) + // the saved status bar text overwritten by DoGiveHelp() + wxString m_oldStatusText; + + // the last help string we have shown in the status bar + wxString m_lastHelpShown; +#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 @@ -219,7 +244,11 @@ protected: wxToolBar *m_frameToolBar; #endif // wxUSE_TOOLBAR +#if wxUSE_MENUS && wxUSE_STATUSBAR DECLARE_EVENT_TABLE() +#endif // wxUSE_MENUS && wxUSE_STATUSBAR + + wxDECLARE_NO_COPY_CLASS(wxFrameBase); }; // include the real class declaration @@ -228,12 +257,16 @@ protected: #else // !__WXUNIVERSAL__ #if defined(__WXMSW__) #include "wx/msw/frame.h" - #elif defined(__WXGTK__) + #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/mac/frame.h" + #include "wx/osx/frame.h" + #elif defined(__WXCOCOA__) + #include "wx/cocoa/frame.h" #elif defined(__WXPM__) #include "wx/os2/frame.h" #endif