Applied Patch #1502804: wx*PickerCtrl documentation fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39639 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-06-08 19:10:00 +00:00
parent df39467f88
commit aaa6f9ba6b
5 changed files with 29 additions and 37 deletions

View File

@@ -32,13 +32,13 @@ It is only available if \texttt{wxUSE\_FONTPICKERCTRL} is set to $1$ (the defaul
\twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxFONTP\_DEFAULT}}{Default style.}
\twocolitem{\windowstyle{wxFONTP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
\twocolitem{\windowstyle{wxFNTP\_DEFAULT}}{Default style.}
\twocolitem{\windowstyle{wxFNTP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
picker button which is completely managed by the \helpref{wxFontPickerCtrl}{wxfontpickerctrl}
and which can be used by the user to specify a font (see \helpref{SetSelectedFont}{wxfontpickerctrlsetselectedfont}).
The text control is automatically synchronized with button's value. Use functions defined in \helpref{wxPickerBase}{wxpickerbase} to modify the text control.}
\twocolitem{\windowstyle{wxFONTP\_FONTDESC\_AS\_LABEL}}{Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text.}
\twocolitem{\windowstyle{wxFONTP\_USEFONT\_FOR\_LABEL}}{Uses the currently selected font to draw the label of the button.}
\twocolitem{\windowstyle{wxFNTP\_FONTDESC\_AS\_LABEL}}{Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text.}
\twocolitem{\windowstyle{wxFNTP\_USEFONT\_FOR\_LABEL}}{Uses the currently selected font to draw the label of the button.}
\end{twocollist}
\wxheading{Event handling}
@@ -47,7 +47,7 @@ The text control is automatically synchronized with button's value. Use function
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_FONTPICKER\_CHANGED(id, func)}}{The user changed the font
selected in the control either using the button or using text control (see
wxFONTP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
wxFNTP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
user's input is valid, i.e. recognizable). }
\end{twocollist}
@@ -66,7 +66,7 @@ user's input is valid, i.e. recognizable). }
\param{const wxFont\& }{font = *wxNORMAL\_FONT},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = wxFONTP\_DEFAULT\_STYLE},\rtfsp
\param{long}{ style = wxFNTP\_DEFAULT\_STYLE},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},
\param{const wxString\& }{name = ``fontpickerctrl"}}
@@ -81,7 +81,7 @@ all the parameters.
\param{const wxFont\& }{font = *wxNORMAL\_FONT},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = wxFONTP\_DEFAULT\_STYLE},\rtfsp
\param{long}{ style = wxFNTP\_DEFAULT\_STYLE},\rtfsp
\param{const wxValidator\& }{validator = wxDefaultValidator},
\param{const wxString\& }{name = ``fontpickerctrl"}}
@@ -97,7 +97,7 @@ all the parameters.
\docparam{size}{Initial size.}
\docparam{style}{The window style, see wxCRLP\_* flags.}
\docparam{style}{The window style, see {\tt wxFNTP\_*} flags.}
\docparam{validator}{Validator which can be used for additional date checks.}
@@ -138,7 +138,7 @@ Returns the maximum point size value allowed for the user-chosen font.
Sets the maximum point size value allowed for the user-chosen font.
The default value is 100. Note that big fonts can require a lot of memory and CPU time
both for creation and for rendering; thus, specially because the user has the option to specify
the fontsize through a text control (see wxFONTP\_USE\_TEXTCTRL), it's a good idea to put a limit
the fontsize through a text control (see wxFNTP\_USE\_TEXTCTRL), it's a good idea to put a limit
to the maximum font size when huge fonts do not make much sense.
@@ -159,7 +159,7 @@ This event class is used for the events generated by
\wxheading{Include files}
<wx/clrpicker.h>
<wx/fontpicker.h>
\wxheading{Event handling}