diff options
Diffstat (limited to 'lib/libX11/man/xkb/XkbAddGeomOutline.man')
-rw-r--r-- | lib/libX11/man/xkb/XkbAddGeomOutline.man | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/lib/libX11/man/xkb/XkbAddGeomOutline.man b/lib/libX11/man/xkb/XkbAddGeomOutline.man new file mode 100644 index 000000000..521614ef4 --- /dev/null +++ b/lib/libX11/man/xkb/XkbAddGeomOutline.man @@ -0,0 +1,94 @@ +.\" Copyright (c) 1999 - Sun Microsystems, Inc. +.\" All rights reserved. +.\" +.\" 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, and/or sell copies of the Software, and to permit persons +.\" to whom the Software is furnished to do so, provided that the above +.\" copyright notice(s) and this permission notice appear in all copies of +.\" the Software and that both the above copyright notice(s) and this +.\" permission notice appear in supporting documentation. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL +.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING +.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION +.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Except as contained in this notice, the name of a copyright holder +.\" shall not be used in advertising or otherwise to promote the sale, use +.\" or other dealings in this Software without prior written authorization +.\" of the copyright holder. +.\" +.TH XkbAddGeomOutline __libmansuffix__ __xorgversion__ "XKB FUNCTIONS" +.SH NAME +XkbAddGeomOutline \- Add one outline to an existing shape +.SH SYNOPSIS +.B XkbOutlinePtr XkbAddGeomOutline +( +.I shape, +.I sz_points +) +.br + XkbShapePtr \fIshape\fP\^; +.br + int \fIsz_points\fP\^; +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I \- shape +shape to be updated +.TP +.I \- sz_points +number of points to be reserved +.SH DESCRIPTION +.LP +Xkb provides functions to add a single new element to the top-level keyboard +geometry. In each case the +.I num_ * +fields of the corresponding structure is incremented by 1. These functions do +not change +.I sz_* +unless there is no more room in the array. Some of these functions fill in the +values of the element's structure from the arguments. For other functions, you +must explicitly write code to fill the structure's elements. + +The top-level geometry description includes a list of +.I geometry properties. +A geometry property associates an arbitrary string with an equally arbitrary +name. Programs that display images of keyboards can use geometry properties as +hints, but they are not interpreted by Xkb. No other geometry structures refer +to geometry properties. + +An outline consists of an arbitrary number of points. +.I XkbAddGeomOutline +adds an outline to the specified +.I shape +by reserving +.I sz_points +points for it. The new outline is allocated and zeroed. +.I XkbAddGeomOutline +returns NULL if any of the parameters is empty or if it was not able to allocate +space. To allocate space for an arbitrary number of outlines to a shape, use +.I XkbAllocGeomOutlines. +.SH STRUCTURES +.LP +.nf + + typedef struct _XkbOutline { + unsigned short num_points; /\(** number of points in the outline */ + unsigned short sz_points; /\(** size of the points array */ + unsigned short corner_radius; /\(** draw corners as circles with this radius */ + XkbPointPtr points; /\(** array of points defining the outline */ + } XkbOutlineRec, *XkbOutlinePtr; + +.fi +.SH "SEE ALSO" +.BR XkbAllocGeomOutlines (__libmansuffix__) |