Line Struct Reference

The Line strutures are attached to the Menu main structure. More...

#include <menu.h>

Collaboration diagram for Line:

Data Fields
char	choice_letter
char *	choice_text
char *	command_str
unsigned int	command_type
int	letter_pos
char *	raw_text
unsigned int	type
void *	ui_runtime
void *	ui_surface

Detailed Description

The Line strutures are attached to the Menu main structure.

Definition at line 57 of file menu.h.

Field Documentation

choice_letter

char Line::choice_letter

The letter that the user can press to select this menu line, if it is a choice line, used for selection purposes

Definition at line 82 of file menu.h.

Referenced by menu_cmd_processor(), menu_engine(), and parse_menu_description().

choice_text

char* Line::choice_text

The formatted text of the menu line, after processing any variables and formatting, used for display purposes

Definition at line 79 of file menu.h.

Referenced by destroy_menu(), menu_cmd_processor(), menu_engine(), and parse_menu_description().

command_str

char* Line::command_str

The command string associated with this menu line, which may be a command to execute, a menu to display, a form to show, etc., depending on the command type, used to determine the specific action to take when this menu line is selected

Definition at line 95 of file menu.h.

Referenced by destroy_menu(), menu_cmd_processor(), and parse_menu_description().

command_type

unsigned int Line::command_type

The type of command associated with this menu line, e.g. CT_RETURNMAIN for a command that returns to the main menu, CT_EXEC for a command that executes a program, CT_HELP for a command that displays help information, etc., used to determine what action to take when this menu line is selected

Definition at line 89 of file menu.h.

Referenced by menu_cmd_processor(), and parse_menu_description().

letter_pos

int Line::letter_pos

The position of the choice letter in the text, for highlighting purposes, used to determine where to highlight the choice letter in the menu display

Definition at line 85 of file menu.h.

Referenced by menu_cmd_processor(), menu_engine(), and parse_menu_description().

raw_text

char* Line::raw_text

The raw text of the menu line, as read from the menu description file, before processing any variables or formatting

Definition at line 76 of file menu.h.

Referenced by destroy_menu(), menu_cmd_processor(), and parse_menu_description().

type

unsigned int Line::type

The type of menu line, e.g. MT_TEXT for a text line, MT_CHOICE for a choice line

Definition at line 74 of file menu.h.

Referenced by menu_cmd_processor(), menu_engine(), and parse_menu_description().

ui_runtime

void* Line::ui_runtime

A pointer to the UI runtime structure, which may be used to access information about the current state of the UI, such as variables, settings, or other data that may be needed for processing the menu line or executing its command, used to provide context and information for processing the menu line and executing its associated command

Definition at line 59 of file menu.h.

ui_surface

void* Line::ui_surface

A pointer to the UI surface structure, which may be used to access information about the current state of the UI surface, such as dimensions, colors, or other properties that may be needed for processing the menu line or executing its command, used to provide context and information for processing the menu line and executing its associated command

Definition at line 66 of file menu.h.

---

The documentation for this struct was generated from the following file:

• include/menu.h