NAME

xcb_list_fonts_with_info - get matching font names and information

SYNOPSIS

#include <xcb/xproto.h>

Request function

xcb_list_fonts_with_info_cookie_t xcb_list_fonts_with_info(xcb_connection_t *conn, uint16_t max_names, uint16_t pattern_len, const char *pattern);

Reply datastructure

typedef struct xcb_list_fonts_with_info_reply_t {


    uint8_t        response_type;


    uint8_t        name_len;


    uint16_t       sequence;


    uint32_t       length;


    xcb_charinfo_t min_bounds;


    uint8_t        pad0[4];


    xcb_charinfo_t max_bounds;


    uint8_t        pad1[4];


    uint16_t       min_char_or_byte2;


    uint16_t       max_char_or_byte2;


    uint16_t       default_char;


    uint16_t       properties_len;


    uint8_t        draw_direction;


    uint8_t        min_byte1;


    uint8_t        max_byte1;


    uint8_t        all_chars_exist;


    int16_t        font_ascent;


    int16_t        font_descent;


    uint32_t       replies_hint;
} xcb_list_fonts_with_info_reply_t;

Reply function

xcb_list_fonts_with_info_reply_t *xcb_list_fonts_with_info_reply(xcb_connection_t *conn, xcb_list_fonts_with_info_cookie_t cookie, xcb_generic_error_t **e);

Reply accessors

xcb_fontprop_t *xcb_list_fonts_with_info_properties(const xcb_list_fonts_with_info_request_t *reply);

int xcb_list_fonts_with_info_properties_length(const xcb_list_fonts_with_info_reply_t *reply);

xcb_fontprop_iterator_t xcb_list_fonts_with_info_properties_iterator(const xcb_list_fonts_with_info_reply_t *reply);

char *xcb_list_fonts_with_info_name(const xcb_list_fonts_with_info_request_t *reply);

int xcb_list_fonts_with_info_name_length(const xcb_list_fonts_with_info_reply_t *reply);

xcb_generic_iterator_t xcb_list_fonts_with_info_name_end(const xcb_list_fonts_with_info_reply_t *reply);

REQUEST ARGUMENTS

conn: The XCB connection to X11.
max_names: The maximum number of fonts to be returned.
pattern_len: The length (in bytes) of pattern.
pattern: 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.

REPLY FIELDS

response_type: The type of this reply, in this case XCB_LIST_FONTS_WITH_INFO. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.
sequence: The sequence number of the last request processed by the X11 server.
length: The length of the reply, in words (a word is 4 bytes).
name_len: The number of matched font names.
min_bounds: minimum bounds over all existing char
max_bounds: maximum bounds over all existing char
min_char_or_byte2: first character
max_char_or_byte2: last character
default_char: char to print for undefined character
properties_len: how many properties there are
draw_direction: One of the following values:

XCB_FONT_DRAW_LEFT_TO_RIGHT: TODO: NOT YET DOCUMENTED.
XCB_FONT_DRAW_RIGHT_TO_LEFT: TODO: NOT YET DOCUMENTED.

min_byte1: TODO: NOT YET DOCUMENTED.
max_byte1: TODO: NOT YET DOCUMENTED.
all_chars_exist: flag if all characters have nonzero size
font_ascent: baseline to top edge of raster
font_descent: baseline to bottom edge of raster
replies_hint: An indication of how many more fonts will be returned. This is only a hint and may be larger or smaller than the number of fonts actually returned. A zero value does not guarantee that no more fonts will be returned.

DESCRIPTION

Gets a list of available font names which match the given pattern.

RETURN VALUE

Returns an xcb_list_fonts_with_info_cookie_t. Errors have to be handled when calling the reply function xcb_list_fonts_with_info_reply.

If you want to handle errors in the event loop instead, use xcb_list_fonts_with_info_unchecked. See xcb-requests(3) for details.

ERRORS

This request does never generate any errors.

AUTHOR

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.