* Declarations of types and functions used to implement
* 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.4 1998/09/14 18:23:15 stanton Exp $
# undef TCL_STORAGE_CLASS
# define TCL_STORAGE_CLASS DLLEXPORT
* A data structure of the following type is kept for each
* widget managed by this file:
Tk_Window tkwin
; /* Window that embodies the widget. NULL
* means that the window has been destroyed
* but the data structures haven't yet been
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. */
char *menuName
; /* Name of menu associated with widget.
* Information about what's displayed in the menu button:
char *text
; /* Text to display in button (malloc'ed)
int underline
; /* Index of character to underline. */
Var textVarName
; /* Name of variable (malloc'ed) or NULL.
* If non-NULL, button displays the contents
Pixmap bitmap
; /* Bitmap to display or None. If not None
* then text and textVar and underline
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
* Information used when displaying widget:
Tk_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
Tk_3DBorder activeBorder
; /* Structure used to draw 3-D
* border and background when window
* is active. NULL means no such
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
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
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
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
int leftBearing
; /* Distance from text origin to leftmost drawn
* pixel (positive means to right). */
int rightBearing
; /* Amount text sticks right from its origin. */
Arg widthString
; /* Value of -width option. Malloc'ed. */
Arg 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
int padX
, padY
; /* Extra space around text or bitmap (pixels
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,
int textHeight
; /* Height needed to display text as requested,
Tk_TextLayout textLayout
; /* Saved text layout information. */
int indicatorOn
; /* Non-zero means display indicator; 0 means
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.
* Miscellaneous information:
Tk_Uid 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
* "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
Tk_Tile tile
, activeTile
, disabledTile
;
* REDRAW_PENDING: Non-zero means a DoWhenIdle handler
* has already been queued to redraw
* 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
* 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.
extern TkClassProcs tkpMenubuttonClass
;
* Declaration of procedures used in the implementation of the button
EXTERN
void TkpComputeMenuButtonGeometry
_ANSI_ARGS_((
EXTERN TkMenuButton
* TkpCreateMenuButton
_ANSI_ARGS_((Tk_Window tkwin
));
EXTERN
void TkpDisplayMenuButton
_ANSI_ARGS_((
EXTERN
void TkpDestroyMenuButton
_ANSI_ARGS_((
EXTERN
void TkMenuButtonWorldChanged
_ANSI_ARGS_((
ClientData instanceData
));
# undef TCL_STORAGE_CLASS
# define TCL_STORAGE_CLASS DLLIMPORT
#endif /* _TKMENUBUTTON */