cleanup - added whitespace around operators, some blank lines, fixed comment typos...

[wxWidgets.git] / include / wx / toplevel.h

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index 3007e976e0ff31f162ca201b3c16d49743e594d5..dbfa07ef6bfb566ca116d1a59aeb735d919b4607 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -21,8 +21,8 @@
 #include "wx/window.h"
 #include "wx/iconbndl.h"
 
-// the default names for various classs
-extern WXDLLEXPORT_DATA(const wxChar*) wxFrameNameStr;
+// the default names for various classes
+extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[];
 
 class WXDLLEXPORT wxTopLevelWindowBase;
 
@@ -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
 //
@@ -154,19 +158,10 @@ public:
     // return true if the frame is in fullscreen mode
     virtual bool IsFullScreen() const = 0;
 
-#if defined(__WXMSW__) || \
-    defined(__WXMOTIF__) || \
-    defined(__WXGTK__)
-
-    // FIXME: This is work in progress about moving SetTitle/GetTitle from wxWindow
-    // to wxTopLevelWindow so initially enabled in wxMSW only to observe results
-    // and continue on other platforms
-
-    // the title (or label, see below) of the window: the text which the
-    // window shows
+    // the title of the top level window: the text which the
+    // window shows usually at the top of the frame/dialog in dedicated bar
     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;
-#endif
 
     // Set the shape of the window to the given region.
     // Returns true if the platform supports this feature (and the
@@ -186,6 +181,11 @@ public:
     virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
 #endif // __SMARTPHONE__
 
+    // centre the window on screen: this is just a shortcut
+    void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); }
+    void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
+
+
     // implementation only from now on
     // -------------------------------
 
@@ -208,30 +208,35 @@ 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() {}
-
 protected:
     // 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;
 
+    // add support for wxCENTRE_ON_SCREEN
+    virtual void DoCentre(int dir);
+
+    // no need to do client to screen translation to get our position in screen
+    // coordinates: this is already the case
+    virtual void DoGetScreenPosition(int *x, int *y) const
+    {
+        DoGetPosition(x, y);
+    }
+
     // 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; }
 
-    // check if we should exit the program after deleting this top level
-    // window (this is used in common dtor and wxMSW code)
+    // 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; }
+
+    // check if we should exit the program after deleting this window
     bool IsLastBeforeExit() const;
 
     // send the iconize event, return true if processed
@@ -263,9 +268,12 @@ protected:
 #elif defined(__WXMSW__)
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowGTK
 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11