xenocara/lib/libXt/man/XtReservePropertyAtom.man

148 lines
3.4 KiB
Groff
Raw Normal View History

2006-11-25 11:01:46 -07:00
.\" Copyright (c) 1993, 1994 X Consortium
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" Permission is hereby granted, free of charge, to any person obtaining a
2012-03-10 09:45:48 -07:00
.\" 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
2006-11-25 11:01:46 -07:00
.\" Software furnished to do so, subject to the following conditions:
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" The above copyright notice and this permission notice shall be included in
.\" all copies or substantial portions of the Software.
2012-03-10 09:45:48 -07:00
.\"
2006-11-25 11:01:46 -07:00
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2012-03-10 09:45:48 -07:00
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2006-11-25 11:01:46 -07:00
.\" SOFTWARE.
2012-03-10 09:45:48 -07:00
.\"
.\" Except as contained in this notice, the name of the X Consortium shall not
.\" be used in advertising or otherwise to promote the sale, use or other
.\" dealing in this Software without prior written authorization from the
2006-11-25 11:01:46 -07:00
.\" X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtReserve-Property-Atom XtRelease-Property-Atom wid-get
.na
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft 1
.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 FD
.LP
.KS
.TA .5i 3i
.ta .5i 3i
.nf
..
.de FN
.fi
.KE
.LP
..
.de IN \" send an index entry to the stderr
..
.de C{
.KS
.nf
.D
.\"
.\" choose appropriate monospace font
.\" the imagen conditional, 480,
.\" may be changed to L if LB is too
.\" heavy for your eyes...
.\"
.ie "\\*(.T"480" .ft L
.el .ie "\\*(.T"300" .ft L
.el .ie "\\*(.T"202" .ft PO
.el .ie "\\*(.T"aps" .ft CW
.el .ft R
.ps \\n(PS
.ie \\n(VS>40 .vs \\n(VSu
.el .vs \\n(VSp
..
.de C}
.DE
.R
..
.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 NT
.ne 7
.ds NO Note
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
.ie n .sp
.el .sp 10p
.TB
.ce
\\*(NO
.ie n .sp
.el .sp 5p
.if '\\$1'C' .ce 99
.if '\\$2'C' .ce 99
.in +5n
.ll -5n
.R
..
. \" Note End -- doug kraft 3/85
.de NE
.ce 0
.in -5n
.ll +5n
.ie n .sp
.el .sp 10p
..
.ny0
.TH XtReservePropertyAtom __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtReservePropertyAtom, XtReleasePropertyAtom \- maintain a cache of property atoms
.SH SYNTAX
.HP
2012-03-10 09:45:48 -07:00
Widget XtReservePropertyAtom(Widget \fIw\fP);
2006-11-25 11:01:46 -07:00
.HP
2012-03-10 09:45:48 -07:00
void XtReleasePropertyAtom(Widget \fIw\fP, Atom \fIatom\fP);
2006-11-25 11:01:46 -07:00
.SH ARGUMENTS
.IP \fIw\fP 1i
Specifies the widget used to reserve the atom.
.IP \fIatom\fP 1i
Specifies the atom whose reservation is to be released.
.SH DESCRIPTION
.ZN XtReservePropertyAtom
returns an atom that may be used for properties in conjunction with
conversion requests from widget \fIw\fP. The atom returned will be
unique for the display of the widget specified.
.SH "SEE ALSO"
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP