code/menu_2lib_8h_source.html

#ifndef MUTT_MENU_LIB_H

#define MUTT_MENU_LIB_H


#include "config.h"

#include <stddef.h>

#include <stdbool.h>

#include <stdint.h>

#include "mutt/lib.h"

#include "type.h"


struct ConfigSubset;

struct MuttWindow;


// Observers of #NT_MENU will not be passed any Event data.

typedef uint8_t MenuRedrawFlags;

#define MENU_REDRAW_NO_FLAGS        0

#define MENU_REDRAW_INDEX     (1 << 0)

#define MENU_REDRAW_MOTION    (1 << 1)

#define MENU_REDRAW_CURRENT   (1 << 2)

#define MENU_REDRAW_FULL      (1 << 3)


struct Menu

{

  int current;

  int max;

  MenuRedrawFlags redraw;

  enum MenuType type;

  int page_len;

  bool tag_prefix : 1;

  struct MuttWindow *win;

  struct ConfigSubset *sub;


  /* the following are used only by menu_loop() */

  int top;

  int old_current;

  int search_dir;

  int num_tagged;

  bool custom_search : 1;


  void (*make_entry)(struct Menu *menu, char *buf, size_t buflen, int line);


  int (*search)(struct Menu *menu, regex_t *rx, int line);


  int (*tag)(struct Menu *menu, int sel, int act);


  struct AttrColor *(*color)(struct Menu *menu, int line);


  struct Notify *notify;


  void *mdata;


  void (*mdata_free)(struct Menu *menu, void **ptr);

};


// Simple movement

MenuRedrawFlags menu_bottom_page   (struct Menu *menu);

MenuRedrawFlags menu_current_bottom(struct Menu *menu);

MenuRedrawFlags menu_current_middle(struct Menu *menu);

MenuRedrawFlags menu_current_top   (struct Menu *menu);

MenuRedrawFlags menu_first_entry   (struct Menu *menu);

MenuRedrawFlags menu_half_down     (struct Menu *menu);

MenuRedrawFlags menu_half_up       (struct Menu *menu);

MenuRedrawFlags menu_last_entry    (struct Menu *menu);

MenuRedrawFlags menu_middle_page   (struct Menu *menu);

MenuRedrawFlags menu_next_entry    (struct Menu *menu);

MenuRedrawFlags menu_next_line     (struct Menu *menu);

MenuRedrawFlags menu_next_page     (struct Menu *menu);

MenuRedrawFlags menu_prev_entry    (struct Menu *menu);

MenuRedrawFlags menu_prev_line     (struct Menu *menu);

MenuRedrawFlags menu_prev_page     (struct Menu *menu);

MenuRedrawFlags menu_top_page      (struct Menu *menu);


void         menu_redraw_current(struct Menu *menu);

void         menu_redraw_full   (struct Menu *menu);

void         menu_redraw_index  (struct Menu *menu);

void         menu_redraw_motion (struct Menu *menu);

int          menu_redraw        (struct Menu *menu);


void         menu_add_dialog_row(struct Menu *menu, const char *row);

void         menu_cleanup(void);

enum MenuType menu_get_current_type(void);

void         menu_init(void);


struct MuttWindow *menu_window_new(enum MenuType type, struct ConfigSubset *sub);


int  menu_get_index(struct Menu *menu);

MenuRedrawFlags menu_set_index(struct Menu *menu, int index);

MenuRedrawFlags menu_move_selection(struct Menu *menu, int index);

void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw);

MenuRedrawFlags menu_move_view_relative(struct Menu *menu, int relative);

MenuRedrawFlags menu_set_and_notify(struct Menu *menu, int top, int index);

void menu_adjust(struct Menu *menu);


int menu_function_dispatcher(struct MuttWindow *win, int op);

int menu_tagging_dispatcher(struct MuttWindow *win, int op);


#endif /* MUTT_MENU_LIB_H */

menu_tagging_dispatcher
int menu_tagging_dispatcher(struct MuttWindow *win, int op)
Perform tagging operations on the Menu - Implements function_dispatcher_t -.
Definition: tagging.c:223

menu_function_dispatcher
int menu_function_dispatcher(struct MuttWindow *win, int op)
Perform a Menu function - Implements function_dispatcher_t -.
Definition: functions.c:317

menu_get_current_type
enum MenuType menu_get_current_type(void)
Get the type of the current Window.
Definition: menu.c:85

menu_init
void menu_init(void)
Initialise all the Menus.
Definition: menu.c:75

menu_next_page
MenuRedrawFlags menu_next_page(struct Menu *menu)
Move the focus to the next page in the menu.
Definition: move.c:562

menu_bottom_page
MenuRedrawFlags menu_bottom_page(struct Menu *menu)
Move the focus to the bottom of the page.
Definition: move.c:363

menu_cleanup
void menu_cleanup(void)
Free the saved Menu searches.
Definition: menu.c:66

menu_adjust
void menu_adjust(struct Menu *menu)
Reapply the config to the Menu.
Definition: move.c:319

menu_half_up
MenuRedrawFlags menu_half_up(struct Menu *menu)
Move the focus up half a page in the menu.
Definition: move.c:506

menu_prev_line
MenuRedrawFlags menu_prev_line(struct Menu *menu)
Move the view up one line, keeping the selection the same.
Definition: move.c:526

menu_redraw_current
void menu_redraw_current(struct Menu *menu)
Redraw the current menu.
Definition: draw.c:438

menu_current_bottom
MenuRedrawFlags menu_current_bottom(struct Menu *menu)
Move the current selection to the bottom of the window.
Definition: move.c:484

