<!-- $XConsortium: WidgetGA.sgm /main/8 1996/09/08 21:21:47 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.MAN570.rsml.1">
<RefMeta>
<RefEntryTitle>XmWidgetGetBaselines</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmWidgetGetBaselines</Function></RefName>
<RefPurpose>Retrieves baseline information for
a widget
<IndexTerm>
<Primary>XmWidgetGetBaselines</Primary>
</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/Xm.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmWidgetGetBaselines</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, baselines, line_count</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>Dimension **<Parameter>baselines</Parameter></ParamDef>
<ParamDef>int *<Parameter>line_count</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmWidgetGetBaselines</Function> returns an array that
contains one or more baseline values associated with the
specified widget. The baseline of any given line of text
is a vertical offset in pixels from the origin of the
widget's bounding box to the given baseline.
<!-- Delete this section when the AES becomes unlocked.--></Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the widget for which baseline values
are requested
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">baselines</Symbol></Term>
<ListItem>
<Para>Returns an array that contains the value of each
baseline of text in the widget.
The function allocates space to hold the returned array.
The application is responsible for managing the allocated space.
The application can recover this allocated space by calling <Function>XtFree</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">line_count</Symbol></Term>
<ListItem>
<Para>Returns the number of lines in the widget
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a Boolean value that indicates whether the
widget contains a baseline. If the value is True, the function returns
a value for each baseline of text. If it is False, the function
was unable to return a baseline value.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmWidgetGetDisplayRect;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
