<!-- $XConsortium: TxtGetCl.sgm /main/7 1996/10/02 11:49:21 cdedoc $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<RefEntry Id="CDEMOT.XmTextGetCenterline">
<RefMeta>
<RefEntryTitle>XmTextGetCenterline</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTextGetCenterline</Function></RefName>
<RefPurpose>
Return the height (length) of a character string
when the writing direction is vertical
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Xm/Text.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>XmTextGetCenterline</Function></FuncDef>
<ParamDef>Widget <Parameter>widget</parameter></paramdef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<para><function>XmTextGetCenterline</function> accesses the x position of the centerline in the
<literal>Text</literal> widget, relative to the x position of the top of the widget.
</para>
<VariableList>
<VarListEntry><term><Symbol Role="Variable">widget</Symbol></term>
<ListItem>
<para>Specifies the <literal>Text</literal> widget ID.
</para>
</ListItem>
</VarListEntry>
</variablelist>
</refsect1>
<refsect1><title>RETURN VALUE</title><para>In the case of horizontal writing, this function accesses 0.
<!-- 'vertical' in spec, but that would make no sense; one case is presumably horizontal. --></para><para>In the case of vertical writing, this function accesses the
x position of the first centerline in the Text widget,
relative to the x position of the left of the widget.
The calculation takes into account the margin width, shadow
thickness, highlight thickness, and a half of font width of
the first font(set) in the fontlist used for drawing text.
</para>
</refsect1>
<refsect1><title>SEE ALSO</title>
<para>&cdeman.XmText;, &cdeman.XmTextGetBaseline;
</para>
</refsect1>
</refentry>
