NeoMutt  2024-04-25-89-g194907
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h
Go to the documentation of this file.
1
41#ifndef MUTT_MENU_LIB_H
42#define MUTT_MENU_LIB_H
43
44#include "config.h"
45#include <stdbool.h>
46#include <stdint.h>
47#include "mutt/lib.h"
48#include "type.h"
49
50struct ConfigSubset;
51struct MuttWindow;
52
53// Observers of #NT_MENU will not be passed any Event data.
54typedef uint8_t MenuRedrawFlags;
55#define MENU_REDRAW_NO_FLAGS 0
56#define MENU_REDRAW_INDEX (1 << 0)
57#define MENU_REDRAW_MOTION (1 << 1)
58#define MENU_REDRAW_CURRENT (1 << 2)
59#define MENU_REDRAW_FULL (1 << 3)
60
67{
69};
70
78struct Menu
79{
80 int current;
81 int max;
85 bool tag_prefix : 1;
86 struct MuttWindow *win;
87 struct ConfigSubset *sub;
88
89 /* the following are used only by menu_loop() */
90 int top;
94
106 int (*make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf);
107
119 int (*search)(struct Menu *menu, regex_t *rx, int line);
120
131 int (*tag)(struct Menu *menu, int sel, int act);
132
143 const struct AttrColor *(*color)(struct Menu *menu, int line);
144
145 struct Notify *notify;
146
147 void *mdata;
148
161 void (*mdata_free)(struct Menu *menu, void **ptr);
162};
163
164// Simple movement
170MenuRedrawFlags menu_half_down (struct Menu *menu);
171MenuRedrawFlags menu_half_up (struct Menu *menu);
175MenuRedrawFlags menu_next_line (struct Menu *menu);
176MenuRedrawFlags menu_next_page (struct Menu *menu);
178MenuRedrawFlags menu_prev_line (struct Menu *menu);
179MenuRedrawFlags menu_prev_page (struct Menu *menu);
180MenuRedrawFlags menu_top_page (struct Menu *menu);
181
182void menu_redraw_current(struct Menu *menu);
183void menu_redraw_full (struct Menu *menu);
184void menu_redraw_index (struct Menu *menu);
185void menu_redraw_motion (struct Menu *menu);
186int menu_redraw (struct Menu *menu);
187
188void menu_add_dialog_row(struct Menu *menu, const char *row);
189void menu_cleanup(void);
191void menu_init(void);
192
193struct MuttWindow *menu_window_new(enum MenuType type, struct ConfigSubset *sub);
194
195int menu_get_index(struct Menu *menu);
196MenuRedrawFlags menu_set_index(struct Menu *menu, int index);
197MenuRedrawFlags menu_move_selection(struct Menu *menu, int index);
198void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw);
199MenuRedrawFlags menu_move_view_relative(struct Menu *menu, int relative);
200MenuRedrawFlags menu_set_and_notify(struct Menu *menu, int top, int index);
201void menu_adjust(struct Menu *menu);
202
203int menu_function_dispatcher(struct MuttWindow *win, int op);
204int menu_tagging_dispatcher(struct MuttWindow *win, int op);
205
206#endif /* MUTT_MENU_LIB_H */
int menu_tagging_dispatcher(struct MuttWindow *win, int op)
Perform tagging operations on the Menu - Implements function_dispatcher_t -.
Definition: tagging.c:230
int menu_function_dispatcher(struct MuttWindow *win, int op)
Perform a Menu function - Implements function_dispatcher_t -.
Definition: functions.c:318
enum MenuType menu_get_current_type(void)
Get the type of the current Window.
Definition: menu.c:89
void menu_init(void)
Initialise all the Menus.
Definition: menu.c:79
MenuRedrawFlags menu_next_page(struct Menu *menu)
Move the focus to the next page in the menu.
Definition: move.c:562
MenuRedrawFlags menu_bottom_page(struct Menu *menu)
Move the focus to the bottom of the page.
Definition: move.c:363
void menu_cleanup(void)
Free the saved Menu searches.
Definition: menu.c:70
void menu_adjust(struct Menu *menu)
Reapply the config to the Menu.
Definition: move.c:319
MenuRedrawFlags menu_half_up(struct Menu *menu)
Move the focus up half a page in the menu.
Definition: move.c:506
MenuRedrawFlags menu_prev_line(struct Menu *menu)
Move the view up one line, keeping the selection the same.
Definition: move.c:526
void menu_redraw_current(struct Menu *menu)
Redraw the current menu.
Definition: draw.c:444
MenuRedrawFlags menu_current_bottom(struct Menu *menu)
Move the current selection to the bottom of the window.
Definition: move.c:484
MenuRedrawFlags menu_move_view_relative(struct Menu *menu, int relative)
Move the view relatively.
Definition: move.c:254
MenuRedrawFlags menu_current_middle(struct Menu *menu)
Move the current selection to the centre of the window.
Definition: move.c:464
void menu_redraw_index(struct Menu *menu)
Force the redraw of the index.
Definition: draw.c:322
ExpandoDataMenu
Expando UIDs for Menus.
Definition: lib.h:67
@ ED_MEN_PERCENTAGE
Menu.top, ...
Definition: lib.h:68
int menu_redraw(struct Menu *menu)
Redraw the parts of the screen that have been flagged to be redrawn.
Definition: draw.c:479
MenuRedrawFlags menu_middle_page(struct Menu *menu)
Move the focus to the centre of the page.
Definition: move.c:343
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition: menu.c:184
MenuRedrawFlags menu_set_and_notify(struct Menu *menu, int top, int index)
Set the Menu selection/view and notify others.
Definition: move.c:66
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition: menu.c:160
MenuRedrawFlags menu_first_entry(struct Menu *menu)
Move the focus to the first entry in the menu.
Definition: move.c:410
void menu_redraw_full(struct Menu *menu)
Force the redraw of the Menu.
Definition: draw.c:308
uint8_t MenuRedrawFlags
Flags, e.g. MENU_REDRAW_INDEX.
Definition: lib.h:54
MenuRedrawFlags menu_half_down(struct Menu *menu)
Move the focus down half a page in the menu.
Definition: move.c:516
MenuRedrawFlags menu_top_page(struct Menu *menu)
Move the focus to the top of the page.
Definition: move.c:333
MenuRedrawFlags menu_move_selection(struct Menu *menu, int index)
Move the selection, keeping within between [0, menu->max].
Definition: move.c:236
MenuRedrawFlags menu_last_entry(struct Menu *menu)
Move the focus to the last entry in the menu.
Definition: move.c:426
MenuRedrawFlags menu_prev_page(struct Menu *menu)
Move the focus to the previous page in the menu.
Definition: move.c:552
MenuRedrawFlags menu_next_line(struct Menu *menu)
Move the view down one line, keeping the selection the same.
Definition: move.c:539
MenuRedrawFlags menu_prev_entry(struct Menu *menu)
Move the focus to the previous item in the menu.
Definition: move.c:382
struct MuttWindow * menu_window_new(enum MenuType type, struct ConfigSubset *sub)
Create a new Menu Window.
Definition: window.c:140
MenuRedrawFlags menu_current_top(struct Menu *menu)
Move the current selection to the top of the window.
Definition: move.c:443
void menu_add_dialog_row(struct Menu *menu, const char *row)
void menu_redraw_motion(struct Menu *menu)
Force the redraw of the list part of the menu.
Definition: draw.c:386
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:174
MenuRedrawFlags menu_next_entry(struct Menu *menu)
Move the focus to the next item in the menu.
Definition: move.c:396
Convenience wrapper for the library headers.
A curses colour and its attributes.
Definition: attr.h:66
String manipulation buffer.
Definition: buffer.h:36
A set of inherited config items.
Definition: subset.h:47
Definition: lib.h:79
struct MuttWindow * win
Window holding the Menu.
Definition: lib.h:86
int search_dir
Direction of search.
Definition: lib.h:92
int current
Current entry.
Definition: lib.h:80
int num_tagged
Number of tagged entries.
Definition: lib.h:93
MenuRedrawFlags redraw
When to redraw the screen.
Definition: lib.h:82
void(* mdata_free)(struct Menu *menu, void **ptr)
Definition: lib.h:161
int(* search)(struct Menu *menu, regex_t *rx, int line)
Definition: lib.h:119
int top
Entry that is the top of the current page.
Definition: lib.h:90
int(* tag)(struct Menu *menu, int sel, int act)
Definition: lib.h:131
enum MenuType type
Menu definition for keymap entries.
Definition: lib.h:83
int(* make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
Definition: lib.h:106
struct ConfigSubset * sub
Inherited config items.
Definition: lib.h:87
struct Notify * notify
Notifications.
Definition: lib.h:145
void * mdata
Private data.
Definition: lib.h:147
bool tag_prefix
User has pressed <tag-prefix>
Definition: lib.h:85
int max
Number of entries in the menu.
Definition: lib.h:81
int page_len
Number of entries per screen.
Definition: lib.h:84
int old_current
For driver use only.
Definition: lib.h:91
enum WindowType type
Window type, e.g. WT_SIDEBAR.
Definition: mutt_window.h:144
Notification API.
Definition: notify.c:53
Menu types.
MenuType
Types of GUI selections.
Definition: type.h:36