1XmStringUnparse(library call)                    XmStringUnparse(library call)
2
3
4

NAME

6       XmStringUnparse — A compound string function that unparses text
7

SYNOPSIS

9       #include <Xm/Xm.h>
10       XtPointer XmStringUnparse(
11       XmString string,
12       XmStringTag tag,
13       XmTextType tag_type,
14       XmTextType output_type,
15       XmParseTable parse_table,
16       Cardinal parse_count,
17       XmParseModel parse_model);
18

DESCRIPTION

20       XmStringUnparse  looks  in  the input string for text segments that are
21       tagged with locale or charset tags that match tag. The tag_type parame‐
22       ter  specifies whether the tag is a locale or charset type.  If tag has
23       a value of NULL, all the segments are matched. When a text  segment  is
24       found  with  a  matching  tag,  it  is  added to the end of a resulting
25       string. The characters in the resulting string are of type output_type.
26
27       XmStringUnparse also checks string for components that match components
28       in  parse_table, and also to see if the component matches the condition
29       specified by parse_model. If  the  string  component  matches  in  both
30       checks,  then  the  associated  character  is  added  to the end of the
31       resulting string.
32
33       string    Specifies the XmString to be converted.
34
35       tag       Specifies the tag to be used in matching with text  segments.
36                 Only  text  segments  that  match tag will be included in the
37                 resulting string. If tag has a value of  NULL,  all  segments
38                 are considered as matches, and tag_type is ignored.
39
40       tag_type  Specifies  the  type  of  tag  to  be searched for, including
41                 XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and XmCHARSET_TEXT.
42
43       output_type
44                 Specifies the type of text to  be  returned  in  the  string,
45                 including      XmMULTIBYTE_TEXT,     XmWIDECHAR_TEXT,     and
46                 XmCHARSET_TEXT.
47
48       parse_table
49                 Specifies the parse table to be used in scanning for compound
50                 string components to be converted to other characters.
51
52       parse_count
53                 Specifies how many entries are in parse_table.
54
55       parse_model
56                 Specifies  which  non-text  components  to  be  considered in
57                 matching in parse_table. These include:
58
59                 XmOUTPUT_ALL
60                           Puts out all matching components.
61
62                 XmOUTPUT_BETWEEN
63                           Puts out only those matching  components  that  are
64                           between two matching text components.
65
66                 XmOUTPUT_BEGINNING
67                           Puts out only those matching components that are at
68                           the beginning of a matching text component.
69
70                 XmOUTPUT_END
71                           Puts out only those matching components that are at
72                           the end of a matching text component.
73
74                 XmOUTPUT_BOTH
75                           Puts out only those matching components that are at
76                           the beginning or end of a matching text component.
77

RETURN

79       Returns a newly allocated string containing characters of a type deter‐
80       mined by output_type.  The application is responsible for managing this
81       allocated space.  The application can recover this allocated  space  by
82       calling XtFree.
83

85       XmString(3), XmParseTable(3), XmParseMapping(3).
86
87
88
89                                                 XmStringUnparse(library call)
Impressum