functions.h File Reference

Browser functions. More...

#include "key/lib.h"

Include dependency graph for functions.h:

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

Go to the source code of this file.

Data Structures
struct	BrowserFunction
	A NeoMutt function. More...

Typedefs
typedef int(*	browser_function_t) (struct BrowserPrivateData *priv, const struct KeyEvent *event)

Functions
int	browser_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Browser function.

Variables
struct MenuDefinition *	MdBrowser
	Browser Menu Definition.

Detailed Description

Browser functions.

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

Typedef Documentation

browser_function_t

typedef int(* browser_function_t) (struct BrowserPrivateData *priv, const struct KeyEvent *event)

Definition at line 45 of file functions.h.

Function Documentation

browser_function_dispatcher()

int browser_function_dispatcher	(	struct MuttWindow *	win,
		const struct KeyEvent *	event )

Perform a Browser function.

Parameters

win	Window for the Browser
event	Event to process

Return values

num	FunctionRetval, e.g. FR_SUCCESS

Definition at line 1152 of file functions.c.

{
  // The Dispatcher may be called on any Window in the Dialog
  struct MuttWindow *dlg = dialog_find(win);
  if (!dlg || !dlg->wdata)
    return FR_ERROR;
 
  struct Menu *menu = dlg->wdata;
  struct BrowserPrivateData *priv = menu->mdata;
  if (!priv)
    return FR_ERROR;
 
  int rc = FR_UNKNOWN;
  for (size_t i = 0; BrowserFunctions[i].op != OP_NULL; i++)
  {
    const struct BrowserFunction *fn = &BrowserFunctions[i];
    if (fn->op == event->op)
    {
      rc = fn->function(priv, event);
      break;
    }
  }
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MdBrowser

struct MenuDefinition* MdBrowser

extern

Browser Menu Definition.

Definition at line 64 of file functions.c.