Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
68 lines (65 sloc) 2.4 KB
.TH xcb_list_fonts 3 2011-12-18 "XCB" "XCB Requests"
.ad l
.SH NAME
xcb_list_fonts \- get matching font names
.SH SYNOPSIS
.hy 0
.B #include <xcb/xproto.h>
.SS Request function
.HP
xcb_list_fonts_cookie_t \fBxcb_list_fonts\fP(xcb_connection_t\ *\fIconn\fP, uint16_t\ \fImax_names\fP, uint16_t\ \fIpattern_len\fP, const char\ *\fIpattern\fP);
.PP
.SS Reply datastructure
.nf
.sp
typedef struct xcb_list_fonts_reply_t {
uint8_t \fIresponse_type\fP;
uint8_t \fIpad0\fP;
uint16_t \fIsequence\fP;
uint32_t \fIlength\fP;
uint16_t \fInames_len\fP;
uint8_t \fIpad1\fP[22];
} \fBxcb_list_fonts_reply_t\fP;
.fi
.SS Reply function
.HP
xcb_list_fonts_reply_t *\fBxcb_list_fonts_reply\fP(xcb_connection_t\ *\fIconn\fP, xcb_list_fonts_cookie_t\ \fIcookie\fP, xcb_generic_error_t\ **\fIe\fP);
.SS Reply accessors
.HP
int \fBxcb_list_fonts_names_length\fP(const xcb_list_fonts_reply_t *\fIreply\fP);
.HP
xcb_str_iterator_t \fBxcb_list_fonts_names_iterator\fP(const xcb_list_fonts_reply_t *\fIreply\fP);
.br
.hy 1
.SH REQUEST ARGUMENTS
.IP \fIconn\fP 1i
The XCB connection to X11.
.IP \fImax_names\fP 1i
The maximum number of fonts to be returned.
.IP \fIpattern_len\fP 1i
The length (in bytes) of \fIpattern\fP.
.IP \fIpattern\fP 1i
A font pattern, for example "-misc-fixed-*".
The asterisk (*) is a wildcard for any number of characters. The question mark
(?) is a wildcard for a single character. Use of uppercase or lowercase does
not matter.
.SH REPLY FIELDS
.IP \fIresponse_type\fP 1i
The type of this reply, in this case \fIXCB_LIST_FONTS\fP. This field is also present in the \fIxcb_generic_reply_t\fP and can be used to tell replies apart from each other.
.IP \fIsequence\fP 1i
The sequence number of the last request processed by the X11 server.
.IP \fIlength\fP 1i
The length of the reply, in words (a word is 4 bytes).
.IP \fInames_len\fP 1i
The number of font names.
.SH DESCRIPTION
Gets a list of available font names which match the given \fIpattern\fP.
.SH RETURN VALUE
Returns an \fIxcb_list_fonts_cookie_t\fP. Errors have to be handled when calling the reply function \fIxcb_list_fonts_reply\fP.
If you want to handle errors in the event loop instead, use \fIxcb_list_fonts_unchecked\fP. See \fBxcb-requests(3)\fP for details.
.SH ERRORS
This request does never generate any errors.
.SH SEE ALSO
.BR xcb-requests (3)
.SH AUTHOR
Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.