utilwin.c File Reference

Utility Window. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "utilwin.h"
#include "color/lib.h"
#include "key/lib.h"
#include "module_data.h"
#include "mutt_curses.h"
#include "mutt_window.h"

Include dependency graph for utilwin.c:

Go to the source code of this file.

Data Structures
struct	UtilWinData
	Utility Window private data. More...

Macros
#define	UTILWIN_COLS   10
	Width of the Utility Window in columns.

Functions
static int	utilwin_recalc (struct MuttWindow *win)
	Recalculate the Utility Window - Implements MuttWindow::recalc() -.
static int	utilwin_repaint (struct MuttWindow *win)
	Repaint the Utility Window - Implements MuttWindow::repaint() -.
static void	utilwin_wdata_free (struct MuttWindow *win, void **ptr)
	Free the private data - Implements MuttWindow::wdata_free() -.
static int	utilwin_key_observer (struct NotifyCallback *nc)
	Notification that key progress has changed - Implements observer_t -.
static int	utilwin_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
struct MuttWindow *	utilwin_new (void)
	Create the Utility Window.
const char *	utilwin_get_text (struct MuttWindow *win)
	Get the text from the Utility Window.
void	utilwin_set_text (struct MuttWindow *win, const char *text)
	Set the text for the Utility Window.

Detailed Description

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

Macro Definition Documentation

UTILWIN_COLS

#define UTILWIN_COLS   10

Width of the Utility Window in columns.

Definition at line 71 of file utilwin.c.

Function Documentation

utilwin_new()

struct MuttWindow * utilwin_new

(

void

)

Create the Utility Window.

Return values

ptr	New Utility Window

The window starts hidden and becomes visible when text is set.

Definition at line 215 of file utilwin.c.

{
  struct MuttWindow *win = mutt_window_new(WT_CUSTOM, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_FIXED, UTILWIN_COLS, 1);
 
  struct UtilWinData *priv = MUTT_MEM_CALLOC(1, struct UtilWinData);
 
  win->wdata = priv;
  win->wdata_free = utilwin_wdata_free;
  win->recalc = utilwin_recalc;
  win->repaint = utilwin_repaint;
 
  window_set_visible(win, false);
 
  struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
  if (mod_data)
    mod_data->utility_window = win;
 
  notify_observer_add(NeoMutt->notify, NT_KEY, utilwin_key_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, utilwin_window_observer, win);
 
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

utilwin_get_text()

const char * utilwin_get_text

(

struct MuttWindow *

win

)

Get the text from the Utility Window.

Parameters

win	Utility Window

Return values

ptr	Text string
NULL	No text or invalid window

Note

Do not free the returned string

Definition at line 247 of file utilwin.c.

{
  if (!win)
  {
    struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
    if (mod_data)
      win = mod_data->utility_window;
  }
  if (!win)
    return NULL;
 
  struct UtilWinData *priv = win->wdata;
  return priv->text;
}

Here is the call graph for this function:

utilwin_set_text()

void utilwin_set_text	(	struct MuttWindow *	win,
		const char *	text )

Set the text for the Utility Window.

Parameters

win	Utility Window (may be NULL to use the default)
text	Text to display (NULL or empty to hide)

Setting text makes the window visible; clearing it hides the window.

Note

The text string will be copied

Definition at line 271 of file utilwin.c.

{
  if (!win)
  {
    struct GuiModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_GUI);
    if (mod_data)
      win = mod_data->utility_window;
  }
  if (!win)
    return;
 
  struct UtilWinData *priv = win->wdata;
 
  if (!text || (*text == '\0'))
  {
    // Clear the old on-screen contents before hiding the window.
    // Hidden windows are skipped by repaint, so they can't erase themselves.
    mutt_window_clear(win);
    FREE(&priv->text);
    window_set_visible(win, false);
    mutt_window_reflow(NULL);
    return;
  }
 
  mutt_str_replace(&priv->text, text);
 
  window_set_visible(win, true);
  win->actions |= WA_RECALC;
  mutt_window_reflow(NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function: