]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/toplevel.h
remove warnings of intentionally unreachable code
[wxWidgets.git] / include / wx / toplevel.h
index 0359691c0b80f0fb016a1c83b0288340f5633531..268ecbd4ad121a04f5c3501f4c59c0f3b375e4fb 100644 (file)
@@ -18,7 +18,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#include "wx/window.h"
+#include "wx/nonownedwnd.h"
 #include "wx/iconbndl.h"
 
 // the default names for various classes
@@ -44,15 +44,19 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 #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
+#if WXWIN_COMPATIBILITY_2_6
 
-// obsolete styles, unused any more
-#define wxDIALOG_MODAL          0
-#define wxDIALOG_MODELESS       0
-#define wxNO_3D                 0
-#define wxUSER_COLOURS          0
+    // 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
+
+#endif // WXWIN_COMPATIBILITY_2_6
 
 // default style
 //
@@ -111,7 +115,7 @@ enum
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
+class WXDLLEXPORT wxTopLevelWindowBase : public wxNonOwnedWindow
 {
 public:
     // construction
@@ -133,20 +137,24 @@ 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;
@@ -159,6 +167,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.)
@@ -169,8 +180,15 @@ public:
     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
     // Is this the active frame (highlighted in the taskbar)?
-    virtual bool IsActive()
-        { return (wxGetTopLevelParent(FindFocus()) == this); }
+    virtual bool IsActive() { return wxGetTopLevelParent(FindFocus()) == this; }
+
+    // this function may be overridden to return false to allow closing the
+    // application even when this top level window is still open
+    //
+    // notice that the window is still closed prior to the application exit and
+    // so it can still veto it even if it returns false from here
+    virtual bool ShouldPreventAppExit() const { return true; }
+
 
 #if defined(__SMARTPHONE__)
     virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
@@ -182,13 +200,39 @@ public:
     void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
 
 
+    // 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
+
+    // used to reset default if pointing to removed child
+    virtual void RemoveChild(wxWindowBase *child);
+
+    // 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
     // -------------------------------
 
     // 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);
@@ -204,16 +248,14 @@ public:
     // 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() {}
+    // a different API for SetSizeHints
+    virtual void SetMinSize(const wxSize& minSize);
+    virtual void SetMaxSize(const wxSize& maxSize);
+
+    // set size hints for "window manager"
+    virtual void DoSetSizeHints( int minW, int minH,
+                                 int maxW = wxDefaultCoord, int maxH = wxDefaultCoord,
+                                 int incW = wxDefaultCoord, int incH = wxDefaultCoord );
 
 protected:
     // the frame client to screen translation should take account of the
@@ -228,7 +270,7 @@ protected:
     // coordinates: this is already the case
     virtual void DoGetScreenPosition(int *x, int *y) const
     {
-        return DoGetPosition(x, y);
+        DoGetPosition(x, y);
     }
 
     // test whether this window makes part of the frame
@@ -236,8 +278,7 @@ protected:
     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)
+    // check if we should exit the program after deleting this window
     bool IsLastBeforeExit() const;
 
     // send the iconize event, return true if processed
@@ -254,9 +295,20 @@ protected:
     static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
     static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
 
+    // reset m_winDefault and m_winTmpDefault if they point to the window being
+    // destroyed
+    void OnChildDestroy(wxWindowDestroyEvent& event);
+
+
     // the frame icon
     wxIconBundle m_icons;
 
+    // a default window (usually a button) or NULL
+    wxWindow *m_winDefault;
+
+    // a temporary override of m_winDefault, use the latter if NULL
+    wxWindow *m_winTmpDefault;
+
     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
     DECLARE_EVENT_TABLE()
 };
@@ -281,6 +333,9 @@ 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"
     #define wxTopLevelWindowNative wxTopLevelWindowMac