Doc and comment cleanup, fixes, tweaks

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

diff --git a/interface/wx/collpane.h b/interface/wx/collpane.h
index b6a1f490806cc7d26974379ca616e474988475c1..d69ae74f601514c258a7e914e5e9f98319f23540 100644 (file)
--- a/interface/wx/collpane.h
+++ b/interface/wx/collpane.h
@@ -82,7 +82,13 @@ public:
 
     @beginStyleTable
     @style{wxCP_DEFAULT_STYLE}
-           The default style: 0.
+        The default style. It includes wxTAB_TRAVERSAL and wxBORDER_NONE.
+    @style{wxCP_NO_TLW_RESIZE}
+        By default wxCollapsiblePane resizes the top level window containing it
+        when its own size changes. This allows to easily implement dialogs
+        containing an optionally shown part, for example, and so is the default
+        behaviour but can be inconvenient in some specific cases -- use this
+        flag to disable this automatic parent resizing then.
     @endStyleTable
 
     @beginEventTable{wxCollapsiblePaneEvent}
@@ -103,7 +109,7 @@ public:
         Default constructor.
     */
     wxCollapsiblePane();
-    
+
     /**
         Initializes the object and calls Create() with all the parameters.
     */
@@ -113,7 +119,7 @@ public:
                       const wxSize& size = wxDefaultSize,
                       long style = wxCP_DEFAULT_STYLE,
                       const wxValidator& validator = wxDefaultValidator,
-                      const wxString& name = "collapsiblePane");
+                      const wxString& name = wxCollapsiblePaneNameStr);
 
     /**
         @param parent
@@ -143,12 +149,12 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxCP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = "collapsiblePane");
+                const wxString& name = wxCollapsiblePaneNameStr);
 
     /**
         Collapses or expands the pane window.
     */
-    void Collapse(bool collapse = true);
+    virtual void Collapse(bool collapse = true);
 
     /**
         Same as calling Collapse(@false).
@@ -159,12 +165,12 @@ public:
         Returns a pointer to the pane window. Add controls to the returned
         wxWindow to make them collapsible.
     */
-    wxWindow* GetPane() const;
+    virtual wxWindow* GetPane() const;
 
     /**
         Returns @true if the pane window is currently hidden.
     */
-    bool IsCollapsed() const;
+    virtual bool IsCollapsed() const;
 
     /**
         Returns @true if the pane window is currently shown.