1XmStringTableProposeTablist(library caXlmlS)tringTableProposeTablist(library call)
2
3
4

NAME

6       XmStringTableProposeTablist — A convenience function that returns a tab
7       list
8

SYNOPSIS

10       #include <Xm/Xm.h>
11       XmTabList XmStringTableProposeTablist(
12       XmStringTable strings,
13       Cardinal num_strings,
14       Widget widget,
15       float pad_value,
16       XmOffsetModel offset_model);
17

DESCRIPTION

19       XmStringTableProposeTablist takes an XmStringTable structure containing
20       tabbed  compound  strings,  information on padding between columns, and
21       rendering information and returns a tab list that, if  used  to  render
22       the strings in the table, would cause the strings to line up in columns
23       with no overlap and with the specified amount of  padding  between  the
24       widest  item  in each column and the start of the next column. Each tab
25       in the tablist would have the same unit type as units, an offset  model
26       of offset_model, and an alignment type of XmALIGNMENT_BEGINNING.
27
28       strings   Specifies an array of compound strings.
29
30       num_strings
31                 Specifies the number of compound strings in strings.
32
33       widget    Specifies the widget used for deriving any necessary informa‐
34                 tion for creating the rendition. In particular, the  XmNunit‐
35                 Type  of  widget  will be used to specify the unit type to be
36                 used in determining the amount of padding separating  columns
37                 and  for  the  tabs  in the proposed tab list. Also, widget's
38                 render table will be  used  in  interpreting  rendition  tags
39                 within the strings.
40
41       pad_value Specifies  the  value  of the amount of padding to be used to
42                 separate columns.  The units for this parameter are specified
43                 as  the  XmNunitType  set for the widget parameter.  Refer to
44                 the XmNunitType  resource  of  the  XmGadget,  XmManager,  or
45                 XmPrimitive reference page.
46
47       offset_model
48                 Specifies  the  offset model to be used in creating the tabs.
49                 Can be XmABSOLUTE or XmRELATIVE.
50

RETURN

52       Returns a new XmTabList.  The function  allocates  space  to  hold  the
53       returned  tab  list.   The  application is responsible for managing the
54       allocated space.  The application can recover the  allocated  space  by
55       calling XmTabListFree.
56
58       XmTabList(3) and XmTabListFree(3).
59
60
61
62                                     XmStringTableProposeTablist(library call)
Impressum