Make wxTopLevelWindow::GetDefaultSize() public and document it.

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

diff --git a/interface/wx/collpane.h b/interface/wx/collpane.h
index b6a1f490806cc7d26974379ca616e474988475c1..9a82bdc0ad5157b9bcc76f25fdc00ceeab1cf26d 100644 (file)
--- a/interface/wx/collpane.h
+++ b/interface/wx/collpane.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxCollapsiblePane
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxCollapsiblePane
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -65,7 +65,7 @@ public:
     Usage sample:
 
     @code
     Usage sample:
 
     @code

-    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, wxT("Details:"));
+    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, "Details:");

 
     // add the pane with a zero proportion value to the 'sz' sizer which contains it
     sz->Add(collpane, 0, wxGROW|wxALL, 5);
 
     // add the pane with a zero proportion value to the 'sz' sizer which contains it
     sz->Add(collpane, 0, wxGROW|wxALL, 5);


@@ -73,7 +73,7 @@ public:
     // now add a test label in the collapsible pane using a sizer to layout it:
     wxWindow *win = collpane->GetPane();
     wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);
     // now add a test label in the collapsible pane using a sizer to layout it:
     wxWindow *win = collpane->GetPane();
     wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);

-    paneSz->Add(new wxStaticText(win, wxID_ANY, wxT("test!")), 1, wxGROW|wxALL, 2);
+    paneSz->Add(new wxStaticText(win, wxID_ANY, "test!"), 1, wxGROW|wxALL, 2);

     win->SetSizer(paneSz);
     paneSz->SetSizeHints(win);
     @endcode
     win->SetSizer(paneSz);
     paneSz->SetSizeHints(win);
     @endcode


@@ -82,17 +82,25 @@ public:
 
     @beginStyleTable
     @style{wxCP_DEFAULT_STYLE}
 
     @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
 
     @endStyleTable
 

-    @beginEventTable{wxCollapsiblePaneEvent}
+    @beginEventEmissionTable{wxCollapsiblePaneEvent,wxNavigationKeyEvent}

     @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
     @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}

-           The user expanded or collapsed the collapsible pane.
+        The user expanded or collapsed the collapsible pane.
+    @event{EVT_NAVIGATION_KEY(func)}
+        Process a navigation key event.

     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}

-    <!-- @appearance{collapsiblepane.png} -->
+    @appearance{collapsiblepane.png}

 
     @see wxPanel, wxCollapsiblePaneEvent
 */
 
     @see wxPanel, wxCollapsiblePaneEvent
 */


@@ -103,7 +111,7 @@ public:
         Default constructor.
     */
     wxCollapsiblePane();
         Default constructor.
     */
     wxCollapsiblePane();

-    
+

     /**
         Initializes the object and calls Create() with all the parameters.
     */
     /**
         Initializes the object and calls Create() with all the parameters.
     */


@@ -113,7 +121,7 @@ public:
                       const wxSize& size = wxDefaultSize,
                       long style = wxCP_DEFAULT_STYLE,
                       const wxValidator& validator = wxDefaultValidator,
                       const wxSize& size = wxDefaultSize,
                       long style = wxCP_DEFAULT_STYLE,
                       const wxValidator& validator = wxDefaultValidator,

-                      const wxString& name = "collapsiblePane");
+                      const wxString& name = wxCollapsiblePaneNameStr);

 
     /**
         @param parent
 
     /**
         @param parent


@@ -143,12 +151,12 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxCP_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 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.
     */
 
     /**
         Collapses or expands the pane window.
     */

-    void Collapse(bool collapse = true);
+    virtual void Collapse(bool collapse = true);

 
     /**
         Same as calling Collapse(@false).
 
     /**
         Same as calling Collapse(@false).


@@ -159,12 +167,12 @@ public:
         Returns a pointer to the pane window. Add controls to the returned
         wxWindow to make them collapsible.
     */
         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.
     */
 
     /**
         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.
 
     /**
         Returns @true if the pane window is currently shown.