dialog.c File Reference

Dialog Windows. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include "mutt/lib.h"
#include "lib.h"

Include dependency graph for dialog.c:

Go to the source code of this file.

Functions
struct MuttWindow *	dialog_find (struct MuttWindow *win)
	Find the parent Dialog of a Window. More...
void	dialog_push (struct MuttWindow *dlg)
	Display a Window to the user. More...
void	dialog_pop (void)
	Hide a Window from the user. More...
static int	alldialogs_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -. More...
struct MuttWindow *	alldialogs_new (void)
	Create the AllDialogs Window. More...
struct MuttWindow *	alldialogs_get_current (void)
	Get the currently active Dialog. More...

Variables
struct MuttWindow *	AllDialogsWindow = NULL
	Parent of all Dialogs. More...

Detailed Description

Dialog Windows.

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

Function Documentation

dialog_find()

struct MuttWindow * dialog_find

(

struct MuttWindow *

win

)

Find the parent Dialog of a Window.

Parameters

win

Window

Return values

ptr

Dialog

Dialog Windows will be owned by a MuttWindow of type WT_ALL_DIALOGS.

Definition at line 83 of file dialog.c.

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

Here is the caller graph for this function:

dialog_push()

void dialog_push

(

struct MuttWindow *

dlg

)

Display a Window to the user.

Parameters

dlg	Window to display

The Dialog Windows are kept in a stack. The topmost is visible to the user, whilst the others are hidden.

When a Window is pushed, the old Window is marked as not visible.

Definition at line 103 of file dialog.c.

{
  if (!dlg || !AllDialogsWindow)
    return;
 
  struct MuttWindow *last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
  if (last)
    last->state.visible = false;
 
  TAILQ_INSERT_TAIL(&AllDialogsWindow->children, dlg, entries);
  notify_set_parent(dlg->notify, AllDialogsWindow->notify);
 
  // Notify the world, allowing plugins to integrate
  mutt_debug(LL_NOTIFY, "NT_WINDOW_DIALOG visible: %s, %p\n",
             mutt_window_win_name(dlg), dlg);
  struct EventWindow ev_w = { dlg, WN_VISIBLE };
  notify_send(dlg->notify, NT_WINDOW, NT_WINDOW_DIALOG, &ev_w);
 
  dlg->state.visible = true;
  dlg->parent = AllDialogsWindow;
  mutt_window_reflow(AllDialogsWindow);
  window_set_focus(dlg);
 
#ifdef USE_DEBUG_WINDOW
  debug_win_dump();
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

dialog_pop()

void dialog_pop

(

void

)

Hide a Window from the user.

The topmost (visible) Window is removed from the stack and the next Window is marked as visible.

Definition at line 137 of file dialog.c.

{
  if (!AllDialogsWindow)
    return;
 
  struct MuttWindow *last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
  if (!last)
    return;
 
  // Notify the world, allowing plugins to clean up
  mutt_debug(LL_NOTIFY, "NT_WINDOW_DIALOG hidden: %s, %p\n",
             mutt_window_win_name(last), last);
  struct EventWindow ev_w = { last, WN_HIDDEN };
  notify_send(last->notify, NT_WINDOW, NT_WINDOW_DIALOG, &ev_w);
 
  last->state.visible = false;
  last->parent = NULL;
  TAILQ_REMOVE(&AllDialogsWindow->children, last, entries);
 
  last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
  if (last)
  {
    last->state.visible = true;
    mutt_window_reflow(AllDialogsWindow);
    window_set_focus(last);
  }
  else
  {
    AllDialogsWindow->focus = 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:

alldialogs_new()

struct MuttWindow * alldialogs_new

(

void

)

Create the AllDialogs Window.

Return values

ptr	New AllDialogs Window

Create the container for all the Dialogs.

Definition at line 206 of file dialog.c.

{
  struct MuttWindow *win_alldlgs = mutt_window_new(WT_ALL_DIALOGS, MUTT_WIN_ORIENT_VERTICAL,
                                                   MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                                   MUTT_WIN_SIZE_UNLIMITED);
 
  notify_observer_add(win_alldlgs->notify, NT_WINDOW, alldialogs_window_observer, win_alldlgs);
 
  AllDialogsWindow = win_alldlgs;
 
  return win_alldlgs;
}

Here is the call graph for this function:

Here is the caller graph for this function:

alldialogs_get_current()

struct MuttWindow * alldialogs_get_current

(

void

)

Get the currently active Dialog.

Return values

ptr	Active Dialog

Definition at line 223 of file dialog.c.

{
  if (!AllDialogsWindow)
    return NULL;
 
  struct MuttWindow *np = NULL;
  TAILQ_FOREACH(np, &AllDialogsWindow->children, entries)
  {
    if (mutt_window_is_visible(np))
      return np;
  }
 
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AllDialogsWindow

struct MuttWindow* AllDialogsWindow = NULL

Parent of all Dialogs.

Definition at line 74 of file dialog.c.