[ 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

diff --git a/docs/latex/wx/clrpicker.tex b/docs/latex/wx/clrpicker.tex
index 017fca0e3ecbbba74b6a77c1d6359428db9b0b96..14f780529039f24b2e8c8bbd6a15485379170a23 100644 (file)
--- a/docs/latex/wx/clrpicker.tex
+++ b/docs/latex/wx/clrpicker.tex
@@ -43,6 +43,9 @@ The text control is automatically synchronized with button's value. Use function
 
 \wxheading{Event handling}
 
 
 \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
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_COLOURPICKER\_CHANGED(id, func)}}{The user changed the

diff --git a/docs/latex/wx/collpane.tex b/docs/latex/wx/collpane.tex
index 4aa80a4e331ada9e75cf2621cc8bdc3ff245a824..8e0702d94171ae1cf121151ed381cbc2c64a7e4b 100644 (file)
--- 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}
 
 
 \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. }
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxPanel}{wxpanel}
+\helpref{wxPanel}{wxpanel},\\
+\helpref{wxCollapsiblePaneEvent}{wxcollapsiblepaneevent}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 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).
+

diff --git a/docs/latex/wx/dirpicker.tex b/docs/latex/wx/dirpicker.tex
index 67b3931ecf8e775843b43d8ecfa649e1f45d945f..cd5927945a42c84965b48a7b8ee1d0fc31e77ee7 100644 (file)
--- a/docs/latex/wx/dirpicker.tex
+++ b/docs/latex/wx/dirpicker.tex
@@ -46,6 +46,9 @@ The text control is automatically synchronized with button's value. Use function
 
 \wxheading{Event handling}
 
 
 \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
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_DIRPICKER\_CHANGED(id, func)}}{The user changed the

diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex
index e7831f37ff9dd6fbffc6a8aa4ee0e105df86f201..5fca3a8fedf7b38519fd2a4c2573d110a12408e9 100644 (file)
--- a/docs/latex/wx/filepicker.tex
+++ b/docs/latex/wx/filepicker.tex
@@ -51,6 +51,9 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported!
 
 \wxheading{Event handling}
 
 
 \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
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_FILEPICKER\_CHANGED(id, func)}}{The user changed the file

diff --git a/docs/latex/wx/fontpicker.tex b/docs/latex/wx/fontpicker.tex
index f69338d86fdb9edd9058c51da8a29c24a0a75711..76c1db276136dfec758d32e764fd4974d32b966f 100644 (file)
--- a/docs/latex/wx/fontpicker.tex
+++ b/docs/latex/wx/fontpicker.tex
@@ -44,6 +44,9 @@ The text control is automatically synchronized with button's value. Use function
 
 \wxheading{Event handling}
 
 
 \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
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_FONTPICKER\_CHANGED(id, func)}}{The user changed the font