X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/83df96d63a52ebb08b9e32549dc255354b4a18d0..e5d92e2bef8fed2f3fabaf9662902eb7189f5f92:/include/wx/toplevel.h?ds=sidebyside diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h index 51caf5929d..86805fe5ed 100644 --- a/include/wx/toplevel.h +++ b/include/wx/toplevel.h @@ -7,7 +7,7 @@ // Created: 06.08.01 // RCS-ID: $Id$ // Copyright: (c) 2001 Vadim Zeitlin -// Vaclav Slavik +// Vaclav Slavik // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// @@ -18,15 +18,11 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma interface "toplevelbase.h" -#endif - #include "wx/window.h" -#include "wx/icon.h" +#include "wx/iconbndl.h" // the default names for various classs -WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr; +extern WXDLLEXPORT_DATA(const wxChar*) wxFrameNameStr; class WXDLLEXPORT wxTopLevelWindowBase; @@ -34,6 +30,57 @@ class WXDLLEXPORT wxTopLevelWindowBase; // constants // ---------------------------------------------------------------------------- +// style common to both wxFrame and wxDialog +#define wxSTAY_ON_TOP 0x8000 +#define wxICONIZE 0x4000 +#define wxMINIMIZE wxICONIZE +#define wxMAXIMIZE 0x2000 +#define wxCLOSE_BOX 0x1000 + +#define wxSYSTEM_MENU 0x0800 +#define wxMINIMIZE_BOX 0x0400 +#define wxMAXIMIZE_BOX 0x0200 +#define wxTINY_CAPTION_HORIZ 0x0100 +#define wxTINY_CAPTION_VERT 0x0080 +#define wxRESIZE_BORDER 0x0040 + +// deprecated versions defined for compatibility reasons +#define wxRESIZE_BOX wxMAXIMIZE_BOX +#define wxTHICK_FRAME wxRESIZE_BORDER + +// obsolete styles, unused any more +#define wxDIALOG_MODAL 0 +#define wxDIALOG_MODELESS 0 +#define wxNO_3D 0 +#define wxUSER_COLOURS 0 + +// default style +// +// under Windows CE (at least when compiling with eVC 4) we should create +// top level windows without any styles at all for them to appear +// "correctly", i.e. as full screen windows with a "hide" button (same as +// "close" but round instead of squared and just hides the applications +// instead of closing it) in the title bar +#if defined(__WXWINCE__) + #if defined(__SMARTPHONE__) + #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE) + #elif defined(__WINCE_STANDARDSDK__) + #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX) + #else + #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER) + #endif +#else // !__WXWINCE__ + #define wxDEFAULT_FRAME_STYLE \ + (wxSYSTEM_MENU | \ + wxRESIZE_BORDER | \ + wxMINIMIZE_BOX | \ + wxMAXIMIZE_BOX | \ + wxCLOSE_BOX | \ + wxCAPTION | \ + wxCLIP_CHILDREN) +#endif + + // Dialogs are created in a special way #define wxTOPLEVEL_EX_DIALOG 0x00000008 @@ -53,6 +100,13 @@ enum wxFULLSCREEN_NOCAPTION }; +// Styles for RequestUserAttention +enum +{ + wxUSER_ATTENTION_INFO = 1, + wxUSER_ATTENTION_ERROR = 2 +}; + // ---------------------------------------------------------------------------- // wxTopLevelWindow: a top level (as opposed to child) window // ---------------------------------------------------------------------------- @@ -67,31 +121,37 @@ public: // top level wnd state // -------------------- - // maximize = TRUE => maximize, otherwise - restore - virtual void Maximize(bool maximize = TRUE) = 0; + // 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; + // iconize = true => iconize, otherwise - restore + virtual void Iconize(bool iconize = true) = 0; - // return TRUE if the frame is maximized + // return true if the frame is maximized virtual bool IsMaximized() const = 0; - // return TRUE if the frame is iconized + // return true if the frame is iconized virtual bool IsIconized() const = 0; // get the frame icon - const wxIcon& GetIcon() const { return m_icon; } + const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); } + + // get the frame icons + const wxIconBundle& GetIcons() const { return m_icons; } // set the frame icon - virtual void SetIcon(const wxIcon& icon) { m_icon = icon; } + virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); } + + // set the frame 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; - // return TRUE if the frame is in fullscreen mode + // return true if the frame is in fullscreen mode virtual bool IsFullScreen() const = 0; /* @@ -102,34 +162,56 @@ public: virtual wxString GetTitle() const = 0; */ - // old functions, use the new ones instead! -#if WXWIN_COMPATIBILITY_2 - bool Iconized() const { return IsIconized(); } -#endif // WXWIN_COMPATIBILITY_2 + // Set the shape of the window to the given region. + // Returns true if the platform supports this feature (and the + // operation is successful.) + virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; } + + // Attracts the users attention to this window if the application is + // inactive (should be called when a background event occurs) + virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO); + + // Is this the active frame (highlighted in the taskbar)? + virtual bool IsActive() + { return (wxGetTopLevelParent(FindFocus()) == this); } + +#if defined(__SMARTPHONE__) + virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0; + virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0; +#endif // __SMARTPHONE__ // implementation only from now on // ------------------------------- // override some base class virtuals virtual bool Destroy(); - virtual bool IsTopLevel() const { return TRUE; } + virtual bool IsTopLevel() const { return true; } + virtual wxSize GetMaxSize() const; // event handlers void OnCloseWindow(wxCloseEvent& event); - void OnSize(wxSizeEvent& event); + void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); } + + // Get rect to be used to center top-level children + virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h); // 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)) { } - // Override in derived, platfrom specific, class if your OS coordinate - // system uses anything other than the top left as 0,0. The second - // method updates any internal sizing parameters such as OS/2's SWP struct - inline virtual void AlterChildPos(void) { } - inline virtual void UpdateInternalSize( wxWindow* WXUNUSED(pChild) - ,int WXUNUSED(nWidth) - ,int WXUNUSED(nHeight) - ) { } + // do the window-specific processing after processing the update event + virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; + + // Reserved for future use + virtual void ReservedTopLevelWindowFunc1() {} + virtual void ReservedTopLevelWindowFunc2() {} + virtual void ReservedTopLevelWindowFunc3() {} + virtual void ReservedTopLevelWindowFunc4() {} + virtual void ReservedTopLevelWindowFunc5() {} + virtual void ReservedTopLevelWindowFunc6() {} + virtual void ReservedTopLevelWindowFunc7() {} + virtual void ReservedTopLevelWindowFunc8() {} + virtual void ReservedTopLevelWindowFunc9() {} protected: // the frame client to screen translation should take account of the @@ -137,22 +219,42 @@ protected: 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; - // test whether this window makes part of the frame // (menubar, toolbar and statusbar are excluded from automatic layout) - virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const { return FALSE; } + virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const + { return false; } + + // check if we should exit the program after deleting this top level + // window (this is used in common dtor and wxMSW code) + bool IsLastBeforeExit() const; + + // send the iconize event, return true if processed + bool SendIconizeEvent(bool iconized = true); + + // do TLW-specific layout: we resize our unique child to fill the entire + // 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) DECLARE_EVENT_TABLE() }; // include the real class declaration -#if defined(__WXMSW__) +#if defined(__WXPALMOS__) + #include "wx/palmos/toplevel.h" + #define wxTopLevelWindowNative wxTopLevelWindowPalm +#elif defined(__WXMSW__) #include "wx/msw/toplevel.h" #define wxTopLevelWindowNative wxTopLevelWindowMSW #elif defined(__WXGTK__) @@ -167,9 +269,15 @@ protected: #elif defined(__WXMAC__) #include "wx/mac/toplevel.h" #define wxTopLevelWindowNative wxTopLevelWindowMac +#elif defined(__WXCOCOA__) + #include "wx/cocoa/toplevel.h" + #define wxTopLevelWindowNative wxTopLevelWindowCocoa #elif defined(__WXPM__) #include "wx/os2/toplevel.h" #define wxTopLevelWindowNative wxTopLevelWindowOS2 +#elif defined(__WXMOTIF__) + #include "wx/motif/toplevel.h" + #define wxTopLevelWindowNative wxTopLevelWindowMotif #endif #ifdef __WXUNIVERSAL__ @@ -182,7 +290,7 @@ protected: // construction wxTopLevelWindow() { Init(); } wxTopLevelWindow(wxWindow *parent, - wxWindowID id, + wxWindowID winid, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -190,10 +298,10 @@ protected: const wxString& name = wxFrameNameStr) { Init(); - Create(parent, id, title, pos, size, style, name); + Create(parent, winid, title, pos, size, style, name); } - DECLARE_DYNAMIC_CLASS(wxTopLevelWindow) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow) }; #endif // wxTopLevelWindowNative #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__