msgcont.h File Reference

Message Window. More...

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

Go to the source code of this file.

Functions
struct MuttWindow *	msgcont_get_msgwin (void)
	Get the Message Window.
struct MuttWindow *	msgcont_new (void)
	Create a new Message Container.
struct MuttWindow *	msgcont_pop_window (void)
	Remove the last Window from the Container Stack.
void	msgcont_push_window (struct MuttWindow *win)
	Add a window to the Container Stack.

Variables
struct MuttWindow *	MessageContainer
	Window acting as a stack for the message windows.

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

Function Documentation

msgcont_get_msgwin()

struct MuttWindow * msgcont_get_msgwin

(

void

)

Get the Message Window.

Return values

ptr	Message Window

The Message Window is the first child of the MessageContainer and will have type WT_MESSAGE.

Definition at line 117 of file msgcont.c.

{
  if (!MessageContainer)
    return NULL;
 
  struct MuttWindow *win = TAILQ_FIRST(&MessageContainer->children);
  if (!win)
    return NULL;
 
  if (win->type != WT_MESSAGE)
    return NULL;
 
  return win;
}

Here is the caller graph for this function:

msgcont_new()

struct MuttWindow * msgcont_new

(

void

)

Create a new Message Container.

Return values

ptr	New Container Window

Definition at line 46 of file msgcont.c.

{
  MessageContainer = mutt_window_new(WT_CONTAINER, MUTT_WIN_ORIENT_VERTICAL,
                                     MUTT_WIN_SIZE_MINIMISE, MUTT_WIN_SIZE_UNLIMITED, 1);
  return MessageContainer;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgcont_pop_window()

struct MuttWindow * msgcont_pop_window

(

void

)

Remove the last Window from the Container Stack.

Return values

ptr	Window removed from the stack

Definition at line 57 of file msgcont.c.

{
  if (!MessageContainer)
    return NULL;
 
  struct MuttWindow *win_pop = TAILQ_LAST(&MessageContainer->children, MuttWindowList);
  // Don't pop the last entry
  if (!TAILQ_PREV(win_pop, MuttWindowList, entries))
    return NULL;
 
  // Hide the old window
  window_set_visible(win_pop, false);
 
  // Make the top of the stack visible
  struct MuttWindow *win_top = TAILQ_PREV(win_pop, MuttWindowList, entries);
 
  TAILQ_REMOVE(&MessageContainer->children, win_pop, entries);
 
  if (win_top)
  {
    window_set_visible(win_top, true);
    win_top->actions |= WA_RECALC;
  }
 
  mutt_window_reflow(NULL);
  window_redraw(NULL);
#ifdef USE_DEBUG_WINDOW
  debug_win_dump();
#endif
  return win_pop;
}

Here is the call graph for this function:

Here is the caller graph for this function:

msgcont_push_window()

void msgcont_push_window

(

struct MuttWindow *

win

)

Add a window to the Container Stack.

Parameters

win	Window to add

Definition at line 93 of file msgcont.c.

{
  if (!MessageContainer || !win)
    return;
 
  // Hide the current top window
  struct MuttWindow *win_top = TAILQ_LAST(&MessageContainer->children, MuttWindowList);
  window_set_visible(win_top, false);
 
  mutt_window_add_child(MessageContainer, win);
  mutt_window_reflow(NULL);
  window_redraw(NULL);
#ifdef USE_DEBUG_WINDOW
  debug_win_dump();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MessageContainer

struct MuttWindow* MessageContainer

extern

Window acting as a stack for the message windows.

Definition at line 40 of file msgcont.c.