<!-- $XConsortium: ScrollBB.sgm /main/8 1996/09/08 21:00:51 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.MAN386.rsml.1">
<RefMeta>
<RefEntryTitle>XmScrollBarGetValues</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmScrollBarGetValues</Function></RefName>
<RefPurpose>A ScrollBar function that returns the ScrollBar's increment values
<IndexTerm>
<Primary>XmScrollBarGetValues</Primary>
</IndexTerm><IndexTerm>
<Primary>ScrollBar functions</Primary>
<Secondary>XmScrollBarGetValues</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/ScrollBar.h>
void XmScrollBarGetValues (<Replaceable>widget, value_return, slider_size_return,
increment_return, page_increment_return</Replaceable>)
        Widget  <Replaceable>widget</Replaceable>;
        int     <Replaceable>* value_return</Replaceable>;
        int     <Replaceable>* slider_size_return</Replaceable>;
        int     <Replaceable>* increment_return</Replaceable>;
        int     <Replaceable>* page_increment_return</Replaceable>;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmScrollBarGetValues</Function> returns the
the ScrollBar's increment values.
The scroll region is overlaid with a
slider bar that is adjusted in size and position using the main ScrollBar or
set slider function attributes.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ScrollBar widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">value_return</Symbol></Term>
<ListItem>
<Para>Returns the ScrollBar's slider position between the
<SystemItem Class="Resource">XmNminimum</SystemItem> and <SystemItem Class="Resource">XmNmaximum</SystemItem> resources.
Specify NULL to prevent the return of a particular value.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">slider_size_return</Symbol></Term>
<ListItem>
<Para>Returns the size of the slider as a value between 0 (zero) and the absolute
value of <SystemItem Class="Resource">XmNmaximum</SystemItem> minus <SystemItem Class="Resource">XmNminimum</SystemItem>. The size of the slider
varies, depending on how much of the slider scroll area it represents.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">increment_return</Symbol></Term>
<ListItem>
<Para>Returns the amount of increment and decrement.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">page_increment_return</Symbol></Term>
<ListItem>
<Para>Returns the amount of page increment and decrement.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of ScrollBar and its associated resources, see
&cdeman.XmScrollBar;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns the ScrollBar's increment values.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmScrollBar;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
