Blob Blame History Raw
'\" t
...\" LstPosTo.sgm /main/8 1996/09/08 20:51:07 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmListPosToBounds" "library call"
.SH "NAME"
\fBXmListPosToBounds\fP \(em A List function that returns the bounding
box of an item at a specified position in a list
.iX "XmListPosToBounds"
.iX "List functions" "XmListPosToBounds"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/List\&.h>
\fBBoolean \fBXmListPosToBounds\fP\fR(
\fBWidget \fBwidget\fR\fR,
\fBint \fBposition\fR\fR,
\fBPosition *\fBx\fR\fR,
\fBPosition *\fBy\fR\fR,
\fBDimension *\fBwidth\fR\fR,
\fBDimension *\fBheight\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmListPosToBounds\fP returns the coordinates
of an item within a list and the dimensions of its bounding
box\&. The function returns the associated x and y-coordinates
of the upper left corner of the bounding box relative to the
upper left corner of the List widget, as well as the width
and the height of the box\&. The caller can pass a NULL value
for the \fIx\fP, \fIy\fP, \fIwidth\fP, or \fIheight\fP parameters
to indicate that the return value for that parameter is not
requested\&.
.IP "\fIwidget\fP" 10
Specifies the ID of the List widget\&.
.IP "\fIposition\fP" 10
Specifies the position of the specified item\&.
A value of 1 indicates the first item in
the list; a value of 2 indicates the second item; and so on\&. A
value of 0 (zero) specifies the last item in the list\&.
.IP "\fIx\fP" 10
Specifies a pointer to the returned x-coordinate of the item\&.
.IP "\fIy\fP" 10
Specifies the pointer to the returned y-coordinate of the item\&.
.IP "\fIwidth\fP" 10
Specifies the pointer to the returned width of the item\&.
.IP "\fIheight\fP" 10
Specifies the pointer to the returned height of the item\&.
.PP
For a complete definition of List and its associated resources, see
\fBXmList\fP(3)\&.
.SH "RETURN"
.PP
If the item at the specified position is not visible,
returns False, and the returned values (if any) are undefined\&. Otherwise,
this function returns True\&.
.SH "RELATED"
.PP
\fBXmList\fP(3) and
\fBXmListYToPos\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:26