DwtLabelGadgetCreate(3Dwt)

Name

DwtLabelGadgetCreate − Creates a label gadget.

Syntax

Widget DwtLabelGadgetCreate (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.

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 DwtLabelGadgetCreate function creates an instance of the label gadget and returns its associated gadget ID. A label gadget is similar in appearance and semantics to a label widget. Like all gadgets, the label gadget does not have a window but uses the window of the closest antecedent widget. Thus, the antecedent widget provides all event dispatching for the gadget. This currently restricts gadgets to being descendents of menu or dialog class (or subclass) widgets. Drawing information such as font and color are also those of the closest antecedent widget.

Inherited Attributes

Attribute Name	Data Type	Default
Rectangle Attributes
DwtNx	Position	Determined by the geometry manager
DwtNy	Position	Determined by the geometry manager
DwtNwidth	Dimension	The width of the label plus margins
DwtNheight	Dimension	The height of the label plus margins
DwtNborderWidth	Dimension	zero pixels
DwtNsensitive	Boolean	True
DwtNancestorSensitive	Boolean	The bitwise AND of the parent widget’s DwtNsensitive and DwtNancestorSensitive attributes

Widget-Specific Attributes

Attribute Name	Data Type	Default
DwtNlabel	DwtCompString	Widget name
DwtNalignment	unsigned char	DwtAlignmentCenter
DwtNdirectionRToL	Boolean	False
DwtNhelpCallback	DwtCallbackPtr	NULL

DwtNlabelSpecifies the label for the text style.

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

DwtNdirectionRToL
Specifies a boolean value that, when False, indicates that the text is drawn from left to right. If True, the text is drawn from right to left.

DwtNhelpCallback
Specifies the callback function or functions called when a help request is made.

Return Value

This function returns 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.

Museum