lib/widget/dialog.h

   1 /*
   2    Dialog box features module for the Midnight Commander
   3  */
   4
   5 /** \file dialog.h
   6  *  \brief Header: dialog box features module
   7  */
   8
   9 #ifndef MC__DIALOG_H
  10 #define MC__DIALOG_H
  11
  12 #include <sys/types.h>          /* size_t */
  13
  14 #include "lib/global.h"
  15 #include "lib/hook.h"           /* hook_t */
  16 #include "lib/keybind.h"        /* global_keymap_t */
  17
  18 /*** typedefs(not structures) and defined constants **********************************************/
  19
  20 #define DIALOG(x) ((WDialog *)(x))
  21 #define CONST_DIALOG(x) ((const WDialog *)(x))
  22
  23 /* Common return values */
  24 /* ATTENTION: avoid overlapping with FileProgressStatus values */
  25 #define B_EXIT          0
  26 #define B_CANCEL        1
  27 #define B_ENTER         2
  28 #define B_HELP          3
  29 #define B_USER          100
  30
  31 /*** enums ***************************************************************************************/
  32
  33 /* Dialog color constants */
  34 typedef enum
  35 {
  36     DLG_COLOR_NORMAL,
  37     DLG_COLOR_FOCUS,
  38     DLG_COLOR_HOT_NORMAL,
  39     DLG_COLOR_HOT_FOCUS,
  40     DLG_COLOR_TITLE,
  41     DLG_COLOR_COUNT
  42 } dlg_colors_enum_t;
  43
  44 /*** typedefs(not structures) ********************************************************************/
  45
  46 typedef struct WDialog WDialog;
  47
  48 /* get string representation of shortcut assigned  with command */
  49 /* as menu is a widget of dialog, ask dialog about shortcut string */
  50 typedef char *(*dlg_shortcut_str) (long command);
  51
  52 /* get dialog name to show in dialog list */
  53 typedef char *(*dlg_title_str) (const WDialog * h, size_t len);
  54
  55 typedef int dlg_colors_t[DLG_COLOR_COUNT];
  56
  57 /*** structures declarations (and typedefs of structures)*****************************************/
  58
  59 struct WDialog
  60 {
  61     WGroup group;               /* base class */
  62
  63     /* Set by the user */
  64     gboolean compact;           /* Suppress spaces around the frame */
  65     const char *help_ctx;       /* Name of the help entry */
  66     const int *colors;          /* Color set. Unused in viewer and editor */
  67
  68     /* Set and received by the user */
  69     int ret_value;              /* Result of dlg_run() */
  70
  71     /* Internal variables */
  72     char *event_group;          /* Name of event group for this dialog */
  73     Widget *bg;                 /* WFrame or WBackground */
  74
  75     /* Data can be passed to dialog */
  76     union
  77     {
  78         void *p;
  79         int i;
  80     } data;
  81
  82     dlg_shortcut_str get_shortcut;      /* Shortcut string */
  83     dlg_title_str get_title;    /* useless for modal dialogs */
  84 };
  85
  86 /*** global variables defined in .c file *********************************************************/
  87
  88 /* Color styles for normal and error dialogs */
  89 extern dlg_colors_t dialog_colors;
  90 extern dlg_colors_t alarm_colors;
  91 extern dlg_colors_t listbox_colors;
  92
  93 /* A hook list for idle events */
  94 extern hook_t *idle_hook;
  95
  96 extern gboolean mouse_close_dialog;
  97
  98 extern const global_keymap_t *dialog_map;
  99
 100 /*** declarations of public functions ************************************************************/
 101
 102 /* Creates a dialog head  */
 103 WDialog *dlg_create (gboolean modal, int y1, int x1, int lines, int cols,
 104                      widget_pos_flags_t pos_flags, gboolean compact,
 105                      const int *colors, widget_cb_fn callback, widget_mouse_cb_fn mouse_callback,
 106                      const char *help_ctx, const char *title);
 107
 108 void dlg_set_default_colors (void);
 109
 110 void dlg_init (WDialog * h);
 111 int dlg_run (WDialog * d);
 112
 113 void dlg_run_done (WDialog * h);
 114 void dlg_save_history (WDialog * h);
 115 void dlg_process_event (WDialog * h, int key, Gpm_Event * event);
 116
 117 char *dlg_get_title (const WDialog * h, size_t len);
 118
 119 /* Default callbacks for dialogs */
 120 cb_ret_t dlg_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data);
 121 void dlg_default_mouse_callback (Widget * w, mouse_msg_t msg, mouse_event_t * event);
 122
 123 void dlg_close (WDialog * h);
 124
 125 /* --------------------------------------------------------------------------------------------- */
 126 /*** inline functions ****************************************************************************/
 127 /* --------------------------------------------------------------------------------------------- */
 128
 129 #endif /* MC__DIALOG_H */