[ 1602455 ] [docs] Fix docs for event used by pickers & collapsiblepane

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@43659 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling 2006-11-26 18:48:36 +00:00
parent d182ca1ba6
commit c8743553a1
5 changed files with 77 additions and 1 deletions

View File

@ -43,6 +43,9 @@ The text control is automatically synchronized with button's value. Use function
\wxheading{Event handling}
To process a colour picker event, use these event handler macros to direct input to member
functions that take a \helpref{wxColourPickerEvent}{wxcolourpickerevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_COLOURPICKER\_CHANGED(id, func)}}{The user changed the

View File

@ -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}}}
@ -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}
<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).

View File

@ -46,6 +46,9 @@ The text control is automatically synchronized with button's value. Use function
\wxheading{Event handling}
To process a directory picker event, use these event handler macros to direct input to member
functions that take a \helpref{wxFileDirPickerEvent}{wxfiledirpickerevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_DIRPICKER\_CHANGED(id, func)}}{The user changed the

View File

@ -51,6 +51,9 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported!
\wxheading{Event handling}
To process a file picker event, use these event handler macros to direct input to member
functions that take a \helpref{wxFileDirPickerEvent}{wxfiledirpickerevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_FILEPICKER\_CHANGED(id, func)}}{The user changed the file

View File

@ -44,6 +44,9 @@ The text control is automatically synchronized with button's value. Use function
\wxheading{Event handling}
To process a font picker event, use these event handler macros to direct input to member
functions that take a \helpref{wxFontPickerEvent}{wxfontpickerevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_FONTPICKER\_CHANGED(id, func)}}{The user changed the font