<!-- $XConsortium: TxtGetBa.sgm /main/12 1996/10/06 18:56: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.MAN511.rsml.1">
<RefMeta>
<RefEntryTitle>XmTextGetBaseline</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextGetBaseline</Function></RefName>
<RefPurpose>A Text function that accesses the y position of the baseline
<IndexTerm>
<Primary>XmTextGetBaseline</Primary>
</IndexTerm><IndexTerm>
<Primary>Text functions</Primary>
<Secondary>XmTextGetBaseline</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Text.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>XmTextGetBaseline</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTextGetBaseline</Function> accesses the <Emphasis>y</Emphasis> position of the
baseline in the Text widget,
relative to the <Emphasis>y</Emphasis> position of the top of the widget.
</Para>
<Para>
In vertical mode (when the <systemitem class="resource">XmNlayoutDirection</systemitem> resource is
<systemitem class="constant">XmTOP_TO_BOTTOM</systemitem>) this function returns 0 and
the program should use <Function>XmTextGetCenterline</Function>
</Para>
<Para>
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the Text widget ID
</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 an integer value that indicates the <Emphasis>y</Emphasis> position
of the baseline in the Text widget.
The calculation takes into account the
margin height, shadow thickness, highlight thickness, and font ascent of
the first font (set) in the fontlist used for drawing text.
In this calculation, the
<Emphasis>y</Emphasis> position of the top of the widget is 0 (zero).
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmText;, &cdeman.XmTextGetCenterline;.
</Para>
</RefSect1>
</RefEntry>
