<!-- $XConsortium: ObjectAP.sgm /main/8 1996/09/08 20:54:48 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.MAN332.rsml.1">
<RefMeta>
<RefEntryTitle>XmObjectAtPoint</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmObjectAtPoint</Function></RefName>
<RefPurpose>A toolkit function that determines which child intersects or comes closest to a specified point
<IndexTerm>
<Primary>XmObjectAtPoint</Primary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- 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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>Widget <Function>XmObjectAtPoint</Function></FuncDef>
<!--<ParamDef>widget, x, y<ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>Position <Parameter>x</Parameter></ParamDef>
<ParamDef>Position <Parameter>y</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmObjectAtPoint</Function> searches the child list of the specified
manager <Symbol Role="Variable">widget</Symbol> and returns the child most closely associated
with the specified <Emphasis>x</Emphasis>,<Emphasis>y</Emphasis> coordinate pair.
</Para>
<Para>For the typical Motif manager <Symbol Role="Variable">widget</Symbol>, <Function>XmObjectAtPoint</Function>
uses the following rules to determine the returned object:
</Para>
<ItemizedList>
<ListItem>
<Para>If one child intersects <Emphasis>x,y</Emphasis>, <Function>XmObjectAtPoint</Function>
returns the widget ID of that child.
</Para>
</ListItem>
<ListItem>
<Para>If more than one child intersects <Emphasis>x,y</Emphasis>,
<Function>XmObjectAtPoint</Function> returns the widget ID of the visible child.
</Para>
</ListItem>
<ListItem>
<Para>If no child intersects <Emphasis>x</Emphasis>,<Emphasis>y</Emphasis>, <Function>XmObjectAtPoint</Function>
returns NULL.
</Para>
</ListItem>
</ItemizedList>
<Para>The preceding rules are only general. In fact, each manager
<Symbol Role="Variable">widget</Symbol> is free to define "most closely associated"
as it desires.
For example, if no child intersects <Emphasis>x,y</Emphasis>, a manager
might return the child closest to <Emphasis>x,y</Emphasis>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies a manager widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>x</Emphasis></Term>
<ListItem>
<Para>Specifies the x-coordinate about which you are seeking child
information. The x-coordinate must be specified in pixels,
relative to the left side of <Emphasis>manager</Emphasis>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>y</Emphasis></Term>
<ListItem>
<Para>Specifies the y-coordinate about which you are seeking child
information. The y-coordinate must be specified in pixels,
relative to the top side of <Emphasis>manager</Emphasis>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the child of <Emphasis>manager</Emphasis> most closely associated
with <Emphasis>x,y</Emphasis>.
If none of its children are sufficiently associated with <Emphasis>x,y</Emphasis>,
returns NULL.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmManager;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
