NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
dialog.h File Reference

Dialog Windows. More...

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

Go to the source code of this file.

Functions

struct MuttWindowdialog_find (struct MuttWindow *win)
 Find the parent Dialog of a Window. More...
 
void dialog_pop (void)
 Hide a Window from the user. More...
 
void dialog_push (struct MuttWindow *dlg)
 Display a Window to the user. More...
 
struct MuttWindowalldialogs_get_current (void)
 Get the currently active Dialog. More...
 
struct MuttWindowalldialogs_new (void)
 Create the AllDialogs Window. More...
 

Variables

struct MuttWindowAllDialogsWindow
 Parent of all Dialogs. More...
 

Detailed Description

Dialog Windows.

Authors
  • Richard Russon

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

Function Documentation

◆ dialog_find()

struct MuttWindow* dialog_find ( struct MuttWindow win)

Find the parent Dialog of a Window.

Parameters
winWindow
Return values
ptrDialog

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

Definition at line 85 of file dialog.c.

86 {
87  for (; win && win->parent; win = win->parent)
88  {
89  if (win->parent->type == WT_ALL_DIALOGS)
90  return win;
91  }
92 
93  return NULL;
94 }
Container for All Dialogs (nested Windows)
Definition: mutt_window.h:74
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:135
enum WindowType type
Window type, e.g. WT_SIDEBAR.
Definition: mutt_window.h:144
+ 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 139 of file dialog.c.

140 {
141  if (!AllDialogsWindow)
142  return;
143 
144  struct MuttWindow *last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
145  if (!last)
146  return;
147 
148  // Notify the world, allowing plugins to clean up
149  mutt_debug(LL_NOTIFY, "NT_WINDOW_DIALOG hidden: %s, %p\n",
150  mutt_window_win_name(last), last);
151  struct EventWindow ev_w = { last, WN_HIDDEN };
153 
154  last->state.visible = false;
155  last->parent = NULL;
156  TAILQ_REMOVE(&AllDialogsWindow->children, last, entries);
157 
158  last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
159  if (last)
160  {
161  last->state.visible = true;
163  window_set_focus(last);
164  }
165  else
166  {
167  AllDialogsWindow->focus = NULL;
168  }
169 #ifdef USE_DEBUG_WINDOW
170  debug_win_dump();
171 #endif
172 }
A new Dialog Window has been created, e.g. WT_DLG_INDEX.
Definition: mutt_window.h:208
Log of notifications.
Definition: logging.h:45
An Event that happened to a Window.
Definition: mutt_window.h:215
#define TAILQ_LAST(head, headname)
Definition: queue.h:819
struct MuttWindow * window_set_focus(struct MuttWindow *win)
Set the Window focus.
Definition: mutt_window.c:680
#define WN_HIDDEN
Window became hidden.
Definition: mutt_window.h:193
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:53
struct MuttWindow * focus
Focussed Window.
Definition: mutt_window.h:140
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
#define TAILQ_REMOVE(head, elm, field)
Definition: queue.h:841
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
bool visible
Window is visible.
Definition: mutt_window.h:59
struct MuttWindow * AllDialogsWindow
Parent of all Dialogs.
Definition: dialog.c:76
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
void mutt_window_reflow(struct MuttWindow *win)
Resize a Window and its children.
Definition: mutt_window.c:361
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:135
struct MuttWindowList children
Children Windows.
Definition: mutt_window.h:136
void debug_win_dump(void)
Definition: window.c:91
const char * mutt_window_win_name(const struct MuttWindow *win)
Get the name of a Window.
Definition: mutt_window.c:731
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ dialog_push()

void dialog_push ( struct MuttWindow dlg)

Display a Window to the user.

Parameters
dlgWindow 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 105 of file dialog.c.