menu_move_view_relative
MenuRedrawFlags menu_move_view_relative(struct Menu *menu, int relative)
Move the view relatively.
Definition: move.c:254

menu_current_middle
MenuRedrawFlags menu_current_middle(struct Menu *menu)
Move the current selection to the centre of the window.
Definition: move.c:464

menu_redraw_index
void menu_redraw_index(struct Menu *menu)
Force the redraw of the index.
Definition: draw.c:322

menu_redraw
int menu_redraw(struct Menu *menu)
Redraw the parts of the screen that have been flagged to be redrawn.
Definition: draw.c:474

menu_middle_page
MenuRedrawFlags menu_middle_page(struct Menu *menu)
Move the focus to the centre of the page.
Definition: move.c:343

menu_queue_redraw
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition: menu.c:179

menu_set_and_notify
MenuRedrawFlags menu_set_and_notify(struct Menu *menu, int top, int index)
Set the Menu selection/view and notify others.
Definition: move.c:66

menu_get_index
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition: menu.c:155

menu_first_entry
MenuRedrawFlags menu_first_entry(struct Menu *menu)
Move the focus to the first entry in the menu.
Definition: move.c:410

menu_redraw_full
void menu_redraw_full(struct Menu *menu)
Force the redraw of the Menu.
Definition: draw.c:308

MenuRedrawFlags
uint8_t MenuRedrawFlags
Flags, e.g. MENU_REDRAW_INDEX.
Definition: lib.h:55

menu_half_down
MenuRedrawFlags menu_half_down(struct Menu *menu)
Move the focus down half a page in the menu.
Definition: move.c:516

menu_top_page
MenuRedrawFlags menu_top_page(struct Menu *menu)
Move the focus to the top of the page.
Definition: move.c:333

menu_move_selection
MenuRedrawFlags menu_move_selection(struct Menu *menu, int index)
Move the selection, keeping within between [0, menu->max].
Definition: move.c:236

menu_last_entry
MenuRedrawFlags menu_last_entry(struct Menu *menu)
Move the focus to the last entry in the menu.
Definition: move.c:426

menu_prev_page
MenuRedrawFlags menu_prev_page(struct Menu *menu)
Move the focus to the previous page in the menu.
Definition: move.c:552

menu_next_line
MenuRedrawFlags menu_next_line(struct Menu *menu)
Move the view down one line, keeping the selection the same.
Definition: move.c:539

menu_prev_entry
MenuRedrawFlags menu_prev_entry(struct Menu *menu)
Move the focus to the previous item in the menu.
Definition: move.c:382

menu_window_new
struct MuttWindow * menu_window_new(enum MenuType type, struct ConfigSubset *sub)
Create a new Menu Window.
Definition: window.c:138

menu_current_top
MenuRedrawFlags menu_current_top(struct Menu *menu)
Move the current selection to the top of the window.
Definition: move.c:443

menu_add_dialog_row
void menu_add_dialog_row(struct Menu *menu, const char *row)

menu_redraw_motion
void menu_redraw_motion(struct Menu *menu)
Force the redraw of the list part of the menu.
Definition: draw.c:379

menu_set_index
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:169

menu_next_entry
MenuRedrawFlags menu_next_entry(struct Menu *menu)
Move the focus to the next item in the menu.
Definition: move.c:396

lib.h
Convenience wrapper for the library headers.

AttrColor
A curses colour and its attributes.
Definition: attr.h:35

ConfigSubset
A set of inherited config items.
Definition: subset.h:47

Menu
Definition: lib.h:70

Menu::win
struct MuttWindow * win
Window holding the Menu.
Definition: lib.h:77

Menu::search_dir
int search_dir
Direction of search.
Definition: lib.h:83

Menu::make_entry
void(* make_entry)(struct Menu *menu, char *buf, size_t buflen, int line)
Definition: lib.h:97

Menu::current
int current
Current entry.
Definition: lib.h:71

Menu::num_tagged
int num_tagged
Number of tagged entries.
Definition: lib.h:84

Menu::redraw
MenuRedrawFlags redraw
When to redraw the screen.
Definition: lib.h:73

Menu::mdata_free
void(* mdata_free)(struct Menu *menu, void **ptr)
Definition: lib.h:152

Menu::search
int(* search)(struct Menu *menu, regex_t *rx, int line)
Definition: lib.h:110

Menu::top
int top
Entry that is the top of the current page.
Definition: lib.h:81

Menu::tag
int(* tag)(struct Menu *menu, int sel, int act)
Definition: lib.h:122

Menu::type
enum MenuType type
Menu definition for keymap entries.
Definition: lib.h:74

Menu::sub
struct ConfigSubset * sub
Inherited config items.
Definition: lib.h:78

Menu::notify
struct Notify * notify
Notifications.
Definition: lib.h:136

Menu::mdata
void * mdata
Private data.
Definition: lib.h:138

Menu::tag_prefix
bool tag_prefix
User has pressed <tag-prefix>
Definition: lib.h:76

Menu::max
int max
Number of entries in the menu.
Definition: lib.h:72

Menu::custom_search
bool custom_search
The menu implements its own non-Menusearch()-compatible search, trickle OP_SEARCH*.
Definition: lib.h:85

Menu::page_len
int page_len
Number of entries per screen.
Definition: lib.h:75

Menu::old_current
int old_current
For driver use only.
Definition: lib.h:82

MuttWindow
Definition: mutt_window.h:123

MuttWindow::type
enum WindowType type
Window type, e.g. WT_SIDEBAR.
Definition: mutt_window.h:144

Notify
Notification API.
Definition: notify.c:51

type.h
Menu types.

MenuType
MenuType
Types of GUI selections.
Definition: type.h:36