1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
'\" t
...\" CvtTxtPr.sgm /main/9 1996/09/08 20:37:52 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "XmCvtTextPropertyToXmStringTable" "library call"
.SH "NAME"
\fBXmCvtTextPropertyToXmStringTable\fP \(em A function that converts from a TextProperty Structure to a StringTable
.iX "XmCvtTextPropertyToXmStringTable"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
int XmCvtTextPropertyToXmStringTable (\fIdisplay, text_prop, string_table_return, count_return\fP)
Display *\fIdisplay\fP;
XTextProperty *\fItext_prop\fP;
XmStringTable *\fIstring_table_return\fP;
int *\fIcount_return\fP;
\fB\fR(\fBvoid\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBXmCvtTextPropertyToXmStringTable\fP converts the specified
\fBXTextProperty\fP structure into an \fBXmStringTable\fR, as follows:
.IP " \(bu" 6
If the encoding member of \fItext_prop\fP is the Atom \fBSTRING\fP, each
returned \fBXmString\fR
has a tag of "ISO8859-1" and a text type of \fBXmCHARSET_TEXT\fP\&.
.IP " \(bu" 6
If
the encoding member of \fItext_prop\fP is the encoding of the current locale,
and if that encoding is not \fBSTRING\fP, each returned \fBXmString\fR has a
tag of \fB_MOTIF_DEFAULT_LOCALE\fP and a text type of
\fBXmMULTIBYTE_TEXT\fP\&.
.IP " \(bu" 6
If
the encoding member of \fItext_prop\fP is other than \fBSTRING\fP or
the encoding of the current locale,
the contents of the returned compound strings are
implementation dependent\&.
.PP
If conversion depends on the
locale and the current locale is not supported, the function returns
\fBXLocaleNotSupported\fP\&. If conversion to the encoding of the current
locale is required and if the locale is supported but no converter is
available for the encoding specified in \fItext_prop\fP, the function
returns \fBXConverterNotFound\fP\&. For supported locales, existence of
a converter
from \fBCOMPOUND_TEXT\fP, \fBSTRING\fP, \fBUTF8_STRING\fP, or the encoding
of the current locale is
guaranteed if \fBXSupportsLocale\fP returns True for the current locale (but
the actual text may contain unconvertible characters)\&. Conversion of
other encodings to the encoding of the current locale is implementation
dependent\&. In all of these error cases, the function does not set any
return values\&.
.PP
If an element of the value member of \fItext_prop\fP is not
convertible to \fBXmString\fR, the corresponding entry in the returned
\fBXmStringTable\fR will be NULL, and
\fBXmCvtTextPropertyToXmStringTable\fP returns Success\&.
.PP
To free the storage for the \fBXmStringTable\fR and its
\fIcount_return\fP compound strings returned by this function, first
free each \fBXmString\fR in the table using \fBXmStringFree\fP, and
then free the \fBXmStringTable\fR itself using \fBXtFree\fP\&.
.IP "\fIdisplay\fP" 10
Specifies the connection to the X server\&.
.IP "\fItext_prop\fP" 10
Specifies a pointer to the \fBXTextProperty\fP\&.
The format member of \fItext_prop\fP must be 8\&.
.IP "\fIstring_table_return\fP" 10
Specifies the \fBXmStringTable\fR array into which the converted compound
strings are placed\&.
.IP "\fIcount_return\fP" 10
Specifies the number of \fBXmString\fRs returned by this function\&.
.SH "RETURN VALUES"
.PP
Upon success, this function returns the set of \fBXmString\fRs in
\fIstring_table_return\fP, and it returns the number of \fBXmString\fRs in
\fIcount_return\fP, and returns Success\&. Otherwise, it returns the
following:
.IP "\fBXLocaleNotSupported\fP" 10
Returned if conversion depends on the
locale and the current locale is not supported\&.
.IP "\fBXConverterNotFound\fP" 10
Returned if conversion to the encoding of the current
locale is required and if the locale is supported but no converter is
available for the encoding specified in \fItext_prop\fP\&.
.SH "RELATED INFORMATION"
.PP
\fBXmCvtXmStringTableToTextProperty\fP(3),
\fBXmText\fP(3), and
\fBXmTextGetString\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:21
|
