was incorrectly forcing the font to 12 in most cases, fixes #4745

[wxWidgets.git] / interface / collpane.h

diff --git a/interface/collpane.h b/interface/collpane.h
index 1be941d5b80a86567ae3eb99d424fd541140c730..161eff344dd89662354af0f040586dd38383b3f7 100644 (file)
--- a/interface/collpane.h
+++ b/interface/collpane.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        collpane.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        collpane.h

-// Purpose:     documentation for wxCollapsiblePaneEvent class
+// Purpose:     interface of wxCollapsiblePane

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -10,14 +10,17 @@
     @class wxCollapsiblePaneEvent
     @wxheader{collpane.h}
 
     @class wxCollapsiblePaneEvent
     @wxheader{collpane.h}
 

-    This event class is used for the events generated by
-    wxCollapsiblePane.
+    This event class is used for the events generated by wxCollapsiblePane.
+
+    @beginEventTable{wxCollapsiblePaneEvent}
+    @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
+           The user expanded or collapsed the collapsible pane.
+    @endEventTable

 
     @library{wxcore}
 
     @library{wxcore}

-    @category{FIXME}
+    @category{events}

 
 

-    @seealso
-    wxCollapsiblePane
+    @see wxCollapsiblePane

 */
 class wxCollapsiblePaneEvent : public wxCommandEvent
 {
 */
 class wxCollapsiblePaneEvent : public wxCommandEvent
 {


@@ -25,8 +28,7 @@ public:
     /**
         The constructor is not normally used by the user code.
     */
     /**
         The constructor is not normally used by the user code.
     */

-    wxCollapsiblePaneEvent(wxObject* generator, int id,
-                           bool collapsed);
+    wxCollapsiblePaneEvent(wxObject* generator, int id, bool collapsed);

 
     /**
         Returns @true if the pane has been collapsed.
 
     /**
         Returns @true if the pane has been collapsed.


@@ -35,76 +37,77 @@ public:
 
     /**
         Sets this as a collapsed pane event (if @a collapsed is @true) or as an
 
     /**
         Sets this as a collapsed pane event (if @a collapsed is @true) or as an

-        expanded
-        pane event (if @a collapsed is @false).
+        expanded pane event (if @a collapsed is @false).

     */
     void SetCollapsed(bool collapsed);
 };
 
 
     */
     void SetCollapsed(bool collapsed);
 };
 
 

