<!-- $XConsortium: TxtFieAV.sgm /main/9 1996/09/08 21:14:44 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.MAN495.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextFieldPosToXY</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextFieldPosToXY</Function></RefName>
<RefPurpose>A TextField function that accesses the x
and y position of a character position
<IndexTerm>
<Primary>XmTextFieldPosToXY</Primary>
</IndexTerm><IndexTerm>
<Primary>TextField functions</Primary>
<Secondary>XmTextFieldPosToXY</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-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/TextF.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmTextFieldPosToXY</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, position, x, y</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>XmTextPosition <Parameter>position</Parameter></ParamDef>
<ParamDef>Position <Parameter>*x</Parameter></ParamDef>
<ParamDef>Position <Parameter>*y</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextFieldPosToXY</Function> accesses the <Emphasis>x</Emphasis> and <Emphasis>y</Emphasis>
position, relative to the upper
left corner of the TextField widget, of a given character position in the
text buffer.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the TextField widget ID
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position</Symbol></Term>
<ListItem>
<Para>Specifies the character position in the text for which the <Emphasis>x</Emphasis> and <Emphasis>y</Emphasis>
position is accessed. This is an integer number of characters
from the beginning of the buffer. The first character position is 0.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>x</Emphasis></Term>
<ListItem>
<Para>Specifies the pointer in which the <Emphasis>x</Emphasis> position is returned.
The returned position is the distance from the left side of the widget
to the left border of the character.
This value is meaningful only if the function returns True.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>y</Emphasis></Term>
<ListItem>
<Para>Specifies the pointer in which the <Emphasis>y</Emphasis> position is returned.
The returned position is the distance from the top of the widget
to the character's baseline.
This value is meaningful only if the function returns True.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of TextField and its associated resources, see
&cdeman.XmTextField;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>This function returns True if the character position is displayed in the
TextField widget; otherwise, it returns False, and no <Emphasis>x</Emphasis> or <Emphasis>y</Emphasis>
value is returned.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmTextField;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
