gui.h File Reference

Shared code for the Alias and Query Dialogs. More...

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

Include dependency graph for gui.h:

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

Go to the source code of this file.

Data Structures
struct	AliasView
	GUI data wrapping an Alias. More...
struct	AliasMenuData
	AliasView array wrapper with Pattern information -. More...

Enumerations
enum	ExpandoDataAlias {   ED_ALI_ADDRESS = 1 , ED_ALI_COMMENT , ED_ALI_FLAGS , ED_ALI_NAME ,   ED_ALI_NUMBER , ED_ALI_TAGGED , ED_ALI_TAGS }
	Expando UIDs for Aliases. More...

Functions
	ARRAY_HEAD (AliasViewArray, struct AliasView)
int	alias_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
int	alias_array_alias_add (struct AliasViewArray *ava, struct Alias *alias)
	Add an Alias to the AliasViewArray.
int	alias_array_alias_delete (struct AliasViewArray *ava, const struct Alias *alias)
	Delete an Alias from the AliasViewArray.
int	alias_array_count_visible (struct AliasViewArray *ava)
	Count number of visible Aliases.
void	alias_set_title (struct MuttWindow *sbar, char *menu_name, char *limit)
	Create a title string for the Menu.
int	alias_recalc (struct MuttWindow *win)
	Recalculate the display of the Alias Window - Implements MuttWindow::recalc() -.

Detailed Description

Shared code for the Alias and Query Dialogs.

Authors

• Romeu Vieira
• Richard Russon
• Dennis Schön

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

Enumeration Type Documentation

ExpandoDataAlias

enum ExpandoDataAlias

Expando UIDs for Aliases.

See also

ED_ALIAS, ExpandoDomain

Enumerator
ED_ALI_ADDRESS	Alias.addr.
ED_ALI_COMMENT	Alias.comment.
ED_ALI_FLAGS	Alias.flags.
ED_ALI_NAME	Alias.name.
ED_ALI_NUMBER	AliasView.num.
ED_ALI_TAGGED	AliasView.tagged.
ED_ALI_TAGS	Alias.tags.

Definition at line 71 of file gui.h.

{
  ED_ALI_ADDRESS = 1,          
  ED_ALI_COMMENT,              
  ED_ALI_FLAGS,                
  ED_ALI_NAME,                 
  ED_ALI_NUMBER,               
  ED_ALI_TAGGED,               
  ED_ALI_TAGS,                 
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	AliasViewArray	,
		struct AliasView
	)

alias_array_alias_add()

int alias_array_alias_add	(	struct AliasViewArray *	ava,
		struct Alias *	alias
	)

Add an Alias to the AliasViewArray.

Parameters

ava	Array of Aliases
alias	Alias to add

Return values

num	Size of array
-1	Error

Note

The Alias is wrapped in an AliasView

Call alias_array_sort() to sort and reindex the AliasViewArray

Definition at line 47 of file array.c.

{
  if (!ava || !alias)
    return -1;
 
  struct AliasView av = {
    .num = 0,
    .orig_seq = ARRAY_SIZE(ava),
    .is_tagged = false,
    .is_deleted = false,
    .is_visible = true,
    .alias = alias,
  };
  ARRAY_ADD(ava, av);
  return ARRAY_SIZE(ava);
}

Here is the caller graph for this function:

alias_array_alias_delete()

int alias_array_alias_delete	(	struct AliasViewArray *	ava,
		const struct Alias *	alias
	)

Delete an Alias from the AliasViewArray.

Parameters

ava	Array of Aliases
alias	Alias to remove

Return values

num	Size of array
-1	Error

Note

Call alias_array_sort() to sort and reindex the AliasViewArray

Definition at line 73 of file array.c.

{
  if (!ava || !alias)
    return -1;
 
  struct AliasView *avp = NULL;
  ARRAY_FOREACH(avp, ava)
  {
    if (avp->alias != alias)
      continue;
 
    ARRAY_REMOVE(ava, avp);
    break;
  }
 
  return ARRAY_SIZE(ava);
}

Here is the caller graph for this function:

alias_array_count_visible()

int alias_array_count_visible

(

struct AliasViewArray *

ava

)

Count number of visible Aliases.

Parameters

ava	Array of Aliases

Definition at line 95 of file array.c.

{
  int count = 0;
 
  struct AliasView *avp = NULL;
  ARRAY_FOREACH(avp, ava)
  {
    if (avp->is_visible)
      count++;
  }
 
  return count;
}

Here is the caller graph for this function:

alias_set_title()

void alias_set_title	(	struct MuttWindow *	sbar,
		char *	menu_name,
		char *	limit
	)

Create a title string for the Menu.

Parameters

sbar	Simple Bar Window
menu_name	Menu name
limit	Limit being applied

Definition at line 72 of file gui.c.

{
  if (!limit)
  {
    sbar_set_title(sbar, menu_name);
    return;
  }
 
  char buf[256] = { 0 };
 
  int len = snprintf(buf, sizeof(buf), "%s - ", menu_name);
 
  snprintf(buf + len, sizeof(buf) - len, _("Limit: %s"), limit);
 
  sbar_set_title(sbar, buf);
}

Here is the call graph for this function:

Here is the caller graph for this function: