File: XmStringUnparse.3

package info (click to toggle)
motif 2.3.4-13
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 81,160 kB
  • ctags: 51,769
  • sloc: ansic: 596,938; cpp: 3,951; yacc: 2,854; makefile: 2,070; csh: 1,199; sh: 1,070; lex: 455
file content (133 lines) | stat: -rw-r--r-- 4,098 bytes parent folder | download | duplicates (9)
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
'\" t
...\" StrUnp.sgm /main/8 1996/09/08 21:07:59 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 "XmStringUnparse" "library call"
.SH "NAME"
\fBXmStringUnparse\fP \(em A compound string function that unparses text
.iX "XmStringUnparse"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBXtPointer \fBXmStringUnparse\fP\fR(
\fBXmString \fBstring\fR\fR,
\fBXmStringTag \fBtag\fR\fR,
\fBXmTextType \fBtag_type\fR\fR,
\fBXmTextType \fBoutput_type\fR\fR,
\fBXmParseTable \fBparse_table\fR\fR,
\fBCardinal \fBparse_count\fR\fR,
\fBXmParseModel \fBparse_model\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmStringUnparse\fP looks in the input \fIstring\fP for text
segments that are
tagged with locale or charset tags that match \fItag\fP\&. The
\fItag_type\fP
parameter specifies whether the tag is a locale or charset type\&.
If \fItag\fP has a value of NULL, all the segments are matched\&. When
a text segment is found with a matching tag, it is added to the end of
a resulting string\&. The characters in the
resulting string are of type \fIoutput_type\fP\&.
.PP
\fBXmStringUnparse\fP also checks \fIstring\fP for components that
match components in \fIparse_table\fP, and also to see if the
component matches the condition specified by \fIparse_model\fP\&. If
the string component matches in both checks, then the associated
character is added to the end of the resulting string\&.
.IP "\fIstring\fP" 10
Specifies the \fBXmString\fR to be converted\&.
.IP "\fItag\fP" 10
Specifies the tag to be used in matching with text segments\&. Only text
segments that match \fItag\fP will be included in the resulting
string\&. If \fItag\fP has a value of NULL, all segments are considered
as
matches, and \fItag_type\fP is ignored\&.
.IP "\fItag_type\fP" 10
Specifies the type of tag to be searched for, including
\fBXmMULTIBYTE_TEXT\fP, \fBXmWIDECHAR_TEXT\fP, and
\fBXmCHARSET_TEXT\fP\&.
.IP "\fIoutput_type\fP" 10
Specifies the type of text to be returned in the string, including
\fBXmMULTIBYTE_TEXT\fP, \fBXmWIDECHAR_TEXT\fP, and
\fBXmCHARSET_TEXT\fP\&.
.IP "\fIparse_table\fP" 10
Specifies the parse table to be used in scanning for compound string
components to be
converted to other characters\&.
.IP "\fIparse_count\fP" 10
Specifies how many entries are in \fIparse_table\fP\&.
.IP "\fIparse_model\fP" 10
Specifies which non-text components to be considered in matching in
\fIparse_table\fP\&. These include:
.RS
.IP "\fBXmOUTPUT_ALL\fP" 10
Puts out all matching components\&.
.IP "\fBXmOUTPUT_BETWEEN\fP" 10
Puts out only those matching components that are between two matching
text components\&.
.IP "\fBXmOUTPUT_BEGINNING\fP" 10
Puts out only those matching components that are at the beginning of a
matching text component\&.
.IP "\fBXmOUTPUT_END\fP" 10
Puts out only those matching components that are at the end of a
matching text component\&.
.IP "\fBXmOUTPUT_BOTH\fP" 10
Puts out only those matching components that are at the beginning or end
of a matching text component\&.
.RE
.SH "RETURN"
.PP
Returns a newly allocated string containing characters of a type
determined by \fIoutput_type\fP\&.
The application is responsible for managing this allocated space\&.
The application can recover this allocated space by calling \fBXtFree\fP\&.
.SH "RELATED"
.PP
\fBXmString\fP(3), \fBXmParseTable\fP(3), \fBXmParseMapping\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:32