summaryrefslogtreecommitdiff
path: root/lib/libX11/man/XmbTextListToTextProperty.man
diff options
context:
space:
mode:
authorMatthieu Herrb <matthieu@cvs.openbsd.org>2020-01-04 17:55:18 +0000
committerMatthieu Herrb <matthieu@cvs.openbsd.org>2020-01-04 17:55:18 +0000
commit1128148d76d7952d7aacfa2b083f5b5a96b4b4d5 (patch)
tree9291b9dfdfb4da1828705353be85e340f302e651 /lib/libX11/man/XmbTextListToTextProperty.man
parent7b7fd95cb6ee85ebe6d6d08b126b770770e86688 (diff)
Uppdate to libX11 1.6.9. Tested by krw@ and naddy@
Diffstat (limited to 'lib/libX11/man/XmbTextListToTextProperty.man')
-rw-r--r--lib/libX11/man/XmbTextListToTextProperty.man266
1 files changed, 118 insertions, 148 deletions
diff --git a/lib/libX11/man/XmbTextListToTextProperty.man b/lib/libX11/man/XmbTextListToTextProperty.man
index b937761ee..e97636597 100644
--- a/lib/libX11/man/XmbTextListToTextProperty.man
+++ b/lib/libX11/man/XmbTextListToTextProperty.man
@@ -40,46 +40,13 @@
.\" to this documentation without specific, written prior permission.
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
-.\" It is provided ``as is'' without express or implied warranty.
+.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
-.na
-.de Ds
-.nf
-.\\$1D \\$2 \\$1
-.ft CW
-.\".ps \\n(PS
-.\".if \\n(VS>=40 .vs \\n(VSu
-.\".if \\n(VS<=39 .vs \\n(VSp
-..
-.de De
-.ce 0
-.if \\n(BD .DF
-.nr BD 0
-.in \\n(OIu
-.if \\n(TM .ls 2
-.sp \\n(DDu
-.fi
-..
-.de IN \" send an index entry to the stderr
-..
-.de Pn
-.ie t \\$1\fB\^\\$2\^\fR\\$3
-.el \\$1\fI\^\\$2\^\fP\\$3
-..
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.de hN
-.ie t <\fB\\$1\fR>\\$2
-.el <\fI\\$1\fP>\\$2
-..
-.ny0
'\" t
.TH XmbTextListToTextProperty __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
@@ -88,27 +55,27 @@ XmbTextListToTextProperty, XwcTextListToTextProperty, Xutf8TextListToTextPropert
.HP
int XmbTextListToTextProperty\^(\^Display *\fIdisplay\fP\^, char
**\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^,
-XTextProperty *\fItext_prop_return\fP\^);
+XTextProperty *\fItext_prop_return\fP\^);
.HP
int XwcTextListToTextProperty\^(\^Display *\fIdisplay\fP\^, wchar_t
**\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^,
-XTextProperty *\fItext_prop_return\fP\^);
+XTextProperty *\fItext_prop_return\fP\^);
.HP
int Xutf8TextListToTextProperty\^(\^Display *\fIdisplay\fP\^, char
**\fIlist\fP\^, int \fIcount\fP\^, XICCEncodingStyle \fIstyle\fP\^,
-XTextProperty *\fItext_prop_return\fP\^);
+XTextProperty *\fItext_prop_return\fP\^);
.HP
int XmbTextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty
-*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^);
+*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^);
.HP
int XwcTextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty
*\fItext_prop\fP\^, wchar_t ***\fIlist_return\fP\^, int
-*\fIcount_return\fP\^);
+*\fIcount_return\fP\^);
.HP
int Xutf8TextPropertyToTextList\^(\^Display *\fIdisplay\fP\^, XTextProperty
-*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^);
+*\fItext_prop\fP\^, char ***\fIlist_return\fP\^, int *\fIcount_return\fP\^);
.HP
-void XwcFreeStringList\^(\^wchar_t **\fIlist\fP\^);
+void XwcFreeStringList\^(\^wchar_t **\fIlist\fP\^);
.HP
char *XDefaultString\^(void)
.SH ARGUMENTS
@@ -122,109 +89,111 @@ Specifies the number of strings specified.
Specifies the manner in which the property is encoded.
.IP \fItext_prop_return\fP 1i
Returns the
-.ZN XTextProperty
+.B XTextProperty
structure.
.IP \fItext_prop\fP 1i
Specifies the
-.ZN XTextProperty
+.B XTextProperty
structure to be used.
.IP \fIlist_return\fP 1i
Returns a list of null-terminated character strings.
-.ds Cn strings
.IP \fIcount_return\fP 1i
-Returns the number of \*(Cn.
+Returns the number of strings.
.IP \fIlist\fP 1i
Specifies the list of strings to be freed.
.SH DESCRIPTION
The
-.ZN XmbTextListToTextProperty ,
-.ZN XwcTextListToTextProperty
+.BR XmbTextListToTextProperty ,
+.B XwcTextListToTextProperty
and
-.ZN Xutf8TextListToTextProperty
-functions set the specified
-.ZN XTextProperty
+.B Xutf8TextListToTextProperty
+functions set the specified
+.B XTextProperty
value to a set of null-separated elements representing the concatenation
-of the specified list of null-terminated text strings. The input text
+of the specified list of null-terminated text strings.
+The input text
strings must be given in the current locale encoding (for
-.ZN XmbTextListToTextProperty
+.B XmbTextListToTextProperty
and
-.ZN XwcTextListToTextProperty ),
+.BR XwcTextListToTextProperty ),
or in UTF-8 encoding (for
-.ZN Xutf8TextListToTextProperty ).
+.BR Xutf8TextListToTextProperty ).
.LP
The functions set the encoding field of text_prop_return to an
-.ZN Atom
-for the specified display
+.B Atom
+for the specified display
naming the encoding determined by the specified style
and convert the specified text list to this encoding for storage in
the text_prop_return value field.
-If the style
-.ZN XStringStyle
-or
-.ZN XCompoundTextStyle
+If the style
+.B XStringStyle
+or
+.B XCompoundTextStyle
is specified,
-this encoding is ``STRING'' or ``COMPOUND_TEXT'', respectively.
+this encoding is \*(lqSTRING\*(rq or \*(lqCOMPOUND_TEXT\*(rq, respectively.
If the style
-.ZN XUTF8StringStyle
+.B XUTF8StringStyle
is specified,
-this encoding is ``UTF8_STRING''.
-(This is an extension introduced by The XFree86 Project, Inc. in their 4.0.2
-release. Its presence is indicated by the macro
-.ZN X_HAVE_UTF8_STRING .)
-If the style
-.ZN XTextStyle
+this encoding is \*(lqUTF8_STRING\*(rq.
+(This is an extension introduced by The XFree86 Project, Inc., in their 4.0.2
+release.
+Its presence is indicated by the macro
+.BR X_HAVE_UTF8_STRING .)
+If the style
+.B XTextStyle
is specified,
this encoding is the encoding of the current locale.
-If the style
-.ZN XStdICCTextStyle
+If the style
+.B XStdICCTextStyle
is specified,
-this encoding is ``STRING'' if the text is fully convertible to STRING,
-else ``COMPOUND_TEXT''.
-A final terminating null byte is stored at the end of the value field
+this encoding is \*(lqSTRING\*(rq if the text is fully convertible to STRING,
+else \*(lqCOMPOUND_TEXT\*(rq.
+A final terminating null byte is stored at the end of the value field
of text_prop_return but is not included in the nitems member.
.LP
If insufficient memory is available for the new value string,
-the functions return
-.ZN XNoMemory .
+the functions return
+.BR XNoMemory .
If the current locale is not supported,
-the functions return
-.ZN XLocaleNotSupported .
+the functions return
+.BR XLocaleNotSupported .
In both of these error cases,
the functions do not set text_prop_return.
.LP
To determine if the functions are guaranteed not to return
-.ZN XLocaleNotSupported ,
+.BR XLocaleNotSupported ,
use
-.ZN XSupportsLocale .
+.BR XSupportsLocale .
.LP
If the supplied text is not fully convertible to the specified encoding,
the functions return the number of unconvertible characters.
Each unconvertible character is converted to an implementation-defined and
encoding-specific default string.
-Otherwise, the functions return
-.ZN Success .
-Note that full convertibility to all styles except
-.ZN XStringStyle
+Otherwise, the functions return
+.BR Success .
+Note that full convertibility to all styles except
+.B XStringStyle
is guaranteed.
.LP
To free the storage for the value field, use
-.ZN XFree .
+.BR XFree .
.LP
-The
-.ZN XmbTextPropertyToTextList ,
-.ZN XwcTextPropertyToTextList
-and
-.ZN Xutf8TextPropertyToTextList
+The
+.BR XmbTextPropertyToTextList ,
+.B XwcTextPropertyToTextList
+and
+.B Xutf8TextPropertyToTextList
functions return a list of text strings representing the
null-separated elements of the specified
-.ZN XTextProperty
-structure. The returned strings are encoded using the current locale encoding
+.B XTextProperty
+structure.
+The returned strings are encoded using the current locale encoding
(for
-.ZN XmbTextPropertyToTextList
+.B XmbTextPropertyToTextList
and
-.ZN XwcTextPropertyToTextList )
+.BR XwcTextPropertyToTextList )
or in UTF-8 (for
-.ZN Xutf8TextPropertyToTextList ).
+.BR Xutf8TextPropertyToTextList ).
The data in text_prop must be format 8.
.LP
Multiple elements of the property (for example, the strings in a disjoint
@@ -233,36 +202,36 @@ The contents of the property are not required to be null-terminated;
any terminating null should not be included in text_prop.nitems.
.LP
If insufficient memory is available for the list and its elements,
-.ZN XmbTextPropertyToTextList ,
-.ZN XwcTextPropertyToTextList
+.BR XmbTextPropertyToTextList ,
+.B XwcTextPropertyToTextList
and
-.ZN Xutf8TextPropertyToTextList
-return
-.ZN XNoMemory .
+.B Xutf8TextPropertyToTextList
+return
+.BR XNoMemory .
If the current locale is not supported,
the functions return
-.ZN XLocaleNotSupported .
-Otherwise, if the encoding field of text_prop is not convertible
+.BR XLocaleNotSupported .
+Otherwise, if the encoding field of text_prop is not convertible
to the encoding of the current locale,
the functions return
-.ZN XConverterNotFound .
+.BR XConverterNotFound .
For supported locales,
existence of a converter from COMPOUND_TEXT, STRING, UTF8_STRING
or the encoding of the current locale is guaranteed if
-.ZN XSupportsLocale
-returns
-.ZN True
+.B XSupportsLocale
+returns
+.B True
for the current locale (but the actual text
may contain unconvertible characters).
Conversion of other encodings is implementation-dependent.
In all of these error cases,
the functions do not set any return values.
.LP
-Otherwise,
-.ZN XmbTextPropertyToTextList ,
-.ZN XwcTextPropertyToTextList
+Otherwise,
+.BR XmbTextPropertyToTextList ,
+.B XwcTextPropertyToTextList
and
-.ZN Xutf8TextPropertyToTextList
+.B Xutf8TextPropertyToTextList
return the list of null-terminated text strings to list_return
and the number of text strings to count_return.
.LP
@@ -271,54 +240,54 @@ encoding of the current locale,
the functions return the number of unconvertible characters.
Each unconvertible character is converted to a string in the
current locale that is specific to the current locale.
-To obtain the value of this string,
+To obtain the value of this string,
use
-.ZN XDefaultString .
+.BR XDefaultString .
Otherwise,
-.ZN XmbTextPropertyToTextList ,
-.ZN XwcTextPropertyToTextList
+.BR XmbTextPropertyToTextList ,
+.B XwcTextPropertyToTextList
and
-.ZN Xutf8TextPropertyToTextList
-return
-.ZN Success .
+.B Xutf8TextPropertyToTextList
+return
+.BR Success .
.LP
To free the storage for the list and its contents returned by
-.ZN XmbTextPropertyToTextList
+.B XmbTextPropertyToTextList
or
-.ZN Xutf8TextPropertyToTextList ,
+.BR Xutf8TextPropertyToTextList ,
use
-.ZN XFreeStringList .
+.BR XFreeStringList .
To free the storage for the list and its contents returned by
-.ZN XwcTextPropertyToTextList ,
+.BR XwcTextPropertyToTextList ,
use
-.ZN XwcFreeStringList .
+.BR XwcFreeStringList .
.LP
The
-.ZN XwcFreeStringList
+.B XwcFreeStringList
function frees memory allocated by
-.ZN XwcTextPropertyToTextList .
+.BR XwcTextPropertyToTextList .
.LP
The
-.ZN XDefaultString
+.B XDefaultString
function returns the default string used by Xlib for text conversion
-(for example, in
-.ZN XmbTextPropertyToTextList ).
-The default string is the string in the current locale that is output
+(for example, in
+.BR XmbTextPropertyToTextList ).
+The default string is the string in the current locale that is output
when an unconvertible character is found during text conversion.
If the string returned by
-.ZN XDefaultString
+.B XDefaultString
is the empty string ("\^"),
no character is output in the converted text.
-.ZN XDefaultString
+.B XDefaultString
does not return NULL.
.LP
-The string returned by
-.ZN XDefaultString
+The string returned by
+.B XDefaultString
is independent of the default string for text drawing;
-see
-.ZN XCreateFontSet
+see
+.B XCreateFontSet
to obtain the default string for an
-.ZN XFontSet .
+.BR XFontSet .
.LP
The behavior when an invalid codepoint is supplied to any Xlib function is
undefined.
@@ -329,29 +298,30 @@ It may be freed after the current locale is changed.
Until freed, it will not be modified by Xlib.
.LP
The functions
-.ZN Xutf8TextListToTextProperty
+.B Xutf8TextListToTextProperty
and
-.ZN Xutf8TextPropertyToTextList
-are extensions introduced by The XFree86 Project, Inc. in their 4.0.2
-release. Their presence is
+.B Xutf8TextPropertyToTextList
+are extensions introduced by The XFree86 Project, Inc., in their 4.0.2
+release.
+Their presence is
indicated by the macro
-.ZN X_HAVE_UTF8_STRING .
+.BR X_HAVE_UTF8_STRING .
.SH STRUCTURES
The
-.ZN XTextProperty
+.B XTextProperty
structure contains:
.LP
-.Ds 0
+.EX
typedef struct {
unsigned char *value; /\&* property data */
Atom encoding; /\&* type of property */
int format; /\&* 8, 16, or 32 */
unsigned long nitems; /\&* number of items in value */
} XTextProperty;
-.De
+.EE
.LP
The
-.ZN XICCEncodingStyle
+.B XICCEncodingStyle
structure contains:
.LP
.TS
@@ -359,26 +329,26 @@ lw(.5i) lw(2i) lw(2.5i).
T{
\&#define
T} T{
-.ZN XNoMemory
+.B XNoMemory
T} T{
\-1
T}
T{
\&#define
T} T{
-.ZN XLocaleNotSupported
+.B XLocaleNotSupported
T} T{
\-2
T}
T{
\&#define
T} T{
-.ZN XConverterNotFound
+.B XConverterNotFound
T} T{
\-3
T}
.TE
-.Ds 0
+.EX
typedef enum {
XStringStyle, /\&* STRING */
XCompoundTextStyle, /\&* COMPOUND_TEXT */
@@ -386,7 +356,7 @@ typedef enum {
XStdICCTextStyle, /\&* STRING, else COMPOUND_TEXT */
XUTF8StringStyle /\&* UTF8_STRING */
} XICCEncodingStyle;
-.De
+.EE
.SH "SEE ALSO"
XSetTextProperty(__libmansuffix__),
XStringListToTextProperty(__libmansuffix__)