Ubuntu Manpage: XmLabel — The Label widget class "XmLabel" "widget class" "Label"

Provided by: libmotif-dev_2.3.8-2build1_amd64

NAME

       XmLabel — The Label widget class "XmLabel" "widget class" "Label"

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 multifont. 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 Label subclass widgets that are
contained in menus. Mnemonics are available 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 Label 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 XmNmarginHeight 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. Otherwise, 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 contents 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 XmNlabelString
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:

• _MOTIF_COMPOUND_STRING

• COMPOUND_TEXT

• UTF8_STRING

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

• 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 XmNlabelType 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 selection 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 target
for the Motif Segment Encoding Registry. Widgets and applications 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 XmPrimitive.

The class pointer is xmLabelWidgetClass.

The class name is XmLabel.

New Resources
The following table defines a set of widget resources used by the programmer to specify data. The
programmer can also set the resource values 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).

┌────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
--

       Core(3),   XmCreateLabel(3),    XmFontListAppendEntry(3),    XmStringCreate(3),    XmStringCreateLtoR(3),
       XmPrimitive(3), XmVaCreateLabel(3), and XmVaCreateManagedLabel(3).

                                                                                                      XmLabel(3)

NAME

SYNOPSIS

DESCRIPTION

RELATED