<!-- $XConsortium: CreScE.sgm /main/8 1996/09/08 20:35:54 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.MAN168.rsml.1">
<RefMeta>
<RefEntryTitle>XmCreateScrolledText</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmCreateScrolledText</Function></RefName>
<RefPurpose>The Text ScrolledText convenience creation function
<IndexTerm>
<Primary>XmCreateScrolledText</Primary>
</IndexTerm><IndexTerm>
<Primary>creation functions</Primary>
<Secondary>XmCreateScrolledText</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>Widget <Function>XmCreateScrolledText</Function></FuncDef>
<!--<ParamDef><Replaceable>parent, name, arglist, argcount</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>parent</Parameter></ParamDef>
<ParamDef>String <Parameter>name</Parameter></ParamDef>
<ParamDef>ArgList <Parameter>arglist</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>argcount</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmCreateScrolledText</Function> creates an instance of a Text widget
that is contained within a ScrolledWindow.
The ScrolledWindow parent is created managed.
All ScrolledWindow subarea
widgets are automatically created by this function.
The ID returned by this function is that of the Text widget
(not the ScrolledWindow widget).
Use this widget ID for all operations on the Text widget.
Use the widget ID of the Text widget's parent for
all operations on the ScrolledWindow.
To obtain the ID of the ScrolledWindow widget associated with the
Text widget, use the Xt Intrinsics <Function>XtParent</Function> function.
The name of the ScrolledWindow created by this function is formed by
concatenating the letters <Symbol Role="Define">SW</Symbol>
onto the end of the <Symbol Role="Variable">name</Symbol> specified in the parameter list.
</Para>
<Para>The Text widget defaults to single-line text edit; therefore, no ScrollBars
are displayed. The Text resource <SystemItem Class="Resource">XmNeditMode</SystemItem> must be set to
<SystemItem Class="Constant">XmMULTI_LINE_EDIT</SystemItem> to display the ScrollBars.
The results of placing a Text widget inside a ScrolledWindow when the
Text's <SystemItem Class="Resource">XmNeditMode</SystemItem> is <SystemItem Class="Constant">XmSINGLE_LINE_EDIT</SystemItem> are undefined.
</Para>
<Para>All arguments to either the Text or the ScrolledWindow widget can be
specified at creation time with this function.
Changes to initial position and size are sent only to the ScrolledWindow
widget.
Other resources are sent to the Text or the ScrolledWindow widget as
appropriate.
Note that the result of providing the <SystemItem Class="Resource">XmNdestroyCallback</SystemItem>
resource in the creation <Symbol Role="Variable">arglist</Symbol> is unspecified. The
application should use the <Function>XtAddCallback</Function> function to add
callbacks to the appropriate widget (Text or ScrolledWindow) after
creating it.
</Para>
<Para>This function forces the following initial values for ScrolledWindow
resources:
</Para>
<ItemizedList>
<ListItem>
<Para><SystemItem Class="Resource">XmNscrollingPolicy</SystemItem> is set to <SystemItem Class="Constant">XmAPPLICATION_DEFINED</SystemItem>.
</Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Resource">XmNvisualPolicy</SystemItem> is set to <SystemItem Class="Constant">XmVARIABLE</SystemItem>.
</Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Resource">XmNscrollBarDisplayPolicy</SystemItem> is set to <SystemItem Class="Constant">XmSTATIC</SystemItem>.
</Para>
</ListItem>
<ListItem>
<Para><SystemItem Class="Resource">XmNshadowThickness</SystemItem> is set to 0 (zero).
</Para>
</ListItem>
</ItemizedList>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">parent</Symbol></Term>
<ListItem>
<Para>Specifies the parent widget ID
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">name</Symbol></Term>
<ListItem>
<Para>Specifies the name of the created widget
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">arglist</Symbol></Term>
<ListItem>
<Para>Specifies the argument list
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">argcount</Symbol></Term>
<ListItem>
<Para>Specifies the number of attribute/value pairs in the argument list
(<Symbol Role="Variable">arglist</Symbol>)
</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 Text widget ID.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmScrolledWindow; and &cdeman.XmText;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
