XmPropertySheet

Synopsis

Public Header	<Xmext/Property.h>
Private Header	<Xmext/PropertyP.h>
Class Name	XmPropertySheet
Class Hierarchy	Core::Composite::Constraint::XmManager:: XmBulletinBoard::XmPropertySheet
Class Pointer	xmPropertySheetWidgetClass

Description

A PropertySheet is a folder. It only accepts PropertyPage widgets to be added as children. It internally creates a tab widget for each property page added. The tab widget created uses the property pages dialogTitle resource as its label text.

New Resources

The PropertySheet widget defines the following resources:

Name	Class	Type	Default	Access
XmNactivePos	XmCActivePos	int	0	CSG
XmNapplyLabelString	XmCApplyLabelString	XmString	dynamic	CSG
XmNcancelLabelString	XmCCancelLabelString	XmString	dynamic	CSG
XmNhelpLabelString	XmCHelpLabelString	XmString	dynamic	CSG
XmNokLabelString	XmCOkLabelString	XmString	dynamic	CSG
XmNpageCount	XmCPageCount	int	0	G
XmNpages	XmCPages	WidgetList	0	G
XmNtabs	XmCTabs	WidgetList	0	G

Callback Resources

The PropertySheet widget defines the following callback resources:

Name	Class	Type	Default	Access
XmNapplyCallback	XmCCallback	XtCallbackList	NULL	CSG
XmNcancelCallback	XmCCallback	XtCallbackList	NULL	CSG
XmNokCallback	XmCCallback	XtCallbackList	NULL	CSG

XmNapplyCallback: The apply callback specifies a list of callback functions that are called when the PropertySheet's apply button is activated.
XmNcancelCallback: The cancel callback specifies a list of callback functions that are called when the PropertySheet's cancel button is activated.
XmNokCallback: The ok callback specifies a list of callback functions that are called when the PropertySheet's ok button is activated.

Callback Structure

typedef struct
{
	int reason;
	XEvent *event;
} XmAnyCallbackStruct;

Modified Inherited Resources

The PropertySheet widget does not alter any inherited resources.

Translations

The translations for the PropertySheet widget are inherited from the BulletinBoard widget.

Public Functions

Widget XmCreatePropertySheet(Widget Parent,char *Name,Arg *arglist,Cardinal count);

Create an instance of a property sheet widget. The routine takes four arguments. The parents widget, the name of the new widget, a list of resources and their corresponding values, and finally the number of resources in the list.

Widget XmCreatePropertySheetDialog(Widget Parent,char *Name,Arg *arglist,Cardinal count);

Create an instance of a property sheet widget and a dialog shell widget. The property sheet widget is created as a child of the dialog shell. The widget of the property sheet is returned. The routine takes four arguments. The parents widget, the name of the new widget, a list of resources and their corresponding values, and finally the number of resources in the list.

Widget XmPropertySheetGetChild(Widget sheet,unsigned char child);

Returns the requested child widget or NULL. The child types are as follows:

XmDIALOG_APPLY_BUTTON
XmDIALOG_CANCEL_BUTTON
XmDIALOG_HELP_BUTTON
XmDIALOG_OK_BUTTON

Widget XmPropertySheetGetPage(Widget sheet,int position);

Returns the requested page widget at the specified position in the sheet or NULL.

void XmPropertySheetAddPage(Widget sheet,Widget page,int position);

Adds the property page widget to the internal list. Then a tab is created and associated to the page.

void XmPropertySheetRemovePage(Widget sheet,Widget page);

Removes the property page widget from the internal list. Then the associated tab is destroyed.

void XmPropertySheetRemovePos(Widget sheet,int position);

Removes the property page widget at the specified position from the internal list. Then the associated tab is destroyed.