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"   /* mouse_msg_t, mouse_event_t */
  11
  12 /*** typedefs(not structures) and defined constants **********************************************/
  13
  14 #define WIDGET(x) ((Widget *)(x))
  15 #define CONST_WIDGET(x) ((const Widget *)(x))
  16
  17 #define widget_move(w, _y, _x) tty_gotoyx (CONST_WIDGET(w)->y + (_y), CONST_WIDGET(w)->x + (_x))
  18 /* Sets/clear the specified flag in the options field */
  19 #define widget_want_cursor(w,i) widget_set_options(w, WOP_WANT_CURSOR, i)
  20 #define widget_want_hotkey(w,i) widget_set_options(w, WOP_WANT_HOTKEY, i)
  21 #define widget_want_idle(w,i) widget_set_options(w, WOP_WANT_IDLE, i)
  22 #define widget_disable(w,i) widget_set_state(w, WST_DISABLED, i)
  23
  24 /*** enums ***************************************************************************************/
  25
  26 /* Widget messages */
  27 typedef enum
  28 {
  29     MSG_INIT = 0,               /* Initialize widget */
  30     MSG_FOCUS,                  /* Draw widget in focused state or widget has got focus */
  31     MSG_UNFOCUS,                /* Draw widget in unfocused state or widget has been unfocused */
  32     MSG_ENABLE,                 /* Change state to enabled */
  33     MSG_DISABLE,                /* Change state to disabled */
  34     MSG_DRAW,                   /* Draw widget on screen */
  35     MSG_KEY,                    /* Sent to widgets on key press */
  36     MSG_HOTKEY,                 /* Sent to widget to catch preprocess key */
  37     MSG_HOTKEY_HANDLED,         /* A widget has got the hotkey */
  38     MSG_UNHANDLED_KEY,          /* Key that no widget handled */
  39     MSG_POST_KEY,               /* The key has been handled */
  40     MSG_ACTION,                 /* Send to widget to handle command */
  41     MSG_NOTIFY,                 /* Typically sent to dialog to inform it of state-change
  42                                  * of listboxes, check- and radiobuttons. */
  43     MSG_CURSOR,                 /* Sent to widget to position the cursor */
  44     MSG_IDLE,                   /* The idle state is active */
  45     MSG_RESIZE,                 /* Screen size has changed */
  46     MSG_VALIDATE,               /* Dialog is to be closed */
  47     MSG_END,                    /* Shut down dialog */
  48     MSG_DESTROY                 /* Sent to widget at destruction time */
  49 } widget_msg_t;
  50
  51 /* Widgets are expected to answer to the following messages:
  52    MSG_FOCUS:   MSG_HANDLED if the accept the focus, MSG_NOT_HANDLED if they do not.
  53    MSG_UNFOCUS: MSG_HANDLED if they accept to release the focus, MSG_NOT_HANDLED if they don't.
  54    MSG_KEY:     MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  55    MSG_HOTKEY:  MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  56  */
  57
  58 typedef enum
  59 {
  60     MSG_NOT_HANDLED = 0,
  61     MSG_HANDLED = 1
  62 } cb_ret_t;
  63
  64 /* Widget options */
  65 typedef enum
  66 {
  67     WOP_DEFAULT = (0 << 0),
  68     WOP_WANT_HOTKEY = (1 << 1),
  69     WOP_WANT_CURSOR = (1 << 2),
  70     WOP_WANT_IDLE = (1 << 3),
  71     WOP_IS_INPUT = (1 << 4)
  72 } widget_options_t;
  73
  74 /* Widget state */
  75 typedef enum
  76 {
  77     WST_DEFAULT = (0 << 0),
  78     WST_DISABLED = (1 << 0)     /* Widget cannot be selected */
  79 } widget_state_t;
  80
  81 /* Flags for widget repositioning on dialog resize */
  82 typedef enum
  83 {
  84     WPOS_CENTER_HORZ = (1 << 0),        /* center widget in horizontal */
  85     WPOS_CENTER_VERT = (1 << 1),        /* center widget in vertical */
  86     WPOS_KEEP_LEFT = (1 << 2),  /* keep widget distance to left border of dialog */
  87     WPOS_KEEP_RIGHT = (1 << 3), /* keep widget distance to right border of dialog */
  88     WPOS_KEEP_TOP = (1 << 4),   /* keep widget distance to top border of dialog */
  89     WPOS_KEEP_BOTTOM = (1 << 5),        /* keep widget distance to bottom border of dialog */
  90     WPOS_KEEP_HORZ = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
  91     WPOS_KEEP_VERT = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
  92     WPOS_KEEP_ALL = WPOS_KEEP_HORZ | WPOS_KEEP_VERT,
  93     WPOS_KEEP_DEFAULT = WPOS_KEEP_LEFT | WPOS_KEEP_TOP
  94 } widget_pos_flags_t;
  95 /* NOTE: if WPOS_CENTER_HORZ flag is used, other horizontal flags (WPOS_KEEP_LEFT, WPOS_KEEP_RIGHT,
  96  * and WPOS_KEEP_HORZ are ignored).
  97  * If WPOS_CENTER_VERT flag is used, other horizontal flags (WPOS_KEEP_TOP, WPOS_KEEP_BOTTOM,
  98  * and WPOS_KEEP_VERT are ignored).
  99  */
 100
 101 /*** structures declarations (and typedefs of structures)*****************************************/
 102
 103 /* Widget callback */
 104 typedef cb_ret_t (*widget_cb_fn) (Widget * widget, Widget * sender, widget_msg_t msg, int parm,
 105                                   void *data);
 106 /* Widget mouse callback */
 107 typedef void (*widget_mouse_cb_fn) (Widget * w, mouse_msg_t msg, mouse_event_t * event);
 108
 109 /* Every Widget must have this as its first element */
 110 struct Widget
 111 {
 112     int x, y;
 113     int cols, lines;
 114     widget_pos_flags_t pos_flags;       /* repositioning flags */
 115     widget_options_t options;
 116     widget_state_t state;
 117     unsigned int id;            /* Number of the widget, starting with 0 */
 118     widget_cb_fn callback;
 119     widget_mouse_cb_fn mouse_callback;
 120     WDialog *owner;
 121     /* Mouse-related fields. */
 122     struct
 123     {
 124         /* Public members: */
 125         gboolean forced_capture;        /* Overrides the 'capture' member. Set explicitly by the programmer. */
 126
 127         /* Implementation details: */
 128         gboolean capture;       /* Whether the widget "owns" the mouse. */
 129         mouse_msg_t last_msg;   /* The previous event type processed. */
 130         int last_buttons_down;
 131     } mouse;
 132 };
 133
 134 /* structure for label (caption) with hotkey, if original text does not contain
 135  * hotkey, only start is valid and is equal to original text
 136  * hotkey is defined as char*, but mc support only singlebyte hotkey
 137  */
 138 typedef struct hotkey_t
 139 {
 140     char *start;
 141     char *hotkey;
 142     char *end;
 143 } hotkey_t;
 144
 145 /*** global variables defined in .c file *********************************************************/
 146
 147 /*** declarations of public functions ************************************************************/
 148
 149 /* create hotkey from text */
 150 hotkey_t parse_hotkey (const char *text);
 151 /* release hotkey, free all mebers of hotkey_t */
 152 void release_hotkey (const hotkey_t hotkey);
 153 /* return width on terminal of hotkey */
 154 int hotkey_width (const hotkey_t hotkey);
 155 /* draw hotkey of widget */
 156 void hotkey_draw (Widget * w, const hotkey_t hotkey, gboolean focused);
 157
 158 /* widget initialization */
 159 void widget_init (Widget * w, int y, int x, int lines, int cols,
 160                   widget_cb_fn callback, widget_mouse_cb_fn mouse_callback);
 161 /* Default callback for widgets */
 162 cb_ret_t widget_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm,
 163                                   void *data);
 164 void widget_set_options (Widget * w, widget_options_t options, gboolean enable);
 165 gboolean widget_set_state (Widget * w, widget_state_t state, gboolean enable);
 166 void widget_set_size (Widget * widget, int y, int x, int lines, int cols);
 167 /* select color for widget in dependance of state */
 168 void widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey);
 169 void widget_redraw (Widget * w);
 170 void widget_erase (Widget * w);
 171 gboolean widget_is_active (const void *w);
 172 gboolean widget_overlapped (const Widget * a, const Widget * b);
 173 void widget_replace (Widget * old, Widget * new);
 174
 175 /* get mouse pointer location within widget */
 176 Gpm_Event mouse_get_local (const Gpm_Event * global, const Widget * w);
 177 gboolean mouse_global_in_widget (const Gpm_Event * event, const Widget * w);
 178
 179 /* --------------------------------------------------------------------------------------------- */
 180 /*** inline functions ****************************************************************************/
 181 /* --------------------------------------------------------------------------------------------- */
 182
 183 static inline cb_ret_t
 184 send_message (void *w, void *sender, widget_msg_t msg, int parm, void *data)
 185 {
 186     cb_ret_t ret = MSG_NOT_HANDLED;
 187
 188 #if 1
 189     if (w != NULL)              /* This must be always true, but... */
 190 #endif
 191         ret = WIDGET (w)->callback (WIDGET (w), WIDGET (sender), msg, parm, data);
 192
 193     return ret;
 194 }
 195
 196 /* --------------------------------------------------------------------------------------------- */
 197 /**
 198   * Check whether one or several option flags are set or not.
 199   * @param w widget
 200   * @param options widget option flags
 201   *
 202   * @return TRUE if all requested option flags are set, FALSE otherwise.
 203   */
 204
 205 static inline gboolean
 206 widget_get_options (const Widget * w, widget_options_t options)
 207 {
 208     return ((w->options & options) == options);
 209 }
 210
 211 /* --------------------------------------------------------------------------------------------- */
 212
 213 /**
 214   * Check whether one or several state flags are set or not.
 215   * @param w widget
 216   * @param state widget state flags
 217   *
 218   * @return TRUE if all requested state flags are set, FALSE otherwise.
 219   */
 220
 221 static inline gboolean
 222 widget_get_state (const Widget * w, widget_state_t state)
 223 {
 224     return ((w->state & state) == state);
 225 }
 226
 227 /* --------------------------------------------------------------------------------------------- */
 228
 229 #endif /* MC__WIDGET_INTERNAL_H */