mutt_window.c File Reference

Window management. More...

#include "config.h"
#include <stdarg.h>
#include <string.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "mutt_window.h"
#include "curs_lib.h"
#include "mutt_curses.h"
#include "mutt_globals.h"
#include "options.h"
#include "reflow.h"
#include "rootwin.h"

Include dependency graph for mutt_window.c:

Go to the source code of this file.

Functions
static bool	window_was_visible (struct MuttWindow *win)
	Was the Window visible? More...
static void	window_notify (struct MuttWindow *win)
	Notify observers of changes to a Window. More...
void	window_notify_all (struct MuttWindow *win)
	Notify observers of changes to a Window and its children. More...
void	window_set_visible (struct MuttWindow *win, bool visible)
	Set a Window visible or hidden. More...
struct MuttWindow *	mutt_window_new (enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
	Create a new Window. More...
void	mutt_window_free (struct MuttWindow **ptr)
	Free a Window and its children. More...
void	mutt_window_clearline (struct MuttWindow *win, int row)
	Clear a row of a Window. More...
void	mutt_window_clrtoeol (struct MuttWindow *win)
	Clear to the end of the line. More...
void	mutt_window_get_coords (struct MuttWindow *win, int *col, int *row)
	Get the cursor position in the Window. More...
int	mutt_window_move (struct MuttWindow *win, int col, int row)
	Move the cursor in a Window. More...
int	mutt_window_mvaddstr (struct MuttWindow *win, int col, int row, const char *str)
	Move the cursor and write a fixed string to a Window. More...
int	mutt_window_mvprintw (struct MuttWindow *win, int col, int row, const char *fmt,...)
	Move the cursor and write a formatted string to a Window. More...
void	mutt_window_reflow (struct MuttWindow *win)
	Resize a Window and its children. More...
int	mutt_window_wrap_cols (int width, short wrap)
	Calculate the wrap column for a given screen width. More...
int	mutt_window_addch (struct MuttWindow *win, int ch)
	Write one character to a Window. More...
int	mutt_window_addnstr (struct MuttWindow *win, const char *str, int num)
	Write a partial string to a Window. More...
int	mutt_window_addstr (struct MuttWindow *win, const char *str)
	Write a string to a Window. More...
int	mutt_window_printf (struct MuttWindow *win, const char *fmt,...)
	Write a formatted string to a Window. More...
void	mutt_window_add_child (struct MuttWindow *parent, struct MuttWindow *child)
	Add a child to Window. More...
struct MuttWindow *	mutt_window_remove_child (struct MuttWindow *parent, struct MuttWindow *child)
	Remove a child from a Window. More...
void	mutt_winlist_free (struct MuttWindowList *head)
	Free a tree of Windows. More...
bool	mutt_window_is_visible (struct MuttWindow *win)
	Is the Window visible? More...
struct MuttWindow *	window_find_child (struct MuttWindow *win, enum WindowType type)
	Recursively find a child Window of a given type. More...
struct MuttWindow *	window_find_parent (struct MuttWindow *win, enum WindowType type)
	Find a (grand-)parent of a Window by type. More...
static void	window_recalc (struct MuttWindow *win)
	Recalculate a tree of Windows. More...
static void	window_repaint (struct MuttWindow *win)
	Repaint a tree of Windows. More...
void	window_redraw (struct MuttWindow *win)
	Reflow, recalc and repaint a tree of Windows. More...
bool	window_is_focused (const struct MuttWindow *win)
	Does the given Window have the focus? More...
struct MuttWindow *	window_get_focus (void)
	Get the currently focused Window. More...
struct MuttWindow *	window_set_focus (struct MuttWindow *win)
	Set the Window focus. More...
void	mutt_window_clear (struct MuttWindow *win)
	Clear a Window. More...
const char *	mutt_window_win_name (const struct MuttWindow *win)
	Get the name of a Window. More...
static void	window_invalidate (struct MuttWindow *win)
	Mark a window as in need of repaint. More...
void	window_invalidate_all (void)
	Mark all windows as in need of repaint. More...
bool	window_status_on_top (struct MuttWindow *panel, struct ConfigSubset *sub)
	Organise windows according to config variable. More...

Variables
static const struct Mapping	WindowNames []
	Lookups for Window Names. More...

Detailed Description

Window management.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file mutt_window.c.

Function Documentation

window_was_visible()

static bool window_was_visible ( struct MuttWindow *  win )

static

Was the Window visible?

Parameters

win

Window

Return values

true	The Window was visible

Using the WindowState old, check if a Window used to be visible. For a Window to be visible, it must have been visible and its parent and grandparent, etc.

Definition at line 87 of file mutt_window.c.

{
  if (!win)
    return false;
 
  for (; win; win = win->parent)
  {
    if (!win->old.visible)
      return false;
  }
 
  return true;
}

Here is the caller graph for this function:

window_notify()

static void window_notify ( struct MuttWindow *  win )

static

Notify observers of changes to a Window.

Parameters

win

Window

Definition at line 105 of file mutt_window.c.

{
  if (!win->notify)
    return;
 
  const struct WindowState *old = &win->old;
  const struct WindowState *state = &win->state;
  WindowNotifyFlags flags = WN_NO_FLAGS;
 
  const bool was_visible = window_was_visible(win);
  const bool is_visible = mutt_window_is_visible(win);
  if (was_visible != is_visible)
    flags |= is_visible ? WN_VISIBLE : WN_HIDDEN;
 
  if ((state->row_offset != old->row_offset) || (state->col_offset != old->col_offset))
    flags |= WN_MOVED;
 
  if (state->rows > old->rows)
    flags |= WN_TALLER;
  else if (state->rows < old->rows)
    flags |= WN_SHORTER;
 
  if (state->cols > old->cols)
    flags |= WN_WIDER;
  else if (state->cols < old->cols)
    flags |= WN_NARROWER;
 
  if (flags == WN_NO_FLAGS)
    return;
 
  mutt_debug(LL_NOTIFY, "NT_WINDOW_STATE: %s, %p\n", mutt_window_win_name(win), win);
  struct EventWindow ev_w = { win, flags };
  notify_send(win->notify, NT_WINDOW, NT_WINDOW_STATE, &ev_w);
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_notify_all()

void window_notify_all

(

struct MuttWindow *

win

)

Notify observers of changes to a Window and its children.

Parameters

win

Window

Definition at line 144 of file mutt_window.c.

{
  if (!win)
    win = RootWindow;
 
  window_notify(win);
 
  struct MuttWindow *np = NULL;
  TAILQ_FOREACH(np, &win->children, entries)
  {
    window_notify_all(np);
  }
  win->old = win->state;
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_set_visible()

void window_set_visible	(	struct MuttWindow *	win,
		bool	visible
	)

Set a Window visible or hidden.

Parameters

win	Window
visible	If true, make Window visible, otherwise hidden

Definition at line 164 of file mutt_window.c.

{
  if (!win)
    win = RootWindow;
 
  win->state.visible = visible;
}

Here is the caller graph for this function:

mutt_window_new()

struct MuttWindow * mutt_window_new	(	enum WindowType	type,
		enum MuttWindowOrientation	orient,
		enum MuttWindowSize	size,
		int	cols,
		int	rows
	)

Create a new Window.

Parameters

type	Window type, e.g. WT_ROOT
orient	Window orientation, e.g. MUTT_WIN_ORIENT_VERTICAL
size	Window size, e.g. MUTT_WIN_SIZE_MAXIMISE
cols	Initial number of columns to allocate, can be MUTT_WIN_SIZE_UNLIMITED
rows	Initial number of rows to allocate, can be MUTT_WIN_SIZE_UNLIMITED

Return values

ptr	New Window

Definition at line 181 of file mutt_window.c.

{
  struct MuttWindow *win = mutt_mem_calloc(1, sizeof(struct MuttWindow));
 
  win->type = type;
  win->orient = orient;
  win->size = size;
  win->req_rows = rows;
  win->req_cols = cols;
  win->state.visible = true;
  win->notify = notify_new();
  TAILQ_INIT(&win->children);
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_free()

void mutt_window_free

(

struct MuttWindow **

ptr

)

Free a Window and its children.

Parameters

ptr	Window to free

Definition at line 201 of file mutt_window.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct MuttWindow *win = *ptr;
 
  if (win->parent && (win->parent->focus == win))
    win->parent->focus = NULL;
 
  mutt_debug(LL_NOTIFY, "NT_WINDOW_DELETE: %s, %p\n", mutt_window_win_name(win), win);
  struct EventWindow ev_w = { win, WN_NO_FLAGS };
  notify_send(win->notify, NT_WINDOW, NT_WINDOW_DELETE, &ev_w);
 
  mutt_winlist_free(&win->children);
 
  if (win->wdata_free && win->wdata)
    win->wdata_free(win, &win->wdata); // Custom function to free private data
 
  notify_free(&win->notify);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_clearline()

void mutt_window_clearline	(	struct MuttWindow *	win,
		int	row
	)

Clear a row of a Window.

Parameters

win	Window
row	Row to clear

Definition at line 230 of file mutt_window.c.

{
  mutt_window_move(win, 0, row);
  mutt_window_clrtoeol(win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_clrtoeol()

void mutt_window_clrtoeol

(

struct MuttWindow *

win

)

Clear to the end of the line.

Parameters

win

Window

Note

Assumes the cursor has already been positioned within the window.

Definition at line 242 of file mutt_window.c.

{
  if (!win || !stdscr)
    return;
 
  if ((win->state.col_offset + win->state.cols) == COLS)
    clrtoeol();
  else
  {
    int row = 0;
    int col = 0;
    getyx(stdscr, row, col);
    int curcol = col;
    while (curcol < (win->state.col_offset + win->state.cols))
    {
      addch(' ');
      curcol++;
    }
    move(row, col);
  }
}

Here is the caller graph for this function:

mutt_window_get_coords()

void mutt_window_get_coords	(	struct MuttWindow *	win,
		int *	col,
		int *	row
	)

Get the cursor position in the Window.

Parameters

[in]	win	Window
[out]	col	Column in Window
[out]	row	Row in Window

Assumes the current position is inside the window. Otherwise it will happily return negative or values outside the window boundaries

Definition at line 273 of file mutt_window.c.

{
  int x = 0;
  int y = 0;
 
  getyx(stdscr, y, x);
  if (col)
    *col = x - win->state.col_offset;
  if (row)
    *row = y - win->state.row_offset;
}

Here is the caller graph for this function:

mutt_window_move()

int mutt_window_move	(	struct MuttWindow *	win,
		int	col,
		int	row
	)

Move the cursor in a Window.

Parameters

win	Window
col	Column to move to
row	Row to move to

Return values

OK	Success
ERR	Error

Definition at line 293 of file mutt_window.c.

{
  return move(win->state.row_offset + row, win->state.col_offset + col);
}

Here is the caller graph for this function:

mutt_window_mvaddstr()

int mutt_window_mvaddstr	(	struct MuttWindow *	win,
		int	col,
		int	row,
		const char *	str
	)

Move the cursor and write a fixed string to a Window.

Parameters

win	Window to write to
col	Column to move to
row	Row to move to
str	String to write

Return values

OK	Success
ERR	Error

Definition at line 307 of file mutt_window.c.

{
  return mvaddstr(win->state.row_offset + row, win->state.col_offset + col, str);
}

Here is the caller graph for this function:

mutt_window_mvprintw()

int mutt_window_mvprintw	(	struct MuttWindow *	win,
		int	col,
		int	row,
		const char *	fmt,
			...
	)

Move the cursor and write a formatted string to a Window.

Parameters

win	Window to write to
col	Column to move to
row	Row to move to
fmt	printf format string
...	printf arguments

Return values

num	Success, characters written
ERR	Error, move failed

Definition at line 322 of file mutt_window.c.

{
  int rc = mutt_window_move(win, col, row);
  if (rc == ERR)
    return rc;
 
  va_list ap;
  va_start(ap, fmt);
  rc = vw_printw(stdscr, fmt, ap);
  va_end(ap);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_reflow()

void mutt_window_reflow

(

struct MuttWindow *

win

)

Resize a Window and its children.

Parameters

win	Window to resize

Definition at line 340 of file mutt_window.c.

{
  if (OptNoCurses)
    return;
 
  if (!win)
    win = RootWindow;
 
  mutt_debug(LL_DEBUG2, "entering\n");
  window_reflow(win);
  window_notify_all(win);
 
#ifdef USE_DEBUG_WINDOW
  debug_win_dump();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_wrap_cols()

int mutt_window_wrap_cols	(	int	width,
		short	wrap
	)

Calculate the wrap column for a given screen width.

Parameters

width	Screen width
wrap	Wrap config

Return values

num	Column that text should be wrapped at

The wrap variable can be negative, meaning there should be a right margin.

Definition at line 365 of file mutt_window.c.

{
  if (wrap < 0)
    return (width > -wrap) ? (width + wrap) : width;
  if (wrap)
    return (wrap < width) ? wrap : width;
  return width;
}

Here is the caller graph for this function:

mutt_window_addch()

int mutt_window_addch	(	struct MuttWindow *	win,
		int	ch
	)

Write one character to a Window.

Parameters

win	Window
ch	Character to write

Return values

0	Success
-1	Error

Definition at line 381 of file mutt_window.c.

{
  return addch(ch);
}

Here is the caller graph for this function:

mutt_window_addnstr()

int mutt_window_addnstr	(	struct MuttWindow *	win,
		const char *	str,
		int	num
	)

Write a partial string to a Window.

Parameters

win	Window
str	String
num	Maximum number of characters to write

Return values

0	Success
-1	Error

Definition at line 394 of file mutt_window.c.

{
  if (!str)
    return -1;
 
  return addnstr(str, num);
}

Here is the caller graph for this function:

mutt_window_addstr()

int mutt_window_addstr	(	struct MuttWindow *	win,
		const char *	str
	)

Write a string to a Window.

Parameters

win	Window
str	String

Return values

0	Success
-1	Error

Definition at line 409 of file mutt_window.c.

{
  if (!str)
    return -1;
 
  return addstr(str);
}

Here is the caller graph for this function:

mutt_window_printf()

int mutt_window_printf	(	struct MuttWindow *	win,
		const char *	fmt,
			...
	)

Write a formatted string to a Window.

Parameters

win	Window
fmt	Format string
...	Arguments

Return values

num	Number of characters written

Definition at line 424 of file mutt_window.c.

{
  va_list ap;
  va_start(ap, fmt);
  int rc = vw_printw(stdscr, fmt, ap);
  va_end(ap);
 
  return rc;
}

Here is the caller graph for this function:

mutt_window_add_child()

void mutt_window_add_child	(	struct MuttWindow *	parent,
		struct MuttWindow *	child
	)

Add a child to Window.

Parameters

parent	Window to add to
child	Window to add

Definition at line 439 of file mutt_window.c.

{
  if (!parent || !child)
    return;
 
  TAILQ_INSERT_TAIL(&parent->children, child, entries);
  child->parent = parent;
 
  notify_set_parent(child->notify, parent->notify);
 
  mutt_debug(LL_NOTIFY, "NT_WINDOW_NEW: %s, %p\n", mutt_window_win_name(child), child);
  struct EventWindow ev_w = { child, WN_NO_FLAGS };
  notify_send(child->notify, NT_WINDOW, NT_WINDOW_ADD, &ev_w);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_remove_child()

struct MuttWindow * mutt_window_remove_child	(	struct MuttWindow *	parent,
		struct MuttWindow *	child
	)

Remove a child from a Window.

Parameters

parent	Window to remove from
child	Window to remove

Return values

ptr	Child Window

Definition at line 460 of file mutt_window.c.

{
  if (!parent || !child)
    return NULL;
 
  // A notification will be sent when the Window is freed
  TAILQ_REMOVE(&parent->children, child, entries);
  child->parent = NULL;
 
  notify_set_parent(child->notify, NULL);
 
  return child;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_winlist_free()

void mutt_winlist_free

(

struct MuttWindowList *

head

)

Free a tree of Windows.

Parameters

head	WindowList to free

Definition at line 478 of file mutt_window.c.

{
  if (!head)
    return;
 
  struct MuttWindow *np = NULL;
  struct MuttWindow *tmp = NULL;
  TAILQ_FOREACH_SAFE(np, head, entries, tmp)
  {
    TAILQ_REMOVE(head, np, entries);
    mutt_winlist_free(&np->children);
    mutt_window_free(&np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_is_visible()

bool mutt_window_is_visible

(

struct MuttWindow *

win

)

Is the Window visible?

Parameters

win

Window

Return values

true	The Window is visible

For a Window to be visible, it must be visible and its parent and grandparent, etc.

Definition at line 501 of file mutt_window.c.

{
  if (!win)
    return false;
 
  for (; win; win = win->parent)
  {
    if (!win->state.visible)
      return false;
  }
 
  return true;
}

Here is the caller graph for this function:

window_find_child()

struct MuttWindow * window_find_child	(	struct MuttWindow *	win,
		enum WindowType	type
	)

Recursively find a child Window of a given type.

Parameters

win	Window to start searching
type	Window type to find, e.g. WT_STATUS_BAR

Return values

ptr	Matching Window
NULL	No match

Definition at line 522 of file mutt_window.c.

{
  if (!win)
    return NULL;
  if (win->type == type)
    return win;
 
  struct MuttWindow *np = NULL;
  struct MuttWindow *match = NULL;
  TAILQ_FOREACH(np, &win->children, entries)
  {
    match = window_find_child(np, type);
    if (match)
      return match;
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_find_parent()

struct MuttWindow * window_find_parent	(	struct MuttWindow *	win,
		enum WindowType	type
	)

Find a (grand-)parent of a Window by type.

Parameters

win	Window
type	Window type, e.g. WT_DLG_INDEX

Return values

ptr

Window

Definition at line 547 of file mutt_window.c.

{
  for (; win; win = win->parent)
  {
    if (win->type == type)
      return win;
  }
 
  return NULL;
}

Here is the caller graph for this function:

window_recalc()

static void window_recalc ( struct MuttWindow *  win )

static

Recalculate a tree of Windows.

Parameters

win	Window to start at

Definition at line 562 of file mutt_window.c.

{
  if (!win || !win->state.visible)
    return;
 
  if (win->recalc && (win->actions & WA_RECALC))
    win->recalc(win);
  win->actions &= ~WA_RECALC;
 
  struct MuttWindow *np = NULL;
  TAILQ_FOREACH(np, &win->children, entries)
  {
    window_recalc(np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_repaint()

static void window_repaint ( struct MuttWindow *  win )

static

Repaint a tree of Windows.

Parameters

win	Window to start at

Definition at line 582 of file mutt_window.c.

{
  if (!win || !win->state.visible)
    return;
 
  if (win->repaint && (win->actions & WA_REPAINT))
    win->repaint(win);
  win->actions &= ~WA_REPAINT;
 
  struct MuttWindow *np = NULL;
  TAILQ_FOREACH(np, &win->children, entries)
  {
    window_repaint(np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_redraw()

void window_redraw

(

struct MuttWindow *

win

)

Reflow, recalc and repaint a tree of Windows.

Parameters

win	Window to start at

Note

If win is NULL, all windows will be redrawn

Definition at line 604 of file mutt_window.c.

{
  if (!win)
    win = RootWindow;
 
  if (SigWinch)
  {
    SigWinch = false;
    window_invalidate_all();
    mutt_resize_screen();
  }
 
  window_reflow(win);
  window_notify_all(win);
 
  window_recalc(win);
  window_repaint(win);
  mutt_refresh();
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_is_focused()

bool window_is_focused

(

const struct MuttWindow *

win

)

Does the given Window have the focus?

Parameters

win	Window to check

Return values

true	Window has focus

Definition at line 629 of file mutt_window.c.

{
  if (!win)
    return false;
 
  struct MuttWindow *win_focus = window_get_focus();
 
  return (win_focus == win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_get_focus()

struct MuttWindow * window_get_focus

(

void

)

Get the currently focused Window.

Return values

ptr	Window with focus

Definition at line 643 of file mutt_window.c.

{
  struct MuttWindow *win = RootWindow;
 
  while (win && win->focus)
    win = win->focus;
 
  return win;
}

Here is the caller graph for this function:

window_set_focus()

struct MuttWindow * window_set_focus

(

struct MuttWindow *

win

)

Set the Window focus.

Parameters

win	Window to focus

Return values

ptr	Old focused Window
NULL	Error, or focus not changed

Definition at line 659 of file mutt_window.c.

{
  if (!win)
    return NULL;
 
  struct MuttWindow *old_focus = window_get_focus();
 
  struct MuttWindow *parent = win->parent;
  struct MuttWindow *child = win;
 
  // Set the chain of focus, all the way to the root
  for (; parent; child = parent, parent = parent->parent)
    parent->focus = child;
 
  // Find the most focused Window
  while (win && win->focus)
    win = win->focus;
 
  if (win == old_focus)
    return NULL;
 
  mutt_debug(LL_NOTIFY, "NT_WINDOW_FOCUS: %s, %p\n", mutt_window_win_name(win), win);
  struct EventWindow ev_w = { win, WN_NO_FLAGS };
  notify_send(win->notify, NT_WINDOW, NT_WINDOW_FOCUS, &ev_w);
#ifdef USE_DEBUG_WINDOW
  debug_win_dump();
#endif
  return old_focus;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_clear()

void mutt_window_clear

(

struct MuttWindow *

win

)

Clear a Window.

Parameters

win

Window

If the Window isn't visible, it won't be cleared.

Definition at line 695 of file mutt_window.c.

{
  if (!mutt_window_is_visible(win))
    return;
 
  for (int i = 0; i < win->state.rows; i++)
    mutt_window_clearline(win, i);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_window_win_name()

const char * mutt_window_win_name

(

const struct MuttWindow *

win

)

Get the name of a Window.

Parameters

win

Window

Return values

ptr	String describing Window
NULL	Error, or unknown

Definition at line 710 of file mutt_window.c.

{
  if (!win)
    return "UNKNOWN";
 
  const char *name = mutt_map_get_name(win->type, WindowNames);
  if (name)
    return name;
  return "UNKNOWN";
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_invalidate()

static void window_invalidate ( struct MuttWindow *  win )

static

Mark a window as in need of repaint.

Parameters

win	Window to start at

Definition at line 725 of file mutt_window.c.

{
  if (!win)
    return;
 
  win->actions |= WA_RECALC | WA_REPAINT;
 
  struct MuttWindow *np = NULL;
  TAILQ_FOREACH(np, &win->children, entries)
  {
    window_invalidate(np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_invalidate_all()

void window_invalidate_all

(

void

)

Mark all windows as in need of repaint.

Definition at line 742 of file mutt_window.c.

{
  window_invalidate(RootWindow);
  clearok(stdscr, true);
  keypad(stdscr, true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

window_status_on_top()

bool window_status_on_top	(	struct MuttWindow *	panel,
		struct ConfigSubset *	sub
	)

Organise windows according to config variable.

Parameters

panel	Window containing WT_MENU and WT_STATUS_BAR
sub	Config Subset

Return values

true	Window order was changed

Set the positions of two Windows based on a config variable $status_on_top.

Note

The children are expected to have types: WT_MENU, WT_STATUS_BAR

Definition at line 759 of file mutt_window.c.

{
  const bool c_status_on_top = cs_subset_bool(sub, "status_on_top");
 
  struct MuttWindow *win = TAILQ_FIRST(&panel->children);
 
  if ((c_status_on_top && (win->type == WT_STATUS_BAR)) ||
      (!c_status_on_top && (win->type != WT_STATUS_BAR)))
  {
    return false;
  }
 
  if (c_status_on_top)
  {
    win = TAILQ_LAST(&panel->children, MuttWindowList);
    TAILQ_REMOVE(&panel->children, win, entries);
    TAILQ_INSERT_HEAD(&panel->children, win, entries);
  }
  else
  {
    TAILQ_REMOVE(&panel->children, win, entries);
    TAILQ_INSERT_TAIL(&panel->children, win, entries);
  }
 
  mutt_window_reflow(panel);
  window_invalidate_all();
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

WindowNames

const struct Mapping WindowNames[]

static

Lookups for Window Names.

Definition at line 46 of file mutt_window.c.