module.c File Reference

Definition of the Browser Module. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "config/lib.h"
#include "core/lib.h"

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	browser_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()

Variables
struct ConfigDef	BrowserVars []
	Config definitions for the browser.
const struct Module	ModuleBrowser
	Module for the Browser library.

Detailed Description

Definition of the Browser Module.

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

Function Documentation

browser_config_define_variables()

static bool browser_config_define_variables ( struct NeoMutt * n, struct ConfigSet * cs )

static

Define the Config Variables - Implements Module::config_define_variables()

Definition at line 40 of file module.c.

{
  return cs_register_variables(cs, BrowserVars);
}

Here is the call graph for this function:

Variable Documentation

BrowserVars

struct ConfigDef BrowserVars[]

extern

Config definitions for the browser.

Definition at line 138 of file config.c.

                                 {
  // clang-format off
  { "browser_abbreviate_mailboxes", DT_BOOL, true, 0, NULL,
    "Abbreviate mailboxes using '~' and '=' in the browser"
  },
  { "browser_sort", DT_SORT|D_SORT_REVERSE, BROWSER_SORT_ALPHA, IP BrowserSortMethods, NULL,
    "Sort method for the browser"
  },
  { "folder_format", DT_EXPANDO|D_NOT_EMPTY, IP "%2C %t %N %F %2l %-8.8u %-8.8g %8s %d %i", IP &FolderFormatDef, NULL,
    "printf-like format string for the browser's display of folders"
  },
  { "group_index_format", DT_EXPANDO|D_NOT_EMPTY, IP "%4C %M%N %5s  %-45.45f %d", IP &GroupIndexFormatDef, NULL,
    "(nntp) printf-like format string for the browser's display of newsgroups"
  },
  { "mailbox_folder_format", DT_EXPANDO|D_NOT_EMPTY, IP "%2C %<n?%6n&      > %6m %i", IP &FolderFormatDef, NULL,
    "printf-like format string for the browser's display of mailbox folders"
  },
  { "mask", DT_REGEX|D_REGEX_MATCH_CASE|D_REGEX_ALLOW_NOT|D_REGEX_NOSUB, IP "!^\\.[^.]", 0, NULL,
    "Only display files/dirs matching this regex in the browser"
  },
  { "show_only_unread", DT_BOOL, false, 0, NULL,
    "(nntp) Only show subscribed newsgroups with unread articles"
  },
  { "browser_sort_dirs_first", DT_BOOL, false, 0, NULL,
    "Group directories before files in the browser"
  },
 
  { "sort_browser", DT_SYNONYM, IP "browser_sort", IP "2024-11-20" },
 
  { NULL },
  // clang-format on
};

ModuleBrowser

const struct Module ModuleBrowser

Initial value:

= {
  MODULE_ID_BROWSER,
  "browser",
  NULL, 
  NULL, 
  browser_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  NULL, 
}

Module for the Browser library.

Definition at line 48 of file module.c.

                                    {
  MODULE_ID_BROWSER,
  "browser",
  NULL, // init
  NULL, // config_define_types
  browser_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  NULL, // cleanup
};