DwtLabel(3Dwt) DwtLabel(3Dwt)
Name
DwtLabel, DwtLabelCreate - Creates a label widget for the application to display identification information (label) on the screen.
Syntax
Widget DwtLabel(parent_widget, name, x, y, label, help_callback)
Widget parent_widget;
char *name;
Position x, y;
DwtCompString label;
DwtCallbackPtr help_callback;
Widget DwtLabelCreate (parent_widget, name,
override_arglist, override_argcount)
Widget parent_widget;
char *name;
ArgList override_arglist;
int override_argcount;
Arguments
parent_widget
Specifies the parent widget ID.
name Specifies the name of the created widget.
x Specifies the placement, in pixels, of the left side of the widget window relative to the inner upper left corner of the parent
window. This argument sets the DwtNx core widget attribute.
y Specifies, in pixels, the placement of the upper left corner of the widget window relative to the inner upper left corner of the
parent window. This argument sets the DwtNy core widget attribute.
label Specifies the label for the text style. This argument sets the DwtNlabel attribute associated with DwtLabelCreate.
help_callback
Specifies the callback function or functions called when a help request is made. This argument sets the DwtNhelpCallback common
widget attribute.
override_arglist
Specifies the application override argument list.
override_argcount
Specifies the number of attributes in the application override argument list (override_arglist).
Description
The DwtLabel and DwtLabelCreate functions create an instance of a label widget and return its associated widget ID. When calling DwtLabel,
you set the label widget attributes presented in the formal parameter list. For DwtLabelCreate, however, you specify a list of attribute
name/value pairs that represent all the possible label widget attributes.
The application uses the label widget to display read only information (label) anywhere within the parent widget window. It has no stan-
dard callback other than DwtNhelpCallback.
Because a label widget does not support children, it always refuses geometry requests. The label widget does nothing on a resize by its
parents.
Inherited Attributes
------------------------------------------------------------------
Attribute Name Data Type Default
------------------------------------------------------------------
Core Attributes
DwtNx Position Determined by the geome-
try manager
DwtNy Position Determined by the geome-
try manager
DwtNwidth Dimension The width of the label
or pixmap, plus two
times DwtNmarginWidth
DwtNheight Dimension The height of the label
or pixmap, plus two
times DwtNmarginHeight
DwtNborderWidth Dimension zero pixels
DwtNborder Pixel Default foreground color
DwtNborderPixmap Pixmap NULL
DwtNbackground Pixel Default background color
DwtNbackgroundPixmap Pixmap NULL
DwtNcolormap Colormap Default color map
DwtNsensitive Boolean True
DwtNancestorSensitive Boolean The bitwise AND of the
parent widget's DwtNsen-
sitive and DwtNances-
torSensitive attributes
DwtNaccelerators XtTranslations NULL
DwtNdepth int Depth of the parent win-
dow
DwtNtranslations XtTranslations NULL
DwtNmappedWhenManaged Boolean True
DwtNscreen Screen * The parent screen
DwtNdestroyCallback DwtCallbackPtr NULL
Common Attributes
DwtNforeground Pixel Default foreground color
DwtNhighlight Pixel Default foreground color
DwtNhighlightPixmap Pixmap NULL
DwtNuserData Opaque * NULL
DwtNdirectionRToL unsigned char DwtDirectionRightDown
DwtNfont DwtFontList The default XUI Toolkit
font
DwtNhelpCallback DwtCallbackPtr NULL
------------------------------------------------------------------
Widget-Specific Attributes
----------------------------------------------------
Attribute Name Data Type Default
----------------------------------------------------
DwtNlabelType unsigned char DwtCString
DwtNlabel DwtCompString Widget name
DwtNmarginWidth Dimension Two pixels for
text
Zero pixels for
pixmap
DwtNmarginHeight Dimension Two pixels for
text
Zero pixels for
pixmap
DwtNalignment unsigned char DwtAlignment-
Center
DwtNpixmap Pixmap NULL
DwtNmarginLeft Dimension Zero
DwtNmarginRight Dimension Zero
DwtNmarginTop Dimension Zero
DwtNmarginBottom Dimension Zero
DwtNconformToText Boolean True, if the
widget is cre-
ated with a
width and
height of zero
False, if the
widget is cre-
ated with a
non-zero width
and height
----------------------------------------------------
DwtNlabelType Specifies the label type. You can pass DwtCString (compound string) or DwtPixmap (icon data in pixmap).
DwtNlabel Specifies the label for the text style.
DwtNmarginWidth
Specifies the number of pixels between the border of the widget window and the label.
DwtNmarginHeight
Specifies the number of pixels between the border of the widget window and the label.
DwtNalignment Specifies the label alignment for text style. You can pass DwtAlignmentCenter (center alignment), DwtAlignmentBeginning
(alignment at the beginning), or DwtAlignmentEnd (alignment at the end).
DwtNpixmap Supplies icon data for the label. Pixmap is used when DwtNlabelType is defined as DwtNpixmap.
DwtNmarginLeft Specifies the number of pixels that are to remain inside the left margin (DwtNmarginWidth) of the widget before the label is
drawn.
DwtNmarginRight
Specifies the number of pixels that are to remain inside the right margin (DwtNmarginWidth) of the widget before the label
is drawn.
DwtNmarginTop Specifies the number of pixels that are to remain inside the top margin (DwtNmarginTop) of the widget before the label is
drawn.
DwtNmarginBottom
Specifies the number of pixels that are to remain inside the bottom margin (DwtNmarginTop) of the widget before the label is
drawn.
DwtNconformToText
Specifies a boolean value that indicates whether or not the widget always attempts to be just big enough to contain the
label. If True, an XtSetValues with a new label string causes the widget to attempt to shrink or expand to fit exactly
(accounting for margins) the new label string. Note that the results of the attempted resize are up to the geometry manager
involved. If False, the widget never attempts to change size on its own.
Return Values
These functions return the ID of the created widget.
Callback Information
The following structure is returned to your callback:
typedef struct {
int reason;
XEvent *event;
} DwtAnyCallbackStruct;
The reason member is set to a constant that represents the reason why this callback was invoked. For this callback, the reason member can
be set to:
DwtCRHelpRequested The user selected Help.
The event member is a pointer to the Xlib structure XEvent, which describes the event that generated this callback. This structure is a
union of the individual structures declared for each event type. For information on XEvent and event processing, see the Guide to the Xlib
Library: C Language Binding.
See Also
Guide to the XUI Toolkit: C Language Binding
Guide to the XUI Toolkit Intrinsics: C Language Binding
DwtLabel(3Dwt)