Menu.addCheckButtonEntry

Add an item to the menu with an image that when selected adds a checked icon.

  1. auto addCheckButtonEntry(string label, CommandCallback callback, string shortCutText)
  2. auto addCheckButtonEntry(Image image, string label, CommandCallback callback, string imagePosition, string shortCutText)
    class Menu
    addCheckButtonEntry
    (
    this T
    )

Parameters

image Image

The image of the entry.

label string

The label of the item.

callback CommandCallback

The callback to execute when this item is selected in the menu.

shortCutText string

The keyboard shortcut text. This is for decoration only, you must also bind this keypress to an event.

imagePosition string

The position of the image in relation to the text.

Return Value

Type: auto

This widget to aid method chaining.

Callback Arguments

These are the fields within the callback's CommandArgs parameter which are populated by this method when the callback is executed.

$(PARAM_TABLE $(PARAM_ROW CommandArgs.element, The menu that executed the callback.) $(PARAM_ROW CommandArgs.uniqueData, The label of the menu entry which was selected.) $(PARAM_ROW CommandArgs.callback, The callback which was executed.) )

See Also

Meta