mutt_menu.h

Go to the documentation of this file.

#ifndef MUTT_MENU_H
#define MUTT_MENU_H

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "keymap.h"
#include "mutt/regex3.h"

struct NotifyCallback;

/* 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) 
#ifdef USE_SIDEBAR
#define REDRAW_SIDEBAR        (1 << 8) 
#endif

enum TreeChar
{
  MUTT_TREE_LLCORNER = 1, 
  MUTT_TREE_ULCORNER,     
  MUTT_TREE_LTEE,         
  MUTT_TREE_HLINE,        
  MUTT_TREE_VLINE,        
  MUTT_TREE_SPACE,        
  MUTT_TREE_RARROW,       
  MUTT_TREE_STAR,         
  MUTT_TREE_HIDDEN,       
  MUTT_TREE_EQUALS,       
  MUTT_TREE_TTEE,         
  MUTT_TREE_BTEE,         
  MUTT_TREE_MISSING,      
  MUTT_TREE_MAX,

  MUTT_SPECIAL_INDEX = MUTT_TREE_MAX, 
};

struct Menu
{
  const char *title;      
  const char *help;       
  void *data;             
  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 dialog != NULL 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.  */
  char **dialog;          
  int dsize;              
  char *prompt;           
  char *keys;             

  /* the following are used only by mutt_menu_loop() */
  int top;                
  int oldcurrent;         
  int search_dir;         
  int tagged;             

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

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

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

  int (*color)(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);
#ifdef USE_SIDEBAR
void         menu_redraw_sidebar(struct Menu *menu);
#endif
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 */