From 34c07b8b63651e46aabb7809c25d95dd40736687 Mon Sep 17 00:00:00 2001 From: Robert Roebling Date: Sun, 8 Oct 2006 15:49:36 +0000 Subject: [PATCH] [ 1573138 ] small docs corrections git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41725 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/clrpicker.tex | 2 +- docs/latex/wx/dirpicker.tex | 4 ++-- docs/latex/wx/filepicker.tex | 10 +++++----- docs/latex/wx/fontpicker.tex | 2 +- docs/latex/wx/xmlnode.tex | 2 ++ 5 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/latex/wx/clrpicker.tex b/docs/latex/wx/clrpicker.tex index a6d349e46d..017fca0e3e 100644 --- a/docs/latex/wx/clrpicker.tex +++ b/docs/latex/wx/clrpicker.tex @@ -32,7 +32,7 @@ It is only available if \texttt{wxUSE\_COLOURPICKERCTRL} is set to $1$ (the defa \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxCLRP\_DEFAULT}}{The default style: 0.} +\twocolitem{\windowstyle{wxCLRP\_DEFAULT\_STYLE}}{The default style: 0.} \twocolitem{\windowstyle{wxCLRP\_USE\_TEXTCTRL}}{Creates a text control to the left of the picker button which is completely managed by the \helpref{wxColourPickerCtrl}{wxcolourpickerctrl} and which can be used by the user to specify a colour (see \helpref{SetColour}{wxcolourpickerctrlsetcolour}). diff --git a/docs/latex/wx/dirpicker.tex b/docs/latex/wx/dirpicker.tex index 89364c49f2..67b3931ecf 100644 --- a/docs/latex/wx/dirpicker.tex +++ b/docs/latex/wx/dirpicker.tex @@ -119,14 +119,14 @@ all the parameters. \constfunc{wxString}{GetPath}{\void} -Returns the currently selected directory. +Returns the absolute path of the currently selected directory. \membersection{wxDirPickerCtrl::SetPath}\label{wxdirpickerctrlsetpath} \func{void}{SetPath}{\param{const wxString \&}{dirname}} -Sets the currently selected directory. his must be a valid directory if +Sets the absolute path of the currently selected directory. This 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 46b2a7db49..ffa3e99652 100644 --- a/docs/latex/wx/filepicker.tex +++ b/docs/latex/wx/filepicker.tex @@ -129,15 +129,15 @@ all the parameters. \constfunc{wxString}{GetPath}{\void} -Returns the currently selected file. +Returns the absolute path of the currently selected file. \membersection{wxFilePickerCtrl::SetPath}\label{wxfilepickerctrlsetpath} \func{void}{SetPath}{\param{const wxString \&}{filename}} -Sets the currently selected file. This must be a valid file if -{\tt wxFLP\_FILE\_MUST\_EXIST} style was given. +Sets the absolute path of the currently selected file. This must be a valid file if +the {\tt wxFLP\_FILE\_MUST\_EXIST} style was given. @@ -187,11 +187,11 @@ The constructor is not normally used by the user code. \constfunc{wxString}{GetPath}{\void} -Retrieve the file/directory the user has just selected. +Retrieve the absolute path of the file/directory the user has just selected. \membersection{wxFileDirPickerEvent::SetPath}\label{wxfiledirpickereventsetpath} \func{void}{SetPath}{\param{const wxString \&}{path}} -Set the file/directory associated with the event. +Set the absolute path of the file/directory associated with the event. diff --git a/docs/latex/wx/fontpicker.tex b/docs/latex/wx/fontpicker.tex index e3a46bbc0c..5d446d9cf8 100644 --- a/docs/latex/wx/fontpicker.tex +++ b/docs/latex/wx/fontpicker.tex @@ -32,7 +32,7 @@ It is only available if \texttt{wxUSE\_FONTPICKERCTRL} is set to $1$ (the defaul \twocolwidtha{5cm}% \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxFNTP\_DEFAULT}}{The default style: +\twocolitem{\windowstyle{wxFNTP\_DEFAULT\_STYLE}}{The default style: wxFNTP\_FONTDESC\_AS\_LABEL | wxFNTP\_USEFONT\_FOR\_LABEL.} \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} diff --git a/docs/latex/wx/xmlnode.tex b/docs/latex/wx/xmlnode.tex index 93e89ad363..2e00889722 100644 --- a/docs/latex/wx/xmlnode.tex +++ b/docs/latex/wx/xmlnode.tex @@ -246,6 +246,8 @@ documents must always produce the exact same tree regardless of the locale it ru Removes the given node from the children list. Returns \true if the node was found and removed or \false if the node could not be found. +Note that the caller is reponsible for deleting the removed node in order to avoid memory leaks. + \membersection{wxXmlNode::SetChildren}\label{wxxmlnodesetchildren} \func{void}{SetChildren}{\param{wxXmlNode* }{child}} -- 2.45.2