From aaa6f9ba6bd0be1fe6a34800e6f753ffdc49900c Mon Sep 17 00:00:00 2001
From: Robin Dunn <robin@alldunn.com>
Date: Thu, 8 Jun 2006 19:10:00 +0000
Subject: [PATCH] Applied Patch #1502804: wx*PickerCtrl documentation fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39639 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/clrpicker.tex  |  6 +++---
 docs/latex/wx/colour.tex     | 15 +++------------
 docs/latex/wx/dirpicker.tex  |  9 +++++----
 docs/latex/wx/filepicker.tex | 16 ++++++++--------
 docs/latex/wx/fontpicker.tex | 20 ++++++++++----------
 5 files changed, 29 insertions(+), 37 deletions(-)

diff --git a/docs/latex/wx/clrpicker.tex b/docs/latex/wx/clrpicker.tex
index cb95378b2e..cc4d6be23c 100644
--- a/docs/latex/wx/clrpicker.tex
+++ b/docs/latex/wx/clrpicker.tex
@@ -70,7 +70,7 @@ the user's input is valid, i.e. recognizable). }
 \param{const wxColour\& }{colour = *wxBLACK},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxCLRP\_DEFAULT\_STYLE},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``colourpickerctrl"}}
 
@@ -85,7 +85,7 @@ all the parameters.
 \param{const wxColour\& }{colour = *wxBLACK},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxCLRP\_DEFAULT\_STYLE},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``colourpickerctrl"}}
 
@@ -101,7 +101,7 @@ all the parameters.
 
 \docparam{size}{Initial size.}
 
-\docparam{style}{The window style, see wxCRLP\_* flags.}
+\docparam{style}{The window style, see {\tt wxCRLP\_*} flags.}
 
 \docparam{validator}{Validator which can be used for additional date checks.}
 
diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 00174d23da..15eb1f6526 100644
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -155,22 +155,13 @@ Returns the red intensity.
 
 \func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}
 
-Sets the RGB intensity values.
-
-
-\membersection{wxColour::Set}\label{wxcolourset2}
-
 \func{void}{Set}{\param{unsigned long}{ RGB}}
 
-Sets the RGB intensity values extracting them from the packed long.
-
-
-\membersection{wxColour::Set}\label{wxcolourset3}
-
 \func{bool}{Set}{\param{const wxString \&}{ str}}
 
-Sets the colour using the given string.
-Accepts colour names (those listed in \helpref{wxTheColourDatabase}{wxcolourdatabase}), the CSS-like \texttt{``RGB(r,g,b)"} syntax (case insensitive) and the HTML-like syntax (i.e. \texttt{``\#"} followed by 6 hexadecimal digits for red, green, blue components).
+Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overloard).
+
+When using third form, Set() accepts: colour names (those listed in \helpref{wxTheColourDatabase}{wxcolourdatabase}), the CSS-like \texttt{``RGB(r,g,b)"} syntax (case insensitive) and the HTML-like syntax (i.e. \texttt{``\#"} followed by 6 hexadecimal digits for red, green, blue components).
 
 Returns \true if the conversion was successful, \false otherwise.
 
diff --git a/docs/latex/wx/dirpicker.tex b/docs/latex/wx/dirpicker.tex
index 8c366d1918..f9bd32ffea 100644
--- a/docs/latex/wx/dirpicker.tex
+++ b/docs/latex/wx/dirpicker.tex
@@ -60,7 +60,7 @@ The text control is automatically synchronized with button's value. Use function
 
 \membersection{wxDirPickerCtrl::wxDirPickerCtrl}\label{wxdirpickerctrl}
 
