correct wxSortedArrayString(wxArrayString) ctor documentation (closes #10944)

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

diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index f0432e2e686f50cc46bd377be3708b5de6ba9683..acb79b1c724a69840a5cac5d38ef183f9a49f593 100644 (file)
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -36,13 +36,31 @@ enum
 
 /**
     @class wxTopLevelWindow
 
 /**
     @class wxTopLevelWindow

-    @wxheader{toplevel.h}

 
     wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an
     abstract base class meaning that you never work with objects of this class
     directly, but all of its methods are also applicable for the two classes
     above.
 
 
     wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an
     abstract base class meaning that you never work with objects of this class
     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}
 
     @library{wxcore}
     @category{managedwnd}
 


@@ -51,6 +69,42 @@ enum
 class wxTopLevelWindow : public wxWindow
 {
 public:
 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.
 
     /**
         Returns @true if the platform supports making the window translucent.
 


@@ -85,7 +139,7 @@ public:
         (including GTK+) where the window manager may not support this operation
         and there is no way to find out.
     */
         (including GTK+) where the window manager may not support this operation
         and there is no way to find out.
     */

-    bool EnableCloseButton(bool enable = true);
+    virtual bool EnableCloseButton(bool enable = true);

 
     /**
         Returns a pointer to the button which is the default for this window, or
 
     /**
         Returns a pointer to the button which is the default for this window, or


@@ -100,7 +154,7 @@ public:
 
         @see GetIcons()
     */
 
         @see GetIcons()
     */

-    const wxIcon GetIcon() const;
+    wxIcon GetIcon() const;

 
     /**
         Returns all icons associated with the window, there will be none of them
 
     /**
         Returns all icons associated with the window, there will be none of them


@@ -109,14 +163,14 @@ public:
 
         @see wxIconBundle
     */
 
         @see wxIconBundle
     */

-    const wxIconBundle GetIcons() const;
+    const wxIconBundle& GetIcons() const;

 
     /**
         Gets a string containing the window title.
 
         @see SetTitle()
     */
 
     /**
         Gets a string containing the window title.
 
         @see SetTitle()
     */

-    wxString GetTitle() const;
+    virtual wxString GetTitle() const;

 
     /**
         Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
 
     /**
         Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input


@@ -134,13 +188,13 @@ public:
 
         @see IsIconized(), Maximize(), wxIconizeEvent.
     */
 
         @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
         currently working with it.
     */
 
     /**
         Returns @true if this window is currently active, i.e. if the user is
         currently working with it.
     */

-    bool IsActive() const;
+    virtual bool IsActive();

 
     /**
         Returns @true if this window is expected to be always maximized, either
 
     /**
         Returns @true if this window is expected to be always maximized, either


@@ -154,17 +208,17 @@ public:
 
         @see ShowFullScreen()
     */
 
         @see ShowFullScreen()
     */

-    bool IsFullScreen();
+    virtual bool IsFullScreen() const;

 
     /**
         Returns @true if the window is iconized.
     */
 
     /**
         Returns @true if the window is iconized.
     */

-    bool IsIconized() const;
+    virtual bool IsIconized() const;

 
     /**
         Returns @true if the window is maximized.
     */
 
     /**
         Returns @true if the window is maximized.
     */

-    bool IsMaximized() const;
+    virtual bool IsMaximized() const;

 
     /**
         This method is specific to wxUniversal port.
 
     /**
         This method is specific to wxUniversal port.


@@ -177,6 +231,12 @@ public:
     */
     bool IsUsingNativeDecorations() const;
 
     */
     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.
 
     /**
         Maximizes or restores the window.
 


@@ -185,7 +245,7 @@ public:
 
         @see Iconize()
     */
 
         @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
 
     /**
         Use a system-dependent way to attract users attention to the window when


@@ -204,14 +264,14 @@ public:
         supporting it.
 
     */
         supporting it.
 
     */

-    void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
+    virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);

 
     /**
         Changes the default item for the panel, usually @a win is a button.
 
         @see GetDefaultItem()
     */
 
     /**
         Changes the default item for the panel, usually @a win is a button.
 
         @see GetDefaultItem()
     */

-    void SetDefaultItem(wxWindow* win);
+    wxWindow* SetDefaultItem(wxWindow* win);

 
     /**
         Sets the icon for this window.
 
     /**
         Sets the icon for this window.


@@ -223,7 +283,9 @@ public:
                  reference counting, the copy is very quick. It is safe to
                  delete @a icon after calling this function.
 
                  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);
 
     */
     void SetIcon(const wxIcon& icon);
 


