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.

nameSpecifies the name of the created widget. 

xSpecifies 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. 

ySpecifies, 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. 

labelSpecifies the label for the text style.  This argument sets the DwtNlabel attribute associated with DwtLabelCreate. 

help_callbackSpecifies 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 standard 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

Widget-Specific Attributes

DwtNlabelTypeSpecifies the label type.  You can pass DwtCString (compound string) or DwtPixmap (icon data in pixmap). 

DwtNlabelSpecifies 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.

DwtNalignmentSpecifies the label alignment for text style.  You can pass DwtAlignmentCenter (center alignment), DwtAlignmentBeginning (alignment at the beginning), or DwtAlignmentEnd (alignment at the end). 

DwtNpixmapSupplies icon data for the label.  Pixmap is used when DwtNlabelType is defined as DwtNpixmap. 

DwtNmarginLeftSpecifies 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. 

DwtNmarginTopSpecifies 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:

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