msgwin.h File Reference

Message Window. More...

#include <stdbool.h>
#include "color/lib.h"

Include dependency graph for msgwin.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	msgwin_clear_text (struct MuttWindow *win)
	Clear the text in the Message Window.
struct MuttWindow *	msgwin_new (bool interactive)
	Create the Message Window.
void	msgwin_add_text (struct MuttWindow *win, const char *text, const struct AttrColor *ac_color)
	Add text to the Message Window.
void	msgwin_add_text_n (struct MuttWindow *win, const char *text, int bytes, const struct AttrColor *ac_color)
	Add some text to the Message Window.
const char *	msgwin_get_text (struct MuttWindow *win)
	Get the text from the Message Window.
struct MuttWindow *	msgwin_get_window (void)
	Get the Message Window pointer.
void	msgwin_set_rows (struct MuttWindow *win, short rows)
	Resize the Message Window.
void	msgwin_set_text (struct MuttWindow *win, const char *text, enum ColorId color)
	Set the text for the Message Window.

Detailed Description

Message Window.

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 msgwin.h.

Function Documentation

msgwin_clear_text()

void msgwin_clear_text

(

struct MuttWindow *

win

)

Clear the text in the Message Window.

Parameters

win	Message Window

Definition at line 519 of file msgwin.c.

{
  msgwin_set_text(win, NULL, MT_COLOR_NORMAL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_new()

struct MuttWindow * msgwin_new

(

bool

interactive

)

Create the Message Window.

Return values

ptr	New Window

Definition at line 371 of file msgwin.c.

{
  struct MuttWindow *win = mutt_window_new(WT_MESSAGE, MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
 
  struct MsgWinWindowData *wdata = msgwin_wdata_new();
 
  win->wdata = wdata;
  win->wdata_free = msgwin_wdata_free;
  win->recalc = msgwin_recalc;
  win->repaint = msgwin_repaint;
 
  if (interactive)
    win->recursor = msgwin_recursor;
 
  // Copy the container's dimensions
  win->state = MessageContainer->state;
 
  notify_observer_add(win->notify, NT_WINDOW, msgwin_window_observer, win);
 
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_add_text()

void msgwin_add_text	(	struct MuttWindow *	win,
		const char *	text,
		const struct AttrColor *	ac_color
	)

Add text to the Message Window.

Parameters

win	Message Window
text	Text to add
ac_color	Colour for text

Definition at line 419 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  if (text)
  {
    buf_addstr(wdata->text, text);
    measure(&wdata->chars, text, ac_color);
    mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
               buf_string(wdata->text));
  }
  else
  {
    int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
    msgwin_set_rows(win, rows);
    win->actions |= WA_RECALC;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_add_text_n()

void msgwin_add_text_n	(	struct MuttWindow *	win,
		const char *	text,
		int	bytes,
		const struct AttrColor *	ac_color
	)

Add some text to the Message Window.

Parameters

win	Message Window
text	Text to add
bytes	Number of bytes of text to add
ac_color	Colour for text

Definition at line 450 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  if (text)
  {
    const char *dptr = wdata->text->dptr;
    buf_addstr_n(wdata->text, text, bytes);
    measure(&wdata->chars, dptr, ac_color);
    mutt_debug(LL_DEBUG5, "MW ADD: %zu, %s\n", buf_len(wdata->text),
               buf_string(wdata->text));
  }
  else
  {
    int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
    msgwin_set_rows(win, rows);
    win->actions |= WA_RECALC;
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_get_text()

const char * msgwin_get_text

(

struct MuttWindow *

win

)

Get the text from the Message Window.

Parameters

win	Message Window

Return values

ptr	Window text

Note

Do not free the returned string

Definition at line 401 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return NULL;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  return buf_string(wdata->text);
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_get_window()

struct MuttWindow * msgwin_get_window

(

void

)

Get the Message Window pointer.

Return values

ptr	Message Window

Allow some users direct access to the Message Window.

Definition at line 530 of file msgwin.c.

{
  return msgcont_get_msgwin();
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_set_rows()

void msgwin_set_rows	(	struct MuttWindow *	win,
		short	rows
	)

Resize the Message Window.

Parameters

win	Message Window
rows	Number of rows required

Resize the other Windows to allow a multi-line message to be displayed.

Note

rows will be clamped between 1 and 3 (MSGWIN_MAX_ROWS) inclusive

Definition at line 303 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  rows = CLAMP(rows, 1, MSGWIN_MAX_ROWS);
 
  if (rows != win->state.rows)
  {
    win->req_rows = rows;
    mutt_window_reflow(NULL);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_set_text()

void msgwin_set_text	(	struct MuttWindow *	win,
		const char *	text,
		enum ColorId	color
	)

Set the text for the Message Window.

Parameters

win	Message Window
text	Text to set
color	Colour for text

Note

The text string will be copied

Definition at line 484 of file msgwin.c.

{
  if (!win)
    win = msgcont_get_msgwin();
  if (!win)
    return;
 
  struct MsgWinWindowData *wdata = win->wdata;
 
  if (mutt_str_equal(buf_string(wdata->text), text))
    return;
 
  buf_strcpy(wdata->text, text);
  ARRAY_FREE(&wdata->chars);
  if (wdata->text)
  {
    const struct AttrColor *ac_normal = simple_color_get(MT_COLOR_NORMAL);
    const struct AttrColor *ac_color = simple_color_get(color);
    const struct AttrColor *ac_merge = merged_color_overlay(ac_normal, ac_color);
 
    measure(&wdata->chars, buf_string(wdata->text), ac_merge);
  }
 
  mutt_debug(LL_DEBUG5, "MW SET: %zu, %s\n", buf_len(wdata->text),
             buf_string(wdata->text));
 
  int rows = msgwin_calc_rows(wdata, win->state.cols, buf_string(wdata->text));
  msgwin_set_rows(win, rows);
  win->actions |= WA_RECALC;
}

Here is the call graph for this function:

Here is the caller graph for this function: