NeoMutt: core/dispatcher.h Source File

#ifndef MUTT_CORE_DISPATCHER_H

#define MUTT_CORE_DISPATCHER_H


struct KeyEvent;

struct MuttWindow;


enum FunctionRetval

{

  FR_UNKNOWN   = -7,

  FR_CONTINUE  = -6,

  FR_DONE      = -5,

  FR_NOT_IMPL  = -4,

  FR_NO_ACTION = -3,

  FR_ERROR     = -2,

  FR_SUCCESS   = -1,

};


typedef int (*function_dispatcher_t)(struct MuttWindow *win, const struct KeyEvent *event);


const char *dispatcher_get_retval_name(int rv);

void dispatcher_flush_on_error(int rv);


#endif /* MUTT_CORE_DISPATCHER_H */

FunctionRetval
FunctionRetval
Possible return values for NeoMutt functions.
Definition dispatcher.h:33

FR_SUCCESS
@ FR_SUCCESS
Valid function - successfully performed.
Definition dispatcher.h:40

FR_DONE
@ FR_DONE
Exit the Dialog.
Definition dispatcher.h:36

FR_UNKNOWN
@ FR_UNKNOWN
Unknown function.
Definition dispatcher.h:34

FR_ERROR
@ FR_ERROR
Valid function - error occurred.
Definition dispatcher.h:39

FR_NOT_IMPL
@ FR_NOT_IMPL
Invalid function - feature not enabled.
Definition dispatcher.h:37

FR_CONTINUE
@ FR_CONTINUE
Remain in the Dialog.
Definition dispatcher.h:35

FR_NO_ACTION
@ FR_NO_ACTION
Valid function - no action performed.
Definition dispatcher.h:38

dispatcher_get_retval_name
const char * dispatcher_get_retval_name(int rv)
Get the name of a return value.
Definition dispatcher.c:55

dispatcher_flush_on_error
void dispatcher_flush_on_error(int rv)
Flush pending keys after a dispatch error.
Definition dispatcher.c:65

function_dispatcher_t
int(* function_dispatcher_t)(struct MuttWindow *win, const struct KeyEvent *event)
Definition dispatcher.h:53

KeyEvent
An event such as a keypress.
Definition get.h:75

MuttWindow
Definition mutt_window.h:129