+

 /**
     @class wxCollapsiblePane
     @wxheader{collpane.h}
 
 /**
     @class wxCollapsiblePane
     @wxheader{collpane.h}
 

-    A collapsible pane is a container with an embedded button-like control which
-    can be
-    used by the user to collapse or expand the pane's contents.
+    A collapsible pane is a container with an embedded button-like control
+    which can be used by the user to collapse or expand the pane's contents.

 
 

-    Once constructed you should use the wxCollapsiblePane::GetPane
-    function to access the pane and add your controls inside it (i.e. use the
-    wxCollapsiblePane::GetPane's returned pointer as parent for the
-    controls which must go in the pane, NOT the wxCollapsiblePane itself!).
+    Once constructed you should use the GetPane() function to access the pane
+    and add your controls inside it (i.e. use the returned pointer from
+    GetPane() as parent for the controls which must go in the pane, @b not the
+    wxCollapsiblePane itself!).

 
     Note that because of its nature of control which can dynamically (and
 
     Note that because of its nature of control which can dynamically (and

-    drastically)
-    change its size at run-time under user-input, when putting wxCollapsiblePane
-    inside
-    a wxSizer you should be careful to add it with a proportion value
-    of zero; this is because otherwise all other windows with non-null proportion
-    values
-    would automatically get resized each time the user expands or collapse the pane
-    window
-    resulting usually in a weird, flickering effect.
+    drastically) change its size at run-time under user-input, when putting
+    wxCollapsiblePane inside a wxSizer you should be careful to add it with a
+    proportion value of zero; this is because otherwise all other windows with
+    non-null proportion values will automatically resize each time the user
+    expands or collapse the pane window usually resulting in a weird,
+    flickering effect.

 
     Usage sample:
 
     @code
 
     Usage sample:
 
     @code

-    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY,
-    wxT("Details:"));
-
-        // add the pane with a zero proportion value to the 'sz' sizer which
-    contains it
-        sz-Add(collpane, 0, wxGROW|wxALL, 5);
-
-        // 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);
-        win-SetSizer(paneSz);
-        paneSz-SetSizeHints(win);
+    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, wxT("Details:"));
+
+    // add the pane with a zero proportion value to the 'sz' sizer which contains it
+    sz->Add(collpane, 0, wxGROW|wxALL, 5);
+
+    // 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);
+    win->SetSizer(paneSz);
+    paneSz->SetSizeHints(win);

     @endcode
 
     It is only available if @c wxUSE_COLLPANE is set to 1 (the default).
 
     @beginStyleTable
     @endcode
 
     It is only available if @c wxUSE_COLLPANE is set to 1 (the default).
 
     @beginStyleTable

-    @style{wxCP_DEFAULT_STYLE}:
+    @style{wxCP_DEFAULT_STYLE}

            The default style: 0.
     @endStyleTable
 
            The default style: 0.
     @endStyleTable
 

+    @beginEventTable{wxCollapsiblePaneEvent}
+    @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
+           The user expanded or collapsed the collapsible pane.
+    @endEventTable
+

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

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

 
 

-    @seealso
-    wxPanel, wxCollapsiblePaneEvent
+    @see wxPanel, wxCollapsiblePaneEvent

 */
 class wxCollapsiblePane : public wxControl
 {
 public:
     /**
 */
 class wxCollapsiblePane : public wxControl
 {
 public:
     /**

-        Initializes the object and calls Create() with
-        all the parameters.
+        Default constructor.
+    */
+    wxCollapsiblePane();
+    
+    /**
+        Initializes the object and calls Create() with all the parameters.

     */
     wxCollapsiblePane(wxWindow* parent, wxWindowID id,
                       const wxString& label,
     */
     wxCollapsiblePane(wxWindow* parent, wxWindowID id,
                       const wxString& label,


@@ -114,19 +117,14 @@ public:
                       const wxValidator& validator = wxDefaultValidator,
                       const wxString& name = "collapsiblePane");
 
                       const wxValidator& validator = wxDefaultValidator,
                       const wxString& name = "collapsiblePane");
 

-    /**
-        Collapses or expands the pane window.
-    */
-    void Collapse(bool collapse = true);
-

     /**
         @param parent
             Parent window, must not be non-@NULL.
         @param id
             The identifier for the control.
         @param label
     /**
         @param parent
             Parent window, must not be non-@NULL.
         @param id
             The identifier for the control.
         @param label

-            The initial label shown in the button which allows the user to expand or
-        collapse the pane window.
+            The initial label shown in the button which allows the user to
+            expand or collapse the pane window.

         @param pos
             Initial position.
         @param size
         @param pos
             Initial position.
         @param size


@@ -137,9 +135,9 @@ public:
             Validator which can be used for additional date checks.
         @param name
             Control name.
             Validator which can be used for additional date checks.
         @param name
             Control name.

-        
-        @returns @true if the control was successfully created or @false if
-                 creation failed.
+
+        @return @true if the control was successfully created or @false if
+                creation failed.

     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label,


@@ -150,13 +148,18 @@ public:
                 const wxString& name = "collapsiblePane");
 
     /**
                 const wxString& name = "collapsiblePane");
 
     /**

-        Same as @c wxCollapsiblePane::Collapse(@false).
+        Collapses or expands the pane window.
+    */
+    void Collapse(bool collapse = true);
+
+    /**
+        Same as calling Collapse(@false).

     */
     void Expand();
 
     /**
     */
     void Expand();
 
     /**

-        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;
 
     */
     wxWindow* GetPane() const;
 


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

+