<!-- $XConsortium: TxtSetTo.sgm /main/8 1996/09/08 21:20:31 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.MAN544.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextSetTopCharacter</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextSetTopCharacter</Function></RefName>
<RefPurpose>A Text function that sets the position of the first character displayed
<IndexTerm>
<Primary>XmTextSetTopCharacter</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextSetTopCharacter</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>void <Function>XmTextSetTopCharacter</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, top_character</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>XmTextPosition <Parameter>top_character</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextSetTopCharacter</Function> sets the position of the text at the top
of the Text widget.
If the <SystemItem Class="Resource">XmNeditMode</SystemItem> is <SystemItem Class="Constant">XmMULTI_LINE_EDIT</SystemItem>, the line of text
that contains <Symbol Role="Variable">top_character</Symbol> is displayed at the top of the widget
without the text shifting left or right.
If the edit mode is <SystemItem Class="Constant">XmSINGLE_LINE_EDIT</SystemItem>, the text moves horizontally
so that <Symbol Role="Variable">top_character</Symbol> is the first character displayed.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the Text widget ID
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">top_character</Symbol></Term>
<ListItem>
<Para>Specifies the position in the text to display at the top of the widget.
This is an integer number of characters from the beginning of the text
buffer. The first character position is 0 (zero).
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Text and its associated resources, see
&cdeman.XmText;.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmText;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
