module.c File Reference

Definition of the Compose Module. More...

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

Include dependency graph for module.c:

Go to the source code of this file.

Functions
static bool	compose_init (struct NeoMutt *n)
	Initialise a Module - Implements Module::init()
static bool	compose_config_define_variables (struct NeoMutt *n, struct ConfigSet *cs)
	Define the Config Variables - Implements Module::config_define_variables()
static bool	compose_cleanup (struct NeoMutt *n)
	Clean up a Module - Implements Module::cleanup()

Variables
struct ConfigDef	ComposeVars []
	Config definitions for compose.
const struct Module	ModuleCompose
	Module for the Compose library.

Detailed Description

Definition of the Compose 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

compose_init()

static bool compose_init ( struct NeoMutt * n )

static

Initialise a Module - Implements Module::init()

Definition at line 42 of file module.c.

{
  // struct ComposeModuleData *md = MUTT_MEM_CALLOC(1, struct ComposeModuleData);
  // neomutt_set_module_data(n, MODULE_ID_COMPOSE, md);
 
  return true;
}

compose_config_define_variables()

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

static

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

Definition at line 53 of file module.c.

{
  return cs_register_variables(cs, ComposeVars);
}

Here is the call graph for this function:

compose_cleanup()

static bool compose_cleanup ( struct NeoMutt * n )

static

Clean up a Module - Implements Module::cleanup()

Definition at line 61 of file module.c.

{
  // struct ComposeModuleData *md = neomutt_get_module_data(n, MODULE_ID_COMPOSE);
  // ASSERT(md);
 
  // FREE(&md);
  return true;
}

Variable Documentation

ComposeVars

struct ConfigDef ComposeVars[]

extern

Config definitions for compose.

Definition at line 65 of file config.c.

                                 {
  // clang-format off
  { "compose_confirm_detach_first", DT_BOOL, true, 0, NULL,
    "Prevent the accidental deletion of the composed message"
  },
  // L10N: $compose_format default format
  { "compose_format", DT_EXPANDO|D_L10N_STRING, IP N_("-- NeoMutt: Compose  [Approx. msg size: %l   Atts: %a]%>-"), IP &ComposeFormatDef, NULL,
    "printf-like format string for the Compose panel's status bar"
  },
  { "compose_show_preview", DT_BOOL, true, 0, NULL,
    "Display a preview of the message body in the Compose window"
  },
  { "compose_show_user_headers", DT_BOOL, true, 0, NULL,
    "Controls whether or not custom headers are shown in the compose envelope"
  },
  { "compose_preview_min_rows", DT_NUMBER|D_INTEGER_NOT_NEGATIVE, 5, 0, NULL,
    "Hide the preview if it has fewer than this number of rows"
  },
  { "compose_preview_above_attachments", DT_BOOL, false, 0, NULL,
    "Show the message preview above the attachments list. By default it is shown below it."
  },
  { "copy", DT_QUAD, MUTT_YES, 0, NULL,
    "Save outgoing emails to $record"
  },
  { "edit_headers", DT_BOOL, false, 0, NULL,
    "Let the user edit the email headers whilst editing an email"
  },
  { "ispell", DT_STRING|D_STRING_COMMAND, IP ISPELL, 0, NULL,
    "External command to perform spell-checking"
  },
  { "postpone", DT_QUAD, MUTT_ASKYES, 0, NULL,
    "Save messages to the `$postponed` folder"
  },
 
  { "edit_hdrs", DT_SYNONYM, IP "edit_headers", IP "2021-03-21" },
  { NULL },
  // clang-format on
};

ModuleCompose

const struct Module ModuleCompose

Initial value:

= {
  MODULE_ID_COMPOSE,
  "compose",
  compose_init,
  NULL, 
  compose_config_define_variables,
  NULL, 
  NULL, 
  NULL, 
  compose_cleanup,
}

Module for the Compose library.

Definition at line 73 of file module.c.

                                    {
  MODULE_ID_COMPOSE,
  "compose",
  compose_init,
  NULL, // config_define_types
  compose_config_define_variables,
  NULL, // commands_register
  NULL, // gui_init
  NULL, // gui_cleanup
  compose_cleanup,
};