NeoMutt  2020-11-20
Teaching an old dog new tricks
DOXYGEN
MuttWindow Struct Reference

A division of the screen. More...

#include "mutt_window.h"

+ Inheritance diagram for MuttWindow:
+ Collaboration diagram for MuttWindow:

Public Member Functions

 TAILQ_ENTRY (MuttWindow) entries
 Linked list. More...
 

Data Fields

short req_cols
 Number of columns required. More...
 
short req_rows
 Number of rows required. More...
 
struct WindowState state
 Current state of the Window. More...
 
struct WindowState old
 Previous state of the Window. More...
 
enum MuttWindowOrientation orient
 Which direction the Window will expand. More...
 
enum MuttWindowSize size
 Type of Window, e.g. MUTT_WIN_SIZE_FIXED. More...
 
WindowActionFlags actions
 Actions to be performed, e.g. WA_RECALC. More...
 
struct MuttWindowparent
 Parent Window. More...
 
struct MuttWindowList children
 Children Windows. More...
 
struct Notifynotify
 Notifications system. More...
 
struct MuttWindowfocus
 Focussed Window. More...
 
int help_menu
 Menu for key bindings, e.g. MENU_PAGER. More...
 
const struct Mappinghelp_data
 Data for the Help Bar. More...
 
enum WindowType type
 Window type, e.g. WT_SIDEBAR. More...
 
void * wdata
 Private data. More...
 
void(* wdata_free )(struct MuttWindow *win, void **ptr)
 Free the private data attached to the MuttWindow. More...
 
int(* recalc )(struct MuttWindow *win)
 Recalculate the Window data. More...
 
int(* repaint )(struct MuttWindow *win)
 Repaint the Window. More...
 

Detailed Description

A division of the screen.

Windows for different parts of the screen

Definition at line 115 of file mutt_window.h.

Member Function Documentation

◆ TAILQ_ENTRY()

MuttWindow::TAILQ_ENTRY ( MuttWindow  )

Linked list.

Field Documentation

◆ req_cols

short MuttWindow::req_cols

Number of columns required.

Definition at line 117 of file mutt_window.h.

◆ req_rows

short MuttWindow::req_rows

Number of rows required.

Definition at line 118 of file mutt_window.h.

◆ state

struct WindowState MuttWindow::state

Current state of the Window.

Definition at line 120 of file mutt_window.h.

◆ old

struct WindowState MuttWindow::old

Previous state of the Window.

Definition at line 121 of file mutt_window.h.

◆ orient

enum MuttWindowOrientation MuttWindow::orient

Which direction the Window will expand.

Definition at line 123 of file mutt_window.h.

◆ size

enum MuttWindowSize MuttWindow::size

Type of Window, e.g. MUTT_WIN_SIZE_FIXED.

Definition at line 124 of file mutt_window.h.

◆ actions

WindowActionFlags MuttWindow::actions

Actions to be performed, e.g. WA_RECALC.

Definition at line 125 of file mutt_window.h.

◆ parent

struct MuttWindow* MuttWindow::parent

Parent Window.

Definition at line 128 of file mutt_window.h.

◆ children

struct MuttWindowList MuttWindow::children

Children Windows.

Definition at line 129 of file mutt_window.h.

◆ notify

struct Notify* MuttWindow::notify

Notifications system.

Definition at line 131 of file mutt_window.h.

◆ focus

struct MuttWindow* MuttWindow::focus

Focussed Window.

Definition at line 133 of file mutt_window.h.

◆ help_menu

int MuttWindow::help_menu

Menu for key bindings, e.g. MENU_PAGER.

Definition at line 134 of file mutt_window.h.

◆ help_data

const struct Mapping* MuttWindow::help_data

Data for the Help Bar.

Definition at line 135 of file mutt_window.h.

◆ type

enum WindowType MuttWindow::type

Window type, e.g. WT_SIDEBAR.

Definition at line 137 of file mutt_window.h.

◆ wdata

void* MuttWindow::wdata

Private data.

Definition at line 138 of file mutt_window.h.

◆ wdata_free

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

Free the private data attached to the MuttWindow.

Parameters
winWindow
ptrWindow data to free

Definition at line 145 of file mutt_window.h.

◆ recalc

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

Recalculate the Window data.

Parameters
winWindow
Return values
0Success
-1Error

Definition at line 153 of file mutt_window.h.

◆ repaint

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

Repaint the Window.

Parameters
winWindow
Return values
0Success
-1Error

Definition at line 161 of file mutt_window.h.


The documentation for this struct was generated from the following file: