DwtRadioBox(3Dwt)

Name

DwtRadioBox, DwtRadioBoxCreate − Creates a radio box widget for the application to display multiple toggle buttons.

Syntax

Widget DwtRadioBox(parent_widget, name, x, y,
                   entry_callback, help_callback)
     Widget parent_widget;
     char *name;
     Position x, y;
     DwtCallbackPtr entry_callback, help_callback;

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

entry_callback
If this callback is defined, all menu entry activation callbacks are revectored to call back through this callback. If this callback is NULL, the individual menu entry callbacks work as usual. For this callback, the reason is DwtCRActivate. This argument sets the DwtNentryCallback attribute associated with DwtMenuCreate.

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 radio box is a composite widget that contains multiple toggle button widgets. The radio box arbitrates and ensures that only one toggle button is on at any one given time. When calling DwtRadioBox, you set the radio box widget attributes presented in the formal parameter list. For DwtRadioBoxCreate, however, you specify a list of attribute name/value pairs that represent all the possible radio box widget attributes. After you create an instance of this widget, you can manipulate it using the appropriate X intrinsics functions.

Inherited Attributes

Attribute Name	Data Type	Default
Core Attributes
DwtNx	Position	Determined by the geometry manager
DwtNy	Position	Determined by the geometry manager
DwtNwidth	Dimension	Set as large as necessary to hold all child widgets
DwtNheight	Dimension	Set as large as necessary to hold all child widgets
DwtNborderWidth	Dimension	One pixel
DwtNborder	Pixel	Default foreground color
DwtNborderPixmap	Pixmap	NULL
DwtNbackground	Pixel	Default background color
DwtNbackgroundPixmap	Pixmap	NULL
DwtNcolormap	Colormap	Default color map
DwtNsensitive	Boolean	True
		Setting the sensitivity of the radio box causes all widgets contained in that radio box to be set to the same sensitivity.
DwtNancestorSensitive	Boolean	The bitwise AND of the parent widget’s DwtNsensitive and DwtNancestorSensitive attributes
DwtNaccelerators	XtTranslations	NULL
DwtNdepth	int	Depth of the parent window
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
Menu Attributes
DwtNspacing	Dimension	Zero pixels
DwtNmarginHeight	Dimension	3 pixels
DwtNmarginWidth	Dimension	Three pixels
DwtNorientation	unsigned char	DwtOrientationVertical
DwtNadjustMargin	Boolean	True
DwtNentryBorder	short	Zero pixels
DwtNmenuAlignment	Boolean	True
DwtNentryAlignment	unsigned char	DwtAlignmentBeginning
DwtNmenuPacking	unsigned char	DwtMenuPackingTight (for all menu types except for radio boxes)
		DwtMenuPackingColumn (for radio boxes)
DwtNmenuNumColumns	short	One row or column
DwtNmenuRadio	Boolean	False
		True (for radio boxes)
DwtNradioAlwaysOne	Boolean	True
DwtNmenuIsHomogeneous	Boolean	False
		True (for radio boxes)
DwtNmenuEntryClass	WidgetClass	NULL Radio boxes, however, default to the togglebuttonwidgetclass.
DwtNmenuHistory	Widget	Zero
DwtNentryCallback	DwtCallbackPtr	NULL
DwtNmenuHelpWidget	Widget	NULL
DwtNchangeVisAtts	Boolean	True
DwtNmenuExtendLastRow	Boolean	True

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;
Widget s_widget;
char *s_tag;
char *s_callbackstruct;
} DwtRadioBoxCallbackStruct;

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:

DwtCRValueChanged	The user activated the toggle button to change state.
DwtCRMap	The radio box is about to be mapped.
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. The s_widget member is set to the ID of the activating subwidget. The s_tag member is set to the tag supplied by the application programmer when the subwidget callback function was specified. The s_callbackstruct member is set to the subwidget’s callback structure.

Museum