<!-- $XConsortium: StrTaC.sgm /main/8 1996/09/08 21:07:27 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.MAN447.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringTableProposeTablist</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringTableProposeTablist</Function></RefName>
<RefPurpose>A convenience function that returns a tab list
<IndexTerm>
<Primary>XmStringTableProposeTablist</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>XmTabList <Function>XmStringTableProposeTablist</Function></FuncDef>
<!--<ParamDef><Replaceable>strings, num_strings, widget, pad_value, offset_model</Replaceable></ParamDef>-->
<ParamDef>XmStringTable <Parameter>strings</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>num_strings</Parameter></ParamDef>
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>float <Parameter>pad_value</Parameter></ParamDef>
<ParamDef>XmOffsetModel <Parameter>offset_model</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmStringTableProposeTablist</Function> takes an <StructName Role="typedef">XmStringTable</StructName>
structure containing tabbed compound strings, information on padding
between columns, and rendering information and returns a tab list
that, if used to render the strings in the table, would cause the
strings to line up in columns with no overlap and with the specified
amount of padding between the widest item in each column and the start
of the next column. Each tab in the tablist would have the same unit
type as <Symbol Role="Variable">units</Symbol>, an offset model of <Symbol Role="Variable">offset_model</Symbol>, and an
alignment type of <SystemItem Class="Constant">XmALIGNMENT_BEGINNING</SystemItem>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">strings</Symbol></Term>
<ListItem>
<Para>Specifies an array of compound strings.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">num_strings</Symbol></Term>
<ListItem>
<Para>Specifies the number of compound strings in <Symbol Role="Variable">strings</Symbol>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the widget used for deriving any necessary information for
creating the rendition. In particular, the <SystemItem Class="Resource">XmNunitType</SystemItem> of
<Symbol Role="Variable">widget</Symbol> will be used to specify the unit type
to be used in determining the amount of padding
separating columns and for the tabs in the proposed tab list. Also,
<Symbol Role="Variable">widget</Symbol>'s render table will be used in interpreting rendition
tags within the strings.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">pad_value</Symbol></Term>
<ListItem>
<Para>Specifies the value of the amount of padding to be used to separate
columns.
The units for this parameter are specified as
the <SystemItem Class="Resource">XmNunitType</SystemItem> set for the <Symbol Role="Variable">widget</Symbol> parameter.
Refer to 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 the offset model to be used in creating the tabs. Can be
<SystemItem Class="Constant">XmABSOLUTE</SystemItem> or <SystemItem Class="Constant">XmRELATIVE</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a new <StructName Role="typedef">XmTabList</StructName>.
The function allocates space to hold the returned tab list.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XmTabListFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmTabList; and
&cdeman.XmTabListFree;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
