Sets the control type for menu items.

Syntax

bool AM_SetControlType(
  MENU_HANDLE menu,
  int id,
  int control,
  bool clearItem
);

Parameters

menu

[in] Menu handle

id

[in] Item ID of menu item.

control

[in] Specify the type of control to be set for the menu item with one of the following values.

Value	Description
AM_NO_CONTROL	No control is added.
AM_CHECK_BOX	Displays a check box in front of the display string.
AM_RADIO_BTN	Displays a radio button in front of the display string.
AM_LIST_MARK	Displays ▼ after the display string. The string is displayed with underline.
AM_JUMP_MARK	Displays ▶ in front of the display string.
AM_CLEAR_ICON	Displays [CLR] icon in front of the display string.
AM_ENT_ICON	Displays [ENT] icon in front of the display string.
AM_SCAN_ICON	Displays [SCAN] icon in front of the display string.
AM_F1_ICON	Displays [F1] icon in front of the display string.
AM_F2_ICON	Displays [F2] icon in front of the display string.
AM_F3_ICON	Displays [F3] icon in front of the display string.
AM_Q1_ICON	Displays [Q1] icon in front of the display string.
AM_Q2_ICON	Displays [F2] icon in front of the display string.
AM_BS_ICON	Displays [BS] icon in front of the display string.
AM_1_ICON	Displays [1] icon in front of the display string.
AM_2_ICON	Displays [2] icon in front of the display string.
AM_3_ICON	Displays [3] icon in front of the display string.
AM_4_ICON	Displays [4] icon in front of the display string.
AM_5_ICON	Displays [5] icon in front of the display string.
AM_6_ICON	Displays [6] icon in front of the display string.
AM_7_ICON	Displays [7] icon in front of the display string.
AM_8_ICON	Displays [8] icon in front of the display string.
AM_9_ICON	Displays [9] icon in front of the display string.
AM_0_ICON	Displays [0] icon in front of the display string.
AM_ASTER_ICON	Displays [*] icon in front of the display string.

Note:

The following values cannot be specified.

AM_TEXT_EDIT
AM_SHIFT_MODE
AM_SHIFT_CANDIDATE
AM_BMPFILE

clearItem

[in] Specify true to clear the original display before updating it, false otherwise.

Return value

Returns true if the function succeeds, false otherwise.

Remarks

Change the control of the menu item specified by id to the control specified by control and update the display.

If the current control type of the menu item specified by id is one of the following, this function will fail and return false.

AM_TEXT_EDIT
AM_SHIFT_MODE
AM_SHIFT_CANDIDATE
AM_BMPFILE

Requirements

Header file:

lib.h
AdvancedMenu.h : Ver.1.3.0 and later

Library file:

libAdvancedMenu.a : Ver.1.3.0 and later
libSTARTUPOPH5000.a