]> git.saurik.com Git - wxWidgets.git/commitdiff
fixed wxEncodingConverter::Convert docs
authorVáclav Slavík <vslavik@fastmail.fm>
Sat, 6 Apr 2002 19:07:40 +0000 (19:07 +0000)
committerVáclav Slavík <vslavik@fastmail.fm>
Sat, 6 Apr 2002 19:07:40 +0000 (19:07 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@14971 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/encconv.tex

index 2bacaf41531da66ce949b1aed6c1d1e4723c6ee2..bbb4c149e941e256fdbaf1ccd69dbf38ecd3e269 100644 (file)
@@ -68,16 +68,35 @@ or output encoding is not supported.)
 
 \membersection{wxEncodingConverter::Convert}\label{wxencodingconverterconvert}
 
+\func{void}{Convert}{\param{const char* }{input}, \param{char* }{output}}
+
+\func{void}{Convert}{\param{const wchar\_t* }{input}, \param{wchar\_t* }{output}}
+
+\func{void}{Convert}{\param{const char* }{input}, \param{wchar\_t* }{output}}
+
+\func{void}{Convert}{\param{const wchar\_t* }{input}, \param{char* }{output}}
+
+Convert input string according to settings passed to
+\helpref{Init}{wxencodingconverterinit} and writes the result to {\it output}.
+
+\func{void}{Convert}{\param{char* }{str}}
+
+\func{void}{Convert}{\param{wchar\_t* }{str}}
+
+Convert input string according to settings passed to
+\helpref{Init}{wxencodingconverterinit} in-place, i.e. write the result to the
+same memory area.
+
 \func{wxString}{Convert}{\param{const wxString\& }{input}}
 
-\func{void}{Convert}{\param{const wxChar* }{input}, \param{wxChar* }{output}}
+Convert wxString and return new wxString object.
 
-\func{void}{Convert}{\param{wxChar* }{str}}
+\wxheading{Notes}
 
-\func{void}{Convert}{\param{const char* }{input}, \param{wxChar* }{output}}
+You must call \helpref{Init}{wxencodingconverterinit} before using this method!
 
-Convert input string according to settings passed to \helpref{Init}{wxencodingconverterinit}.
-Note that you must call Init before using Convert!
+{\tt wchar\_t} versions of the method are not available if wxWindows was compiled
+with {\tt wxUSE\_WCHAR\_T} set to 0.
 
 \membersection{wxEncodingConverter::GetPlatformEquivalents}\label{wxencodingconvertergetplatformequivalents}