/*

 * $XConsortium: Toggle.h,v 1.7 89/12/11 15:23:02 kit Exp $

 *

 * Copyright 1989 Massachusetts Institute of Technology

 *

 * Permission to use, copy, modify, distribute, and sell this software and its

 * documentation for any purpose is hereby granted without fee, provided that

 * the above copyright notice appear in all copies and that both that

 * copyright notice and this permission notice appear in supporting

 * documentation, and that the name of M.I.T. not be used in advertising or

 * publicity pertaining to distribution of the software without specific,

 * written prior permission.  M.I.T. makes no representations about the

 * suitability of this software for any purpose.  It is provided "as is"

 * without express or implied warranty.

 *

 * M.I.T. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL

 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL M.I.T.

 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION

 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 

 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 */

/*

 * ToggleP.h - Private definitions for Toggle widget

 *

 * Author: Chris D. Peterson

 *         MIT X Consortium

 *         [email protected]

 *  

 * Date:   January 12, 1989

 */

#ifndef _XawToggle_h

#define _XawToggle_h

/***********************************************************************

 *

 * Toggle Widget

 *

 ***********************************************************************/

#include <./Xaw3_1Command.h>

/* Resources:

 Name		     Class		RepType		Default Value

 ----		     -----		-------		-------------

 radioGroup          RadioGroup         Widget          NULL              +

 radioData           RadioData          Pointer         (caddr_t) Widget  ++

 state               State              Boolean         Off

 background	     Background		Pixel		XtDefaultBackground

 bitmap		     Pixmap		Pixmap		None

 border		     BorderColor	Pixel		XtDefaultForeground

 borderWidth	     BorderWidth	Dimension	1

 callback	     Callback		Pointer		NULL

 cursor		     Cursor		Cursor		None

 destroyCallback     Callback		Pointer		NULL

 font		     Font		XFontStructx*	XtDefaultFont

 foreground	     Foreground		Pixel		XtDefaultForeground

 height		     Height		Dimension	text height

 highlightThickness  Thickness		Dimension	2

 insensitiveBorder   Insensitive	Pixmap		Gray

 internalHeight	     Height		Dimension	2

 internalWidth	     Width		Dimension	4

 justify	     Justify		XtJustify	XtJustifyCenter

 label		     Label		String		NULL

 mappedWhenManaged   MappedWhenManaged	Boolean		True

 resize		     Resize		Boolean		True

 sensitive	     Sensitive		Boolean		True

 width		     Width		Dimension	text width

 x		     Position		Position	0

 y		     Position		Position	0

+ To use the toggle as a radio toggle button, set this resource to point to

  any other widget in the radio group.

++ This is the data returned from a call to XtToggleGetCurrent, by default

   this is set to the name of toggle widget.

*/

/*

 * These should be in StringDefs.h but aren't so we will define

 * them here if they are needed.

 */

#define XtCWidget "Widget"

#define XtCState "State"

#define XtCRadioGroup "RadioGroup"

#define XtCRadioData "RadioData"

#define XtRWidget "Widget"

#define XtNstate "state"

#define XtNradioGroup "radioGroup"

#define XtNradioData "radioData"

extern WidgetClass               toggleWidgetClass;

typedef struct _ToggleClassRec   *ToggleWidgetClass;

typedef struct _ToggleRec        *ToggleWidget;

/************************************************************

 * 

 * Public Functions

 *

 ************************************************************/

/*	Function Name: XawToggleChangeRadioGroup

 *	Description: Allows a toggle widget to change radio lists.

 *	Arguments: w - The toggle widget to change lists.

 *                 radio_group - any widget in the new list.

 *	Returns: none.

 */

void XawToggleChangeRadioGroup(/* w, radio_group */);

/* Widget w, radio_group; */

/*	Function Name: XawToggleGetCurrent

 *	Description: Returns the RadioData associated with the toggle

 *                   widget that is currently active in a toggle list.

 *	Arguments: radio_group - any toggle widget in the toggle list.

 *	Returns: The XtNradioData associated with the toggle widget.

 */

caddr_t XawToggleGetCurrent(/* radio_group */);

/* Widget radio_group; */

/*	Function Name: XawToggleSetCurrent

 *	Description: Sets the Toggle widget associated with the

 *                   radio_data specified.

 *	Arguments: radio_group - any toggle widget in the toggle list.

 *                 radio_data - radio data of the toggle widget to set.

 *	Returns: none.

 */

void XawToggleSetCurrent(/* radio_group, radio_data */);

/* Widget radio_group;

 * caddr_t radio_data;

 */

/*	Function Name: XawToggleUnsetCurrent

 *	Description: Unsets all Toggles in the radio_group specified.

 *	Arguments: radio_group - any toggle widget in the toggle list.

 *	Returns: none.

 */

void XawToggleUnsetCurrent( /* radio_group */);

/* Widget radio_group; */

#ifdef XAW_BC

/*************************************************************

 * For Compatibility only.                                   */

#define XtToggleChangeRadioGroup       XawToggleChangeRadioGroup

#define XtToggleSetCurrent             XawToggleSetCurrent

#define XtToggleUnsetCurrent           XawToggleUnsetCurrent

#define XtToggleGetCurrent             XawToggleGetCurrent

/*************************************************************/

#endif /* XAW_BC */

#endif /* _XawToggle_h */

/* DON'T ADD STUFF AFTER THIS */