1XmCvtTextPropertyToXmStringTable(XlmiCbvrtaTreyxtcParlolp)ertyToXmStringTable(library call)
2
3
4

NAME

6       XmCvtTextPropertyToXmStringTable  —  A  function  that  converts from a
7       TextProperty Structure to a StringTable
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       int XmCvtTextPropertyToXmStringTable (display, text_prop, string_table_return, count_return)
12               Display *display;
13               XTextProperty   *text_prop;
14               XmStringTable   *string_table_return;
15               int     *count_return;
16       (void)
17

DESCRIPTION

19       XmCvtTextPropertyToXmStringTable converts the  specified  XTextProperty
20       structure into an XmStringTable, as follows:
21
22          ·  If  the  encoding  member  of  text_prop is the Atom STRING, each
23             returned XmString has a tag of "ISO8859-1" and  a  text  type  of
24             XmCHARSET_TEXT.
25
26          ·  If  the  encoding member of text_prop is the encoding of the cur‐
27             rent locale, and if that encoding is not  STRING,  each  returned
28             XmString  has  a  tag of _MOTIF_DEFAULT_LOCALE and a text type of
29             XmMULTIBYTE_TEXT.
30
31          ·  If the encoding member of text_prop is other than STRING  or  the
32             encoding of the current locale, the contents of the returned com‐
33             pound strings are implementation dependent.
34
35       If conversion depends on the locale and the current locale is not  sup‐
36       ported,  the function returns XLocaleNotSupported. If conversion to the
37       encoding of the current locale is required and if the  locale  is  sup‐
38       ported  but  no  converter  is  available for the encoding specified in
39       text_prop,  the  function  returns  XConverterNotFound.  For  supported
40       locales,   existence   of   a  converter  from  COMPOUND_TEXT,  STRING,
41       UTF8_STRING, or the encoding of the current  locale  is  guaranteed  if
42       XSupportsLocale  returns  True  for  the current locale (but the actual
43       text may contain unconvertible characters). Conversion of other  encod‐
44       ings to the encoding of the current locale is implementation dependent.
45       In all of these error cases, the function does not set any return  val‐
46       ues.
47
48       If  an  element  of the value member of text_prop is not convertible to
49       XmString, the corresponding entry in the returned XmStringTable will be
50       NULL, and XmCvtTextPropertyToXmStringTable returns Success.
51
52       To free the storage for the XmStringTable and its count_return compound
53       strings returned by this function, first free each XmString in the  ta‐
54       ble  using  XmStringFree,  and then free the XmStringTable itself using
55       XtFree.
56
57       display   Specifies the connection to the X server.
58
59       text_prop Specifies a pointer to the XTextProperty.  The format  member
60                 of text_prop must be 8.
61
62       string_table_return
63                 Specifies  the  XmStringTable  array into which the converted
64                 compound strings are placed.
65
66       count_return
67                 Specifies the number of XmStrings returned by this function.
68

RETURN VALUES

70       Upon success, this function returns the set of XmStrings in  string_ta‐
71       ble_return, and it returns the number of XmStrings in count_return, and
72       returns Success. Otherwise, it returns the following:
73
74       XLocaleNotSupported
75                 Returned if conversion depends on the locale and the  current
76                 locale is not supported.
77
78       XConverterNotFound
79                 Returned  if conversion to the encoding of the current locale
80                 is required and if the locale is supported but  no  converter
81                 is available for the encoding specified in text_prop.
82

84       XmCvtXmStringTableToTextProperty(3), XmText(3), and XmTextGetString(3).
85
86
87
88                                XmCvtTextPropertyToXmStringTable(library call)
Impressum