106 {
107  if (!dlg || !AllDialogsWindow)
108  return;
109 
110  struct MuttWindow *last = TAILQ_LAST(&AllDialogsWindow->children, MuttWindowList);
111  if (last)
112  last->state.visible = false;
113 
116 
117  // Notify the world, allowing plugins to integrate
118  mutt_debug(LL_NOTIFY, "NT_WINDOW_DIALOG visible: %s, %p\n",
119  mutt_window_win_name(dlg), dlg);
120  struct EventWindow ev_w = { dlg, WN_VISIBLE };
122 
123  dlg->state.visible = true;
124  dlg->parent = AllDialogsWindow;
126  window_set_focus(dlg);
127 
128 #ifdef USE_DEBUG_WINDOW
129  debug_win_dump();
130 #endif
131 }
A new Dialog Window has been created, e.g. WT_DLG_INDEX.
Definition: mutt_window.h:208
Log of notifications.
Definition: logging.h:45
An Event that happened to a Window.
Definition: mutt_window.h:215
#define TAILQ_LAST(head, headname)
Definition: queue.h:819
struct MuttWindow * window_set_focus(struct MuttWindow *win)
Set the Window focus.
Definition: mutt_window.c:680
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:53
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
bool visible
Window is visible.
Definition: mutt_window.h:59
#define TAILQ_INSERT_TAIL(head, elm, field)
Definition: queue.h:809
struct MuttWindow * AllDialogsWindow
Parent of all Dialogs.
Definition: dialog.c:76
#define mutt_debug(LEVEL,...)
Definition: logging.h:85
void mutt_window_reflow(struct MuttWindow *win)
Resize a Window and its children.
Definition: mutt_window.c:361
struct MuttWindow * parent
Parent Window.
Definition: mutt_window.h:135
#define WN_VISIBLE
Window became visible.
Definition: mutt_window.h:192
struct MuttWindowList children
Children Windows.
Definition: mutt_window.h:136
void notify_set_parent(struct Notify *notify, struct Notify *parent)
Set the parent notification handler.
Definition: notify.c:93
void debug_win_dump(void)
Definition: window.c:91
const char * mutt_window_win_name(const struct MuttWindow *win)
Get the name of a Window.
Definition: mutt_window.c:731
bool notify_send(struct Notify *notify, enum NotifyType event_type, int event_subtype, void *event_data)
Send out a notification message.
Definition: notify.c:171
+ 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
ptrActive Dialog

Definition at line 224 of file dialog.c.

225 {
226  if (!AllDialogsWindow)
227  return NULL;
228 
229  struct MuttWindow *np = NULL;
230  TAILQ_FOREACH(np, &AllDialogsWindow->children, entries)
231  {
232  if (mutt_window_is_visible(np))
233  return np;
234  }
235 
236  return NULL;
237 }
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:725
bool mutt_window_is_visible(struct MuttWindow *win)
Is the Window visible?
Definition: mutt_window.c:529
struct MuttWindow * AllDialogsWindow
Parent of all Dialogs.
Definition: dialog.c:76
struct MuttWindowList children
Children Windows.
Definition: mutt_window.h:136
+ 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
ptrNew AllDialogs Window

Create the container for all the Dialogs.

Definition at line 207 of file dialog.c.

208 {
209  struct MuttWindow *win_alldlgs =
212 
213  notify_observer_add(win_alldlgs->notify, NT_WINDOW, alldialogs_window_observer, win_alldlgs);
214 
215  AllDialogsWindow = win_alldlgs;
216 
217  return win_alldlgs;
218 }
Window uses all available vertical space.
Definition: mutt_window.h:38
static int alldialogs_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t.
Definition: dialog.c:181
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:53
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
bool notify_observer_add(struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
Add an observer to an object.
Definition: notify.c:189
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:52
struct MuttWindow * AllDialogsWindow
Parent of all Dialogs.
Definition: dialog.c:76
Container for All Dialogs (nested Windows)
Definition: mutt_window.h:74
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:180
Window wants as much space as possible.
Definition: mutt_window.h:48
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ AllDialogsWindow

struct MuttWindow* AllDialogsWindow

Parent of all Dialogs.

Definition at line 76 of file dialog.c.