@@ -236,9 +298,12 @@ public:
         @param icons
             The icons to associate with this window.
 
         @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

     */
     */

-    void SetIcons(const wxIconBundle& icons);
+    virtual void SetIcons(const wxIconBundle& icons);

 
     /**
         Sets action or menu activated by pressing left hardware button on the
 
     /**
         Sets action or menu activated by pressing left hardware button on the


@@ -261,12 +326,12 @@ public:
     /**
         A simpler interface for setting the size hints than SetSizeHints().
     */
     /**
         A simpler interface for setting the size hints than SetSizeHints().
     */

-    void SetMaxSize(const wxSize& size);
+    virtual void SetMaxSize(const wxSize& size);

 
     /**
         A simpler interface for setting the size hints than SetSizeHints().
     */
 
     /**
         A simpler interface for setting the size hints than SetSizeHints().
     */

-    void SetMinSize(const wxSize& size);
+    virtual void SetMinSize(const wxSize& size);

 
     /**
         Sets action or menu activated by pressing right hardware button on the
 
     /**
         Sets action or menu activated by pressing right hardware button on the


@@ -276,7 +341,7 @@ public:
             Identifier for this button.
         @param label
             Text to be displayed on the screen area dedicated to this hardware
             Identifier for this button.
         @param label
             Text to be displayed on the screen area dedicated to this hardware

-            button. 
+            button.

         @param subMenu
             The menu to be opened after pressing this hardware button.
 
         @param subMenu
             The menu to be opened after pressing this hardware button.
 


@@ -293,13 +358,21 @@ public:
         window to the normal rectangular shape simply call SetShape() again with
         an empty wxRegion. Returns @true if the operation is successful.
     */
         window to the normal rectangular shape simply call SetShape() again with
         an empty wxRegion. Returns @true if the operation is successful.
     */

-    bool SetShape(const wxRegion& region);
+    virtual bool SetShape(const wxRegion& region);

 
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 
 
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 

+        @param minW
+            The minimum width.
+        @param minH
+            The minimum height.
+        @param maxW
+            The maximum width.
+        @param maxH
+            The maximum height.

         @param incW
             Specifies the increment for sizing the width (GTK/Motif/Xt only).
         @param incH
         @param incW
             Specifies the increment for sizing the width (GTK/Motif/Xt only).
         @param incH


@@ -311,16 +384,19 @@ public:
                  wxWindow::SetSize().
 
     */
                  wxWindow::SetSize().
 
     */

-    virtual void SetSizeHints(int minW, int minH, int maxW = -1,
-                              int maxH = -1,
-                              int incW = -1,
-                              int incH = -1);
+    virtual void SetSizeHints(int minW, int minH,
+                              int maxW = -1, int maxH = -1,
+                              int incW = -1, int incH = -1);

 
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 
 
     /**
         Allows specification of minimum and maximum window sizes, and window
         size increments. If a pair of values is not set (or set to -1), no
         constraints will be used.
 

+        @param minSize
+            The minimum size of the window.
+        @param maxSize
+            The maximum size of the window.

         @param incSize
             Increment size (only taken into account under X11-based ports such
             as wxGTK/wxMotif/wxX11).
         @param incSize
             Increment size (only taken into account under X11-based ports such
             as wxGTK/wxMotif/wxX11).


@@ -353,7 +429,7 @@ public:
             fully transparent, and a value of 255 sets the window to be fully
             opaque.
     */
             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
 
     /**
         This virtual function is not meant to be called directly but can be


@@ -384,7 +460,7 @@ public:
 
         @see IsFullScreen()
     */
 
         @see IsFullScreen()
     */

-    bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
+    virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);

 
     /**
         This method is specific to wxUniversal port.
 
     /**
         This method is specific to wxUniversal port.


@@ -418,7 +494,7 @@ public:
         decorations are used by default and so it may make sense to call this
         method with default argument if the application can't use custom
         decorations at all for some reason.
         decorations are used by default and so it may make sense to call this
         method with default argument if the application can't use custom
         decorations at all for some reason.

-        
+

         @see UseNativeDecorations()
     */
     void UseNativeDecorationsByDefault(bool native = true);
         @see UseNativeDecorations()
     */
     void UseNativeDecorationsByDefault(bool native = true);