-\func{}{wxdirpickerctrl}{\param{wxWindow *}{parent},\rtfsp
+\func{}{wxDirPickerCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
 \param{const wxString\& }{path = wxEmptyString},\rtfsp
 \param{const wxString\& }{message = ``Select a folder"},\rtfsp
@@ -94,13 +94,13 @@ all the parameters.
 
 \docparam{path}{The initial directory shown in the control. Must be a valid path to a directory or the empty string.}
 
-\docparam{message}{The message shown to the user in the \helpref{wxFileDialog}{wxfiledialog} shown by the control.}
+\docparam{message}{The message shown to the user in the \helpref{wxDirDialog}{wxdirdialog} shown by the control.}
 
 \docparam{pos}{Initial position.}
 
 \docparam{size}{Initial size.}
 
-\docparam{style}{The window style, see wxDIRP\_* flags.}
+\docparam{style}{The window style, see {\tt wxDIRP\_*} flags.}
 
 \docparam{validator}{Validator which can be used for additional date checks.}
 
@@ -122,6 +122,7 @@ Returns the currently selected directory.
 
 \func{void}{SetPath}{\param{const wxString \&}{dirname}}
 
-Sets the currently selected directory. This must be a valid directory.
+Sets the currently selected directory. his must be a valid directory if
+{\tt wxDIRP\_DIR\_MUST\_EXIST} style was given.
 
 
diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex
index 855a22d6b2..f21c9e5687 100644
--- a/docs/latex/wx/filepicker.tex
+++ b/docs/latex/wx/filepicker.tex
@@ -53,8 +53,8 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported!
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_FILEPICKER\_CHANGED(id, func)}}{The user changed the file
 selected in the control either using the button or using text control (see
-wxFILEP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
-user's input is valid, e.g. an existing file path if wxFILEP\_FILE\_MUST\_EXIST
+wxFLP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
+user's input is valid, e.g. an existing file path if wxFLP\_FILE\_MUST\_EXIST
 was given).}
 \end{twocollist}
 
@@ -68,14 +68,14 @@ was given).}
 
 \membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrl}
 
-\func{}{wxfilepickerctrl}{\param{wxWindow *}{parent},\rtfsp
+\func{}{wxFilePickerCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
 \param{const wxString\& }{path = wxEmptyString},\rtfsp
 \param{const wxString\& }{message = ``Select a file"},\rtfsp
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxFILEP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxFLP\_DEFAULT\_STYLE},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 
@@ -92,7 +92,7 @@ all the parameters.
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{long}{ style = wxFILEP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxFLP\_DEFAULT\_STYLE},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 
@@ -106,13 +106,13 @@ all the parameters.
 
 \docparam{message}{The message shown to the user in the \helpref{wxFileDialog}{wxfiledialog} shown by the control.}
 
-\docparam{wildcard}{A wildcard which defines user-selectable files (use the same syntax as for \helpref{wxFileDialog}{wxfiledialog}'s wildcards.}
+\docparam{wildcard}{A wildcard which defines user-selectable files (use the same syntax as for \helpref{wxFileDialog}{wxfiledialog}'s wildcards).}
 
 \docparam{pos}{Initial position.}
 
 \docparam{size}{Initial size.}
 
-\docparam{style}{The window style, see wxFILEP\_* flags.}
+\docparam{style}{The window style, see {\tt wxFLP\_*} flags.}
 
 \docparam{validator}{Validator which can be used for additional date checks.}
 
@@ -135,7 +135,7 @@ Returns the currently selected file.
 \func{void}{SetPath}{\param{const wxString \&}{filename}}
 
 Sets the currently selected file. This must be a valid file if
-wxFILEP\_FILE\_MUST\_EXIST style was given.
+{\tt wxFLP\_FILE\_MUST\_EXIST} style was given.
 
 
 
diff --git a/docs/latex/wx/fontpicker.tex b/docs/latex/wx/fontpicker.tex
index 4e66d8e2b6..10f7f31c93 100644
--- a/docs/latex/wx/fontpicker.tex
+++ b/docs/latex/wx/fontpicker.tex
@@ -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}
 
-- 
2.50.0

