# MenuButton Widget

    Application Header file	<X11/Xaw/MenuButton.h>

    Class Header file	<X11/Xaw/MenuButtonP.h>

    Class		menuButtonWidgetClass

    Class Name	MenuButton

    Superclass	Command

The MenuButton widget is an area, often rectangular, that displays a graphic. The graphic may be a text string containing multiple lines of characters in an 8 bit or 16 bit character set (to be displayed with a font), or in a multi-byte encoding (for use with a fontset). The graphic may also be a bitmap or pixmap.

When the pointer cursor is on a MenuButton widget, the MenuButton becomes highlighted by drawing a rectangle around its perimeter. This highlighting indicates that the MenuButton is ready for selection. When a pointer button is pressed, the MenuButton widget will pop up the menu named in the `menuName` resource.

## Resources

When creating a MenuButton widget instance, the following resources are retrieved from the argument list or from the resource database:

Name | Class | Type | Notes | Default Value
accelerators | Accelerators | AcceleratorTable |  | NULL
ancestorSensitive | AncestorSensitive | Boolean | D | True
background | Background | Pixel |  | XtDefaultBackground
backgroundPixmap | Pixmap | Pixmap |  | XtUnspecifiedPixmap
bitmap | Bitmap | Pixmap |  | None
borderColor | BorderColor | Pixel |  | XtDefaultForeground
borderPixmap | Pixmap | Pixmap |  | XtUnspecifiedPixmap
borderWidth | BorderWidth | Dimension |  | 1
callback | Callback | XtCallbackList |  | NULL
colormap | Colormap | Colormap |  | Parent's Colormap
cornerRoundPercent | CornerRoundPercent | Dimension |  | 25
cursor | Cursor | Cursor |  | None
cursorName | Cursor | String |  | None
depth | Depth | int | C | Parent's Depth
destroyCallback | Callback | XtCallbackList |  | NULL
encoding | Encoding | UnsignedChar |  | XawTextEncoding8bit
font | Font | XFontStruct |  | XtDefaultFont
fontSet | FontSet | XFontSet |  | XtDefaultFontSet
foreground | Foreground | Pixel |  | XtDefaultForeground
height | Height | Dimension | A | graphic height + 2 * `internalHeight`
highlightThickness | Thickness | Dimension | A | 2 (0 if Shaped)
insensitiveBorder | Insensitive | Pixmap |  | GreyPixmap
internalHeight | Height | Dimension |  | 2
internalWidth | Width | Dimension |  | 4
international | International | Boolean | C | False
justify | Justify | Justify |  | XtJustifyCenter (center)
label | Label | String |  | name of widget
leftBitmap | LeftBitmap | Bitmap |  | None
mappedWhenManaged | MappedWhenManaged | Boolean |  | True
menuName | MenuName | String |  | "menu"
pointerColor | Foreground | Pixel |  | XtDefaultForeground
pointerColorBackground | Background | Pixel |  | XtDefaultBackground
resize | Resize | Boolean |  | True
screen | Screen | Screen | R | Parent's Screen
sensitive | Sensitive | Boolean |  | True
shapeStype | ShapeStyle | ShapeStyle |  | Rectangle
translations | Translations | TranslationTable |  | See below
width | Width | Dimension | A | graphic width + 2 * `internalWidth`
x | Position | Position |  | 0
y | Position | Position |  | 0
_

`menuName`

- The name of a popup shell to popup as a menu. The MenuButton will search for this name using `XtNameToWidget` starting with itself as the reference widget. If the search is unsuccessful the widget will continue up the widget tree using each of its ancestors as the reference widget passed to `XtNameToWidget`. If no widget of called `menuName` is found by this algorithm, the widget will print a warning message and give up. When the menu is found it will be popped up exclusive and spring_loaded. The MenuButton widget does not copy the value of this resource into newly allocated memory. The application programmer must pass the resource value in nonvolatile memory.

## MenuButton Actions

The MenuButton widget supports the following actions:

- Switching the button between the foreground and background colors with `set` and `unset`

- Processing application callbacks with `notify`

- Switching the internal border between highlighted and unhighlighted states with `highlight` and `unhighlight`

- Popping up a menu with `PopupMenu`

The following are the default translation bindings used by the MenuButton widget:

    	<EnterWindow>:	highlight(\|)
    	<LeaveWindow>:	reset(\|)
    	<BtnDown>:	reset(\|) PopupMenu(\)

## MenuButton Actions

The full list of actions supported by MenuButton is:

`highlight`(`condition`)

- Displays the internal highlight border in the color (`foreground` or `background` ) that contrasts with the interior color of the Command widget. The conditions `WhenUnset` and `Always` are understood by this action procedure. If no argument is passed, `WhenUnset` is assumed.

`unhighlight`(\|)

- Displays the internal highlight border in the color (`XtNforeground` or `background` ) that matches the interior color of the MenuButton widget.

`set`(\|)

- Enters the `set` state, in which `notify` is possible. This action causes the button to display its interior in the `foreground` color. The label or bitmap is displayed in the `background` color.

`unset`(\|)

- Cancels the set state and displays the interior of the button in the `background` color. The label or bitmap is displayed in the `foreground` color.

`reset`(\|)

- Cancels any `set` or `highlight` and displays the interior of the button in the `background` color, with the label displayed in the `foreground` color.

`notify`(\|)

- When the button is in the `set` state this action calls all functions in the callback list named by the `callback` resource. The value of the call_data argument in these callback functions is undefined.

`PopupMenu`(\|)

- Pops up the menu specified by the `menuName` resource.

The MenuButton widget does not place a server grab on itself. Instead, PopupMenu is registered as a grab action. As a result, clients which popup menus without using XtMenuPopup or MenuPopup or PopupMenu in translations will fail to have a grab active. They should make a call to XtRegisterGrabAction on the appropriate action in the application initialization routine, or use a different translation.