<!-- $XConsortium: LstPosTo.sgm /main/8 1996/09/08 20:51:07 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN302.rsml.1">
<RefMeta>
<RefEntryTitle>XmListPosToBounds</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmListPosToBounds</Function></RefName>
<RefPurpose>A List function that returns the bounding
box of an item at a specified position in a list
<IndexTerm>
<Primary>XmListPosToBounds</Primary>
</IndexTerm><IndexTerm>
<Primary>List functions</Primary>
<Secondary>XmListPosToBounds</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/List.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmListPosToBounds</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, position, x, y, width, height</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>int <Parameter>position</Parameter></ParamDef>
<ParamDef>Position *<Parameter>x</Parameter></ParamDef>
<ParamDef>Position *<Parameter>y</Parameter></ParamDef>
<ParamDef>Dimension *<Parameter>width</Parameter></ParamDef>
<ParamDef>Dimension *<Parameter>height</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmListPosToBounds</Function> 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 <Emphasis>x</Emphasis>, <Emphasis>y</Emphasis>, <Symbol Role="Variable">width</Symbol>, or <Symbol Role="Variable">height</Symbol> parameters
to indicate that the return value for that parameter is not
requested.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the List widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position</Symbol></Term>
<ListItem>
<Para>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.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>x</Emphasis></Term>
<ListItem>
<Para>Specifies a pointer to the returned x-coordinate of the item.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>y</Emphasis></Term>
<ListItem>
<Para>Specifies the pointer to the returned y-coordinate of the item.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">width</Symbol></Term>
<ListItem>
<Para>Specifies the pointer to the returned width of the item.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">height</Symbol></Term>
<ListItem>
<Para>Specifies the pointer to the returned height of the item.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of List and its associated resources, see
&cdeman.XmList;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>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.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmList; and
&cdeman.XmListYToPos;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
