--- /dev/null
+/////////////////////////////////////////////////////////////////////////////
+// Name: class_conv.h
+// Purpose: Conversion classes group docs
+// Author: wxWidgets team
+// RCS-ID: $Id$
+// Licence: wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+
+@defgroup group_class_conv Text Conversion
+@ingroup group_class
+
+These are the classes used for conversions between different text encodings.
+
+*/
+
@li @ref page_class_cat_logging
@li @ref page_class_cat_threading
@li @ref page_class_cat_data
+@li @ref page_class_cat_conv
@li @ref page_class_cat_containers
@li @ref page_class_cat_smartpointers
@li @ref page_class_cat_file
+@section page_class_cat_conv Text Conversion
+
+These classes define objects for performing conversions between different
+multibyte and Unicode encodings and wide character strings.
+
+@li wxMBConv: Base class for all convertors, defines the API implemented by all
+ the other convertor classes.
+@li wxMBConvUTF7: Convertor for UTF-7
+@li wxMBConvUTF8: Convertor for UTF-8
+@li wxMBConvUTF16: Convertor for UTF-16
+@li wxMBConvUTF32: Convertor for UTF-32
+@li wxCSConv: Convertor for any system-supported encoding which can be
+ specified by name.
+
+Related Overviews: @ref overview_mbconv
+
+
@section page_class_cat_containers Containers
These are classes, templates and class macros are used by wxWidgets. Most of
This class converts between the UTF-7 encoding and Unicode.
It has one predefined instance, @b wxConvUTF7.
- @b WARNING: this class is not implemented yet.
-
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxMBConvUTF8, @ref overview_mbconv "wxMBConv classes overview"
*/
It has one predefined instance, @b wxConvUTF8.
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxMBConvUTF7, @ref overview_mbconv "wxMBConv classes overview"
*/
under Mac).
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconv "wxMBConv classes overview"
*/
default user character set.
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxMBConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv classes overview"
*/
is used as fall back.
*/
wxCSConv(const wxChar* charset);
-
+
/**
- Constructor. You can specify an encoding constant for the
+ Constructor. You can specify an encoding constant for the
character set you want to convert from/to or. If the encoding
is not recognized, ISO 8859-1 is used as fall back.
*/
(although it would be better to use wxFopen(name, wxT("r")) in this case.)
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see @ref overview_mbconv "wxMBConv classes overview"
*/
under Mac).
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconv "wxMBConv classes overview"
*/
under Windows) or 4 (Unix).
@library{wxbase}
- @category{FIXME}
+ @category{conv}
@see wxCSConv, wxEncodingConverter, @ref overview_mbconv "wxMBConv classes overview"
*/