XQueryBestCursor (3)

Leading comments

Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the foll...

(The comments found at the beginning of the groff file "man3/XQueryBestCursor.3".)

NAME

XRecolorCursor, XFreeCursor, XQueryBestCursor - manipulate cursors

SYNTAX

int XRecolorCursor(Display *display, Cursor cursor, XColor *foreground_color, XColor *background_color);

int XFreeCursor(Display *display, Cursor cursor);

Status XQueryBestCursor(Display *display, Drawable d, unsigned int width, unsigned int height, unsigned int *width_return, unsigned int *height_return);

ARGUMENTS

background_color

Specifies the RGB values for the background of the source.

cursor

Specifies the cursor.

d

Specifies the drawable, which indicates the screen.

display

Specifies the connection to the X server.

foreground_color

Specifies the RGB values for the foreground of the source.

width

height

Specify the width and heightof the cursor that you want the size information for.

width_return

height_return

Return the best width and height that is closest to the specified width and height.

DESCRIPTION

The XRecolorCursor function changes the color of the specified cursor, and if the cursor is being displayed on a screen, the change is visible immediately. The pixel members of the XColor structures are ignored; only the RGB values are used.

XRecolorCursor can generate a BadCursor error.

The XFreeCursor function deletes the association between the cursor resource ID and the specified cursor. The cursor storage is freed when no other resource references it. The specified cursor ID should not be referred to again.

XFreeCursor can generate a BadCursor error.

Some displays allow larger cursors than other displays. The XQueryBestCursor function provides a way to find out what size cursors are actually possible on the display. It returns the largest size that can be displayed. Applications should be prepared to use smaller cursors on displays that cannot support large ones.

XQueryBestCursor can generate a BadDrawable error.

DIAGNOSTICS

BadCursor

A value for a Cursor argument does not name a defined Cursor.

BadDrawable

A value for a Drawable argument does not name a defined Window or Pixmap.

SEE ALSO

XCreateColormap(3), XCreateFontCursor(3), XDefineCursor(3)
Xlib - C Language X Interface