src/dialog.h

   1 /* Dialog box features module for the Midnight Commander
   2    Copyright (C) 1994, 1995 Radek Doulik, Miguel de Icaza
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  */
  18
  19 /** \file dialog.h
  20  *  \brief Header: dialog box features module
  21  */
  22
  23 #ifndef MC_DIALOG_H
  24 #define MC_DIALOG_H
  25
  26 #include "../src/tty/mouse.h"
  27 #include "util.h" /* Hook */
  28
  29 /* Common return values */
  30 #define B_EXIT          0
  31 #define B_CANCEL        1
  32 #define B_ENTER         2
  33 #define B_HELP          3
  34 #define B_USER          100
  35
  36 /* Widget messages */
  37 typedef enum {
  38     WIDGET_INIT,                /* Initialize widget */
  39     WIDGET_FOCUS,               /* Draw widget in focused state */
  40     WIDGET_UNFOCUS,             /* Draw widget in unfocused state */
  41     WIDGET_DRAW,                /* Sent to widget to draw themselves */
  42     WIDGET_KEY,                 /* Sent to widgets on key press */
  43     WIDGET_HOTKEY,              /* Sent to widget to catch preprocess key */
  44     WIDGET_COMMAND,             /* Send to widget to handle command */
  45     WIDGET_DESTROY,             /* Sent to widget at destruction time */
  46     WIDGET_CURSOR,              /* Sent to widget to position the cursor */
  47     WIDGET_IDLE,                /* Sent to widgets with options & W_WANT_IDLE*/
  48     WIDGET_RESIZED              /* Sent after a widget has been resized */
  49 } widget_msg_t;
  50
  51 typedef enum {
  52     MSG_NOT_HANDLED     = 0,
  53     MSG_HANDLED         = 1
  54 } cb_ret_t;
  55
  56 /* Widgets are expected to answer to the following messages:
  57
  58    WIDGET_FOCUS:   1 if the accept the focus, 0 if they do not.
  59    WIDGET_UNFOCUS: 1 if they accept to release the focus, 0 if they don't.
  60    WIDGET_KEY:     1 if they actually used the key, 0 if not.
  61    WIDGET_HOTKEY:  1 if they actually used the key, 0 if not.
  62 */
  63
  64 /* Dialog messages */
  65 typedef enum {
  66     DLG_KEY,                    /* Key before sending to widget */
  67     DLG_INIT,                   /* Initialize dialog */
  68     DLG_END,                    /* Shut down dialog */
  69     DLG_ACTION,                 /* State of check- and radioboxes has changed
  70                                  * and listbox current entry has changed */
  71     DLG_DRAW,                   /* Draw dialog on screen */
  72     DLG_FOCUS,                  /* A widget has got focus */
  73     DLG_UNFOCUS,                /* A widget has been unfocused */
  74     DLG_RESIZE,                 /* Window size has changed */
  75     DLG_POST_KEY,               /* The key has been handled */
  76     DLG_IDLE,                   /* The idle state is active */
  77     DLG_UNHANDLED_KEY,          /* Key that no widget handled */
  78     DLG_HOTKEY_HANDLED,         /* A widget has got the hotkey */
  79     DLG_VALIDATE                /* Dialog is to be closed */
  80 } dlg_msg_t;
  81
  82
  83 /* Dialog callback */
  84 struct Dlg_head;
  85 typedef cb_ret_t (*dlg_cb_fn)(struct Dlg_head *h, dlg_msg_t msg, int parm);
  86
  87 /* menu command execution */
  88 typedef cb_ret_t (*menu_exec_fn) (int command);
  89
  90 /* get string representation of shortcut assigned  with command */
  91 /* as menu is a widget of dialog, ask dialog about shortcut string */
  92 typedef char * (*dlg_shortcut_str) (int command);
  93
  94 /* Dialog color constants */
  95 #define DLG_COLOR_NUM           4
  96 #define DLG_NORMALC(h)          ((h)->color[0])
  97 #define DLG_FOCUSC(h)           ((h)->color[1])
  98 #define DLG_HOT_NORMALC(h)      ((h)->color[2])
  99 #define DLG_HOT_FOCUSC(h)       ((h)->color[3])
 100
 101 typedef struct Dlg_head {
 102     /* Set by the user */
 103     int flags;                          /* User flags */
 104     const char *help_ctx;               /* Name of the help entry */
 105     int *color;                         /* Color set. Unused in viewer and editor */
 106     /*notconst*/ char *title;           /* Title of the dialog */
 107
 108     /* Set and received by the user */
 109     int ret_value;                      /* Result of run_dlg() */
 110
 111     /* Geometry */
 112     int x, y;                           /* Position relative to screen origin */
 113     int cols, lines;                    /* Width and height of the window */
 114
 115     /* Internal flags */
 116     unsigned int running:1;             /* The dialog is currently active */
 117     unsigned int fullscreen:1;          /* Parents dialogs don't need refresh */
 118     int mouse_status;                   /* For the autorepeat status of the mouse */
 119
 120     /* Internal variables */
 121     int count;                          /* Number of widgets */
 122     struct Widget *current;             /* Curently active widget */
 123     void *data;                         /* Data can be passed to dialog */
 124     dlg_cb_fn callback;
 125     menu_exec_fn menu_executor;         /* Execute menu commands */
 126     dlg_shortcut_str get_shortcut;      /* Shortcut string */
 127     struct Dlg_head *parent;            /* Parent dialog */
 128 } Dlg_head;
 129
 130 /* Color styles for normal and error dialogs */
 131 extern int dialog_colors[4];
 132 extern int alarm_colors[4];
 133
 134 typedef struct Widget Widget;
 135
 136 /* Widget callback */
 137 typedef cb_ret_t (*callback_fn) (Widget *widget, widget_msg_t msg, int parm);
 138
 139 /* widget options */
 140 typedef enum {
 141     W_WANT_HOTKEY       = (1 << 1),
 142     W_WANT_CURSOR       = (1 << 2),
 143     W_WANT_IDLE         = (1 << 3),
 144     W_IS_INPUT          = (1 << 4)
 145 } widget_options_t;
 146
 147 /* Flags for widget repositioning on dialog resize */
 148 typedef enum {
 149     WPOS_KEEP_LEFT      = (1 << 0), /* keep widget distance to left border of dialog */
 150     WPOS_KEEP_RIGHT     = (1 << 1), /* keep widget distance to right border of dialog */
 151     WPOS_KEEP_TOP       = (1 << 2), /* keep widget distance to top border of dialog */
 152     WPOS_KEEP_BOTTOM    = (1 << 3), /* keep widget distance to bottom border of dialog */
 153     WPOS_KEEP_HORZ      = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
 154     WPOS_KEEP_VERT      = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
 155     WPOS_KEEP_ALL       = WPOS_KEEP_HORZ | WPOS_KEEP_VERT
 156 } widget_pos_flags_t;
 157
 158 /* Every Widget must have this as its first element */
 159 struct Widget {
 160     int x, y;
 161     int cols, lines;
 162     widget_options_t options;
 163     widget_pos_flags_t pos_flags;       /* repositioning flags */
 164     int dlg_id;                         /* Number of the widget, starting with 0 */
 165     struct Widget *next;
 166     struct Widget *prev;
 167     callback_fn callback;
 168     mouse_h mouse;
 169     struct Dlg_head *parent;
 170 };
 171
 172 /* draw box in window */
 173 void draw_box (Dlg_head *h, int y, int x, int ys, int xs);
 174
 175 /* Flags for create_dlg: */
 176 #define DLG_REVERSE     (1 << 5) /* Tab order is opposite to the add order */
 177 #define DLG_WANT_TAB    (1 << 4) /* Should the tab key be sent to the dialog? */
 178 #define DLG_WANT_IDLE   (1 << 3) /* Dialog wants idle events */
 179 #define DLG_COMPACT     (1 << 2) /* Suppress spaces around the frame */
 180 #define DLG_TRYUP       (1 << 1) /* Try to move two lines up the dialog */
 181 #define DLG_CENTER      (1 << 0) /* Center the dialog */
 182 #define DLG_NONE        (000000) /* No options */
 183
 184 /* Creates a dialog head  */
 185 Dlg_head *create_dlg (int y1, int x1, int lines, int cols,
 186                       const int *color_set, dlg_cb_fn callback,
 187                       const char *help_ctx, const char *title, int flags);
 188
 189 void dlg_set_default_colors (void);
 190
 191 int add_widget_autopos (Dlg_head *dest, void *w, widget_pos_flags_t pos_flags);
 192 int add_widget         (Dlg_head *dest, void *w);
 193
 194 /* sets size of dialog, leaving positioning to automatic mehtods
 195    according to dialog flags */
 196 void dlg_set_size (Dlg_head *h, int lines, int cols);
 197 /* this function allows to set dialog position */
 198 void dlg_set_position (Dlg_head *h, int y1, int x1, int y2, int x2);
 199
 200 /* Runs dialog d */
 201 int run_dlg               (Dlg_head *d);
 202
 203 void dlg_run_done         (Dlg_head *h);
 204 void dlg_process_event    (Dlg_head *h, int key, Gpm_Event *event);
 205 void init_dlg             (Dlg_head *h);
 206
 207 /* To activate/deactivate the idle message generation */
 208 void set_idle_proc        (Dlg_head *d, int enable);
 209
 210 void dlg_redraw           (Dlg_head *h);
 211 void destroy_dlg          (Dlg_head *h);
 212
 213 void widget_set_size      (Widget *widget, int y, int x, int lines, int cols);
 214
 215 void dlg_broadcast_msg    (Dlg_head *h, widget_msg_t message, int reverse);
 216
 217 void init_widget (Widget *w, int y, int x, int lines, int cols,
 218                   callback_fn callback, mouse_h mouse_handler);
 219
 220 /* Default callback for dialogs */
 221 cb_ret_t default_dlg_callback (Dlg_head *h, dlg_msg_t msg, int parm);
 222
 223 /* Default paint routine for dialogs */
 224 void common_dialog_repaint (struct Dlg_head *h);
 225
 226 #define widget_move(w, _y, _x) tty_gotoyx (((Widget *)(w))->y + _y, ((Widget *)(w))->x + _x)
 227 #define dlg_move(h, _y, _x) tty_gotoyx (((Dlg_head *)(h))->y + _y, ((Dlg_head *)(h))->x + _x)
 228
 229 extern Dlg_head *current_dlg;
 230
 231 /* A hook list for idle events */
 232 extern Hook *idle_hook;
 233
 234 static inline cb_ret_t
 235 send_message (Widget *w, widget_msg_t msg, int parm)
 236 {
 237     return (*(w->callback)) (w, msg, parm);
 238 }
 239
 240 /* Return 1 if the widget is active, 0 otherwise */
 241 static inline int
 242 dlg_widget_active (void *w)
 243 {
 244     Widget *w1 = (Widget *) w;
 245     return (w1->parent->current == w1);
 246 }
 247
 248 void dlg_replace_widget   (Widget *old, Widget *new);
 249 int  dlg_overlap          (Widget *a, Widget *b);
 250 void widget_erase         (Widget *);
 251 void dlg_erase            (Dlg_head *h);
 252 void dlg_stop             (Dlg_head *h);
 253
 254 /* Widget selection */
 255 void dlg_select_widget     (void *widget);
 256 void dlg_one_up            (Dlg_head *h);
 257 void dlg_one_down          (Dlg_head *h);
 258 int  dlg_focus             (Dlg_head *h);
 259 Widget *find_widget_type   (Dlg_head *h, callback_fn callback);
 260 void dlg_select_by_id (Dlg_head *h, int id);
 261
 262 /* Redraw all dialogs */
 263 void do_refresh (void);
 264
 265 /* Sets/clear the specified flag in the options field */
 266 #define widget_option(w,f,i) \
 267     w.options = ((i) ? (w.options | (f)) : (w.options & (~(f))))
 268
 269 #define widget_want_cursor(w,i) widget_option(w, W_WANT_CURSOR, i)
 270 #define widget_want_hotkey(w,i) widget_option(w, W_WANT_HOTKEY, i)
 271
 272 /* Used in load_prompt() */
 273 void update_cursor (Dlg_head *h);
 274
 275 #endif                          /* MC_DIALOG_H */