X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8ffbb0f8df8e4c2facffc65c394c8933ac79c3af..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/collpane.tex diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex index 4aa80a4e33..8b8d412c79 100644 --- a/docs/latex/wx/collpane.tex +++ b/docs/latex/wx/collpane.tex @@ -65,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. } @@ -73,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}}} @@ -103,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} @@ -163,3 +167,63 @@ 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} + + + +\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). +