diff options
Diffstat (limited to 'generic/tkMenubutton.h')
| -rw-r--r-- | generic/tkMenubutton.h | 459 |
1 files changed, 232 insertions, 227 deletions
diff --git a/generic/tkMenubutton.h b/generic/tkMenubutton.h index 087db07..9c36003 100644 --- a/generic/tkMenubutton.h +++ b/generic/tkMenubutton.h @@ -1,227 +1,232 @@ -/* - * tkMenubutton.h -- - * - * Declarations of types and functions used to implement the menubutton - * widget. - * - * Copyright (c) 1996-1997 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: tkMenubutton.h,v 1.11 2005/11/27 02:36:14 das Exp $ - */ - -#ifndef _TKMENUBUTTON -#define _TKMENUBUTTON - -#ifndef _TKINT -#include "tkInt.h" -#endif - -#ifndef _TKMENU -#include "tkMenu.h" -#endif - -#ifdef BUILD_tk -# undef TCL_STORAGE_CLASS -# define TCL_STORAGE_CLASS DLLEXPORT -#endif - -/* - * Legal values for the "orient" field of TkMenubutton records. - */ - -enum direction { - DIRECTION_ABOVE, DIRECTION_BELOW, DIRECTION_FLUSH, - DIRECTION_LEFT, DIRECTION_RIGHT -}; - -/* - * Legal values for the "state" field of TkMenubutton records. - */ - -enum state { - STATE_ACTIVE, STATE_DISABLED, STATE_NORMAL -}; - -/* - * A data structure of the following type is kept for each widget managed by - * this file: - */ - -typedef struct { - Tk_Window tkwin; /* Window that embodies the widget. NULL means - * that the window has been destroyed but the - * data structures haven't yet been cleaned - * up. */ - Display *display; /* Display containing widget. Needed, among - * other things, so that resources can bee - * freed up even after tkwin has gone away. */ - Tcl_Interp *interp; /* Interpreter associated with menubutton. */ - Tcl_Command widgetCmd; /* Token for menubutton's widget command. */ - Tk_OptionTable optionTable; /* Table that defines configuration options - * available for this widget. */ - char *menuName; /* Name of menu associated with widget. - * Malloc-ed. */ - - /* - * Information about what's displayed in the menu button: - */ - - char *text; /* Text to display in button (malloc'ed) or - * NULL. */ - int underline; /* Index of character to underline. */ - 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 and underline 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. */ - - /* - * Information used when displaying widget: - */ - - enum state 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. <= 0 means - * don't draw a highlight. */ - XColor *highlightBgColorPtr;/* Color for drawing traversal highlight area - * when highlight is off. */ - XColor *highlightColorPtr; /* 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 means - * use normalFg with a 50% stipple instead. */ - GC normalTextGC; /* GC for drawing text in normal mode. */ - GC activeTextGC; /* GC for drawing text in active mode (NULL - * means use normalTextGC). */ - Pixmap gray; /* Pixmap for displaying disabled text/icon if - * disabledFg is NULL. */ - GC disabledGC; /* Used to produce disabled effect for text */ - GC stippleGC; /* Used to produce disabled stipple effect for - * images when disabled. */ - int leftBearing; /* Distance from text origin to leftmost drawn - * pixel (positive means to right). */ - int rightBearing; /* Amount text sticks right from its origin */ - 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 - * onto next line. <= 0 means don't wrap - * except at newlines. */ - int padX, padY; /* Extra space around text or bitmap (pixels - * on each side). */ - Tk_Anchor anchor; /* Where text/bitmap should be displayed - * inside window region. */ - Tk_Justify justify; /* Justification to use for multi-line text */ - int textWidth; /* Width needed to display text as requested, - * in pixels. */ - int textHeight; /* Height needed to display text as requested, - * in pixels. */ - Tk_TextLayout textLayout; /* Saved text layout information. */ - int indicatorOn; /* Non-zero means display indicator; 0 means - * don't display. */ - int indicatorHeight; /* Height of indicator in pixels. This same - * amount of extra space is also left on each - * side of the indicator. 0 if no indicator */ - int indicatorWidth; /* Width of indicator in pixels, including - * indicatorHeight in padding on each side. 0 - * if no indicator. */ - - /* - * Miscellaneous information: - */ - - int compound; /* Value of -compound option; specifies - * whether the menubutton should show both an - * image and text, and, if so, how. */ - - enum direction direction; /* Direction for where to pop the menu. Valid - * directions are "above", "below", "left", - * "right", and "flush". "flush" means that - * the upper left corner of the menubutton is - * where the menu pops up. "above" and "below" - * will attempt to pop the menu compleletly - * above or below the menu respectively. - * "left" and "right" will pop the menu left - * or right, and the active item will be next - * to the button. */ - Tk_Cursor cursor; /* Current cursor for window, or None. */ - char *takeFocus; /* Value of -takefocus option; not used in the - * C code, but used by keyboard traversal - * scripts. Malloc'ed, but may be NULL. */ - int flags; /* Various flags; see below for definitions */ -} TkMenuButton; - -/* - * Flag bits for buttons: - * - * REDRAW_PENDING: Non-zero means a DoWhenIdle handler has - * already been queued to redraw this window. - * POSTED: Non-zero means that the menu associated with - * this button has been posted (typically because - * of an active button press). - * GOT_FOCUS: Non-zero means this button currently has the - * input focus. - */ - -#define REDRAW_PENDING 1 -#define POSTED 2 -#define GOT_FOCUS 4 - -/* - * The following constants define the dimensions of the cascade indicator, - * which is displayed if the "-indicatoron" option is true. The units for - * these options are 1/10 millimeters. - */ - -#define INDICATOR_WIDTH 40 -#define INDICATOR_HEIGHT 17 - -/* - * Declaration of variables shared between the files in the button module. - */ - -MODULE_SCOPE Tk_ClassProcs tkpMenubuttonClass; - -/* - * Declaration of procedures used in the implementation of the button widget. - */ - -MODULE_SCOPE void TkpComputeMenuButtonGeometry(TkMenuButton *mbPtr); -MODULE_SCOPE TkMenuButton *TkpCreateMenuButton(Tk_Window tkwin); -MODULE_SCOPE void TkpDisplayMenuButton(ClientData clientData); -MODULE_SCOPE void TkpDestroyMenuButton(TkMenuButton *mbPtr); -MODULE_SCOPE void TkMenuButtonWorldChanged(ClientData instanceData); - -# undef TCL_STORAGE_CLASS -# define TCL_STORAGE_CLASS DLLIMPORT - -#endif /* _TKMENUBUTTON */ +/*
+ * tkMenubutton.h --
+ *
+ * Declarations of types and functions used to implement the menubutton
+ * widget.
+ *
+ * Copyright (c) 1996-1997 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: tkMenubutton.h,v 1.12 2007/06/24 16:07:35 dkf Exp $
+ */
+
+#ifndef _TKMENUBUTTON
+#define _TKMENUBUTTON
+
+#ifndef _TKINT
+#include "tkInt.h"
+#endif
+
+#ifndef _TKMENU
+#include "tkMenu.h"
+#endif
+
+#ifdef BUILD_tk
+# undef TCL_STORAGE_CLASS
+# define TCL_STORAGE_CLASS DLLEXPORT
+#endif
+
+/*
+ * Legal values for the "orient" field of TkMenubutton records.
+ */
+
+enum direction {
+ DIRECTION_ABOVE, DIRECTION_BELOW, DIRECTION_FLUSH,
+ DIRECTION_LEFT, DIRECTION_RIGHT
+};
+
+/*
+ * Legal values for the "state" field of TkMenubutton records.
+ */
+
+enum state {
+ STATE_ACTIVE, STATE_DISABLED, STATE_NORMAL
+};
+
+/*
+ * A data structure of the following type is kept for each widget managed by
+ * this file:
+ */
+
+typedef struct {
+ Tk_Window tkwin; /* Window that embodies the widget. NULL means
+ * that the window has been destroyed but the
+ * data structures haven't yet been cleaned
+ * up. */
+ Display *display; /* Display containing widget. Needed, among
+ * other things, so that resources can bee
+ * freed up even after tkwin has gone away. */
+ Tcl_Interp *interp; /* Interpreter associated with menubutton. */
+ Tcl_Command widgetCmd; /* Token for menubutton's widget command. */
+ Tk_OptionTable optionTable; /* Table that defines configuration options
+ * available for this widget. */
+ char *menuName; /* Name of menu associated with widget.
+ * Malloc-ed. */
+
+ /*
+ * Information about what's displayed in the menu button:
+ */
+
+ char *text; /* Text to display in button (malloc'ed) or
+ * NULL. */
+ int underline; /* Index of character to underline. */
+ 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 and underline 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. */
+
+ /*
+ * Information used when displaying widget:
+ */
+
+ enum state 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. <= 0 means
+ * don't draw a highlight. */
+ XColor *highlightBgColorPtr;/* Color for drawing traversal highlight area
+ * when highlight is off. */
+ XColor *highlightColorPtr; /* 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 means
+ * use normalFg with a 50% stipple instead. */
+ GC normalTextGC; /* GC for drawing text in normal mode. */
+ GC activeTextGC; /* GC for drawing text in active mode (NULL
+ * means use normalTextGC). */
+ Pixmap gray; /* Pixmap for displaying disabled text/icon if
+ * disabledFg is NULL. */
+ GC disabledGC; /* Used to produce disabled effect for
+ * text. */
+ GC stippleGC; /* Used to produce disabled stipple effect for
+ * images when disabled. */
+ int leftBearing; /* Distance from text origin to leftmost drawn
+ * pixel (positive means to right). */
+ int rightBearing; /* Amount text sticks right from its
+ * origin. */
+ 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
+ * onto next line. <= 0 means don't wrap
+ * except at newlines. */
+ int padX, padY; /* Extra space around text or bitmap (pixels
+ * on each side). */
+ Tk_Anchor anchor; /* Where text/bitmap should be displayed
+ * inside window region. */
+ Tk_Justify justify; /* Justification to use for multi-line
+ * text. */
+ int textWidth; /* Width needed to display text as requested,
+ * in pixels. */
+ int textHeight; /* Height needed to display text as requested,
+ * in pixels. */
+ Tk_TextLayout textLayout; /* Saved text layout information. */
+ int indicatorOn; /* Non-zero means display indicator; 0 means
+ * don't display. */
+ int indicatorHeight; /* Height of indicator in pixels. This same
+ * amount of extra space is also left on each
+ * side of the indicator. 0 if no
+ * indicator. */
+ int indicatorWidth; /* Width of indicator in pixels, including
+ * indicatorHeight in padding on each side. 0
+ * if no indicator. */
+
+ /*
+ * Miscellaneous information:
+ */
+
+ int compound; /* Value of -compound option; specifies
+ * whether the menubutton should show both an
+ * image and text, and, if so, how. */
+ enum direction direction; /* Direction for where to pop the menu. Valid
+ * directions are "above", "below", "left",
+ * "right", and "flush". "flush" means that
+ * the upper left corner of the menubutton is
+ * where the menu pops up. "above" and "below"
+ * will attempt to pop the menu compleletly
+ * above or below the menu respectively.
+ * "left" and "right" will pop the menu left
+ * or right, and the active item will be next
+ * to the button. */
+ Tk_Cursor cursor; /* Current cursor for window, or None. */
+ char *takeFocus; /* Value of -takefocus option; not used in the
+ * C code, but used by keyboard traversal
+ * scripts. Malloc'ed, but may be NULL. */
+ int flags; /* Various flags; see below for
+ * definitions. */
+} TkMenuButton;
+
+/*
+ * Flag bits for buttons:
+ *
+ * REDRAW_PENDING: Non-zero means a DoWhenIdle handler has
+ * already been queued to redraw this window.
+ * POSTED: Non-zero means that the menu associated with
+ * this button has been posted (typically because
+ * of an active button press).
+ * GOT_FOCUS: Non-zero means this button currently has the
+ * input focus.
+ */
+
+#define REDRAW_PENDING 1
+#define POSTED 2
+#define GOT_FOCUS 4
+
+/*
+ * The following constants define the dimensions of the cascade indicator,
+ * which is displayed if the "-indicatoron" option is true. The units for
+ * these options are 1/10 millimeters.
+ */
+
+#define INDICATOR_WIDTH 40
+#define INDICATOR_HEIGHT 17
+
+/*
+ * Declaration of variables shared between the files in the button module.
+ */
+
+MODULE_SCOPE Tk_ClassProcs tkpMenubuttonClass;
+
+/*
+ * Declaration of procedures used in the implementation of the button widget.
+ */
+
+MODULE_SCOPE void TkpComputeMenuButtonGeometry(TkMenuButton *mbPtr);
+MODULE_SCOPE TkMenuButton *TkpCreateMenuButton(Tk_Window tkwin);
+MODULE_SCOPE void TkpDisplayMenuButton(ClientData clientData);
+MODULE_SCOPE void TkpDestroyMenuButton(TkMenuButton *mbPtr);
+MODULE_SCOPE void TkMenuButtonWorldChanged(ClientData instanceData);
+
+# undef TCL_STORAGE_CLASS
+# define TCL_STORAGE_CLASS DLLIMPORT
+
+#endif /* _TKMENUBUTTON */
|