Add documentation of emitted events to wxScrolled documentation.

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

diff --git a/interface/wx/collpane.h b/interface/wx/collpane.h
index d69ae74f601514c258a7e914e5e9f98319f23540..2ad1b466378386a4fb788d17d6f34c18dcc1458e 100644 (file)
--- a/interface/wx/collpane.h
+++ b/interface/wx/collpane.h
@@ -3,9 +3,12 @@
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#define wxCP_DEFAULT_STYLE          (wxTAB_TRAVERSAL | wxNO_BORDER)
+#define wxCP_NO_TLW_RESIZE          (0x0002)
+

 /**
     @class wxCollapsiblePaneEvent
 
 /**
     @class wxCollapsiblePaneEvent
 


@@ -41,7 +44,7 @@ public:
     void SetCollapsed(bool collapsed);
 };
 
     void SetCollapsed(bool collapsed);
 };
 

-
+wxEventType wxEVT_COMMAND_COLLPANE_CHANGED;

 
 /**
     @class wxCollapsiblePane
 
 /**
     @class wxCollapsiblePane


@@ -65,7 +68,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 +76,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 +94,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
 */


@@ -177,4 +182,3 @@ public:
     */
     bool IsExpanded() const;
 };
     */
     bool IsExpanded() const;
 };

-