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

FreeBSD Manual Pages

  
 
  

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

NAME
       XmLabel -- The Label widget class

SYNOPSIS
       #include	<Xm/Label.h>

DESCRIPTION
       Label  is  an  instantiable widget and is also used as a	superclass for
       other button widgets, such as PushButton	and  ToggleButton.  The	 Label
       widget  does  not accept	any button or key input, and the help callback
       is the only callback defined.  Label  also  receives  enter  and	 leave
       events.

       Label  can  contain  either  text or a pixmap. Label text is a compound
       string. Refer to	the Motif Programmer's Guide for more  information  on
       compound	strings.  The text can be multilingual,	multiline, and/or mul-
       tifont. When a Label is insensitive, its	text is	stippled, or the user-
       supplied	insensitive pixmap is displayed.

       Label supports both accelerators	and mnemonics primarily	for use	in La-
       bel subclass widgets that are contained in menus.  Mnemonics are	avail-
       able  in	 a  menu system	when the button	is visible.  Accelerators in a
       menu system are accessible even when the	button is  not	visible.   The
       Label  widget  displays	the mnemonic by	underlining the	first matching
       character in the	text string.  The accelerator is displayed as  a  text
       string  adjacent	 to  the label text or pixmap, depending on the	layout
       direction.

       Label consists of many margin fields surrounding	the  text  or  pixmap.
       These  margin fields are	resources that may be set by the user, but La-
       bel subclasses and Manager parents also modify some  of	these  fields.
       They  tend  to  modify the XmNmarginLeft, XmNmarginRight, XmNmarginTop,
       and XmNmarginBottom resources and leave	the  XmNmarginWidth  and  XmN-
       marginHeight resources as set by	the application.

       Label  takes  into account XmNshadowThickness in	determining its	layout
       but does	not draw the shadow. That is, if XmNshadowThickness is greater
       than  0	(zero),	Label leaves space for the shadow, but the shadow does
       not appear.

       In a Label, XmNtraversalOn and XmNhighlightOnEnter are forced to	 False
       inside  Popup menu panes, Pulldown menu panes, and OptionMenus.	Other-
       wise, these resources default to	False.

       Label uses the XmQTmenuSystem and  XmQTspecifyRenderTable  traits,  and
       holds the XmQTaccessTextual, XmQTmenuSavvy, and XmQTtransfer traits.

   Data	Transfer Behavior
       Label  and  it  subclasses,  except when	used in	a menu system, support
       dragging	of the label contents from the Label.  However,	the label con-
       tents  are  draggable only if the XmNenableUnselectableDrag resource of
       XmDisplay is set	to True.

       As a source of data, Label and its  subclasses  support	the  following
       targets and associated conversions of data to these targets:

       locale	 If  the locale	target matches the widget's locale, the	widget
		 transfers XmNlabelString in the encoding of the locale.  This
		 target	  is   supported  when	XmNlabelType  is  XmSTRING  or
		 XmPIXMAP_AND_STRING.

       COMPOUND_TEXT
		 The widget transfers XmNlabelString  as  type	COMPOUND_TEXT.
		 This  target  is  supported  when XmNlabelType	is XmSTRING or
		 XmPIXMAP_AND_STRING.

       UTF8_STRING
		 The widget  transfers	XmNlabelString	as  type  UTF8_STRING.
		 This  target  is  supported  when XmNlabelType	is XmSTRING or
		 XmPIXMAP_AND_STRING.

       PIXMAP	 The widget transfers XmNlabelPixmap as	type  DRAWABLE.	  This
		 target	  is   supported  when	XmNlabelType  is  XmPIXMAP  or
		 XmPIXMAP_AND_STRING.

       STRING	 The widget transfers XmNlabelString  as  type	STRING.	  This
		 target	  is   supported  when	XmNlabelType  is  XmSTRING  or
		 XmPIXMAP_AND_STRING.

       TEXT	 If XmNlabelString is fully convertible	to the encoding	of the
		 locale,  the  widget transfers	XmNlabelString in the encoding
		 of the	locale.	 Otherwise,  the  widget  transfers  XmNlabel-
		 String	 as type COMPOUND_TEXT.	 This target is	supported only
		 when XmNlabelType is XmSTRING or XmPIXMAP_AND_STRING.

       _MOTIF_CLIPBOARD_TARGETS
		 The widget transfers, as type ATOM, a list of the targets  it
		 supports  for	the CLIPBOARD selection.  When XmNlabelType is
		 XmSTRING or XmPIXMAP_AND_STRING, these	include	the  following
		 targets:

		    o  _MOTIF_COMPOUND_STRING

		    o  COMPOUND_TEXT

		    o  UTF8_STRING

		    o  The  encoding of	the locale, if XmNlabelString is fully
		       convertible to the encoding of the locale

		    o  STRING,	if  XmNlabelString  is	fully  convertible  to
		       STRING

		 When  XmNlabelType  is	 XmPIXMAP  or XmPIXMAP_AND_STRING, the
		 targets include PIXMAP.

       _MOTIF_COMPOUND_STRING
		 The widget transfers XmNlabelString as	a compound  string  in
		 Byte  Stream format.  This target is supported	when XmNlabel-
		 Type is XmSTRING or XmPIXMAP_AND_STRING.

       _MOTIF_EXPORT_TARGETS
		 The widget transfers, as type ATOM, a list of the targets  to
		 be used as the	value of the DragContext's XmNexportTargets in
		 a drag-and-drop transfer.  When XmNlabelType is  XmSTRING  or
		 XmPIXMAP_AND_STRING,  these  include  _MOTIF_COMPOUND_STRING,
		 COMPOUND_TEXT,	 UTF8_STRING,  the  encoding  of  the  locale,
		 STRING,  TEXT,	BACKGROUND, and	FOREGROUND.  When XmNlabelType
		 is XmPIXMAP or	 XmPIXMAP_AND_STRING,  these  include  PIXMAP,
		 BACKGROUND, and FOREGROUND.

       As  a  source of	data, Label also supports the following	standard Motif
       targets:

       BACKGROUND
		 The widget transfers XmNbackground as type PIXEL.

       CLASS	 The widget finds the first shell in the widget	hierarchy that
		 has a WM_CLASS	property and transfers the contents as text in
		 the current locale.

       CLIENT_WINDOW
		 The widget finds the first shell in the widget	hierarchy  and
		 transfers its window as type WINDOW.

       COLORMAP	 The widget transfers XmNcolormap as type COLORMAP.

       FOREGROUND
		 The widget transfers XmNforeground as type PIXEL.

       NAME	 The widget finds the first shell in the widget	hierarchy that
		 has a WM_NAME property	and transfers the contents as text  in
		 the current locale.

       TARGETS	 The  widget transfers,	as type	ATOM, a	list of	the targets it
		 supports.  These include the standard targets in  this	 list.
		 When  XmNlabelType  is	XmSTRING or XmPIXMAP_AND_STRING, these
		 also	 include    _MOTIF_COMPOUND_STRING,	COMPOUND_TEXT,
		 UTF8_STRING,  the  encoding  of the locale, STRING, and TEXT.
		 When XmNlabelType is XmPIXMAP or  XmPIXMAP_AND_STRING,	 these
		 also include PIXMAP.

       TIMESTAMP The widget transfers the timestamp used to acquire the	selec-
		 tion as type INTEGER.

       _MOTIF_RENDER_TABLE
		 The widget transfers XmNrenderTable if	it exists, or else the
		 default text render table, as type STRING.

       _MOTIF_ENCODING_REGISTRY
		 The  widget  transfers	 its encoding registry as type STRING.
		 The value is a	list of	NULL separated items in	 the  form  of
		 tag encoding pairs.  This target symbolizes the transfer tar-
		 get for the Motif Segment Encoding Registry.  Widgets and ap-
		 plications  can  use  this Registry to	register text encoding
		 formats for specified render table tags.  Applications	access
		 this	Registry   by  calling	XmRegisterSegmentEncoding  and
		 XmMapSegmentEncoding.

   Classes
       Label inherits behavior,	resources, and traits from Core	 and  XmPrimi-
       tive.

       The class pointer is xmLabelWidgetClass.

       The class name is XmLabel.

   New Resources
       The  following table defines a set of widget resources used by the pro-
       grammer to specify data.	The programmer can also	set the	resource  val-
       ues  for	 the  inherited	 classes to set	attributes for this widget. To
       reference a resource by name or by class	in a .Xdefaults	 file,	remove
       the  XmN	or XmC prefix and use the remaining letters. To	specify	one of
       the defined values for a	resource in a .Xdefaults file, remove  the  Xm
       prefix and use the remaining letters (in	either lowercase or uppercase,
       but include any underscores between words).  The	codes  in  the	access
       column  indicate	if the given resource can be set at creation time (C),
       set by using XtSetValues	(S), retrieved by using	XtGetValues (G), or is
       not applicable (N/A).

       +------------------------------------------------------------------------------------------------------------+
       |			  |		   XmLabel Resource Set		  |			   |	    |
       |Name			  | Class		      |	Type		  | Default		   | Access |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNaccelerator		  | XmCAccelerator	      |	String		  | NULL		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNacceleratorText	  | XmCAcceleratorText	      |	XmString	  | NULL		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNalignment		  | XmCAlignment	      |	unsigned char	  | dynamic		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNfontList		  | XmCFontList		      |	XmFontList	  | dynamic		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNlabelInsensitivePixmap | XmCLabelInsensitivePixmap |	Pixmap		  | XmUNSPECIFIED_PIXMAP   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNlabelPixmap		  | XmCLabelPixmap	      |	Pixmap		  | XmUNSPECIFIED_PIXMAP   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNlabelString		  | XmCXmString		      |	XmString	  | dynamic		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNlabelType		  | XmCLabelType	      |	unsigned char	  | XmSTRING		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginBottom		  | XmCMarginBottom	      |	Dimension	  | 0			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginHeight		  | XmCMarginHeight	      |	Dimension	  | 2			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginLeft		  | XmCMarginLeft	      |	Dimension	  | 0			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginRight		  | XmCMarginRight	      |	Dimension	  | 0			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginTop		  | XmCMarginTop	      |	Dimension	  | 0			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmarginWidth		  | XmCMarginWidth	      |	Dimension	  | 2			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmnemonic		  | XmCMnemonic		      |	KeySym		  | NULL		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNmnemonicCharSet	  | XmCMnemonicCharSet	      |	String		  | XmFONTLIST_DEFAULT_TAG | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNpixmapPlacement	  | XmCPixmapPlacement	      |	unsigned int	  | XmPIXMAP_LEFT	   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNpixmapTextPadding	  | XmCSpace		      |	Dimension	  | 2			   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNrecomputeSize	  | XmCRecomputeSize	      |	Boolean		  | True		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNrenderTable		  | XmCRenderTable	      |	XmRenderTable	  | dynamic		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       |XmNstringDirection	  | XmCStringDirection	      |	XmStringDirection | dynamic		   | CSG    |
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       +--------------------------+---------------------------+-------------------+------------------------+--------+
       XmNaccelerator
		 Sets  the accelerator on a button widget in a menu, which ac-
		 tivates a visible or invisible, but managed, button from  the
		 keyboard.   This resource is a	string that describes a	set of
		 modifiers and the key that may	be used	to select the  button.
		 The  format  of  this string is identical to that used	by the
		 translations manager, with the	exception that only  a	single
		 event may be specified	and only KeyPress events are allowed.

		 Accelerators  for  buttons are	supported only for PushButtons
		 and ToggleButtons in Pulldown and Popup menu panes.

       XmNacceleratorText
		 Specifies the text displayed for the accelerator.   The  text
		 is  displayed adjacent	to the label string or pixmap. The di-
		 rection of its	layout depends on the  XmNlayoutDirection  re-
		 source	 of  the widget.  Accelerator text for buttons is dis-
		 played	only for PushButtons and ToggleButtons in Pulldown and
		 Popup Menus.

       XmNalignment
		 Specifies the label alignment for text	or pixmap.

		 XmALIGNMENT_BEGINNING (left alignment)
			   Causes  the	left  sides of the lines of text to be
			   vertically aligned with the left edge of the	widget
			   window.  For	 a pixmap, its left side is vertically
			   aligned with	the left edge of the widget window.

		 XmALIGNMENT_CENTER (center alignment)
			   Causes the centers of the lines of text to be  ver-
			   tically aligned in the center of the	widget window.
			   For a pixmap, its center is vertically aligned with
			   the center of the widget window.

		 XmALIGNMENT_END (right	alignment)
			   Causes  the	right sides of the lines of text to be
			   vertically aligned with the right edge of the  wid-
			   get	window.	For a pixmap, its right	side is	verti-
			   cally aligned with the right	 edge  of  the	widget
			   window.

		 The  preceding	descriptions for text are correct when XmNlay-
		 outDirection is XmLEFT_TO_RIGHT. When that  resource  is  Xm-
		 RIGHT_TO_LEFT,	the descriptions for XmALIGNMENT_BEGINNING and
		 XmALIGNMENT_END are switched.

		 If the	parent is a RowColumn whose XmNisAligned  resource  is
		 True, XmNalignment is forced to the same value	as the RowCol-
		 umn's XmNentryAlignment if the	 RowColumn's  XmNrowColumnType
		 is  XmWORK_AREA  or  if  the widget is	a subclass of XmLabel.
		 Otherwise, the	default	is XmALIGNMENT_CENTER.

       XmNfontList
		 Specifies the font of the  text  used	in  the	 widget.  XmN-
		 fontList is obsolete and exists for compatibility with	previ-
		 ous releases. You should now use  XmNrenderTable  instead  of
		 XmNfontList.  If  both	 are  specified, the render table will
		 take precedence. If XmNfontList is  NULL  at  initialization,
		 Label searches	its parent hierarchy for an ancestor that is a
		 subclass of the XmBulletinBoard, VendorShell, or  XmMenuShell
		 widget	class. If such an ancestor is found, Label initializes
		 XmNfontList to	the XmNlabelFontList of	the  ancestor  widget.
		 Similarly,  button subclasses of Label	initialize XmNfontList
		 to the	XmNbuttonFontList of the ancestor widget.  (Currently,
		 all  subclasses  of  Label are	button subclasses.) If no such
		 ancestor is found, the	default	is  implementation  dependent.
		 Refer	to  XmFontList(3) for more information on the creation
		 and structure of a font list.

       XmNlabelInsensitivePixmap
		 Specifies a pixmap used as the	button face if XmNlabelType is
		 XmPIXMAP  and	the button is insensitive.  The	default	value,
		 XmUNSPECIFIED_PIXMAP, displays	an empty label.

       XmNlabelPixmap
		 Specifies  the	 pixmap	 when  XmNlabelType  is	 XmPIXMAP   or
		 XmPIXMAP_AND_STRING.	  The	 default   value,   XmUNSPECI-
		 FIED_PIXMAP, displays an empty	label.

       XmNlabelString
		 Specifies the compound	string when XmNlabelType  is  XmSTRING
		 or  XmPIXMAP_AND_STRING.   If	this value is NULL, it is ini-
		 tialized by converting	the name of the	widget to  a  compound
		 string.   Refer  to  XmString(3)  for more information	on the
		 creation and structure	of compound strings.

       XmNlabelType
		 Specifies the label type.

		 XmSTRING  Displays text using XmNlabelString.

		 XmPIXMAP  Displays pixmap using XmNlabelPixmap	or

		 XmPIXMAP_AND_STRING
			   Displays text and pixmap  using  XmNlabelPixmap  or
			   XmNlabelInsensitivePixmap and XmNlabelString.

       XmNmarginBottom
		 Specifies the amount of spacing between the bottom of the la-
		 bel text and the top of the bottom margin specified  by  XmN-
		 marginHeight.	 This  may  be modified	by Label's subclasses.
		 For example, CascadeButton may	increase this  field  to  make
		 room for the cascade pixmap.

       XmNmarginHeight
		 Specifies an equal amount of spacing above the	margin defined
		 by XmNmarginTop and below the margin defined by XmNmarginBot-
		 tom.  XmNmarginHeight specifies the amount of spacing between
		 the top edge of the margin set	by XmNmarginTop	and the	bottom
		 edge of the top shadow, and the amount	of spacing between the
		 bottom	edge of	the margin specified  by  XmNmarginBottom  and
		 the top edge of the bottom shadow.

       XmNmarginLeft
		 Specifies  the	amount of spacing between the left edge	of the
		 label text and	the right side of the left  margin  (specified
		 by  XmNmarginWidth).	This  may  be modified by Label's sub-
		 classes. For example, ToggleButton may	increase this field to
		 make  room  for  the toggle indicator and for spacing between
		 the indicator and label.  Whether this	 actually  applies  to
		 the  left  or right side of the label depends on the value of
		 the XmNlayoutDirection	resource.

       XmNmarginRight
		 Specifies the amount of spacing between the right edge	of the
		 label	text  and the left side	of the right margin (specified
		 by XmNmarginWidth).  This may be  modified  by	 Label's  sub-
		 classes.  For	example, CascadeButton may increase this field
		 to make room for the cascade pixmap.  Whether	this  actually
		 applies to the	left or	right side of the label	depends	on the
		 value of the XmNlayoutDirection resource.

       XmNmarginTop
		 Specifies the amount of spacing between the top of the	 label
		 text and the bottom of	the top	margin specified by XmNmargin-
		 Height.  This may be modified by Label's subclasses. For  ex-
		 ample,	CascadeButton may increase this	field to make room for
		 the cascade pixmap.

       XmNmarginWidth
		 Specifies an equal amount of spacing to the left of the  mar-
		 gin  defined  by XmNmarginLeft	and to the right of the	margin
		 defined  by  XmNmarginRight.  XmNmarginWidth  specifies   the
		 amount	 of spacing between the	left edge of the margin	set by
		 XmNmarginLeft and the right edge of the left shadow, and  the
		 amount	of spacing between the right edge of the margin	speci-
		 fied by XmNmarginRight	and the	left edge of the right shadow.

       XmNmnemonic
		 Provides the user with	an alternate  means  of	 activating  a
		 button.  A button in a	MenuBar, a Popup menu pane, or a Pull-
		 down menu pane	can have a mnemonic.

		 This resource contains	a keysym as listed in the  X11	keysym
		 table.	  The first character in the label string that exactly
		 matches the mnemonic in the character set specified in	 XmNm-
		 nemonicCharSet	is underlined when the button is displayed.

		 When  a  mnemonic  has	been specified,	the user activates the
		 button	by pressing the	mnemonic key while the button is visi-
		 ble.	If  the	button is a CascadeButton in a MenuBar and the
		 MenuBar does not have the focus, the user must	use  the  MAlt
		 modifier  while pressing the mnemonic.	 The user can activate
		 the button by pressing	either the shifted  or	the  unshifted
		 mnemonic key.

       XmNmnemonicCharSet
		 Specifies  the	 character  set	of the mnemonic	for the	label.
		 The default is	XmFONTLIST_DEFAULT_TAG.

       XmNpixmapPlacement
		 The location of the pixmap with respect to  the  text	label.
		 This	resource   can	take  one  of  the  following  values:
		 XmPIXMAP_TOP,	   XmPIXMAP_BOTTOM,	XmPIXMAP_LEFT,	   and
		 XmPIXMAP_RIGHT.  A  type  converter  has been registered that
		 converts the following	strings: "top",	"bottom", "left",  and
		 "right".

       XmNpixmapTextPadding
		 The amount of space to	be left	between	the pixmap and the la-
		 bel string.

       XmNrecomputeSize
		 Specifies a Boolean value that	indicates whether  the	widget
		 shrinks  or expands to	accommodate its	contents (label	string
		 or pixmap) as a result	of an XtSetValues resource value  that
		 would	change	the  size  of  the widget. If True, the	widget
		 shrinks or expands to exactly fit the label string or pixmap.
		 If  False,  the  widget  never	attempts to change size	on its
		 own.

       XmNrenderTable
		 Specifies the render table associated with  the  labelString.
		 If  this  value is NULL at initialization, Label searches its
		 parent	hierarchy for an ancestor that	holds  the  XmQTspeci-
		 fyRenderTable	trait.	 If  such  an ancestor is found, Label
		 initializes XmNrenderTable to the XmLABEL_RENDER_TABLE	 value
		 of the	ancestor widget. Similarly, button subclasses of Label
		 initialize XmNrenderTable to the XmBUTTON_RENDER_TABLE	 value
		 of  the ancestor widget. (Note	that all current subclasses of
		 Label are button subclasses.) If no such ancestor  is	found,
		 the default is	implementation dependent. If a font list and a
		 render	table are both sepcified, the render table  will  take
		 precedence. Refer to XmRenderTable(3) for more	information on
		 the creation and structure of a render	table.

       XmNstringDirection
		 Is a synthetic	resource for setting XmNlayoutDirection.   The
		 values	 for  this  resource are XmSTRING_DIRECTION_L_TO_R and
		 XmSTRING_DIRECTION_R_TO_L. Refer  to  the  XmNlayoutDirection
		 resource  description.	The XmNstringDirection resource	is ob-
		 soleted by XmNlayoutDirection,	but is kept here for  backward
		 compatibility.

   Inherited Resources
       Label  inherits behavior	and resources from the following superclasses.
       For a complete description of each resource,  refer  to	the  reference
       page for	that superclass.

       +---------------------------------------------------------------------------------------------------+
       |			|	     XmPrimitive|Resource Set	   |			  |	   |
       |Name			| Class			| Type		   | Default		  | Access |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNbottomShadowColor	| XmCBottomShadowColor	| Pixel		   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNbottomShadowPixmap	| XmCBottomShadowPixmap	| Pixmap	   | XmUNSPECIFIED_PIXMAP | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNconvertCallback	| XmCCallback		| XtCallbackList   | NULL		  | C	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNforeground		| XmCForeground		| Pixel		   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNhelpCallback		| XmCCallback		| XtCallbackList   | NULL		  | C	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNhighlightColor	| XmCHighlightColor	| Pixel		   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNhighlightOnEnter	| XmCHighlightOnEnter	| Boolean	   | False		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNhighlightPixmap	| XmCHighlightPixmap	| Pixmap	   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNhighlightThickness	| XmCHighlightThickness	| Dimension	   | 0			  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNlayoutDirection	| XmCLayoutDirection	| XmDirection	   | dynamic		  | CG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNnavigationType	| XmCNavigationType	| XmNavigationType | XmNONE		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNpopupHandlerCallback	| XmCCallback		| XtCallbackList   | NULL		  | C	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNshadowThickness	| XmCShadowThickness	| Dimension	   | 0			  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNtopShadowColor	| XmCTopShadowColor	| Pixel		   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNtopShadowPixmap	| XmCTopShadowPixmap	| Pixmap	   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNtraversalOn		| XmCTraversalOn	| Boolean	   | False		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNunitType		| XmCUnitType		| unsigned char	   | dynamic		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       |XmNuserData		| XmCUserData		| XtPointer	   | NULL		  | CSG	   |
       +------------------------+-----------------------+------------------+----------------------+--------+
       +------------------------+-----------------------+------------------+----------------------+--------+
       +---------------------------------------------------------------------------------------------------------------+
       |			      |		      Core Resource SetName			      |	Class			      |	Type	       | Default	      |	Access |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNaccelerators		      |	XmCAccelerators		      |	XtAccelerators | dynamic	      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNancestorSensitive	      |	XmCSensitive		      |	Boolean	       | dynamic	      |	G      |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNbackground		      |	XmCBackground		      |	Pixel	       | dynamic	      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNbackgroundPixmap	      |	XmCPixmap		      |	Pixmap	       | XmUNSPECIFIED_PIXMAP |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNborderColor		      |	XmCBorderColor		      |	Pixel	       | XtDefaultForeground  |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNborderPixmap		      |	XmCPixmap		      |	Pixmap	       | XmUNSPECIFIED_PIXMAP |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNborderWidth		      |	XmCBorderWidth		      |	Dimension      | 0		      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNcolormap		      |	XmCColormap		      |	Colormap       | dynamic	      |	CG     |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNdepth		      |	XmCDepth		      |	int	       | dynamic	      |	CG     |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNdestroyCallback	      |	XmCCallback		      |	XtCallbackList | NULL		      |	C      |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNheight		      |	XmCHeight		      |	Dimension      | dynamic	      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNinitialResourcesPersistent |	XmCInitialResourcesPersistent |	Boolean	       | True		      |	C      |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNmappedWhenManaged	      |	XmCMappedWhenManaged	      |	Boolean	       | True		      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNscreen		      |	XmCScreen		      |	Screen *       | dynamic	      |	CG     |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNsensitive		      |	XmCSensitive		      |	Boolean	       | True		      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNtranslations		      |	XmCTranslations		      |	XtTranslations | dynamic	      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNwidth		      |	XmCWidth		      |	Dimension      | dynamic	      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNx			      |	XmCPosition		      |	Position       | 0		      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       |XmNy			      |	XmCPosition		      |	Position       | 0		      |	CSG    |
       +------------------------------+-------------------------------+----------------+----------------------+--------+
       +------------------------------+-------------------------------+----------------+----------------------+--------+
   Translations
       XmLabel includes	translations from Primitive.  The XmLabel translations
       are described in	the following list.

       The following key names are listed in the X standard key	event transla-
       tion table syntax.  This	format is the one used by Motif	to specify the
       widget actions corresponding to a given key.  A brief overview  of  the
       format  is  provided under VirtualBindings(3).  For a complete descrip-
       tion of the format, please refer	to the X Toolkit Instrinsics  Documen-
       tation.

       <Btn2Down>:
		 ProcessDrag()

       :<Key><osfHelp>:
		 Help()

       The  translations  used by subclasses of	XmLabel	for menu traversal are
       described in the	following list.

       :<Key><osfCancel>:
		 MenuEscape()

       :<Key><osfLeft>:
		 MenuTraverseLeft()

       :<Key><osfRight>:
		 MenuTraverseRight()

       :<Key><osfUp>:
		 MenuTraverseUp()

       :<Key><osfDown>:
		 MenuTraverseDown()

   Action Routines
       The XmLabel action routines are

       Help():	 In a Popup or Pulldown	MenuPane, unposts  all	menus  in  the
		 menu hierarchy	and, when the shell's keyboard focus policy is
		 XmEXPLICIT, restores keyboard focus to	the  widget  that  had
		 the  focus  before  the  menu	system was entered.  Calls the
		 callbacks for XmNhelpCallback if any exist.  If there are  no
		 help  callbacks  for  this widget, this action	calls the help
		 callbacks for the nearest ancestor that has them.

       MenuEscape():
		 In a MenuBar, disarms the CascadeButton  and  the  menu  and,
		 when  the  shell's  keyboard  focus policy is XmEXPLICIT, re-
		 stores	keyboard focus to the widget that had the focus	before
		 the menu was entered.

		 In  a top-level Pulldown MenuPane from	a MenuBar, unposts the
		 menu, disarms the MenuBar CascadeButton and the MenuBar, and,
		 when  the  shell's  keyboard  focus policy is XmEXPLICIT, re-
		 stores	keyboard focus to the widget that had the focus	before
		 the  MenuBar  was  entered.  In other Pulldown	MenuPanes, un-
		 posts the menu	and moves the focus to its CascadeButton.

		 In a Popup MenuPane, unposts the menu and, when  the  shell's
		 keyboard  focus policy	is XmEXPLICIT, restores	keyboard focus
		 to the	widget from which the menu was posted.

       MenuTraverseDown():
		 If the	current	menu item has a	submenu	and is in  a  MenuBar,
		 then  this action posts the submenu, disarms the current menu
		 item, and arms	the submenu's first traversable	menu item.

		 If the	current	menu item is in	a MenuPane, then  this	action
		 disarms  the  current	menu  item and arms the	item below it.
		 This action wraps within the MenuPane.	The direction  of  the
		 wrapping depends on the XmNlayoutDirection resource.

       MenuTraverseLeft():
		 When  the current menu	item is	in a MenuBar, then this	action
		 disarms the current item and arms the	MenuBar	 item  to  the
		 left.	This action wraps within the MenuBar.

		 In  MenuPanes,	 if  the  current menu item is not at the left
		 edge of a MenuPane, this action disarms the current item  and
		 arms  the  item  to its left.	If the current menu item is at
		 the left edge of a submenu attached to	a MenuBar  item,  then
		 this  action unposts the submenu and traverses	to the MenuBar
		 item to the left, wrapping if necessary. If that MenuBar item
		 has  a	 submenu, it posts the submenu and arms	the first tra-
		 versable item in the submenu.	If the current menu item is at
		 the left edge of a submenu not	directly attached to a MenuBar
		 item, then this action	unposts	the current submenu only.

		 In Popup or Torn-off MenuPanes, when the current menu item is
		 at  the  left edge, this action wraps within the MenuPane. If
		 the current menu item is at the left edge of the MenuPane and
		 not  in  the top row, this action wraps to the	rightmost menu
		 item in the row above.	If the current menu item is in the up-
		 per,  leftmost	corner,	this action wraps to the tear-off con-
		 trol, if present, or else it wraps to the  bottom,  rightmost
		 menu item in the MenuPane.  The preceding description applies
		 when  the  XmNlayoutDirection	horizontal  direction  is  Xm-
		 LEFT_TO_RIGHT.	If the XmNlayoutDirection horizontal direction
		 is XmRIGHT_TO_LEFT, then the following	applies.

		 If the	current	menu item is in	a MenuBar,  then  this	action
		 disarms  the  current	item  and arms the MenuBar item	to the
		 left.	This action wraps within the MenuBar.

		 In MenuPanes, if the current menu item	 is  a	CascadeButton,
		 then  this  action posts its associated submenu.  If the cur-
		 rent menu item	is not a CascadeButton and is not at the  left
		 edge  of a MenuPane, this action disarms the current item and
		 arms the item to its left, wrapping  if  necessary.   If  the
		 current  menu	item is	not a CascadeButton and	is at the left
		 edge of a submenu that	is a descendent	 of  a	MenuBar,  then
		 this action unposts all submenus and traverses	to the MenuBar
		 item to the left.  If that MenuBar item  has  a  submenu,  it
		 posts	the  submenu  and arms the submenu's first traversable
		 item.

		 In Popup or Torn-off menus, if	the current menu item is not a
		 CascadeButton	and  is	 at the	left edge of a row (except the
		 bottom	row), this action wraps	to the rightmost menu item  in
		 the  row below. If the	current	menu item is not a CascadeBut-
		 ton and is in the bottom, leftmost corner of a	Popup or Pull-
		 down  MenuPane, this action wraps to the tear-off control, if
		 present, or else it wraps to the top, rightmost menu item  of
		 the MenuPane.

       MenuTraverseRight():
		 If  the  current  menu	item is	in a MenuBar, then this	action
		 disarms the current item and arms the	MenuBar	 item  to  the
		 right.	 This action wraps within the MenuBar.

		 In  MenuPanes,	 if  the current menu item is a	CascadeButton,
		 then this action posts	its associated submenu.	 If  the  cur-
		 rent menu item	is not a CascadeButton and is not at the right
		 edge of a MenuPane, this action disarms the current item  and
		 arms  the  item  to its right,	wrapping if necessary.	If the
		 current menu item is not a CascadeButton and is at the	 right
		 edge  of  a  submenu  that is a descendent of a MenuBar, then
		 this action unposts all submenus and traverses	to the MenuBar
		 item  to  the	right.	If that	MenuBar	item has a submenu, it
		 posts the submenu and arms the	 submenu's  first  traversable
		 item.

		 In Popup or Torn-off menus, if	the current menu item is not a
		 CascadeButton and is at the right edge	of a row  (except  the
		 bottom	 row),	this action wraps to the leftmost menu item in
		 the row below.	If the current menu item is not	a  CascadeBut-
		 ton  and  is  in  the	bottom,	rightmost corner of a Popup or
		 Pulldown MenuPane, this action	wraps to the tear-off control,
		 if  present,  or else it wraps	to the top, leftmost menu item
		 of the	MenuPane.  The preceding description applies when  the
		 XmNlayoutDirection  horizontal	 direction is XmLEFT_TO_RIGHT.
		 If  the  XmNlayoutDirection  horizontal  direction   is   Xm-
		 RIGHT_TO_LEFT,	 then the following applies.  When the current
		 menu item is in a MenuBar, then this action disarms the  cur-
		 rent item and arms the	MenuBar	item to	the left.  This	action
		 wraps within the MenuBar.

		 In MenuPanes, if the current menu item	is not	at  the	 right
		 edge  of a MenuPane, this action disarms the current item and
		 arms the item to its right.  If the current menu item	is  at
		 the  right edge of a submenu attached to a MenuBar item, then
		 this action unposts the submenu and traverses to the  MenuBar
		 item  to  the	right,	wrapping if necessary. If that MenuBar
		 item has a submenu, it	posts the submenu and arms  the	 first
		 traversable item in the submenu.  If the current menu item is
		 at the	right edge of a	submenu	not  directly  attached	 to  a
		 MenuBar  item,	 then  this action unposts the current submenu
		 only.

		 In Popup or Torn-off MenuPanes, when the current menu item is
		 at  the right edge, this action wraps within the MenuPane. If
		 the current menu item is at the right edge  of	 the  MenuPane
		 and  not  in  the  top	row, this action wraps to the leftmost
		 menu item in the row above. If	the current menu  item	is  in
		 the  upper,  rightmost	corner,	this action wraps to the tear-
		 off control, if present, or else  it  wraps  to  the  bottom,
		 leftmost menu item in the MenuPane.

       MenuTraverseUp():
		 When the current menu item is in a MenuPane, then this	action
		 disarms the current menu item and arms	 the  item  above  it.
		 This  action  wraps within the	MenuPane. The direction	of the
		 wrapping depends on the XmNlayoutDirection resource.

       ProcessDrag():
		 Drags the contents of a Label,	identified when	 BTransfer  is
		 pressed.  This	action sets the	XmNconvertProc of the DragCon-
		 text to a function that calls the  XmNconvertCallback	proce-
		 dures,	 possibly  multiple  times, for	the _MOTIF_DROP	selec-
		 tion.	This action is undefined for Labels  used  in  a  menu
		 system.

   Virtual Bindings
       The  bindings  for  virtual  keys are vendor specific.  For information
       about bindings for virtual buttons and keys, see	VirtualBindings(3).

RELATED
       Core(3),	XmCreateLabel(3), XmFontListAppendEntry(3), XmStringCreate(3),
       XmStringCreateLtoR(3), XmPrimitive(3), XmVaCreateLabel(3), and XmVaCre-
       ateManagedLabel(3).

								    XmLabel(3)

NAME | SYNOPSIS | DESCRIPTION | RELATED

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XmLabel&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help