mutt_window.h

Go to the documentation of this file.

 
#ifndef MUTT_GUI_MUTT_WINDOW_H
#define MUTT_GUI_MUTT_WINDOW_H
 
#include <stdbool.h>
#include <stdint.h>
#include "mutt/lib.h"
 
struct ConfigSubset;

enum MuttWindowOrientation
{
  MUTT_WIN_ORIENT_VERTICAL = 1, 
  MUTT_WIN_ORIENT_HORIZONTAL,   
};

enum MuttWindowSize
{
  MUTT_WIN_SIZE_FIXED = 1, 
  MUTT_WIN_SIZE_MAXIMISE,  
  MUTT_WIN_SIZE_MINIMISE,  
};
 
#define MUTT_WIN_SIZE_UNLIMITED -1 

struct WindowState
{
  bool visible;     
  short cols;       
  short rows;       
  short col_offset; 
  short row_offset; 
};

enum WindowType
{
  // Structural Windows
  WT_ROOT,            
  WT_CONTAINER,       
  WT_ALL_DIALOGS,     
 
  // Dialogs (nested Windows) displayed to the user
  WT_DLG_ALIAS,       
  WT_DLG_ATTACH,      
  WT_DLG_AUTOCRYPT,   
  WT_DLG_BROWSER,     
  WT_DLG_CERTIFICATE, 
  WT_DLG_COMPOSE,     
  WT_DLG_GPGME,       
  WT_DLG_PAGER,       
  WT_DLG_HISTORY,     
  WT_DLG_INDEX,       
  WT_DLG_PATTERN,     
  WT_DLG_PGP,         
  WT_DLG_POSTPONE,    
  WT_DLG_QUERY,       
  WT_DLG_SMIME,       
 
  // Common Windows
  WT_CUSTOM,          
  WT_HELP_BAR,        
  WT_INDEX,           
  WT_MENU,            
  WT_MESSAGE,         
  WT_PAGER,           
  WT_SIDEBAR,         
  WT_STATUS_BAR,      
};
 
ARRAY_HEAD(MuttWindowArray, struct MuttWindow *);

enum WindowActionFlag
{
  WA_NONE    =       0,  
  WA_REFLOW  = 1U << 0,  
  WA_RECALC  = 1U << 1,  
  WA_REPAINT = 1U << 2,  
};
typedef uint8_t WindowActionFlags;

struct MuttWindow
{
  short req_cols;                        
  short req_rows;                        
 
  struct WindowState state;              
  struct WindowState old;                
 
  enum MuttWindowOrientation orient;     
  enum MuttWindowSize size;              
  WindowActionFlags actions;             
 
  struct MuttWindow *parent;             
  struct MuttWindowArray children;       
 
  struct Notify *notify;                 
 
  struct MuttWindow *focus;              
  const struct MenuDefinition *help_md;  
  const struct Mapping *help_data;       
 
  enum WindowType type;                  
  void *wdata;                           

  void (*wdata_free)(struct MuttWindow *win, void **ptr);

  int (*recalc)(struct MuttWindow *win);

  int (*repaint)(struct MuttWindow *win);

  bool (*recursor)(struct MuttWindow *win);
};

enum WindowNotifyFlag
{
  WN_NONE     =       0,  
  WN_TALLER   = 1U << 0,  
  WN_SHORTER  = 1U << 1,  
  WN_WIDER    = 1U << 2,  
  WN_NARROWER = 1U << 3,  
  WN_MOVED    = 1U << 4,  
  WN_VISIBLE  = 1U << 5,  
  WN_HIDDEN   = 1U << 6,  
};
typedef uint8_t WindowNotifyFlags;

enum NotifyWindow
{
  NT_WINDOW_ADD = 1, 
  NT_WINDOW_DELETE,  
  NT_WINDOW_STATE,   
  NT_WINDOW_DIALOG,  
  NT_WINDOW_FOCUS,   
};

struct EventWindow
{
  struct MuttWindow *win;  
  WindowNotifyFlags flags; 
};
 
// Functions that deal with the Window
void               mutt_window_add_child          (struct MuttWindow *parent, struct MuttWindow *child);
void               mutt_window_free               (struct MuttWindow **ptr);
void               mutt_window_get_coords         (struct MuttWindow *win, int *row, int *col);
struct MuttWindow *mutt_window_new                (enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows);
void               mutt_window_reflow             (struct MuttWindow *win);
struct MuttWindow *mutt_window_remove_child       (struct MuttWindow *parent, struct MuttWindow *child);
int                mutt_window_wrap_cols          (int width, short wrap);
 
// Functions for drawing on the Window
int  mutt_window_addch    (struct MuttWindow *win, int ch);
int  mutt_window_addnstr  (struct MuttWindow *win, const char *str, int num);
int  mutt_window_addstr   (struct MuttWindow *win, const char *str);
void mutt_window_clearline(struct MuttWindow *win, int row);
void mutt_window_clear    (struct MuttWindow *win);
void mutt_window_clrtoeol (struct MuttWindow *win);
int  mutt_window_move     (struct MuttWindow *win, int row, int col);
int  mutt_window_printf   (struct MuttWindow *win, const char *format, ...)
                            __attribute__((__format__(__printf__, 2, 3)));
bool mutt_window_is_visible(struct MuttWindow *win);
 
void               mutt_winlist_free (struct MuttWindowArray *wa);
struct MuttWindow *window_find_child (struct MuttWindow *win, enum WindowType type);
struct MuttWindow *window_find_parent(struct MuttWindow *win, enum WindowType type);
void               window_notify_all (struct MuttWindow *win);
void               window_set_visible(struct MuttWindow *win, bool visible);
struct MuttWindow *window_set_focus  (struct MuttWindow *win);
struct MuttWindow *window_get_focus  (void);
bool               window_is_focused (const struct MuttWindow *win);
 
void window_redraw(struct MuttWindow *win);
void window_invalidate_all(void);
const char *mutt_window_win_name(const struct MuttWindow *win);
bool window_status_on_top(struct MuttWindow *panel, const struct ConfigSubset *sub);
bool mutt_window_swap(struct MuttWindow *parent, struct MuttWindow *win1, struct MuttWindow *win2);
 
#endif /* MUTT_GUI_MUTT_WINDOW_H */