fixing wrong version commit

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

diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index 197bf2df3e37f042166fb436b0916ea827fb4ee2..29a65bfb2f6b2c8f34c62a322a8a9b36a3466b2d 100644 (file)
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -42,6 +42,25 @@ enum
     directly, but all of its methods are also applicable for the two classes
     above.
 
+    Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
+    internal top level window list.
+
+    @beginEventEmissionTable
+    @event{EVT_ACTIVATE(id, func)}
+        Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
+    @event{EVT_MOVE(func)}
+        Process a @c wxEVT_MOVE event, which is generated when a window is moved.
+        See wxMoveEvent.
+    @event{EVT_MOVE_START(func)}
+        Process a @c wxEVT_MOVE_START event, which is generated when the user starts
+        to move or size a window. wxMSW only.
+        See wxMoveEvent.
+    @event{EVT_MOVE_END(func)}
+        Process a @c wxEVT_MOVE_END event, which is generated when the user stops
+        moving or sizing a window. wxMSW only.
+        See wxMoveEvent.
+    @endEventTable
+
     @library{wxcore}
     @category{managedwnd}
 
@@ -50,6 +69,42 @@ enum
 class wxTopLevelWindow : public wxWindow
 {
 public:
+    /**
+        Default ctor.
+    */
+    wxTopLevelWindow();
+
+    /**
+        Constructor creating the top level window.
+    */
+    wxTopLevelWindow(wxWindow *parent,
+                    wxWindowID winid,
+                    const wxString& title,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxDEFAULT_FRAME_STYLE,
+                    const wxString& name = wxFrameNameStr);
+
+    /**
+        Destructor. Remember that wxTopLevelWindows do not get immediately
+        destroyed when the user (or the app) closes them; they have a
+        @b delayed destruction.
+
+        See @ref overview_windowdeletion for more info.
+    */
+    virtual ~wxTopLevelWindow();
+
+    /**
+        Creates the top level window.
+    */
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr);
+
     /**
         Returns @true if the platform supports making the window translucent.
 
@@ -99,7 +154,7 @@ public:
 
         @see GetIcons()
     */
-    const wxIcon GetIcon() const;
+    wxIcon GetIcon() const;
 
     /**
         Returns all icons associated with the window, there will be none of them
@@ -108,7 +163,7 @@ public:
 
         @see wxIconBundle
     */
-    const wxIconBundle GetIcons() const;
+    const wxIconBundle& GetIcons() const;
 
     /**
         Gets a string containing the window title.
@@ -133,7 +188,7 @@ public:
 
         @see IsIconized(), Maximize(), wxIconizeEvent.
     */
-    void Iconize(bool iconize);
+    virtual void Iconize(bool iconize = true);
 
     /**
         Returns @true if this window is currently active, i.e. if the user is
@@ -176,6 +231,12 @@ public:
     */
     bool IsUsingNativeDecorations() const;
 
+    /**
+        See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
+        called automatically when the window is resized.
+    */
+    virtual bool Layout();
+
     /**
         Maximizes or restores the window.
 
@@ -184,7 +245,7 @@ public:
 
         @see Iconize()
     */
-    void Maximize(bool maximize);
+    virtual void Maximize(bool maximize = true);
 
     /**
         Use a system-dependent way to attract users attention to the window when
@@ -210,7 +271,7 @@ public:
 
         @see GetDefaultItem()
     */
-    void SetDefaultItem(wxWindow* win);
+    wxWindow* SetDefaultItem(wxWindow* win);
 
     /**
         Sets the icon for this window.
@@ -222,7 +283,9 @@ public:
                  reference counting, the copy is very quick. It is safe to
                  delete @a icon after calling this function.
 
-        @see wxIcon
+        @note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
+
+        @see wxIcon, SetIcons()
     */
     void SetIcon(const wxIcon& icon);
 
@@ -235,7 +298,10 @@ public:
         @param icons
             The icons to associate with this window.
 
-        @see wxIconBundle.
+        @note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
+              preferably both.
+
+        @see wxIconBundle
     */
     virtual void SetIcons(const wxIconBundle& icons);
 
@@ -363,7 +429,7 @@ public:
             fully transparent, and a value of 255 sets the window to be fully
             opaque.
     */
-    virtual bool SetTransparent(int alpha);
+    virtual bool SetTransparent(wxByte alpha);
 
     /**
         This virtual function is not meant to be called directly but can be
@@ -373,6 +439,23 @@ public:
         there are any open top level windows.
     */
     virtual bool ShouldPreventAppExit() const;
+    
+    /**
+        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 OSXSetModified(bool modified);
+    
+    /**
+        Returns the current modified state of the wxTopLevelWindow on OS X.
+        On other platforms, this method does nothing.
+        
+        @see OSXSetModified()
+    */
+    virtual bool OSXIsModified() const;
 
     /**
         Depending on the value of @a show parameter the window is either shown