LessTif Manual Page
- Widget Classes
XmToggleButton
Synopsis
| Widget Class |
xmToggleButton |
| Public Header |
<Xm/ToggleB.h> |
| Private Header |
<Xm/ToggleBP.h> |
| Class Hierarchy |
Core::
XmPrimitive::
XmLabel::
XmToggleButton
|
Description
Under Construction
Resources
| Name |
Class |
Type |
Default |
Access |
| XmNarmCallback |
XmCCallback |
XtCallbackList | NULL |
CSG |
| XmNdisarmCallback |
XmCCallback |
XtCallbackList | NULL |
CSG |
| XmNfillOnSelect |
XmCFillOnSelect |
Boolean | True |
CSG |
| XmNindicatorOn |
XmCIndicatorOn |
Boolean | True |
CSG |
| XmNindicatorSize |
XmCIndicatorSize |
Dimension | XmINVALID_DIMENSION |
CSG |
| XmNindicatorType |
XmCIndicatorType |
XmRIndicatorType | _XmToggleButtonIndicatorTypeDefault |
CSG |
| XmNselectColor |
XmCSelectColor |
Pixel | _XmSelectColorDefault |
CSG |
| XmNselectPixmap |
XmCSelectPixmap |
Pixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNselectInsensitivePixmap |
XmCSelectInsensitivePixmap |
Pixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNset |
XmCSet |
Boolean | False |
CSG |
| XmNspacing |
XmCspacing |
XmRHorizontalDimension | 4 |
CSG |
| XmNvalueChangedCallback |
XmCCallback |
XtCallbackList | NULL |
CSG |
| XmNvisibleWhenOff |
XmCVisibleWhenOff |
Boolean | False |
CSG |
- XmNfillOnSelect
- XmNindicatorOn
- XmNindicatorSize
- XmNindicatorType
- XmNselectColor
- XmNselectPixmap
- XmNselectInsensitivePixmap
- XmNset
- XmNspacing
- XmNvisibleWhenOff
Callbacks
Callback Resources
The ToggleButton widget defines the following callback resources:
- XmNvalueChangedCallback
- The activateCallback specifies a list of callback functions that are
called when the ToggleButton Widget is activated.
This is when the Toggle Button is pressed and release.
The reason field of the Callback structure has the values XmCR_VALUE_CHANGED.
- XmNarmCallback
- The armCallback specifies a list of callback functions that are
called when the ToggleButton Widget is armed.
This is when the Toggle Button is Pressed.
The reason field of the Callback structure has the values XmCR_ARM.
- XmNdisarmCallback
- The armCallback specifies a list of callback functions that are
called when the ToggleButton Widget is disarmed.
This is when the Toggle Button is pressed and release.
The reason field of the Callback structure has the values XmCR_DISARM.
Callback Structure
typedef struct {
int reason;
XEvent *event;
int set;
} XmToggleButtonCallbackStruct;
Inherited Resources
XmToggleButton inherits resources from the following widget classes:
- XmLabel
Resources
| Name |
Class |
Type |
Default |
Access |
| XmNaccelerator |
XmCAccelerator |
XmString | XmUNSPECIFIED |
CSG |
| XmNacceleratorText |
XmCAcceleratorText |
XmString | XmUNSPECIFIED |
CSG |
| XmNalignment |
XmCAlignment |
unsigned char | XmALIGNMENT_CENTER |
CSG |
| XmNfontList |
XmCFontList |
XmRFontlist | XmUNSPECIFIED |
CSG |
| XmNlabelInsensitivePixmap |
XmCLabelInsensitivePixmap |
XmRPixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNlabelPixmap |
XmCLabelPixmap |
XmRPixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNlabelString |
XmCLabelString |
XmString | XmUNSPECIFIED |
CSG |
| XmNlabelType |
XmCLabelType |
XmRLabelType | XmSTRING |
CSG |
| XmNmarginBottom |
XmCMarginBottom |
XmRDimension | 0 |
CSG |
| XmNmarginHeight |
XmCMarginHeight |
XmRDimension | 2 |
CSG |
| XmNmarginLeft |
XmCMarginLeft |
XmRDimension | 0 |
CSG |
| XmNmarginRight |
XmCMarginRight |
XmRDimension | 0 |
CSG |
| XmNmarginTop |
XmCMarginTop |
XmRDimension | 0 |
CSG |
| XmNmarginWidth |
XmCMarginWidth |
XmRDimension | 2 |
CSG |
| XmNmnemonicCharSet |
XmCMnemonicCharSet |
XmString | XmFONTLIST_DEFAULT_TAG |
CSG |
| XmNrecomputeSize |
XmCRecomputeSize |
XmRBoolean | True |
CSG |
| XmNstringDirection |
XmCStringDirection |
XmStringDirection | NULL |
CSG |
| XmNtraversalOn |
XmCTraversalOn |
Boolean | False |
CSG |
| XmNhighlightOnEnter |
XmCHighlightOnEnter |
Boolean | False |
CSG |
- XmPrimitive
XmPrimitive Resources
| Name |
Type |
Default |
Access |
| XmNforeground |
Pixel | _XmForegroundColorDefault |
CSG |
| XtNbackground |
Pixel | _XmBackgroundColorDefault |
CSG |
| XmNbottomShadowColor |
Pixel | _XmBottomShadowColorDefault |
CSG |
| XmNbottomShadowPixmap |
Pixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNtopShadowColor |
Pixel | _XmTopShadowColorDefault |
CSG |
| XmNtopShadowPixmap |
Pixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNshadowThickness |
Dimension | 2 |
CSG |
| XmNhighlightColor |
Pixel | _XmHighlightColorDefault |
CSG |
| XmNhighlightOnEnter |
Boolean | False |
CSG |
| XmNhighlightPixmap |
Pixmap | XmUNSPECIFIED_PIXMAP |
CSG |
| XmNhighlightThickness |
Dimension | 2 |
CSG |
| XmNnavigationType |
XmNavigationType | XmNONE |
CSG |
| XmNtraversalOn |
Boolean | True |
CSG |
| XmNunitType |
unsigned char | 0 |
CSG |
| XmNuserData |
XtPointer | NULL |
CSG |
| XmNhelpCallback |
XtCallbackList | NULL |
C |
- Core
Core Resources
Actions
- Arm()
-
- ArmAndActivate()
-
- Disarm()
-
- Select()
-
- Help()
-
- BtnDown()
-
- BtnUp()
-
- Enter()
-
- Leave()
-
Usage
An ToggleButton widget can be created using the standard Xt toolkit
functions XtCreateWidget or XtCreateManagedWidget.
Widget toggle = XtCreateManagedWidget("Toggle",xmToggleButtonWidgetClass,parent,args,n);
Public Functions
- Widget XmCreateToggleButton(Widget Parent,char *Name,Arg *arglist,Cardinal count)
- Create an instance of an togglebutton widget with the name Name and
a parent of Parent using the first count arguments of arglist
- Widget XmToggleButtonGetState();
- Widget XmToggleButtonSetState();
Code Example
See testXm/togglebutton/toggle1.c for an example of its usage.
See Also
Core,
XmPrimitive,
XmLabel,
XmPushButton,
XmArrowButton,
XmCascadeButton,
XmDrawnButton,
Go Back to Index
Go Back to Main Index
Last Update:Fri 8 Dec 08:36:14 1995