NeoMutt  2021-02-05-89-gabe350
Teaching an old dog new tricks
ConfigDef Struct Reference

Config item definition. More...

#include "set.h"

Data Fields

const char * name
 User-visible name. More...
uint32_t type
 Variable type, e.g. DT_STRING. More...
void * var
 Pointer to the global variable. More...
intptr_t initial
 Initial value. More...
intptr_t data
 Extra variable data. More...
int(* validator )(const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)
 Validate a config variable. More...
const char * docs
 One-liner description. More...

Detailed Description

Config item definition.

Every config variable that NeoMutt supports is backed by a ConfigDef.

Definition at line 61 of file set.h.

Field Documentation

◆ name

const char* ConfigDef::name

User-visible name.

Definition at line 63 of file set.h.

◆ type

uint32_t ConfigDef::type

Variable type, e.g. DT_STRING.

Definition at line 64 of file set.h.

◆ var

void* ConfigDef::var

Pointer to the global variable.

Definition at line 65 of file set.h.

◆ initial

intptr_t ConfigDef::initial

Initial value.

Definition at line 66 of file set.h.

◆ data

intptr_t ConfigDef::data

Extra variable data.

Definition at line 67 of file set.h.

◆ validator

int(* ConfigDef::validator) (const struct ConfigSet *cs, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err)

Validate a config variable.

csConfig items
cdefConfig definition
valueNative value
errMessage for the user
Return values

Definition at line 78 of file set.h.

◆ docs

const char* ConfigDef::docs

One-liner description.

Definition at line 80 of file set.h.

The documentation for this struct was generated from the following file: