lib/widget/widget-common.h

   1
   2 /** \file widget-common.h
   3  *  \brief Header: shared stuff of widgets
   4  */
   5
   6 #ifndef MC__WIDGET_INTERNAL_H
   7 #define MC__WIDGET_INTERNAL_H
   8
   9 #include "lib/tty/mouse.h"
  10 #include "lib/widget/mouse.h"   /* typedef easy_mouse_callback */
  11
  12 /*** typedefs(not structures) and defined constants **********************************************/
  13
  14 #define WIDGET(x) ((Widget *)(x))
  15
  16 #define widget_move(w, _y, _x) tty_gotoyx (WIDGET(w)->y + (_y), WIDGET(w)->x + (_x))
  17 /* Sets/clear the specified flag in the options field */
  18 #define widget_want_cursor(w,i) widget_set_options(w, W_WANT_CURSOR, i)
  19 #define widget_want_hotkey(w,i) widget_set_options(w, W_WANT_HOTKEY, i)
  20 #define widget_want_idle(w,i) widget_set_options(w, W_WANT_IDLE, i)
  21 #define widget_disable(w,i) widget_set_options(w, W_DISABLED, i)
  22
  23 /*** enums ***************************************************************************************/
  24
  25 /* Widget messages */
  26 typedef enum
  27 {
  28     MSG_INIT = 0,               /* Initialize widget */
  29     MSG_FOCUS,                  /* Draw widget in focused state or widget has got focus */
  30     MSG_UNFOCUS,                /* Draw widget in unfocused state or widget has been unfocused */
  31     MSG_DRAW,                   /* Draw widget on screen */
  32     MSG_KEY,                    /* Sent to widgets on key press */
  33     MSG_HOTKEY,                 /* Sent to widget to catch preprocess key */
  34     MSG_HOTKEY_HANDLED,         /* A widget has got the hotkey */
  35     MSG_UNHANDLED_KEY,          /* Key that no widget handled */
  36     MSG_POST_KEY,               /* The key has been handled */
  37     MSG_ACTION,                 /* Send to widget to handle command */
  38     MSG_NOTIFY,                 /* Typically sent to dialog to inform it of state-change
  39                                  * of listboxes, check- and radiobuttons. */
  40     MSG_CURSOR,                 /* Sent to widget to position the cursor */
  41     MSG_IDLE,                   /* The idle state is active */
  42     MSG_RESIZE,                 /* Screen size has changed */
  43     MSG_VALIDATE,               /* Dialog is to be closed */
  44     MSG_END,                    /* Shut down dialog */
  45     MSG_DESTROY                 /* Sent to widget at destruction time */
  46 } widget_msg_t;
  47
  48 /* Widgets are expected to answer to the following messages:
  49    MSG_FOCUS:   MSG_HANDLED if the accept the focus, MSG_NOT_HANDLED if they do not.
  50    MSG_UNFOCUS: MSG_HANDLED if they accept to release the focus, MSG_NOT_HANDLED if they don't.
  51    MSG_KEY:     MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  52    MSG_HOTKEY:  MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  53  */
  54
  55 typedef enum
  56 {
  57     MSG_NOT_HANDLED = 0,
  58     MSG_HANDLED = 1
  59 } cb_ret_t;
  60
  61 /* Widget options */
  62 typedef enum
  63 {
  64     W_DEFAULT = (0 << 0),
  65     W_WANT_HOTKEY = (1 << 1),
  66     W_WANT_CURSOR = (1 << 2),
  67     W_WANT_IDLE = (1 << 3),
  68     W_IS_INPUT = (1 << 4),
  69     W_DISABLED = (1 << 5)       /* Widget cannot be selected */
  70 } widget_options_t;
  71
  72 /* Flags for widget repositioning on dialog resize */
  73 typedef enum
  74 {
  75     WPOS_CENTER_HORZ = (1 << 0),        /* center widget in horizontal */
  76     WPOS_CENTER_VERT = (1 << 1),        /* center widget in vertical */
  77     WPOS_KEEP_LEFT = (1 << 2),  /* keep widget distance to left border of dialog */
  78     WPOS_KEEP_RIGHT = (1 << 3), /* keep widget distance to right border of dialog */
  79     WPOS_KEEP_TOP = (1 << 4),   /* keep widget distance to top border of dialog */
  80     WPOS_KEEP_BOTTOM = (1 << 5),        /* keep widget distance to bottom border of dialog */
  81     WPOS_KEEP_HORZ = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
  82     WPOS_KEEP_VERT = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
  83     WPOS_KEEP_ALL = WPOS_KEEP_HORZ | WPOS_KEEP_VERT,
  84     WPOS_KEEP_DEFAULT = WPOS_KEEP_LEFT | WPOS_KEEP_TOP
  85 } widget_pos_flags_t;
  86 /* NOTE: if WPOS_CENTER_HORZ flag is used, other horizontal flags (WPOS_KEEP_LEFT, WPOS_KEEP_RIGHT,
  87  * and WPOS_KEEP_HORZ are ignored).
  88  * If WPOS_CENTER_VERT flag is used, other horizontal flags (WPOS_KEEP_TOP, WPOS_KEEP_BOTTOM,
  89  * and WPOS_KEEP_VERT are ignored).
  90  */
  91
  92 /*** structures declarations (and typedefs of structures)*****************************************/
  93
  94 /* Widget callback */
  95 typedef cb_ret_t (*widget_cb_fn) (Widget * widget, Widget * sender, widget_msg_t msg, int parm,
  96                                   void *data);
  97
  98 /* Every Widget must have this as its first element */
  99 struct Widget
 100 {
 101     int x, y;
 102     int cols, lines;
 103     widget_options_t options;
 104     widget_pos_flags_t pos_flags;       /* repositioning flags */
 105     unsigned int id;            /* Number of the widget, starting with 0 */
 106     widget_cb_fn callback;
 107     mouse_h mouse;
 108     void (*set_options) (Widget * w, widget_options_t options, gboolean enable);
 109     WDialog *owner;
 110     /* Mouse-related fields. */
 111     struct
 112     {
 113         easy_mouse_callback callback;
 114         gboolean capture;       /* Whether the widget "owns" the mouse. */
 115         gboolean forced_capture;        /* Overrides the above. Set explicitly by the programmer. */
 116     } Mouse;
 117     /* "Mouse" capitalized -- as we already have a lowercase "mouse" here.
 118      * @FIXME: rename "mouse" to something else. */
 119 };
 120
 121 /* structure for label (caption) with hotkey, if original text does not contain
 122  * hotkey, only start is valid and is equal to original text
 123  * hotkey is defined as char*, but mc support only singlebyte hotkey
 124  */
 125 typedef struct hotkey_t
 126 {
 127     char *start;
 128     char *hotkey;
 129     char *end;
 130 } hotkey_t;
 131
 132 /*** global variables defined in .c file *********************************************************/
 133
 134 /*** declarations of public functions ************************************************************/
 135
 136 /* create hotkey from text */
 137 hotkey_t parse_hotkey (const char *text);
 138 /* release hotkey, free all mebers of hotkey_t */
 139 void release_hotkey (const hotkey_t hotkey);
 140 /* return width on terminal of hotkey */
 141 int hotkey_width (const hotkey_t hotkey);
 142 /* draw hotkey of widget */
 143 void hotkey_draw (Widget * w, const hotkey_t hotkey, gboolean focused);
 144
 145 /* widget initialization */
 146 void widget_init (Widget * w, int y, int x, int lines, int cols,
 147                   widget_cb_fn callback, mouse_h mouse_handler);
 148 /* Default callback for widgets */
 149 cb_ret_t widget_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm,
 150                                   void *data);
 151 void widget_default_set_options_callback (Widget * w, widget_options_t options, gboolean enable);
 152 void widget_set_options (Widget * w, widget_options_t options, gboolean enable);
 153 void widget_set_size (Widget * widget, int y, int x, int lines, int cols);
 154 /* select color for widget in dependance of state */
 155 void widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey);
 156 void widget_redraw (Widget * w);
 157 void widget_erase (Widget * w);
 158 gboolean widget_is_active (const void *w);
 159 gboolean widget_overlapped (const Widget * a, const Widget * b);
 160 void widget_replace (Widget * old, Widget * new);
 161
 162 /* get mouse pointer location within widget */
 163 Gpm_Event mouse_get_local (const Gpm_Event * global, const Widget * w);
 164 gboolean mouse_global_in_widget (const Gpm_Event * event, const Widget * w);
 165
 166 /* --------------------------------------------------------------------------------------------- */
 167 /*** inline functions ****************************************************************************/
 168 /* --------------------------------------------------------------------------------------------- */
 169
 170 static inline cb_ret_t
 171 send_message (void *w, void *sender, widget_msg_t msg, int parm, void *data)
 172 {
 173     cb_ret_t ret = MSG_NOT_HANDLED;
 174
 175 #if 1
 176     if (w != NULL)              /* This must be always true, but... */
 177 #endif
 178         ret = WIDGET (w)->callback (WIDGET (w), WIDGET (sender), msg, parm, data);
 179
 180     return ret;
 181 }
 182
 183 /* --------------------------------------------------------------------------------------------- */
 184
 185 #endif /* MC__WIDGET_INTERNAL_H */