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 a3b3afcce1c801ecfdcb6e5c427edb0c2936c61f..dbfa07ef6bfb566ca116d1a59aeb735d919b4607 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -14,10 +14,6 @@
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "toplevelbase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -25,8 +21,8 @@
 #include "wx/window.h"
 #include "wx/iconbndl.h"
 
 #include "wx/window.h"
 #include "wx/iconbndl.h"
 

-// the default names for various classs
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
+// the default names for various classes
+extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[];

 
 class WXDLLEXPORT wxTopLevelWindowBase;
 
 
 class WXDLLEXPORT wxTopLevelWindowBase;
 


@@ -48,15 +44,19 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 #define wxTINY_CAPTION_VERT     0x0080
 #define wxRESIZE_BORDER         0x0040
 
 #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
+
+    // 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

 
 

-// 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
 //
 
 // default style
 //


@@ -71,7 +71,7 @@ class WXDLLEXPORT wxTopLevelWindowBase;
     #elif defined(__WINCE_STANDARDSDK__)
         #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
     #else
     #elif defined(__WINCE_STANDARDSDK__)
         #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
     #else

-        #define wxDEFAULT_FRAME_STYLE (0)
+        #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)

     #endif
 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \
     #endif
 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \


@@ -158,13 +158,10 @@ public:
     // return true if the frame is in fullscreen mode
     virtual bool IsFullScreen() const = 0;
 
     // return true if the frame is in fullscreen mode
     virtual bool IsFullScreen() const = 0;
 

-    /*
-       for now we already have them in wxWindow, but this is wrong: these
-       methods really only make sense for wxTopLevelWindow!
-
+    // 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;
     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;

-     */

 
     // Set the shape of the window to the given region.
     // Returns true if the platform supports this feature (and the
 
     // Set the shape of the window to the given region.
     // Returns true if the platform supports this feature (and the


@@ -184,6 +181,11 @@ public:
     virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
 #endif // __SMARTPHONE__
 
     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
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -196,6 +198,9 @@ public:
     void OnCloseWindow(wxCloseEvent& event);
     void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
 
     void OnCloseWindow(wxCloseEvent& 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)) { }
     // 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)) { }


@@ -209,13 +214,29 @@ protected:
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 
     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; }
 
     // 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
     bool IsLastBeforeExit() const;
 
     // send the iconize event, return true if processed


@@ -241,12 +262,18 @@ protected:
 
 
 // include the real class declaration
 
 
 // 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
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK
     #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
 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11