<!-- $XConsortium: TxtGetTo.sgm /main/8 1996/09/08 21:18:16 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.MAN524.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextGetTopCharacter</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextGetTopCharacter</Function></RefName>
<RefPurpose>A Text function that accesses the position of the first character displayed
<IndexTerm>
<Primary>XmTextGetTopCharacter</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextGetTopCharacter</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/Text.h>
</FuncSynopsisInfo>
<FuncDef>XmTextPosition <Function>XmTextGetTopCharacter</Function></FuncDef>
<!--<ParamDef><Replaceable>widget</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextGetTopCharacter</Function> accesses the position of the text at the top
of the Text widget.
If there is no text in the Text widget (in other words,
<SystemItem Class="Resource">XmNvalue</SystemItem> contains an empty string),
then <Function>XmTextGetTopCharacter</Function> returns 0.
</Para>
<Para>Suppose that the <SystemItem Class="Resource">XmNtopCharacter</SystemItem> resource has been
set to a value greater than the number of characters in
the text widget. In this case,
<Function>XmTextGetTopCharacter</Function> returns an
<StructName Role="typedef">XmTextPosition</StructName> value identifying
the position of the first character in the last line of text in a
multiline case; otherwise, it identifies the position of the last
character in the line.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the Text widget ID
</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 an <StructName Role="typedef">XmTextPosition</StructName> value that indicates the state of the
<SystemItem Class="Resource">XmNtopCharacter</SystemItem> resource. This is an integer number of characters
from the beginning of the text buffer. The first character position is
0 (zero).
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmText;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
