<!-- $XConsortium: TxtXYToP.sgm /main/11 1996/09/08 21:20:46 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.MAN546.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextXYToPos</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextXYToPos</Function></RefName>
<RefPurpose>A Text function that accesses the character position nearest an x and y position
<IndexTerm>
<Primary>XmTextXYToPos</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextXYToPos</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Text.h>
</FuncSynopsisInfo>
<FuncDef>XmTextPosition <Function>XmTextXYToPos</Function></FuncDef>
<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>XmTextXYToPos</Function> accesses the character position nearest to the
specified <Emphasis>x</Emphasis> and <Emphasis>y</Emphasis> position, relative to the upper left corner of the
Text widget.
</Para>
<Para>In the case of horizontal writing, the position is the origin of the character.
In the case of vertical writing, the position is the vertical origin of
the character.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the Text widget ID
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>x</Emphasis></Term>
<ListItem>
<Para>Specifies the <Emphasis>x</Emphasis> position, relative to the upper left corner of the
widget
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>y</Emphasis></Term>
<ListItem>
<Para>Specifies the <Emphasis>y</Emphasis> position, relative to the upper left corner of the
widget
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Text and its associated resources, see
&cdeman.XmText;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the character position in the text nearest the <Emphasis>x</Emphasis> and <Emphasis>y</Emphasis>
position specified. This is an integer number of characters
from the beginning of the buffer. The first character position is 0 (zero).
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmText;.
</Para>
</RefSect1>
</RefEntry>
