don't declare inline function with dllexport declaration, this provokes mingw32 warni...

[wxWidgets.git] / docs / latex / wx / collpane.tex

diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex
index 1eccbe335fcf149e1d6ac913bedfab13fc24a867..8b8d412c7914cb63aa64ef9d9d8acb0b70219d49 100644 (file)
--- a/docs/latex/wx/collpane.tex
+++ b/docs/latex/wx/collpane.tex
@@ -26,6 +26,7 @@ would automatically get resized each time the user expands or collapse the pane
 resulting usually in a weird, flickering effect.
 
 Usage sample:
+
 \begin{verbatim}
     wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, wxT("Details:"));
 
@@ -64,6 +65,9 @@ It is only available if \texttt{wxUSE\_COLLPANE} is set to $1$ (the default).
 
 \wxheading{Event handling}
 
+To process a collapsible pane event, use these event handler macros to direct input to member
+functions that take a \helpref{wxCollapsiblePaneEvent}{wxcollapsiblepaneevent} argument.
+
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_COLLAPSIBLEPANE\_CHANGED(id, func)}}{The user showed or hidden the collapsible pane. }
@@ -72,7 +76,8 @@ It is only available if \texttt{wxUSE\_COLLPANE} is set to $1$ (the default).
 
 \wxheading{See also}
 
-\helpref{wxPanel}{wxpanel}
+\helpref{wxPanel}{wxpanel},\\
+\helpref{wxCollapsiblePaneEvent}{wxcollapsiblepaneevent}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -102,7 +107,7 @@ all the parameters.
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},
-\param{const wxString\& }{name = ``colourpickerctrl"}}
+\param{const wxString\& }{name = ``collapsiblePane"}}
 
 \wxheading{Parameters}
 
@@ -161,3 +166,64 @@ Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}.
 
 Returns a pointer to the pane window. Add controls to the returned \helpref{wxWindow}{wxwindow}
 to make them collapsible.
+
+
+
+
+
+%% wxCollapsiblePaneEvent documentation
+
+\section{\class{wxCollapsiblePaneEvent}}\label{wxcollapsiblepaneevent}
+
+This event class is used for the events generated by
+\helpref{wxCollapsiblePane}{wxcollapsiblepane}.
+
+\wxheading{Derived from}
+
+\helpref{wxCommandEvent}{wxcommandevent}\\
+\helpref{wxEvent}{wxevent}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/collpane.h>
+
+\wxheading{Event handling}
+
+To process input from a wxCollapsiblePane, use one of these event handler macros to
+direct input to member function that take a
+\helpref{wxCollapsiblePaneEvent}{wxcollapsiblepaneevent} argument:
+
+\twocolwidtha{7cm}
+\begin{twocollist}
+\twocolitem{{\bf EVT\_COLLAPSIBLEPANE\_CHANGED(id, func)}}{The user showed or hidden the collapsible pane.}
+\end{twocollist}%
+
+
+\wxheading{See also}
+
+\helpref{wxCollapsiblePane}{wxcollapsiblepane}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxCollapsiblePaneEvent::wxCollapsiblePaneEvent}\label{wxcollapsiblepaneeventctor}
+
+\func{}{wxCollapsiblePaneEvent}{\param{wxObject *}{ generator}, \param{int}{ id}, \param{bool}{ collapsed}}
+
+The constructor is not normally used by the user code.
+
+
+\membersection{wxCollapsiblePaneEvent::GetCollapsed}\label{wxcollapsiblepaneeventgetcollapsed}
+
+\constfunc{bool}{GetCollapsed}{\void}
+
+Returns \true if the pane has been collapsed.
+
+
+\membersection{wxCollapsiblePaneEvent::SetCollapsed}\label{wxcollapsiblepaneeventsetcollapsed}
+
+\func{void}{SetCollapsed}{\param{bool}{ collapsed}}
+
+Sets this as a collapsed pane event (if \arg{collapsed} is \true) or as an expanded
+pane event (if \arg{collapsed} is \false).
+