Maplets[Elements] - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Maplets : Elements : Menu Elements : Maplets/Elements/CheckBoxMenuItem

Maplets[Elements]

  

CheckBoxMenuItem

  

define a menu item with a check box in a menu

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

CheckBoxMenuItem(opts)

CheckBoxMenuItem[refID](opts)

Parameters

opts

-

equation(s) of the form option=value where option is one of caption, enabled, image, onclick, reference, value, or visible; specify options for the CheckBoxMenuItem element

refID

-

name or string; reference to the element

Description

• 

The CheckBoxMenuItem menu element defines a menu entry with a check box in a menu.

  

 

• 

The CheckBoxMenuItem element features can be modified by using options. To simplify specifying options in the Maplets package, certain options and contents can be set without using an equation. The following table lists elements, symbols, and types (in the left column) and the corresponding option or content (in the right column) to which inputs of this type are, by default, assigned.

Elements, Symbols, or Types

Assumed Option or Content

 

 

Action or command elements

onclick option

Image element

image option

refID

reference option

string or symbol

caption option

 

 

• 

A CheckBoxMenuItem element can contain Action or command elements to specify the onclick option and an Image element to specify the image option.

• 

A CheckBoxMenuItem element can be contained in a Menu or PopupMenu element.

• 

The following table describes the control and use of the CheckBoxMenuItem element options.

  

An x in the I column indicates that the option can be initialized, that is, specified in the calling sequence (element definition).

  

An x in the R column indicates that the option is required in the calling sequence.

  

An x in the G column indicates that the option can be read, that is, retrieved by using the Get tool.

  

An x in the S column indicates that the option can be written, that is, set by using the SetOption element or the Set tool.

Option

I

R

G

S

 

 

 

 

 

caption

x

x

x

x

enabled

x

 

x

x

image

x

 

 

 

onclick

x

 

 

 

reference

x

 

 

 

value

x

 

x

x

visible

x

 

x

x

 

 

 

 

 

• 

The opts argument can contain one or more of the following equations that set Maplet application options.

  

 

  

caption = string or symbol

  

The caption that appears on the check box menu item.  The caption can have a mnemonic key or access key associated with it.  For more information, see Maplets Mnemonic Key.

  

 

  

enabled = true or false

  

Whether a check box menu item can be selected.  If enabled is set to false, the check box menu item is dimmed, and any action associated with it cannot be initiated.  By default, the value is true.

  

 

  

image = reference

  

A reference to an Image element.

  

 

  

onclick = Action or command element, or reference to an Action element (name or string)

  

The action that occurs when the check box menu item is selected.

  

 

  

reference = name or string

  

A reference to the CheckBoxMenuItem element.

  

If the reference is specified by both an index, for example, CheckBoxMenuItem[refID], and a reference in the calling sequence, the index reference takes precedence.

  

 

  

value = true or false

  

Whether the check box on the menu item is selected.  By default, the value is false.

  

 

  

visible = true or false

  

Whether the check box menu item is visible to the user.  By default, the value is true.

Examples

withMapletsElements:

mapletMapletWindowmenubar=MB1,ButtonOK,ShutdownClosed from button,MenuBarMB1MenuFile,MenuItemClose,ShutdownClosed from menu,CBMI1,MenuOptions,CheckBoxMenuItemCBMI1Check Option:

MapletsDisplaymaplet

See Also

Maplets Mnemonic Key

Maplets/CommandElements

Maplets/MenuElements

Maplets[Display]

Maplets[Elements]

Maplets[Elements][Action]

Maplets[Elements][Button]

Maplets[Elements][CheckBox]

Maplets[Elements][Image]

Maplets[Elements][Maplet]

Maplets[Elements][Menu]

Maplets[Elements][MenuBar]

Maplets[Elements][MenuItem]

Maplets[Elements][MenuSeparator]

Maplets[Elements][PopupMenu]

Maplets[Elements][RadioButtonMenuItem]

Maplets[Elements][SetOption]

Maplets[Elements][Shutdown]

Maplets[Elements][Window]

Maplets[Tools][Get]

Maplets[Tools][Set]

Overview of Maplet Applications