Blob Blame History Raw
'\" t
...\" StrTaC.sgm /main/8 1996/09/08 21:07:27 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmStringTableProposeTablist" "library call"
.SH "NAME"
\fBXmStringTableProposeTablist\fP \(em A convenience function that returns a tab list
.iX "XmStringTableProposeTablist"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBXmTabList \fBXmStringTableProposeTablist\fP\fR(
\fBXmStringTable \fBstrings\fR\fR,
\fBCardinal \fBnum_strings\fR\fR,
\fBWidget \fBwidget\fR\fR,
\fBfloat \fBpad_value\fR\fR,
\fBXmOffsetModel \fBoffset_model\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmStringTableProposeTablist\fP takes an \fBXmStringTable\fR
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 \fIunits\fP, an offset model of \fIoffset_model\fP, and an
alignment type of \fBXmALIGNMENT_BEGINNING\fP\&.
.IP "\fIstrings\fP" 10
Specifies an array of compound strings\&.
.IP "\fInum_strings\fP" 10
Specifies the number of compound strings in \fIstrings\fP\&.
.IP "\fIwidget\fP" 10
Specifies the widget used for deriving any necessary information for
creating the rendition\&. In particular, the \fBXmNunitType\fP of
\fIwidget\fP 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,
\fIwidget\fP\&'s render table will be used in interpreting rendition
tags within the strings\&.
.IP "\fIpad_value\fP" 10
Specifies the value of the amount of padding to be used to separate
columns\&.
The units for this parameter are specified as
the \fBXmNunitType\fP set for the \fIwidget\fP parameter\&.
Refer to the \fBXmNunitType\fP resource of the
\fBXmGadget\fP, \fBXmManager\fP, or \fBXmPrimitive\fP reference page\&.
.IP "\fIoffset_model\fP" 10
Specifies the offset model to be used in creating the tabs\&. Can be
\fBXmABSOLUTE\fP or \fBXmRELATIVE\fP\&.
.SH "RETURN"
.PP
Returns a new \fBXmTabList\fR\&.
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 \fBXmTabListFree\fP\&.
.SH "RELATED"
.PP
\fBXmTabList\fP(3) and
\fBXmTabListFree\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:32