* Merged 8.1 branch into the main trunk

1 files changed, 145 insertions, 98 deletions

diff --git a/generic/tkButton.h b/generic/tkButton.h
index a873dbe..ae24bae 100644
--- a/generic/tkButton.h
+++ b/generic/tkButton.h
@@ -4,12 +4,12 @@
  *	Declarations of types and functions used to implement
  *	button-like widgets.
  *
- * Copyright (c) 1996 by Sun Microsystems, Inc.
+ * Copyright (c) 1996-1998 by Sun Microsystems, Inc.
  *
  * See the file "license.terms" for information on usage and redistribution
  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  *
- * RCS: @(#) $Id: tkButton.h,v 1.4 1998/09/14 18:23:04 stanton Exp $
+ * RCS: @(#) $Id: tkButton.h,v 1.5 1999/04/16 01:51:11 stanton Exp $
  */
 
 #ifndef _TKBUTTON
@@ -25,6 +25,22 @@
 #endif
 
 /*
+ * Legal values for the "state" field of TkButton records.
+ */
+
+enum state {
+    STATE_ACTIVE, STATE_DISABLED, STATE_NORMAL
+};
+
+/*
+ * Legal values for the "defaultState" field of TkButton records.
+ */
+
+enum defaultState {
+    DEFAULT_ACTIVE, DEFAULT_DISABLED, DEFAULT_NORMAL
+};
+
+/*
  * A data structure of the following type is kept for each
  * widget managed by this file:
  */
@@ -36,69 +52,88 @@ typedef struct {
 				 * free up resources after tkwin is gone. */
     Tcl_Interp *interp;		/* Interpreter associated with button. */
     Tcl_Command widgetCmd;	/* Token for button's widget command. */
-    int type;			/* Type of widget:  restricts operations
-				 * that may be performed on widget.  See
-				 * below for possible values. */
+    int type;			/* Type of widget, such as TYPE_LABEL:
+				 * restricts operations that may be performed
+				 * on widget.  See below for legal values. */
+    Tk_OptionTable optionTable;	/* Table that defines configuration options
+				 * available for this widget. */
 
     /*
      * Information about what's in the button.
      */
 
-    char *text;			/* Text to display in button (malloc'ed)
-				 * or NULL. */
-    int underline;		/* Index of character to underline.  < 0 means
+    Tcl_Obj *textPtr;		/* Value of -text option: specifies text to
+				 * display in button. */
+    int underline;		/* Value of -underline option: specifies
+				 * index of character to underline.  < 0 means
 				 * don't underline anything. */
-    char *textVarName;		/* Name of variable (malloc'ed) or NULL.
-				 * If non-NULL, button displays the contents
-				 * of this variable. */
-    Pixmap bitmap;		/* Bitmap to display or None.  If not None
-				 * then text and textVar are ignored. */
-    char *imageString;		/* Name of image to display (malloc'ed), or
-				 * NULL.  If non-NULL, bitmap, text, and
-				 * textVarName are ignored. */
-    Tk_Image image;		/* Image to display in window, or NULL if
-				 * none. */
-    char *selectImageString;	/* Name of image to display when selected
-				 * (malloc'ed), or NULL. */
-    Tk_Image selectImage;	/* Image to display in window when selected,
-				 * or NULL if none.  Ignored if image is
+    Tcl_Obj *textVarNamePtr;	/* Value of -textvariable option: specifies
+				 * name of variable or NULL.  If non-NULL,
+				 * button displays the contents of this
+				 * variable. */
+    Pixmap bitmap;		/* Value of -bitmap option.  If not None,
+				 * specifies bitmap to display and text and
+				 * textVar are ignored. */
+    Tcl_Obj *imagePtr;		/* Value of -image option: specifies image
+				 * to display in window, or NULL if none.
+				 * If non-NULL, bitmap, text, and textVarName
+				 * are ignored.*/
+    Tk_Image image;		/* Derived from imagePtr by calling
+				 * Tk_GetImage, or NULL if imagePtr is NULL. */
+    Tcl_Obj *selectImagePtr;	/* Value of -selectimage option: specifies
+				 * image to display in window when selected,
+				 * or NULL if none.  Ignored if imagePtr is
 				 * NULL. */
+    Tk_Image selectImage;	/* Derived from selectImagePtr by calling
+				 * Tk_GetImage, or NULL if selectImagePtr
+				 * is NULL. */
 
     /*
      * Information used when displaying widget:
      */
 
-    Tk_Uid state;		/* State of button for display purposes:
-				 * normal, active, or disabled. */
-    Tk_3DBorder normalBorder;	/* Structure used to draw 3-D
-				 * border and background when window
-				 * isn't active.  NULL means no such
-				 * border exists. */
-    Tk_3DBorder activeBorder;	/* Structure used to draw 3-D
-				 * border and background when window
-				 * is active.  NULL means no such
-				 * border exists. */
-    int borderWidth;		/* Width of border. */
-    int relief;			/* 3-d effect: TK_RELIEF_RAISED, etc. */
-    int highlightWidth;		/* Width in pixels of highlight to draw
-				 * around widget when it has the focus.
+    enum state state;		/* Value of -state option: specifies
+				 * state of button for display purposes.*/
+    Tk_3DBorder normalBorder;	/* Value of -background option: specifies
+				 * color for background (and border) when
+				 * window isn't active. */
+    Tk_3DBorder activeBorder;	/* Value of -activebackground option:
+				 * this is the color used to draw 3-D border
+				 * and background when widget is active. */
+    Tcl_Obj *borderWidthPtr;	/* Value of -borderWidth option: specifies
+				 * width of border in pixels. */
+    int borderWidth;		/* Integer value corresponding to
+				 * borderWidthPtr.  Always >= 0. */
+    int relief;			/* Value of -relief option: specifies 3-d
+				 * effect for border, such as
+				 * TK_RELIEF_RAISED. */
+    Tcl_Obj *highlightWidthPtr;	/* Value of -highlightthickness option:
+				 * specifies width in pixels of highlight to
+				 * draw around widget when it has the focus.
 				 * <= 0 means don't draw a highlight. */
-    Tk_3DBorder highlightBorder;
-				/* Structure used to draw 3-D default ring
-				 * and focus highlight area when highlight
-				 * is off. */
-    XColor *highlightColorPtr;	/* Color for drawing traversal highlight. */
-
+    int highlightWidth;		/* Integer value corresponding to
+				 * highlightWidthPtr.  Always >= 0. */
+    Tk_3DBorder highlightBorder;/* Value of -highlightbackground option:
+				 * specifies background with which to draw 3-D
+				 * default ring and focus highlight area when
+				 * highlight is off. */
+    XColor *highlightColorPtr;	/* Value of -highlightcolor option:
+				 * specifies color for drawing traversal
+				 * highlight. */
     int inset;			/* Total width of all borders, including
 				 * traversal highlight and 3-D border.
 				 * Indicates how much interior stuff must
 				 * be offset from outside edges to leave
 				 * room for borders. */
-    Tk_Font tkfont;		/* Information about text font, or NULL. */
-    XColor *normalFg;		/* Foreground color in normal mode. */
-    XColor *activeFg;		/* Foreground color in active mode.  NULL
-				 * means use normalFg instead. */
-    XColor *disabledFg;		/* Foreground color when disabled.  NULL
+    Tk_Font tkfont;		/* Value of -font option: specifies font
+				 * to use for display text. */
+    XColor *normalFg;		/* Value of -font option: specifies foreground
+				 * color in normal mode. */
+    XColor *activeFg;		/* Value of -activeforeground option:
+				 * foreground color in active mode.  NULL
+				 * means use -foreground instead. */
+    XColor *disabledFg;		/* Value of -disabledforeground option:
+				 * foreground color when disabled.  NULL
 				 * means use normalFg with a 50% stipple
 				 * instead. */
     GC normalTextGC;		/* GC for drawing text in normal mode.  Also
@@ -106,36 +141,47 @@ typedef struct {
 				 * screen. */
     GC activeTextGC;		/* GC for drawing text in active mode (NULL
 				 * means use normalTextGC). */
-    Pixmap gray;		/* Pixmap for displaying disabled text if
-				 * disabledFg is NULL. */
     GC disabledGC;		/* Used to produce disabled effect.  If
 				 * disabledFg isn't NULL, this GC is used to
 				 * draw button text or icon.  Otherwise
 				 * text or icon is drawn with normalGC and
 				 * this GC is used to stipple background
 				 * across it.  For labels this is None. */
+    Pixmap gray;		/* Pixmap for displaying disabled text if
+				 * disabledFg is NULL. */
     GC copyGC;			/* Used for copying information from an
 				 * off-screen pixmap to the screen. */
-    char *widthString;		/* Value of -width option.  Malloc'ed. */
-    char *heightString;		/* Value of -height option.  Malloc'ed. */
-    int width, height;		/* If > 0, these specify dimensions to request
-				 * for window, in characters for text and in
-				 * pixels for bitmaps.  In this case the actual
-				 * size of the text string or bitmap is
-				 * ignored in computing desired window size. */
-    int wrapLength;		/* Line length (in pixels) at which to wrap
+    Tcl_Obj *widthPtr;		/* Value of -width option. */
+    int width;			/* Integer value corresponding to widthPtr. */
+    Tcl_Obj *heightPtr;		/* Value of -height option. */
+    int height;			/* Integer value corresponding to heightPtr. */
+    Tcl_Obj *wrapLengthPtr;	/* Value of -wraplength option: specifies
+				 * line length (in pixels) at which to wrap
 				 * onto next line.  <= 0 means don't wrap
 				 * except at newlines. */
-    int padX, padY;		/* Extra space around text (pixels to leave
-				 * on each side).  Ignored for bitmaps and
+    int wrapLength;		/* Integer value corresponding to
+				 * wrapLengthPtr. */
+    Tcl_Obj *padXPtr;		/* Value of -padx option: specifies how many
+				 * pixels of extra space to leave on left and
+				 * right of text.  Ignored for bitmaps and
 				 * images. */
-    Tk_Anchor anchor;		/* Where text/bitmap should be displayed
-				 * inside button region. */
-    Tk_Justify justify;		/* Justification to use for multi-line text. */
-    int indicatorOn;		/* True means draw indicator, false means
-				 * don't draw it. */
-    Tk_3DBorder selectBorder;	/* For drawing indicator background, or perhaps
-				 * widget background, when selected. */
+    int padX;			/* Integer value corresponding to padXPtr. */
+    Tcl_Obj *padYPtr;		/* Value of -padx option: specifies how many
+				 * pixels of extra space to leave above and
+				 * below text.  Ignored for bitmaps and
+				 * images. */
+    int padY;			/* Integer value corresponding to padYPtr. */
+    Tk_Anchor anchor;		/* Value of -anchor option: specifies where
+				 * text/bitmap should be displayed inside
+				 * button region. */
+    Tk_Justify justify;		/* Value of -justify option: specifies how
+				 * to align lines of multi-line text. */
+    int indicatorOn;		/* Value of -indicatoron option:  1 means
+				 * draw indicator in checkbuttons and
+				 * radiobuttons, 0 means don't draw it. */
+    Tk_3DBorder selectBorder;	/* Value of -selectcolor option: specifies
+				 * color for drawing indicator background, or
+				 * perhaps widget background, when selected. */
     int textWidth;		/* Width needed to display text as requested,
 				 * in pixels. */
     int textHeight;		/* Height needed to display text as requested,
@@ -144,36 +190,42 @@ typedef struct {
     int indicatorSpace;		/* Horizontal space (in pixels) allocated for
 				 * display of indicator. */
     int indicatorDiameter;	/* Diameter of indicator, in pixels. */
-    Tk_Uid defaultState;	/* State of default ring: normal, active, or
-				 * disabled. */
-        
+    enum defaultState defaultState;
+				/* Value of -default option, such as
+				 * DEFAULT_NORMAL: specifies state
+				 * of default ring for buttons (normal,
+				 * active, or disabled).  NULL for other
+				 * classes. */
+
     /*
      * For check and radio buttons, the fields below are used
      * to manage the variable indicating the button's state.
      */
 
-    char *selVarName;		/* Name of variable used to control selected
-				 * state of button.  Malloc'ed (if
-				 * not NULL). */
-    char *onValue;		/* Value to store in variable when
-				 * this button is selected.  Malloc'ed (if
-				 * not NULL). */
-    char *offValue;		/* Value to store in variable when this
-				 * button isn't selected.  Malloc'ed
-				 * (if not NULL).  Valid only for check
-				 * buttons. */
+    Tcl_Obj *selVarNamePtr;	/* Value of -variable option: specifies name
+				 * of variable used to control selected
+				 * state of button. */
+    Tcl_Obj *onValuePtr;	/* Value of -offvalue option: specifies value
+				 * to store in variable when this button is
+				 * selected. */
+    Tcl_Obj *offValuePtr;	/* Value of -offvalue option: specifies value
+				 * to store in variable when this button
+				 * isn't selected.  Used only by
+				 * checkbuttons. */
 
     /*
      * Miscellaneous information:
      */
 
-    Tk_Cursor cursor;		/* Current cursor for window, or None. */
-    char *takeFocus;		/* Value of -takefocus option;  not used in
+    Tk_Cursor cursor;		/* Value of -cursor option: if not None,
+				 * specifies current cursor for window. */
+    Tcl_Obj *takeFocusPtr;	/* Value of -takefocus option;  not used in
 				 * the C code, but used by keyboard traversal
-				 * scripts.  Malloc'ed, but may be NULL. */
-    char *command;		/* Command to execute when button is
-				 * invoked; valid for buttons only.
-				 * If not NULL, it's malloc-ed. */
+				 * scripts. */
+    Tcl_Obj *commandPtr;	/* Value of -command option: specifies script 
+				 * to execute when button is invoked.  If
+				 * widget is label or has no command, this
+				 * is NULL. */
     int flags;			/* Various flags;  see below for
 				 * definitions. */
 } TkButton;
@@ -200,36 +252,31 @@ typedef struct {
  *				so special highlight should be drawn.
  * GOT_FOCUS:			Non-zero means this button currently
  *				has the input focus.
+ * BUTTON_DELETED:		Non-zero needs that this button has been
+ *				deleted, or is in the process of being
+ *				deleted.
  */
 
 #define REDRAW_PENDING		1
 #define SELECTED		2
 #define GOT_FOCUS		4
-
-/*
- * Mask values used to selectively enable entries in the
- * configuration specs:
- */
-
-#define LABEL_MASK		TK_CONFIG_USER_BIT
-#define BUTTON_MASK		TK_CONFIG_USER_BIT << 1
-#define CHECK_BUTTON_MASK	TK_CONFIG_USER_BIT << 2
-#define RADIO_BUTTON_MASK	TK_CONFIG_USER_BIT << 3
-#define ALL_MASK		(LABEL_MASK | BUTTON_MASK \
-	| CHECK_BUTTON_MASK | RADIO_BUTTON_MASK)
+#define BUTTON_DELETED		0x8
 
 /*
  * Declaration of variables shared between the files in the button module.
  */
 
 extern TkClassProcs tkpButtonProcs;
-extern Tk_ConfigSpec tkpButtonConfigSpecs[];
 
 /*
  * Declaration of procedures used in the implementation of the button
  * widget. 
  */
 
+#ifndef TkpButtonSetDefaults
+EXTERN void		TkpButtonSetDefaults _ANSI_ARGS_((
+			    Tk_OptionSpec *specPtr));
+#endif
 EXTERN void		TkButtonWorldChanged _ANSI_ARGS_((
 			    ClientData instanceData));
 EXTERN void		TkpComputeButtonGeometry _ANSI_ARGS_((