menu.c File Reference

GUI present the user with a selectable list. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "expando/lib.h"
#include "key/lib.h"
#include "type.h"

Include dependency graph for menu.c:

Go to the source code of this file.

Functions
static const struct AttrColor *	default_color (struct Menu *menu, int line)
	Get the default colour for a line of the menu - Implements Menu::color() -.
static int	generic_search (struct Menu *menu, regex_t *rx, int line)
	Search a menu for a item matching a regex - Implements Menu::search() -.
void	menu_cleanup (void)
	Free the saved Menu searches.
void	menu_init (void)
	Initialise all the Menus.
enum MenuType	menu_get_current_type (void)
	Get the type of the current Window.
void	menu_free (struct Menu **ptr)
	Free a Menu.
struct Menu *	menu_new (const struct MenuDefinition *md, struct MuttWindow *win, struct ConfigSubset *sub)
	Create a new Menu.
int	menu_get_index (struct Menu *menu)
	Get the current selection in the Menu.
MenuRedrawFlags	menu_set_index (struct Menu *menu, int index)
	Set the current selection in the Menu.
void	menu_queue_redraw (struct Menu *menu, MenuRedrawFlags redraw)
	Queue a request for a redraw.

Variables
char *	SearchBuffers [MENU_MAX]
	Previous search string, one for each MenuType.

Detailed Description

GUI present the user with a selectable list.

Authors

• Richard Russon
• R Primus

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

Function Documentation

menu_cleanup()

void menu_cleanup

(

void

)

Free the saved Menu searches.

Definition at line 72 of file menu.c.

{
  for (int i = 0; i < MENU_MAX; i++)
    FREE(&SearchBuffers[i]);
}

Here is the caller graph for this function:

menu_init()

void menu_init

(

void

)

Initialise all the Menus.

Definition at line 81 of file menu.c.

{
  for (int i = 0; i < MENU_MAX; i++)
    SearchBuffers[i] = NULL;
}

Here is the caller graph for this function:

menu_get_current_type()

enum MenuType menu_get_current_type

(

void

)

Get the type of the current Window.

Return values

enum	Menu Type, e.g. MENU_PAGER

Definition at line 91 of file menu.c.

{
  struct MuttWindow *win = window_get_focus();
 
  // This should only happen before the first window is created
  if (!win)
    return MENU_INDEX;
 
  if ((win->type == WT_CUSTOM) && (win->parent->type == WT_PAGER))
    return MENU_PAGER;
 
  if (win->type != WT_MENU)
    return MENU_GENERIC;
 
  struct Menu *menu = win->wdata;
  if (!menu)
    return MENU_GENERIC;
 
  return menu->md->id;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_free()

void menu_free

(

struct Menu **

ptr

)

Free a Menu.

Parameters

ptr	Menu to free

Definition at line 116 of file menu.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Menu *menu = *ptr;
 
  notify_free(&menu->notify);
 
  if (menu->mdata_free && menu->mdata)
    menu->mdata_free(menu, &menu->mdata); // Custom function to free private data
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_new()

struct Menu * menu_new	(	const struct MenuDefinition *	md,
		struct MuttWindow *	win,
		struct ConfigSubset *	sub )

Create a new Menu.

Parameters

md	Menu Definition
win	Parent Window
sub	Config items

Return values

ptr

New Menu

Definition at line 138 of file menu.c.

{
  struct Menu *menu = MUTT_MEM_CALLOC(1, struct Menu);
 
  menu->md = md;
  menu->redraw = MENU_REDRAW_FULL;
  menu->color = default_color;
  menu->search = generic_search;
  menu->notify = notify_new();
  menu->win = win;
  menu->page_len = win->state.rows;
  menu->sub = sub;
  menu->show_indicator = true;
 
  notify_set_parent(menu->notify, win->notify);
  menu_add_observers(menu);
 
  return menu;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_get_index()

int menu_get_index

(

struct Menu *

menu

)

Get the current selection in the Menu.

Parameters

menu

Menu

Return values

num	Index of selection

Definition at line 164 of file menu.c.

{
  if (!menu)
    return -1;
 
  return menu->current;
}

menu_set_index()

MenuRedrawFlags menu_set_index	(	struct Menu *	menu,
		int	index )

Set the current selection in the Menu.

Parameters

menu	Menu
index	Item to select

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_INDEX

Definition at line 178 of file menu.c.

{
  return menu_move_selection(menu, index);
}

Here is the call graph for this function:

menu_queue_redraw()

void menu_queue_redraw	(	struct Menu *	menu,
		MenuRedrawFlags	redraw )

Queue a request for a redraw.

Parameters

menu	Menu
redraw	Item to redraw, e.g. MENU_REDRAW_CURRENT

Definition at line 188 of file menu.c.

{
  if (!menu)
    return;
 
  menu->redraw |= redraw;
  menu->win->actions |= WA_RECALC;
}

Variable Documentation

SearchBuffers

char* SearchBuffers[MENU_MAX]

Previous search string, one for each MenuType.

Definition at line 45 of file menu.c.