mutt_window.h

Go to the documentation of this file.

#ifndef MUTT_MUTT_WINDOW_H
#define MUTT_MUTT_WINDOW_H

#include "config.h"

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 rows;       
  short cols;       
  short row_offset; 
  short col_offset; 
};

enum WindowType
{
  WT_ROOT,        
  WT_ALL_DIALOGS, 
  WT_DIALOG,      
  WT_CONTAINER,   
  WT_HELP_BAR,    
  WT_MESSAGE,     
  WT_INDEX,       
  WT_INDEX_BAR,   
  WT_PAGER,       
  WT_PAGER_BAR,   
  WT_SIDEBAR,     
};

TAILQ_HEAD(MuttWindowList, MuttWindow);

struct MuttWindow
{
  short req_rows;                    
  short req_cols;                    

  struct WindowState state;          
  struct WindowState old;            

  enum MuttWindowOrientation orient; 
  enum MuttWindowSize size;          

  TAILQ_ENTRY(MuttWindow) entries;   
  struct MuttWindow *parent;         
  struct MuttWindowList children;    

  enum WindowType type;              
  void *wdata;                       
  void (*free_wdata)(struct MuttWindow *win, void **); 
};

extern struct MuttWindow *MuttDialogWindow;
extern struct MuttWindow *MuttHelpWindow;
extern struct MuttWindow *MuttMessageWindow;

// Functions that deal with the Window
void               mutt_window_add_child          (struct MuttWindow *parent, struct MuttWindow *child);
void               mutt_window_copy_size          (const struct MuttWindow *win_src, struct MuttWindow *win_dst);
void               mutt_window_free               (struct MuttWindow **ptr);
void               mutt_window_free_all           (void);
void               mutt_window_get_coords         (struct MuttWindow *win, int *col, int *row);
void               mutt_window_init               (void);
struct MuttWindow *mutt_window_new                (enum MuttWindowOrientation orient, enum MuttWindowSize size, int rows, int cols);
void               mutt_window_reflow             (struct MuttWindow *win);
void               mutt_window_reflow_message_rows(int mw_rows);
void               mutt_window_set_root           (int rows, int cols);
int                mutt_window_wrap_cols          (int width, short wrap);

// Functions for drawing on the Window
int  mutt_window_addch    (int ch);
int  mutt_window_addnstr  (const char *str, int num);
int  mutt_window_addstr   (const char *str);
void mutt_window_clearline(struct MuttWindow *win, int row);
void mutt_window_clrtobot (void);
void mutt_window_clrtoeol (struct MuttWindow *win);
int  mutt_window_move     (struct MuttWindow *win, int row, int col);
void mutt_window_move_abs (int row, int col);
int  mutt_window_mvaddstr (struct MuttWindow *win, int row, int col, const char *str);
int  mutt_window_mvprintw (struct MuttWindow *win, int row, int col, const char *fmt, ...);
int  mutt_window_printf   (const char *format, ...);
bool mutt_window_is_visible(struct MuttWindow *win);

void mutt_winlist_free       (struct MuttWindowList *head);
struct MuttWindow *mutt_window_find(struct MuttWindow *root, enum WindowType type);
struct MuttWindow *mutt_window_dialog(struct MuttWindow *win);

void mutt_winlist_free       (struct MuttWindowList *head);
void dialog_pop(void);
void dialog_push(struct MuttWindow *dlg);

#endif /* MUTT_MUTT_WINDOW_H */