diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 0890616f79..b16e1efa25 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -40,6 +40,7 @@ \input countstr.tex \input critsect.tex \input crtslock.tex +\input csconv.tex \input custdobj.tex \input cursor.tex \input database.tex @@ -147,6 +148,10 @@ \input log.tex \input longlong.tex \input mask.tex +\input mbconv.tex +\input mbcnvfil.tex +\input mbcnvut7.tex +\input mbcnvut8.tex \input mdi.tex \input memorydc.tex \input fs_mem.tex diff --git a/docs/latex/wx/csconv.tex b/docs/latex/wx/csconv.tex new file mode 100644 index 0000000000..31100d93ed --- /dev/null +++ b/docs/latex/wx/csconv.tex @@ -0,0 +1,60 @@ +% +% automatically generated by HelpGen from +% ../include/wx/strconv.h at 25/Mar/00 10:20:56 +% + + +\section{\class{wxCSConv}}\label{wxcsconv} + +This class converts between any character sets and Unicode. +It has one predefined instance, {\bf wxConvLocal}, for the +default user character set. + +\wxheading{Derived from} + +\helpref{wxMBConv}{wxmbconv} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxMBConv}{wxmbconv}, +\helpref{wxEncodingConverter}{wxencodingconverter} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxCSConv::wxCSConv}\label{wxcsconvwxcsconv} + +\func{}{wxCSConv}{\param{const wxChar* }{charset}} + +Constructor. Specify the name of the character set you want to convert +from/to. + +\membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor} + +\func{}{\destruct{wxCSConv}}{\void} + +Destructor. + +\membersection{wxCSConv::LoadNow}\label{wxcsconvloadnow} + +\func{void}{LoadNow}{\void} + +If the conversion tables needs to be loaded from disk, this method +will do so. Otherwise, they will be loaded when any of the conversion +methods are called. + +\membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc} + +\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}} + +Converts from the selected character set to Unicode. Returns the size of the destination buffer. + +\membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb} + +\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}} + +Converts from Unicode to the selected character set. Returns the size of the destination buffer. diff --git a/docs/latex/wx/mbcnvfil.tex b/docs/latex/wx/mbcnvfil.tex new file mode 100644 index 0000000000..b7fdbf5561 --- /dev/null +++ b/docs/latex/wx/mbcnvfil.tex @@ -0,0 +1,45 @@ +% +% automatically generated by HelpGen from +% ../include/wx/strconv.h at 25/Mar/00 10:20:56 +% + + +\section{\class{wxMBConvFile}}\label{wxmbconvfile} + +This class converts file names between filesystem multibyte encoding and +Unicode. It has one predefined instance, {\bf wxConvFile}. +Since some platforms (e.g. Win32) use Unicode in the filenames, +and others (e.g. Unix) use multibyte encodings, this class should only +be used directly if wxMBFILES is defined to 1. A convenience macro, +wxFNCONV, is defined to wxConvFile.cWX2MB in this case. You could use it +like this: + +\begin{verbatim} +wxChar *name = wxT("rawfile.doc"); +FILE *fil = fopen(wxFNCONV(name), "r"); +\end{verbatim} + +(although it would be better to use wxFopen(name, wxT("r")) in this case.) + +\wxheading{Derived from} + +\helpref{wxMBConv}{wxmbconv} + +\wxheading{Include files} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMBConvFile::MB2WC}\label{wxmbconvfilemb2wc} + +\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}} + +Converts from multibyte filename encoding to Unicode. Returns the size of the destination buffer. + +\membersection{wxMBConvFile::WC2MB}\label{wxmbconvfilewc2mb} + +\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}} + +Converts from Unicode to multibyte filename encoding. Returns the size of the destination buffer. diff --git a/docs/latex/wx/mbcnvut7.tex b/docs/latex/wx/mbcnvut7.tex new file mode 100644 index 0000000000..35188e2b0f --- /dev/null +++ b/docs/latex/wx/mbcnvut7.tex @@ -0,0 +1,38 @@ +% +% automatically generated by HelpGen from +% ../include/wx/strconv.h at 25/Mar/00 10:20:56 +% + + +\section{\class{wxMBConvUTF7}}\label{wxmbconvutf7} + +This class converts between the UTF-7 encoding and Unicode. +It has one predefined instance, {\bf wxConvUTF7}. +Unfortunately, this class is not quite implemented yet. + +\wxheading{Derived from} + +\helpref{wxMBConv}{wxmbconv} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxMBConvUTF8}{wxmbconvutf8} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMBConvUTF7::MB2WC}\label{wxmbconvutf7mb2wc} + +\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}} + +Converts from UTF-7 encoding to Unicode. Returns the size of the destination buffer. + +\membersection{wxMBConvUTF7::WC2MB}\label{wxmbconvutf7wc2mb} + +\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}} + +Converts from Unicode to UTF-7 encoding. Returns the size of the destination buffer. diff --git a/docs/latex/wx/mbcnvut8.tex b/docs/latex/wx/mbcnvut8.tex new file mode 100644 index 0000000000..4595a5225c --- /dev/null +++ b/docs/latex/wx/mbcnvut8.tex @@ -0,0 +1,37 @@ +% +% automatically generated by HelpGen from +% ../include/wx/strconv.h at 25/Mar/00 10:20:56 +% + + +\section{\class{wxMBConvUTF8}}\label{wxmbconvutf8} + +This class converts between the UTF-8 encoding and Unicode. +It has one predefined instance, {\bf wxConvUTF8}. + +\wxheading{Derived from} + +\helpref{wxMBConv}{wxmbconv} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxMBConvUTF7}{wxmbconvutf7} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMBConvUTF8::MB2WC}\label{wxmbconvutf8mb2wc} + +\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}} + +Converts from UTF-8 encoding to Unicode. Returns the size of the destination buffer. + +\membersection{wxMBConvUTF8::WC2MB}\label{wxmbconvutf8wc2mb} + +\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}} + +Converts from Unicode to UTF-8 encoding. Returns the size of the destination buffer. diff --git a/docs/latex/wx/mbconv.tex b/docs/latex/wx/mbconv.tex new file mode 100644 index 0000000000..67aa270a22 --- /dev/null +++ b/docs/latex/wx/mbconv.tex @@ -0,0 +1,104 @@ +% +% automatically generated by HelpGen from +% ../include/wx/strconv.h at 25/Mar/00 10:20:56 +% + + +\section{\class{wxMBConv}}\label{wxmbconv} + +This class is the base class of a hierarchy of classes capable of converting +text strings between multibyte (SBCS or DBCS) encodings and Unicode. It is itself +a wrapper around the standard libc mbstowcs() and wcstombs() routines, and has +one predefined instance, {\bf wxConvLibc}. + +\wxheading{Derived from} + +No base class + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxCSConv}{wxcsconv}, +\helpref{wxEncodingConverter}{wxencodingconverter} + +\latexignore{\rtfignore{\wxheading{Members}}} + + +\membersection{wxMBConv::wxMBConv}\label{wxmbconvwxmbconv} + +\func{}{wxMBConv}{\void} + +Constructor. + +\membersection{wxMBConv::MB2WC}\label{wxmbconvmb2wc} + +\constfunc{virtual size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}} + +Converts from multibyte encoding to Unicode, using the libc routine mbstowcs() +(this is overridden by derived classes). Returns the size of the destination buffer. + +\membersection{wxMBConv::WC2MB}\label{wxmbconvwc2mb} + +\constfunc{virtual size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}} + +Converts from Unicode to multibyte encoding, using the libc routine wcstombs() +(this is overridden by derived classes). Returns the size of the destination buffer. + +\membersection{wxMBConv::cMB2WC}\label{wxmbconvcmb2wc} + +\constfunc{const wxWCharBuffer}{cMB2WC}{\param{const char* }{psz}} + +Converts from multibyte encoding to Unicode by calling MB2WC, +allocating a temporary wxWCharBuffer to hold the result. + +\membersection{wxMBConv::cWC2MB}\label{wxmbconvcwc2mb} + +\constfunc{const wxCharBuffer}{cWC2MB}{\param{const wchar\_t* }{psz}} + +Converts from Unicode to multibyte encoding by calling WC2MB, +allocating a temporary wxCharBuffer to hold the result. + +\membersection{wxMBConv::cMB2WX}\label{wxmbconvcmb2wx} + +\constfunc{const char*}{cMB2WX}{\param{const char* }{psz}} + +\constfunc{const wxWCharBuffer}{cMB2WX}{\param{const char* }{psz}} + +Converts from multibyte encoding to the current wxChar type +(which depends on whether wxUSE\_UNICODE is set to 1). If wxChar is char, +it returns the parameter unaltered. If wxChar is wchar\_t, it returns the +result in a wxWCharBuffer. + +\membersection{wxMBConv::cWX2MB}\label{wxmbconvcwx2mb} + +\constfunc{const char*}{cWX2MB}{\param{const wxChar* }{psz}} + +\constfunc{const wxCharBuffer}{cWX2MB}{\param{const wxChar* }{psz}} + +Converts from the current wxChar type to multibyte encoding. If wxChar is char, +it returns the parameter unaltered. If wxChar is wchar\_t, it returns the +result in a wxCharBuffer. + +\membersection{wxMBConv::cWC2WX}\label{wxmbconvcwc2wx} + +\constfunc{const wchar\_t*}{cWC2WX}{\param{const wchar\_t* }{psz}} + +\constfunc{const wxCharBuffer}{cWC2WX}{\param{const wchar\_t* }{psz}} + +Converts from Unicode to the current wxChar type. If wxChar is wchar\_t, +it returns the parameter unaltered. If wxChar is char, it returns the +result in a wxCharBuffer. + +\membersection{wxMBConv::cWX2WC}\label{wxmbconvcwx2wc} + +\constfunc{const wchar\_t*}{cWX2WC}{\param{const wxChar* }{psz}} + +\constfunc{const wxWCharBuffer}{cWX2WC}{\param{const wxChar* }{psz}} + +Converts from the current wxChar type to Unicode. If wxChar is wchar\_t, +it returns the parameter unaltered. If wxChar is char, it returns the +result in a wxWCharBuffer. +