XmCvtXmStringToCT(3X)

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

SYNOPSIS
     #include <Xm/Xm.h>

     char * XmCvtXmStringToCT (string)
          XmString    string;


VERSION
     This page documents version 1.2 of the Motif library.

DESCRIPTION
     XmCvtXmStringToCT converts a compound string to a (char *) string  in  com-
     pound  text format.  The application must call XtAppInitialize before call-
     ing 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  XCom-
          poundTextStyle 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 Com-
          pound Text Encoding.

      3.  If the compound string segment tag is mapped to a charset in the  reg-
          istry  that  is  neither  XmFONTLIST_DEFAULT_TAG nor an MIT registered
          charset, the converter creates the compound text for that segment  us-
          ing  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 VALUE
     Returns a (char *) string in compound text  format.   This  format  is  de-
     scribed in the X Consortium Standard Compound Text Encoding.

RELATED INFORMATION
     XmCvtCTToXmString(3X), XmFontList(3X), XmMapSegmentEncoding(3X), XmRegis-
     terSegmentEncoding(3X), and XmString.

                                                           XmCvtXmStringToCT(3X)