X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c1f8cb1f5cbef0f7699110fd28027948e644c6f..048128e086f0eacc6e4cd1b16b966c641676a177:/docs/latex/wx/collpane.tex diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex index 40774f130f..d511432675 100644 --- a/docs/latex/wx/collpane.tex +++ b/docs/latex/wx/collpane.tex @@ -8,13 +8,19 @@ %% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - - \section{\class{wxCollapsiblePane}}\label{wxcollapsiblepane} A collapsable panel is a container with an embedded button-like control which can be used by the user to collapse or expand the pane's contents. +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 \helpref{wxSizer}{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 collaps the pane window. + +It is only available if \texttt{wxUSE\_COLLPANE} is set to $1$ (the default). + \wxheading{Derived from} \helpref{wxControl}{wxcontrol}\\ @@ -28,9 +34,18 @@ used by the user to collapse or expand the pane's contents. \wxheading{Window styles} -There are no specific styles for this window. +\twocolwidtha{5cm}% +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxCP\_DEFAULT\_STYLE}}{The default style: 0.} +\end{twocollist} + +\wxheading{Event handling} + +\twocolwidtha{7cm}% +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf EVT\_COLLAPSIBLEPANE\_CHANGED(id, func)}}{The user showed or hidden the collapsible pane. } +\end{twocollist} -See also \helpref{window styles overview}{windowstyles}. \wxheading{See also} @@ -96,6 +111,12 @@ all the parameters. Returns \true if the pane window is currently hidden. +\membersection{wxCollapsiblePane::IsExpanded}\label{wxcollapsiblepaneisexpanded} + +\constfunc{bool}{IsExpanded}{\void} + +Returns \true if the pane window is currently shown. + \membersection{wxCollapsiblePane::Collapse}\label{wxcollapsiblepanecollapse} @@ -104,11 +125,10 @@ Returns \true if the pane window is currently hidden. Collapses or expands the pane window. - \membersection{wxCollapsiblePane::Expand}\label{wxcollapsiblepaneexpand} \func{void}{Expand}{\void} -Equivalent to {\tt Collapse(false)}. +Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}.