Menu Struct Reference

GUI selectable list of items. More...

#include "mutt_menu.h"

Collaboration diagram for Menu:

Data Fields
char *	title
	Title of this menu. More...
char *	help
	Quickref for the current menu. More...
void *	data
	Extra data for the current menu. More...
int	current
	Current entry. More...
int	max
	Number of entries in the menu. More...
MuttRedrawFlags	redraw
	When to redraw the screen. More...
enum MenuType	type
	Menu definition for keymap entries. More...
int	offset
	Row offset within the window to start the index. More...
int	pagelen
	Number of entries per screen. More...
bool	tagprefix: 1
bool	is_mailbox_list: 1
struct MuttWindow *	win_index
struct MuttWindow *	win_ibar
char **	dialog
	Dialog lines themselves. More...
int	dsize
	Number of allocated dialog lines. More...
char *	prompt
	Prompt for user, similar to mutt_multi_choice. More...
char *	keys
	Keys used in the prompt. More...
int	top
	Entry that is the top of the current page. More...
int	oldcurrent
	For driver use only. More...
int	search_dir
	Direction of search. More...
int	tagged
	Number of tagged entries. More...
void(*	menu_make_entry )(char *buf, size_t buflen, struct Menu *menu, int line)
	Format a item for a menu. More...
int(*	menu_search )(struct Menu *menu, regex_t *rx, int line)
	Search a menu for a item matching a regex. More...
int(*	menu_tag )(struct Menu *menu, int sel, int act)
	Tag some menu items. More...
int(*	menu_color )(int line)
	Calculate the colour for a line of the menu. More...
void(*	menu_custom_redraw )(struct Menu *menu)
	Redraw the menu. More...
void *	redraw_data

Detailed Description

GUI selectable list of items.

Definition at line 82 of file mutt_menu.h.

Field Documentation

title

char* Menu::title

Title of this menu.

Definition at line 84 of file mutt_menu.h.

help

char* Menu::help

Quickref for the current menu.

Definition at line 85 of file mutt_menu.h.

data

void* Menu::data

Extra data for the current menu.

Definition at line 86 of file mutt_menu.h.

current

int Menu::current

Current entry.

Definition at line 87 of file mutt_menu.h.

max

int Menu::max

Number of entries in the menu.

Definition at line 88 of file mutt_menu.h.

redraw

MuttRedrawFlags Menu::redraw

When to redraw the screen.

Definition at line 89 of file mutt_menu.h.

type

enum MenuType Menu::type

Menu definition for keymap entries.

Definition at line 90 of file mutt_menu.h.

offset

int Menu::offset

Row offset within the window to start the index.

Definition at line 91 of file mutt_menu.h.

pagelen

int Menu::pagelen

Number of entries per screen.

Definition at line 92 of file mutt_menu.h.

tagprefix

bool Menu::tagprefix

Definition at line 93 of file mutt_menu.h.

is_mailbox_list

bool Menu::is_mailbox_list

Definition at line 94 of file mutt_menu.h.

win_index

struct MuttWindow* Menu::win_index

Definition at line 95 of file mutt_menu.h.

win_ibar

struct MuttWindow* Menu::win_ibar

Definition at line 96 of file mutt_menu.h.

dialog

char** Menu::dialog

Dialog lines themselves.

Definition at line 102 of file mutt_menu.h.

dsize

int Menu::dsize

Number of allocated dialog lines.

Definition at line 103 of file mutt_menu.h.

prompt

char* Menu::prompt

Prompt for user, similar to mutt_multi_choice.

Definition at line 104 of file mutt_menu.h.

keys

char* Menu::keys

Keys used in the prompt.

Definition at line 105 of file mutt_menu.h.

top

int Menu::top

Entry that is the top of the current page.

Definition at line 108 of file mutt_menu.h.

oldcurrent

int Menu::oldcurrent

For driver use only.

Definition at line 109 of file mutt_menu.h.

search_dir

int Menu::search_dir

Direction of search.

Definition at line 110 of file mutt_menu.h.

tagged

int Menu::tagged

Number of tagged entries.

Definition at line 111 of file mutt_menu.h.

menu_make_entry

void(* Menu::menu_make_entry) (char *buf, size_t buflen, struct Menu *menu, int line)

Format a item for a menu.

Parameters

[out]	buf	Buffer in which to save string
[in]	buflen	Buffer length
[in]	menu	Menu containing items
[in]	line	Menu line number

Definition at line 120 of file mutt_menu.h.

menu_search

int(* Menu::menu_search) (struct Menu *menu, regex_t *rx, int line)

Search a menu for a item matching a regex.

Parameters

menu	Menu to search
rx	Regex to match
line	Menu entry to match

Return values

0	Success
>0	Error, e.g. REG_NOMATCH

Definition at line 129 of file mutt_menu.h.

menu_tag

int(* Menu::menu_tag) (struct Menu *menu, int sel, int act)

Tag some menu items.

Parameters

menu	Menu to tag
sel	Current selection
act	Action: 0 untag, 1 tag, -1 toggle

Return values

num	Net change in number of tagged attachments

Definition at line 137 of file mutt_menu.h.

menu_color

int(* Menu::menu_color) (int line)

Calculate the colour for a line of the menu.

Parameters

line	Menu line number

Return values

>0	Colour pair in an integer
0	No colour

Definition at line 144 of file mutt_menu.h.

menu_custom_redraw

void(* Menu::menu_custom_redraw) (struct Menu *menu)

Redraw the menu.

Parameters

menu	Menu to redraw

Definition at line 149 of file mutt_menu.h.

redraw_data

void* Menu::redraw_data

Definition at line 150 of file mutt_menu.h.

---

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

• mutt_menu.h