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 32c64c41667ec54ac0ddc9f7ffd4e67660d0ca48..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


@@ -91,14 +91,16 @@ public:
         flag to disable this automatic parent resizing then.
     @endStyleTable
 
         flag to disable this automatic parent resizing then.
     @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
 */


@@ -154,7 +156,7 @@ public:
     /**
         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).


@@ -165,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.