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 typedef struct Widget Widget;
  37
  38 /* Widget messages */
  39 typedef enum {
  40     WIDGET_INIT,                /* Initialize widget */
  41     WIDGET_FOCUS,               /* Draw widget in focused state */
  42     WIDGET_UNFOCUS,             /* Draw widget in unfocused state */
  43     WIDGET_DRAW,                /* Sent to widget to draw themselves */
  44     WIDGET_KEY,                 /* Sent to widgets on key press */
  45     WIDGET_HOTKEY,              /* Sent to widget to catch preprocess key */
  46     WIDGET_COMMAND,             /* Send to widget to handle command */
  47     WIDGET_DESTROY,             /* Sent to widget at destruction time */
  48     WIDGET_CURSOR,              /* Sent to widget to position the cursor */
  49     WIDGET_IDLE,                /* Sent to widgets with options & W_WANT_IDLE*/
  50     WIDGET_RESIZED              /* Sent after a widget has been resized */
  51 } widget_msg_t;
  52
  53 typedef enum {
  54     MSG_NOT_HANDLED     = 0,
  55     MSG_HANDLED         = 1
  56 } cb_ret_t;
  57
  58 /* Widgets are expected to answer to the following messages:
  59
  60    WIDGET_FOCUS:   1 if the accept the focus, 0 if they do not.
  61    WIDGET_UNFOCUS: 1 if they accept to release the focus, 0 if they don't.
  62    WIDGET_KEY:     1 if they actually used the key, 0 if not.
  63    WIDGET_HOTKEY:  1 if they actually used the key, 0 if not.
  64 */
  65
  66 /* Dialog messages */
  67 typedef enum {
  68     DLG_INIT            = 0,    /* Initialize dialog */
  69     DLG_IDLE            = 1,    /* The idle state is active */
  70     DLG_DRAW            = 2,    /* Draw dialog on screen */
  71     DLG_FOCUS           = 3,    /* A widget has got focus */
  72     DLG_UNFOCUS         = 4,    /* A widget has been unfocused */
  73     DLG_RESIZE          = 5,    /* Window size has changed */
  74     DLG_KEY             = 6,    /* Key before sending to widget */
  75     DLG_HOTKEY_HANDLED  = 7,    /* A widget has got the hotkey */
  76     DLG_POST_KEY        = 8,    /* The key has been handled */
  77     DLG_UNHANDLED_KEY   = 9,    /* Key that no widget handled */
  78     DLG_ACTION          = 10,   /* State of check- and radioboxes has changed
  79                                  * and listbox current entry has changed */
  80     DLG_VALIDATE        = 11,   /* Dialog is to be closed */
  81     DLG_END             = 12    /* Shut down dialog */
  82 } dlg_msg_t;
  83
  84
  85 /* Dialog callback */
  86 typedef struct Dlg_head Dlg_head;
  87 typedef cb_ret_t (*dlg_cb_fn)(struct Dlg_head *h, Widget *sender,
  88                                 dlg_msg_t msg, int parm, void *data);
  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) (unsigned long 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 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     dlg_shortcut_str get_shortcut;      /* Shortcut string */
 126     struct Dlg_head *parent;            /* Parent dialog */
 127 };
 128
 129 /* Color styles for normal and error dialogs */
 130 extern int dialog_colors[4];
 131 extern int alarm_colors[4];
 132
 133
 134 /* Widget callback */
 135 typedef cb_ret_t (*callback_fn) (Widget *widget, widget_msg_t msg, int parm);
 136
 137 /* widget options */
 138 typedef enum {
 139     W_WANT_HOTKEY       = (1 << 1),
 140     W_WANT_CURSOR       = (1 << 2),
 141     W_WANT_IDLE         = (1 << 3),
 142     W_IS_INPUT          = (1 << 4)
 143 } widget_options_t;
 144
 145 /* Flags for widget repositioning on dialog resize */
 146 typedef enum {
 147     WPOS_KEEP_LEFT      = (1 << 0), /* keep widget distance to left border of dialog */
 148     WPOS_KEEP_RIGHT     = (1 << 1), /* keep widget distance to right border of dialog */
 149     WPOS_KEEP_TOP       = (1 << 2), /* keep widget distance to top border of dialog */
 150     WPOS_KEEP_BOTTOM    = (1 << 3), /* keep widget distance to bottom border of dialog */
 151     WPOS_KEEP_HORZ      = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
 152     WPOS_KEEP_VERT      = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
 153     WPOS_KEEP_ALL       = WPOS_KEEP_HORZ | WPOS_KEEP_VERT
 154 } widget_pos_flags_t;
 155
 156 /* Every Widget must have this as its first element */
 157 struct Widget {
 158     int x, y;
 159     int cols, lines;
 160     widget_options_t options;
 161     widget_pos_flags_t pos_flags;       /* repositioning flags */
 162     int dlg_id;                         /* Number of the widget, starting with 0 */
 163     struct Widget *next;
 164     struct Widget *prev;
 165     callback_fn callback;
 166     mouse_h mouse;
 167     struct Dlg_head *parent;
 168 };
 169
 170 /* draw box in window */
 171 void draw_box (Dlg_head *h, int y, int x, int ys, int xs);
 172
 173 /* Flags for create_dlg: */
 174 #define DLG_REVERSE     (1 << 5) /* Tab order is opposite to the add order */
 175 #define DLG_WANT_TAB    (1 << 4) /* Should the tab key be sent to the dialog? */
 176 #define DLG_WANT_IDLE   (1 << 3) /* Dialog wants idle events */
 177 #define DLG_COMPACT     (1 << 2) /* Suppress spaces around the frame */
 178 #define DLG_TRYUP       (1 << 1) /* Try to move two lines up the dialog */
 179 #define DLG_CENTER      (1 << 0) /* Center the dialog */
 180 #define DLG_NONE        (000000) /* No options */
 181
 182 /* Creates a dialog head  */
 183 Dlg_head *create_dlg (int y1, int x1, int lines, int cols,
 184                       const int *color_set, dlg_cb_fn callback,
 185                       const char *help_ctx, const char *title, int flags);
 186
 187 void dlg_set_default_colors (void);
 188
 189 int add_widget_autopos (Dlg_head *dest, void *w, widget_pos_flags_t pos_flags);
 190 int add_widget         (Dlg_head *dest, void *w);
 191
 192 /* sets size of dialog, leaving positioning to automatic mehtods
 193    according to dialog flags */
 194 void dlg_set_size (Dlg_head *h, int lines, int cols);
 195 /* this function allows to set dialog position */
 196 void dlg_set_position (Dlg_head *h, int y1, int x1, int y2, int x2);
 197
 198 /* Runs dialog d */
 199 int run_dlg               (Dlg_head *d);
 200
 201 void dlg_run_done         (Dlg_head *h);
 202 void dlg_process_event    (Dlg_head *h, int key, Gpm_Event *event);
 203 void init_dlg             (Dlg_head *h);
 204
 205 /* To activate/deactivate the idle message generation */
 206 void set_idle_proc        (Dlg_head *d, int enable);
 207
 208 void dlg_redraw           (Dlg_head *h);
 209 void destroy_dlg          (Dlg_head *h);
 210
 211 void widget_set_size      (Widget *widget, int y, int x, int lines, int cols);
 212
 213 void dlg_broadcast_msg    (Dlg_head *h, widget_msg_t message, int reverse);
 214
 215 void init_widget (Widget *w, int y, int x, int lines, int cols,
 216                   callback_fn callback, mouse_h mouse_handler);
 217
 218 /* Default callback for dialogs */
 219 cb_ret_t default_dlg_callback (Dlg_head *h, Widget *sender,
 220                                 dlg_msg_t msg, int parm, void *data);
 221
 222 /* Default paint routine for dialogs */
 223 void common_dialog_repaint (struct Dlg_head *h);
 224
 225 #define widget_move(w, _y, _x) tty_gotoyx (((Widget *)(w))->y + _y, ((Widget *)(w))->x + _x)
 226 #define dlg_move(h, _y, _x) tty_gotoyx (((Dlg_head *)(h))->y + _y, ((Dlg_head *)(h))->x + _x)
 227
 228 extern Dlg_head *current_dlg;
 229
 230 /* A hook list for idle events */
 231 extern Hook *idle_hook;
 232
 233 static inline cb_ret_t
 234 send_message (Widget *w, widget_msg_t msg, int parm)
 235 {
 236     return (*(w->callback)) (w, msg, parm);
 237 }
 238
 239 /* Return 1 if the widget is active, 0 otherwise */
 240 static inline int
 241 dlg_widget_active (void *w)
 242 {
 243     Widget *w1 = (Widget *) w;
 244     return (w1->parent->current == w1);
 245 }
 246
 247 void dlg_replace_widget   (Widget *old, Widget *new);
 248 int  dlg_overlap          (Widget *a, Widget *b);
 249 void widget_erase         (Widget *);
 250 void dlg_erase            (Dlg_head *h);
 251 void dlg_stop             (Dlg_head *h);
 252
 253 /* Widget selection */
 254 void dlg_select_widget     (void *widget);
 255 void dlg_one_up            (Dlg_head *h);
 256 void dlg_one_down          (Dlg_head *h);
 257 int  dlg_focus             (Dlg_head *h);
 258 Widget *find_widget_type   (const Dlg_head *h, callback_fn callback);
 259 void dlg_select_by_id (const Dlg_head *h, int id);
 260
 261 /* Redraw all dialogs */
 262 void do_refresh (void);
 263
 264 /* Sets/clear the specified flag in the options field */
 265 #define widget_option(w,f,i) \
 266     w.options = ((i) ? (w.options | (f)) : (w.options & (~(f))))
 267
 268 #define widget_want_cursor(w,i) widget_option(w, W_WANT_CURSOR, i)
 269 #define widget_want_hotkey(w,i) widget_option(w, W_WANT_HOTKEY, i)
 270
 271 /* Used in load_prompt() */
 272 void update_cursor (Dlg_head *h);
 273
 274 #endif                          /* MC_DIALOG_H */