<!-- $XConsortium: TabCre.sgm /main/8 1996/09/08 21:08:31 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.MAN454.rsml.1">
<RefMeta>
<RefEntryTitle>XmTabCreate</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTabCreate</Function></RefName>
<RefPurpose>A convenience function that creates a tab stop
<IndexTerm>
<Primary>XmTabCreate</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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>XmTab <Function>XmTabCreate</Function></FuncDef>
<!--<ParamDef><Replaceable>value, units, offset_model, alignment, decimal</Replaceable></ParamDef>-->
<ParamDef>float <Parameter>value</Parameter></ParamDef>
<ParamDef>unsigned char <Parameter>units</Parameter></ParamDef>
<ParamDef>XmOffsetModel <Parameter>offset_model</Parameter></ParamDef>
<ParamDef>unsigned char <Parameter>alignment</Parameter></ParamDef>
<ParamDef>char <Parameter>*decimal</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTabCreate</Function> creates a tab stop at a position defined by the
<Symbol Role="Variable">value</Symbol> and <Symbol Role="Variable">units</Symbol> arguments.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">value</Symbol></Term>
<ListItem>
<Para>Specifies the floating point value to be used in conjunction
with <Symbol Role="Variable">units</Symbol> to calculate the location of the tab stop.
Note that negative values are not permitted.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">units</Symbol></Term>
<ListItem>
<Para>Specifies the unit type (for example, <SystemItem Class="Constant">XmMILLIMETERS</SystemItem>)
to be used in conjunction with <Symbol Role="Variable">value</Symbol>
to calculate the location of the tab stop. You can specify
any unit described by the <Function>XmConvertUnits</Function> reference page.
For resources of type, dimension, or position, you can specify units
as described in the <SystemItem Class="Resource">XmNunitType</SystemItem> resource of the
<Classname>XmGadget</Classname>, <Classname>XmManager</Classname>, or <Classname>XmPrimitive</Classname> reference page.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">offset_model</Symbol></Term>
<ListItem>
<Para>Specifies whether the tab value represents an absolute position or a
relative offset from the previous tab. Valid values are
<SystemItem Class="Constant">XmABSOLUTE</SystemItem> and <SystemItem Class="Constant">XmRELATIVE</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">alignment</Symbol></Term>
<ListItem>
<Para>Specifies how the text should be aligned relative to this tab stop.
Valid values are <SystemItem Class="Constant">XmALIGNMENT_BEGINNING</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">decimal</Symbol></Term>
<ListItem>
<Para>Specifies the multibyte character in the current language environment
to be used as the decimal point for a decimal aligned tab stop. This
is currently unused.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a newly allocated <StructName Role="typedef">XmTab</StructName>.
The application is responsible for managing this allocated space.
The application can recover this allocated space by calling <Function>XmTabFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmTab; and
&cdeman.XmTabFree;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
