lib.h

Go to the documentation of this file.

 
#ifndef MUTT_MENU_LIB_H
#define MUTT_MENU_LIB_H
 
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "type.h"
 
struct ConfigSubset;
struct KeyEvent;
struct MenuDefinition;
struct MuttWindow;
 
// Observers of #NT_MENU will not be passed any Event data.
enum MenuRedrawFlag
{
  MENU_REDRAW_NONE    =       0,  
  MENU_REDRAW_INDEX   = 1U << 0,  
  MENU_REDRAW_MOTION  = 1U << 1,  
  MENU_REDRAW_CURRENT = 1U << 2,  
  MENU_REDRAW_FULL    = 1U << 3,  
};
typedef uint8_t MenuRedrawFlags;

enum ExpandoDataMenu
{
  ED_MEN_PERCENTAGE,           
};

struct Menu
{
  int current;                       
  int max;                           
  MenuRedrawFlags redraw;            
  const struct MenuDefinition *md;   
  int page_len;                      
  bool tag_prefix     : 1;           
  bool show_indicator : 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;                    

  int (*make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf);

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

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

  const 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, int count);
MenuRedrawFlags menu_half_down     (struct Menu *menu, int count);
MenuRedrawFlags menu_half_up       (struct Menu *menu, int count);
MenuRedrawFlags menu_last_entry    (struct Menu *menu, int count);
MenuRedrawFlags menu_middle_page   (struct Menu *menu);
MenuRedrawFlags menu_next_entry    (struct Menu *menu, int count);
MenuRedrawFlags menu_next_line     (struct Menu *menu, int count);
MenuRedrawFlags menu_next_page     (struct Menu *menu, int count);
MenuRedrawFlags menu_prev_entry    (struct Menu *menu, int count);
MenuRedrawFlags menu_prev_line     (struct Menu *menu, int count);
MenuRedrawFlags menu_prev_page     (struct Menu *menu, int count);
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);
 
enum MenuType menu_get_current_type(void);
void         menu_init2(char **search_buffers);
 
struct MuttWindow *menu_window_new(const struct MenuDefinition *md, 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, const struct KeyEvent *event);
int menu_tagging_dispatcher(struct MuttWindow *win, const struct KeyEvent *event);
 
#endif /* MUTT_MENU_LIB_H */