The list display functions display the screen according to the definition of the screen design and provides functions for displaying a scrollable list in a specified location.

The outline of the list display functions is as follows.

Generate list resource

Generate a list resource by passing the menu items and options defined by the screen design with the list area specification to the AL_CreateList function, and get the list handle to refer to that resource.

When closing the list display, release the list resource with AL_ReleaseList function.

Note:
  • Immediately after the list resource is generated, no list item is registered.
  • The list resource contains a menu resource for displaying the menu items.

Register list items

Register list items to be displayed in the list area with AL_AddListItem function or AL_AddListItemEx function.
You can get the number of registered list items with AL_GetLines function.
You can get the registered list item data with AL_GetListItemData function.
You can sort the registered list items with AL_SortListItem function.

Display the list screen

Display the list screen with AL_ShowList function.
You can move the focus to the specified list item with AL_SelectIndex function.
You can redraw the list screen with AL_RepaintList function.

Wait for input on the list screen

You can use AL_ExecList function to wait for key input and have it perform the following processing.
  • Display the highlight on the list item that has focus.
  • Moves the focus up and down when you press the [Q1] key or the [Q2] key.
  • When more list items are registered than the number of rows in the list area, scroll the list up and down as the focus moves so that the list item with focus is always displayed in the list area.
  • Returns an event if there is any input.
  • If there is no input, wait for input while calling Idle function.

You can get the list item that has focus with AL_GetSelectedIndex function
You can get the list item displayed at the beginning of the list area with AL_GetStartIndex function

Change the data of the list item

Use the following function to change the data of the list item.
AL_SetPaletteIndex function
AL_SetChecked function
AL_SetText function
AL_SetUserParam1 function
AL_SetUserParam2 function
AL_SetUserParam3 function

Use the following function to get the data of the list item.
AL_GetLines function
AL_GetListItemData function
AL_IsChecked function

Change the display of menu items in the list screen

To change the display of the menu items in the list screen, call menu display functions with the menu handle obtained by AL_GetMenuHandle function.

Last updated: 2020/10/16