menudef.h File Reference

Menu Definitions. More...

#include "mutt/lib.h"
#include "keymap.h"

Include dependency graph for menudef.h:

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

Go to the source code of this file.

Data Structures
struct	SubMenu
	Collection of related functions. More...
struct	MenuDefinition
	Functions for a Dialog or Window. More...

Functions
	ARRAY_HEAD (SubMenuArray, struct SubMenu *)
	ARRAY_HEAD (MenuDefinitionArray, struct MenuDefinition *)
void	submenu_free (struct SubMenu **pptr)
	Free a SubMenu.
struct SubMenu *	submenu_new (void)
	Create a new SubMenu.
void	menudef_free (struct MenuDefinition **pptr)
	Free a MenuDefinition.
struct MenuDefinition *	menudef_new (void)
	Create a new MenuDefinition.

Detailed Description

Menu Definitions.

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

Function Documentation

ARRAY_HEAD() [1/2]

ARRAY_HEAD	(	SubMenuArray	,
		struct SubMenu *	)

ARRAY_HEAD() [2/2]

ARRAY_HEAD	(	MenuDefinitionArray	,
		struct MenuDefinition *	)

submenu_free()

void submenu_free

(

struct SubMenu **

pptr

)

Free a SubMenu.

Parameters

pptr	SubMenu to free

Definition at line 38 of file menudef.c.

{
  if (!pptr || !*pptr)
    return;
 
  struct SubMenu *sm = *pptr;
  keymaplist_free(&sm->keymaps);
 
  FREE(pptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

submenu_new()

struct SubMenu * submenu_new

(

void

)

Create a new SubMenu.

Return values

New

SubMenu

Definition at line 53 of file menudef.c.

{
  struct SubMenu *sm = MUTT_MEM_CALLOC(1, struct SubMenu);
 
  ARRAY_INIT(&sm->keymaps);
 
  return sm;
}

Here is the caller graph for this function:

menudef_free()

void menudef_free

(

struct MenuDefinition **

pptr

)

Free a MenuDefinition.

Parameters

pptr	MenuDefinition to free

Definition at line 66 of file menudef.c.

{
  if (!pptr || !*pptr)
    return;
 
  struct MenuDefinition *md = *pptr;
 
  FREE(&md->name);
 
  ARRAY_FREE(&md->submenus);
 
  FREE(pptr);
}

Here is the caller graph for this function:

menudef_new()

struct MenuDefinition * menudef_new

(

void

)

Create a new MenuDefinition.

Return values

ptr	New MenuDefinition

Definition at line 84 of file menudef.c.

{
  struct MenuDefinition *md = MUTT_MEM_CALLOC(1, struct MenuDefinition);
 
  ARRAY_INIT(&md->submenus);
 
  return md;
}

Here is the caller graph for this function: