XmCvtXmStringToCT(library call) XmCvtXmStringToCT(library call)

NAME

XmCvtXmStringToCT -- A compound string function that converts a
compound string to compound text

SYNOPSIS

#include <Xm/Xm.h>
char * XmCvtXmStringToCT(
XmString string);

DESCRIPTION

XmCvtXmStringToCT converts a compound string to a (char *) string in
compound text format. The application must call XtAppInitialize
before calling this function. The converter uses the font list tag
associated with a given compound string segment to select a compound
text format for that segment. A registry defines a mapping between
font list tags and compound text encoding formats. The converter
uses the following algorithm for each compound string segment:

1. If the compound string segment tag is mapped to
XmFONTLIST_DEFAULT_TAG in the registry, the converter passes
the text of the compound string segment to
XmbTextListToTextProperty with an encoding style of
XCompoundTextStyle and uses the resulting compound text for
that segment.

2. If the compound string segment tag is mapped to an MIT
registered charset in the registry, the converter creates the
compound text for that segment using the charset (from the
registry) and the text of the compound string segment as
defined in the X Consortium Standard Compound Text Encoding.

3. If the compound string segment tag is mapped to a charset in
the registry that is neither XmFONTLIST_DEFAULT_TAG nor an MIT
registered charset, the converter creates the compound text for
that segment using the charset (from the registry) and the text
of the compound string segment as an "extended segment" with a
variable number of octets per character.

4. If the compound string segment tag is not mapped in the
registry, the result is implementation dependent.

string Specifies a compound string to be converted to compound
text.

RETURN

Returns a (char *) string in compound text format. This format is
described in the X Consortium Standard Compound Text Encoding. The
function allocates space to hold the returned string. The
application is responsible for managing the allocated space. The
application can recover the allocated space by calling XtFree.

RELATED

XmCvtCTToXmString(3), XmFontList(3), XmMapSegmentEncoding(3),
XmRegisterSegmentEncoding(3), and XmString.

XmCvtXmStringToCT(library call)