Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
XmColumn(3)		    Library Functions Manual		     XmColumn(3)

NAME
     XmColumn -- The XmColumn widget class

SYNOPSIS
     #include <Xm/Column.h>

DESCRIPTION
     XmColumn  displays  its children stacked in a column, each with an optional
     associated label: labels appear in one column,  and  children  in	another.
     This  is useful for displaying, for example, labeled data-entry fields.  It
     can also display all label-child pairs  in  a  horizontal	orientation.This
     widget  offers  several  constraint  resources  that allow specification of
     characteristics of the label, such as displaying text or a  pixmap,  align-
     ment  of  text, font to use, and so forth. It also offers several resources
     for setting defaults for children that specify no specic values.

Classes
     XmColumn inherits behavior and resources from Core, Composite,  Constraint,
     XmManager, and XmBulletinBoard.

     The class pointer is xmColumnWidgetClass.

     The class name is XmColumn.

   New Resources
     The  following table defines a set of widget resources used by the program-
     mer to specify data. The programmer can also set the  resource  values  for
     the inherited classes to set attributes for this widget. To reference a re-
     source by name or by class in a .Xdefaults file, remove the XmN or XmC pre-
     fix  and  use  the remaining letters (in either lowercase or uppercase, but
     include any underscores between words). The codes in the access column  in-
     dicate  if  the  given resource can be at createion time (C), or is not ap-
     plicable (N/A).
     +----------------------------------------------------------------------------------------------------+
     |				       |     XmColumn Resource Set	 |			 |	  |
     | Name			       | Class		 | Type 	 | Default		 | Access |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNdefaultEntryLabelAlignment   | XmCAlignment	 | unsigned char | XmALIGNMENT_BEGINNING | CSG	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNdefaultEntryLabelFontList    | XmCFontList	 | XmRFontList	 | dynamic		 | CGS	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNdefaultEntryLabelRenderTable | XmCRendertable  | XmRFontList	 | dynamic		 | CGS	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNdefaultFillStyle	       | XmCFillStyle	 | unsigned char | XmFILL_RAGGED	 | CGS	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNdistribution		       | XmCDistribution | unsigned char | XmDISTRIBUTE_TIGHT	 | CGS	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNitemSpacing		       | XmCItemSpacing  | Dimension	 | 2			 | CSG	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNlabelSpacing		       | XmCLabelSpacing | Dimentsion	 | 10			 | CSG	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     | XmNorientation		       | XmCOrientation  | unsigned char | XmVERTICAL		 | CSG	  |
     +---------------------------------+-----------------+---------------+-----------------------+--------+
     +---------------------------------+-----------------+---------------+-----------------------+--------+

     XmNdefaultEntryLabelAlignment
	       Specifies the default XmNentryLabelAlignment to use when a  child
	       specifies no significant value.	Resources that specify Alignment
	       have values of XmALIGNMENT_BEGINNING,
	       XmALIGNMENT_CENTER, XmALIGNMENT_END, and XmALIGNMENT_UNSPECIFIED.
	       Valid  string  values  that  can be used in a resources file are:
	       alignment_unspecified, unspecified,  alignment_beginning,  begin-
	       ning, alignment_center, center, alignment_end, end.

     XmNdefaultEntryLabelFontList
	       Specifies  the  default XmNentryLabelFontList to use when a child
	       specifies no significant value. If  unspecified,  uses  XmNlabel-
	       FontList resource of the XmBulletinBoard.

     XmNdefaultFillStyle
	       Specifies  the default XmNfillStyle to use when a child specifies
	       no significant value.

     XmNdistribution
	       Specifies whether the spacing between each pair of rows should be
	       increased  equally  (XmDISTRIBUTE_SPREAD)  or   remain	constant
	       (XmDISTRIBUTE_TIGHT)  when the column is resized vertically to be
	       larger than its natural size. This resource has no effect if  any
	       child has its
	       XmNstretchable  resource set to True. This resource is valid only
	       when the orientation is vertical.

     XmNitemSpacing
	       Specifies the spacing between each pair of rows (in vertical ori-
	       entation) or between pairs of labels and children (in  horizontal
	       orientation).

     XmNlabelSpacing
	       Specifies  the  spacing	between the column containing the labels
	       and the column containing the XmColumn's children.

     XmNorientation
	       Specifies the layout direction of the XmColumn. When  XmVERTICAL,
	       the  widgets and their associated labels are laid out in two ver-
	       tical columns. When XmHORIZONTAL, the widgets and  their  associ-
	       ated labels are laid out in a single row.

     The  visual  appearance  of  columns  is affected by setting constraint re-
     sources on the children of the XmColumn.  These resources are derived  from
     those  supported by XmLabel; see the manual page for XmLabel for valid val-
     ues and usage.

     +------------------------------------------------------------------------------------------------+
     |				|     XmColumn Constraint Resource Set			   |	      |
     | Name			| Class 	 | Type 	 | Default		   | AccessfP |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelAlignment	| XmCAlignment	 | unsigned char | XmALIGNMENT_UNSPECIFIED | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelFontList	| XmCFontList	 | XmFontList	 | dynamic		   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelRenderTable | XmCRenderTable | XmRenderTable | dynamic		   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelPixmap	| XmCLabelPixmap | Pixmap	 | XmUNPECIFIED_PIXMAP	   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelString	| XmCLabelString | XmString	 | NULL 		   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNentryLabelType	| XmCLabelType	 | unsigned char | XmSTRING		   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNfillStyle		| XmCFillStyle	 | unsigned char | XmFILL_UNSPECIFIED	   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNshowEntryLabel	| XmCShowLabel	 | Boolean	 | True 		   | CSG      |
     +--------------------------+----------------+---------------+-------------------------+----------+
     | XmNstretchable		| XmCStretchable | Boolean	 | False		   | CG       |
     +--------------------------+----------------+---------------+-------------------------+----------+
     +--------------------------+----------------+---------------+-------------------------+----------+

     XmNentryLabelAlignment
	       Specifies justification of text within the child's associated la-
	       bel. Valid values are the same as  those  for  XmNdefaultEntryLa-
	       belAlignment.

     mNentryLabelFontList
	       Specifies fontList used to render the text within the child's as-
	       sociated label.

     XmNentryLabelPixmap
	       Specifies the pixmap used in the child's associated label.

     XmNentryLabelString
	       Specifies the text used in the child's associated label.

     XmNentryLabelType
	       Specifies  whether  to  display	a  string (XmSTRING) or a pixmap
	       (XmPIXMAP) in the child's associated label.

     XmNfillStyle
	       Specifies whether the child should be displayed	at  its  natural
	       size (XmFILL_RAGGED) or stretched to fill the entire width of the
	       column it is displayed within (XmFILL_FLUSH).
	       XmFILL_UNSPECIFIED  uses  the value of the XmColumn's XmNdefault-
	       FillStyle.

     XmNshowEntryLabel
	       Specifies whether or not to display the child's associated label.

     XmNstretchable
	       Specifies whether the child should expand in size proportionately
	       when the XmColumn is resized vertically to  be  larger  than  its
	       natural size.

RELATED
     Composite(3), Core(3), XmBulletinBoard(3), XmCreateColumn(3), XmManager(3),
     XmVaCreateColumn(3), and XmVaCreateManagedColumn(3).

VERSION
     This manual page documents the XmColumn widget shipped in Motif version 2.2

								     XmColumn(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmColumn&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help