code/mutt__menu_8h_source.html

#ifndef MUTT_MENU_H

#define MUTT_MENU_H


#include "config.h"

#include <stdbool.h>

#include <stdint.h>

#include <stdio.h>

#include "mutt/lib.h"

#include "keymap.h"


/* These Config Variables are only used in menu.c */

extern short C_MenuContext;

extern bool  C_MenuMoveOff;

extern bool  C_MenuScroll;


typedef uint16_t MuttRedrawFlags;

#define REDRAW_NO_FLAGS             0

#define REDRAW_INDEX          (1 << 0)

#define REDRAW_MOTION         (1 << 1)

#define REDRAW_MOTION_RESYNC  (1 << 2)

#define REDRAW_CURRENT        (1 << 3)

#define REDRAW_STATUS         (1 << 4)

#define REDRAW_FULL           (1 << 5)

#define REDRAW_BODY           (1 << 6)

#define REDRAW_FLOW           (1 << 7)


struct Menu

{

  const char *title;

  void *mdata;

  int current;

  int max;

  MuttRedrawFlags redraw;

  enum MenuType type;

  int pagelen;

  bool tagprefix : 1;

  bool is_mailbox_list : 1;

  struct MuttWindow *win_index;

  struct MuttWindow *win_ibar;


  /* Setting a non-empty dialog overrides normal menu behavior.

   * In dialog mode menubar is hidden and prompt keys are checked before

   * normal menu movement keys. This can cause problems with scrolling, if

   * prompt keys override movement keys.  */

  ARRAY_HEAD(,char*) dialog;

  char *prompt;

  char *keys;


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

  int top;

  int oldcurrent;

  int search_dir;

  int 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);


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


  void (*custom_redraw)(struct Menu *menu);


  void *redraw_data;

};


void         menu_bottom_page(struct Menu *menu);

void         menu_check_recenter(struct Menu *menu);

void         menu_current_bottom(struct Menu *menu);

void         menu_current_middle(struct Menu *menu);

void         menu_current_top(struct Menu *menu);

void         menu_first_entry(struct Menu *menu);

void         menu_half_down(struct Menu *menu);

void         menu_half_up(struct Menu *menu);

void         menu_last_entry(struct Menu *menu);

void         menu_middle_page(struct Menu *menu);

void         menu_next_line(struct Menu *menu);

void         menu_next_page(struct Menu *menu);

void         menu_prev_line(struct Menu *menu);

void         menu_prev_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);

void         menu_redraw_status(struct Menu *menu);

int          menu_redraw(struct Menu *menu);

void         menu_top_page(struct Menu *menu);

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

void         mutt_menu_current_redraw(void);

void         mutt_menu_free(struct Menu **ptr);

void         mutt_menu_init(void);

int          mutt_menu_loop(struct Menu *menu);

struct Menu *mutt_menu_new(enum MenuType type);

void         mutt_menu_pop_current(struct Menu *menu);

void         mutt_menu_push_current(struct Menu *menu);

void         mutt_menu_set_current_redraw_full(void);

void         mutt_menu_set_current_redraw(MuttRedrawFlags redraw);

void         mutt_menu_set_redraw_full(enum MenuType menu);

void         mutt_menu_set_redraw(enum MenuType menu, MuttRedrawFlags redraw);


int mutt_menu_color_observer (struct NotifyCallback *nc);

int mutt_menu_config_observer(struct NotifyCallback *nc);


#endif /* MUTT_MENU_H */