msgwin.c File Reference

Message Window. More...

#include "config.h"
#include "mutt/lib.h"
#include "msgwin.h"
#include "color/lib.h"
#include "mutt_curses.h"
#include "mutt_window.h"

Include dependency graph for msgwin.c:

Go to the source code of this file.

Data Structures
struct	MsgWinPrivateData
	Private data for the Message Window. More...

Functions
static int	msgwin_recalc (struct MuttWindow *win)
	Recalculate the display of the Message Window - Implements MuttWindow::recalc() -. More...
static int	msgwin_repaint (struct MuttWindow *win)
	Redraw the Message Window - Implements MuttWindow::repaint() -. More...
static int	msgwin_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -. More...
static void	msgwin_wdata_free (struct MuttWindow *win, void **ptr)
	Free the private data attached to the Message Window - Implements MuttWindow::wdata_free() -. More...
static struct MsgWinPrivateData *	msgwin_wdata_new (void)
	Create new private data for the Message Window. More...
struct MuttWindow *	msgwin_new (void)
	Create the Message Window. More...
const char *	msgwin_get_text (void)
	Get the text from the Message Window. More...
void	msgwin_set_text (enum ColorId cid, const char *text)
	Set the text for the Message Window. More...
void	msgwin_clear_text (void)
	Clear the text in the Message Window. More...
struct MuttWindow *	msgwin_get_window (void)
	Get the Message Window pointer. More...
size_t	msgwin_get_width (void)
	Get the width of the Message Window. More...
void	msgwin_set_height (short height)
	Resize the Message Window. More...

Variables
static struct MuttWindow *	MessageWindow = NULL
	Message Window for messages, warnings, errors etc. More...

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.c.

Function Documentation

msgwin_wdata_new()

static struct MsgWinPrivateData * msgwin_wdata_new ( void  )

static

Create new private data for the Message Window.

Return values

ptr	New private data

Definition at line 184 of file msgwin.c.

{
  struct MsgWinPrivateData *msgwin_data = mutt_mem_calloc(1, sizeof(struct MsgWinPrivateData));
 
  msgwin_data->cid = MT_COLOR_NORMAL;
 
  return msgwin_data;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_new()

struct MuttWindow * msgwin_new

(

void

)

Create the Message Window.

Return values

ptr	New Window

Definition at line 197 of file msgwin.c.

{
  MessageWindow = mutt_window_new(WT_MESSAGE, MUTT_WIN_ORIENT_VERTICAL,
                                  MUTT_WIN_SIZE_FIXED, MUTT_WIN_SIZE_UNLIMITED, 1);
  MessageWindow->wdata = msgwin_wdata_new();
  MessageWindow->wdata_free = msgwin_wdata_free;
  MessageWindow->recalc = msgwin_recalc;
  MessageWindow->repaint = msgwin_repaint;
 
  notify_observer_add(MessageWindow->notify, NT_WINDOW, msgwin_window_observer, MessageWindow);
 
  return MessageWindow;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_get_text()

const char * msgwin_get_text

(

void

)

Get the text from the Message Window.

Note

Do not free the returned string

Definition at line 216 of file msgwin.c.

{
  if (!MessageWindow)
    return NULL;
 
  struct MsgWinPrivateData *priv = MessageWindow->wdata;
 
  return priv->text;
}

Here is the caller graph for this function:

msgwin_set_text()

void msgwin_set_text	(	enum ColorId	cid,
		const char *	text
	)

Set the text for the Message Window.

Parameters

cid	Colour Id, e.g. MT_COLOR_MESSAGE
text	Text to set

Note

The text string will be copied

Definition at line 233 of file msgwin.c.

{
  if (!MessageWindow)
    return;
 
  struct MsgWinPrivateData *priv = MessageWindow->wdata;
 
  priv->cid = cid;
  mutt_str_replace(&priv->text, text);
 
  MessageWindow->actions |= WA_RECALC;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgwin_clear_text()

void msgwin_clear_text

(

void

)

Clear the text in the Message Window.

Definition at line 249 of file msgwin.c.

{
  msgwin_set_text(MT_COLOR_NORMAL, NULL);
}

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 260 of file msgwin.c.

{
  return MessageWindow;
}

Here is the caller graph for this function:

msgwin_get_width()

size_t msgwin_get_width

(

void

)

Get the width of the Message Window.

Return values

num	Width of Message Window

Definition at line 269 of file msgwin.c.

{
  if (!MessageWindow)
    return 0;
 
  return MessageWindow->state.cols;
}

Here is the caller graph for this function:

msgwin_set_height()

void msgwin_set_height

(

short

height

)

Resize the Message Window.

Parameters

height

Number of rows required

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

Definition at line 283 of file msgwin.c.

{
  if (!MessageWindow)
    return;
 
  if (height < 1)
    height = 1;
  else if (height > 3)
    height = 3;
 
  struct MuttWindow *win_cont = MessageWindow->parent;
 
  win_cont->req_rows = height;
  mutt_window_reflow(win_cont->parent);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MessageWindow

struct MuttWindow* MessageWindow = NULL

static

Message Window for messages, warnings, errors etc.

Definition at line 88 of file msgwin.c.