Better document wxAutomationObject::GetDispatchPtr() return value.

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

diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index d712256b500272ed61e70a318e63eb12b74f7bd5..bb8bdea42f415ee3c1110dd4a57a0d565b6f706b 100644 (file)
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTopLevelWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -59,6 +59,8 @@ enum
         Process a @c wxEVT_MOVE_END event, which is generated when the user stops
         moving or sizing a window. wxMSW only.
         See wxMoveEvent.
+    @event{EVT_SHOW(func)}
+        Process a @c wxEVT_SHOW event. See wxShowEvent.
     @endEventTable
 
     @library{wxcore}
@@ -148,6 +150,19 @@ public:
     */
     wxWindow* GetDefaultItem() const;
 
+    /**
+        Get the default size for a new top level window.
+
+        This is used internally by wxWidgets on some platforms to determine the
+        default size for a window created using ::wxDefaultSize so it is not
+        necessary to use it when creating a wxTopLevelWindow, however it may be
+        useful if a rough estimation of the window size is needed for some
+        other reason.
+
+        @since 2.9.2
+     */
+    static wxSize GetDefaultSize();
+
     /**
         Returns the standard icon of the window. The icon will be invalid if it
         hadn't been previously set by SetIcon().
@@ -441,16 +456,21 @@ public:
     virtual bool ShouldPreventAppExit() const;
     
     /**
-        This function sets the wxTopLevelWindow's modified state, so that the 
-        wxTopLevelWindow can change its GUI to reflect the current state. (e.g. on 
-        Mac, the close button gets a black dot to reflect that there are unsaved changes)
+        This function sets the wxTopLevelWindow's modified state on OS X,
+        which currently draws a black dot in the wxTopLevelWindow's close button.
+        On other platforms, this method does nothing.
+        
+        @see OSXIsModified()
     */
-    virtual void SetModified(bool modified);
+    virtual void OSXSetModified(bool modified);
     
     /**
-        Returns the current modified state of the wxTopLevelWindow. 
+        Returns the current modified state of the wxTopLevelWindow on OS X.
+        On other platforms, this method does nothing.
+        
+        @see OSXSetModified()
     */
-    virtual bool GetModified() const;
+    virtual bool OSXIsModified() const;
 
     /**
         Depending on the value of @a show parameter the window is either shown