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
  22 /* Common return values */
  23 /* ATTENTION: avoid overlapping with FileProgressStatus values */
  24 #define B_EXIT          0
  25 #define B_CANCEL        1
  26 #define B_ENTER         2
  27 #define B_HELP          3
  28 #define B_USER          100
  29
  30 /*** enums ***************************************************************************************/
  31
  32 /* Dialog color constants */
  33 typedef enum
  34 {
  35     DLG_COLOR_NORMAL,
  36     DLG_COLOR_FOCUS,
  37     DLG_COLOR_HOT_NORMAL,
  38     DLG_COLOR_HOT_FOCUS,
  39     DLG_COLOR_TITLE,
  40     DLG_COLOR_COUNT
  41 } dlg_colors_enum_t;
  42
  43 /*** typedefs(not structures) ********************************************************************/
  44
  45 typedef struct WDialog WDialog;
  46
  47 /* get string representation of shortcut assigned  with command */
  48 /* as menu is a widget of dialog, ask dialog about shortcut string */
  49 typedef char *(*dlg_shortcut_str) (long command);
  50
  51 /* get dialog name to show in dialog list */
  52 typedef char *(*dlg_title_str) (const WDialog * h, size_t len);
  53
  54 typedef int dlg_colors_t[DLG_COLOR_COUNT];
  55
  56 /* menu command execution */
  57 typedef cb_ret_t (*menu_exec_fn) (int command);
  58
  59 /*** structures declarations (and typedefs of structures)*****************************************/
  60
  61 struct WDialog
  62 {
  63     WGroup group;               /* base class */
  64
  65     /* Set by the user */
  66     gboolean compact;           /* Suppress spaces around the frame */
  67     const char *help_ctx;       /* Name of the help entry */
  68     const int *color;           /* Color set. Unused in viewer and editor */
  69     char *title;                /* Title of the dialog */
  70
  71     /* Set and received by the user */
  72     int ret_value;              /* Result of dlg_run() */
  73
  74     /* Internal flags */
  75     int mouse_status;           /* For the autorepeat status of the mouse */
  76
  77     /* Internal variables */
  78     void *data;                 /* Data can be passed to dialog */
  79     char *event_group;          /* Name of event group for this dialog */
  80
  81     dlg_shortcut_str get_shortcut;      /* Shortcut string */
  82     dlg_title_str get_title;    /* useless for modal dialogs */
  83 };
  84
  85 /*** global variables defined in .c file *********************************************************/
  86
  87 /* Color styles for normal and error dialogs */
  88 extern dlg_colors_t dialog_colors;
  89 extern dlg_colors_t alarm_colors;
  90 extern dlg_colors_t listbox_colors;
  91
  92 extern GList *top_dlg;
  93
  94 /* A hook list for idle events */
  95 extern hook_t *idle_hook;
  96
  97 extern gboolean fast_refresh;
  98 extern gboolean mouse_close_dialog;
  99
 100 extern const global_keymap_t *dialog_map;
 101
 102 /*** declarations of public functions ************************************************************/
 103
 104 /* Creates a dialog head  */
 105 WDialog *dlg_create (gboolean modal, int y1, int x1, int lines, int cols,
 106                      widget_pos_flags_t pos_flags, gboolean compact,
 107                      const int *colors, widget_cb_fn callback, widget_mouse_cb_fn mouse_callback,
 108                      const char *help_ctx, const char *title);
 109
 110 void dlg_set_default_colors (void);
 111
 112 /* sets size of dialog, leaving positioning to automatic mehtods
 113    according to dialog flags */
 114 void dlg_set_size (WDialog * h, int lines, int cols);
 115 /* this function allows to set dialog position */
 116 void dlg_set_position (WDialog * h, int y, int x, int lines, int cols);
 117
 118 void dlg_init (WDialog * h);
 119 int dlg_run (WDialog * d);
 120 void dlg_destroy (WDialog * h);
 121
 122 void dlg_run_done (WDialog * h);
 123 void dlg_save_history (WDialog * h);
 124 void dlg_process_event (WDialog * h, int key, Gpm_Event * event);
 125
 126 void dlg_set_title (WDialog * h, const char *title);
 127 char *dlg_get_title (const WDialog * h, size_t len);
 128
 129 void dlg_draw (WDialog * h);
 130
 131 void dlg_broadcast_msg (WDialog * h, widget_msg_t message);
 132
 133 /* Default callback for dialogs */
 134 cb_ret_t dlg_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm, void *data);
 135
 136 /* Default paint routine for dialogs */
 137 void dlg_default_repaint (WDialog * h);
 138
 139 void dlg_erase (WDialog * h);
 140 void dlg_stop (WDialog * h);
 141
 142 /* Widget selection */
 143 Widget *find_widget_type (const WDialog * h, widget_cb_fn callback);
 144 GList *dlg_find (const WDialog * h, const Widget * w);
 145 Widget *dlg_find_by_id (const WDialog * h, unsigned long id);
 146
 147 /* Redraw all dialogs */
 148 void do_refresh (void);
 149
 150 /* Used in load_prompt() */
 151 void update_cursor (WDialog * h);
 152
 153 /* --------------------------------------------------------------------------------------------- */
 154 /*** inline functions ****************************************************************************/
 155 /* --------------------------------------------------------------------------------------------- */
 156
 157 static inline unsigned long
 158 dlg_get_current_widget_id (const WDialog * h)
 159 {
 160     return WIDGET (GROUP (h)->current->data)->id;
 161 }
 162
 163 /* --------------------------------------------------------------------------------------------- */
 164
 165 #endif /* MC__DIALOG_H */