X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/171a1afede70b31846524f5fb98a884379f8ee7b..1f0acb435592470b421b80df854fbbb08cd2853f:/include/wx/toplevel.h?ds=sidebyside diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h index 8824066fe8..bf8123e5ab 100644 --- a/include/wx/toplevel.h +++ b/include/wx/toplevel.h @@ -18,18 +18,53 @@ // headers // ---------------------------------------------------------------------------- -#include "wx/window.h" +#include "wx/nonownedwnd.h" #include "wx/iconbndl.h" +#include "wx/containr.h" +#include "wx/weakref.h" // the default names for various classes -extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[]; +extern WXDLLIMPEXP_DATA_CORE(const char) wxFrameNameStr[]; -class WXDLLEXPORT wxTopLevelWindowBase; +class WXDLLIMPEXP_FWD_CORE wxTopLevelWindowBase; // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- +/* + Summary of the bits used (some of them are defined in wx/frame.h and + wx/dialog.h and not here): + + +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ + |15|14|13|12|11|10| 9| 8| 7| 6| 5| 4| 3| 2| 1| 0| + +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+ + | | | | | | | | | | | | | | | | + | | | | | | | | | | | | | | | \_ wxCENTRE + | | | | | | | | | | | | | | \____ wxFRAME_NO_TASKBAR + | | | | | | | | | | | | | \_______ wxFRAME_TOOL_WINDOW + | | | | | | | | | | | | \__________ wxFRAME_FLOAT_ON_PARENT + | | | | | | | | | | | \_____________ wxFRAME_SHAPED + | | | | | | | | | | \________________ + | | | | | | | | | \___________________ wxRESIZE_BORDER + | | | | | | | | \______________________ wxTINY_CAPTION_VERT + | | | | | | | \_________________________ wxDIALOG_NO_PARENT + | | | | | | \____________________________ wxMAXIMIZE_BOX + | | | | | \_______________________________ wxMINIMIZE_BOX + | | | | \__________________________________ wxSYSTEM_MENU + | | | \_____________________________________ wxCLOSE_BOX + | | \________________________________________ wxMAXIMIZE + | \___________________________________________ wxMINIMIZE + \______________________________________________ wxSTAY_ON_TOP + + + Notice that the 8 lower bits overlap with wxCENTRE and the button selection + bits (wxYES, wxOK wxNO, wxCANCEL, wxAPPLY, wxCLOSE and wxNO_DEFAULT) which + can be combined with the dialog style for several standard dialogs and + hence shouldn't overlap with any styles which can be used for the dialogs. + Additionally, wxCENTRE can be used with frames also. + */ + // style common to both wxFrame and wxDialog #define wxSTAY_ON_TOP 0x8000 #define wxICONIZE 0x4000 @@ -40,10 +75,17 @@ class WXDLLEXPORT wxTopLevelWindowBase; #define wxSYSTEM_MENU 0x0800 #define wxMINIMIZE_BOX 0x0400 #define wxMAXIMIZE_BOX 0x0200 -#define wxTINY_CAPTION_HORIZ 0x0100 -#define wxTINY_CAPTION_VERT 0x0080 + +#define wxTINY_CAPTION 0x0080 // clashes with wxNO_DEFAULT #define wxRESIZE_BORDER 0x0040 +#if WXWIN_COMPATIBILITY_2_8 + // HORIZ and VERT styles are equivalent anyhow so don't use different names + // for them + #define wxTINY_CAPTION_HORIZ wxTINY_CAPTION + #define wxTINY_CAPTION_VERT wxTINY_CAPTION +#endif + #if WXWIN_COMPATIBILITY_2_6 // deprecated versions defined for compatibility reasons @@ -115,7 +157,8 @@ enum // wxTopLevelWindow: a top level (as opposed to child) window // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow +class WXDLLIMPEXP_CORE wxTopLevelWindowBase : + public wxNavigationEnabled { public: // construction @@ -137,24 +180,34 @@ public: // return true if the frame is maximized virtual bool IsMaximized() const = 0; + // return true if the frame is always maximized + // due to native guidelines or current policy + virtual bool IsAlwaysMaximized() const; + // return true if the frame is iconized virtual bool IsIconized() const = 0; // get the frame icon - const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); } + wxIcon GetIcon() const; // get the frame icons const wxIconBundle& GetIcons() const { return m_icons; } - // set the frame icon - virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); } + // set the frame icon: implemented in terms of SetIcons() + void SetIcon(const wxIcon& icon); // set the frame icons - virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; } + virtual void SetIcons(const wxIconBundle& icons) { m_icons = icons; } // maximize the window to cover entire screen virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0; + // shows the window, but doesn't activate it. If the base code is being run, + // it means the port doesn't implement this method yet and so alert the user. + virtual void ShowWithoutActivating() { + wxFAIL_MSG("ShowWithoutActivating not implemented on this platform."); + } + // return true if the frame is in fullscreen mode virtual bool IsFullScreen() const = 0; @@ -163,6 +216,9 @@ public: virtual void SetTitle(const wxString& title) = 0; virtual wxString GetTitle() const = 0; + // enable/disable close button [x] + virtual bool EnableCloseButton(bool WXUNUSED(enable) ) { return false; } + // Set the shape of the window to the given region. // Returns true if the platform supports this feature (and the // operation is successful.) @@ -192,6 +248,33 @@ public: void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); } void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); } + // Get the default size for a new top level window. This is used when + // creating a wxTLW under some platforms if no explicit size given. + static wxSize GetDefaultSize(); + + + // default item access: we have a permanent default item which is the one + // set by the user code but we may also have a temporary default item which + // would be chosen if the user pressed "Enter" now but the default action + // reverts to the "permanent" default as soon as this temporary default + // item loses focus + + // get the default item, temporary or permanent + wxWindow *GetDefaultItem() const + { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; } + + // set the permanent default item, return the old default + wxWindow *SetDefaultItem(wxWindow *win) + { wxWindow *old = GetDefaultItem(); m_winDefault = win; return old; } + + // return the temporary default item, can be NULL + wxWindow *GetTmpDefaultItem() const { return m_winTmpDefault; } + + // set a temporary default item, SetTmpDefaultItem(NULL) should be called + // soon after a call to SetTmpDefaultItem(window), return the old default + wxWindow *SetTmpDefaultItem(wxWindow *win) + { wxWindow *old = GetDefaultItem(); m_winTmpDefault = win; return old; } + // implementation only from now on // ------------------------------- @@ -199,7 +282,7 @@ public: // override some base class virtuals virtual bool Destroy(); virtual bool IsTopLevel() const { return true; } - virtual wxSize GetMaxSize() const; + virtual bool IsVisible() const { return IsShown(); } // event handlers void OnCloseWindow(wxCloseEvent& event); @@ -215,6 +298,13 @@ public: // do the window-specific processing after processing the update event virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; + // a different API for SetSizeHints + virtual void SetMinSize(const wxSize& minSize); + virtual void SetMaxSize(const wxSize& maxSize); + + virtual void OSXSetModified(bool modified) { m_modified = modified; } + virtual bool OSXIsModified() const { return m_modified; } + protected: // the frame client to screen translation should take account of the // toolbar which may shift the origin of the client area @@ -246,17 +336,22 @@ protected: // client area void DoLayout(); - // Get the default size for the new window if no explicit size given. If - // there are better default sizes then these can be changed, just as long - // as they are not too small for TLWs (and not larger than screen). - static wxSize GetDefaultSize(); static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; } static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; } + // the frame icon wxIconBundle m_icons; - DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase) + // a default window (usually a button) or NULL + wxWindowRef m_winDefault; + + // a temporary override of m_winDefault, use the latter if NULL + wxWindowRef m_winTmpDefault; + + bool m_modified; + + wxDECLARE_NO_COPY_CLASS(wxTopLevelWindowBase); DECLARE_EVENT_TABLE() }; @@ -280,8 +375,11 @@ protected: #elif defined(__WXMGL__) #include "wx/mgl/toplevel.h" #define wxTopLevelWindowNative wxTopLevelWindowMGL +#elif defined(__WXDFB__) + #include "wx/dfb/toplevel.h" + #define wxTopLevelWindowNative wxTopLevelWindowDFB #elif defined(__WXMAC__) - #include "wx/mac/toplevel.h" + #include "wx/osx/toplevel.h" #define wxTopLevelWindowNative wxTopLevelWindowMac #elif defined(__WXCOCOA__) #include "wx/cocoa/toplevel.h" @@ -297,28 +395,25 @@ protected: #ifdef __WXUNIVERSAL__ #include "wx/univ/toplevel.h" #else // !__WXUNIVERSAL__ - #ifdef wxTopLevelWindowNative - class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative + class WXDLLIMPEXP_CORE wxTopLevelWindow : public wxTopLevelWindowNative + { + public: + // construction + wxTopLevelWindow() { } + wxTopLevelWindow(wxWindow *parent, + wxWindowID winid, + const wxString& title, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxDEFAULT_FRAME_STYLE, + const wxString& name = wxFrameNameStr) + : wxTopLevelWindowNative(parent, winid, title, + pos, size, style, name) { - public: - // construction - wxTopLevelWindow() { Init(); } - wxTopLevelWindow(wxWindow *parent, - wxWindowID winid, - const wxString& title, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxDEFAULT_FRAME_STYLE, - const wxString& name = wxFrameNameStr) - { - Init(); - Create(parent, winid, title, pos, size, style, name); - } - - DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow) - }; - #endif // wxTopLevelWindowNative -#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ + } + DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow) + }; +#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__ #endif // _WX_TOPLEVEL_BASE_H_