<!-- $XConsortium: TxtScrol.sgm /main/12 1996/09/08 21:19:24 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.MAN534.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextScroll</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextScroll</Function></RefName>
<RefPurpose>A Text function that scrolls text
<IndexTerm>
<Primary>XmTextScroll</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextScroll</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Text.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>XmTextScroll</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>int <Parameter>lines</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextScroll</Function> scrolls text by a given number
of lines in a Text widget. The sign of the number is interpreted
according to the value of the <Symbol>XmNlayoutDirection</Symbol> resource.
</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">lines</Symbol></Term>
<ListItem>
<Para>Specifies the number of lines of text to scroll. A positive value
causes text to scroll upward; a negative value causes text to scroll
downward.
Note that the text will scroll only as long as one line of text
remains visible in the window.
</Para>
<Para>If a navigator exists, this function uses the <Symbol Role="Globalvar">XmQTnavigator</Symbol>
trait to update the vertical navigator's value.
</Para>
<Para>In the case of vertical writing, a positive value causes the text to scroll forward;
a negative value causes the lines to scroll backward.
</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>

