root/lib/widget/widget-common.h

/* [previous][next][first][last][top][bottom][index][help]  */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. send_message
  2. widget_get_options
  3. widget_get_state
  4. widget_find
  5. widget_find_by_type
  6. widget_find_by_id
  7. widget_set_state
  8. widget_get_colors
  9. widget_update_cursor
  10. widget_set_size_rect
  11. widget_show
  12. widget_hide

   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/keybind.h"        /* global_keymap_t */
  10 #include "lib/tty/mouse.h"
  11 #include "lib/widget/mouse.h"   /* mouse_msg_t, mouse_event_t */
  12 
  13 /*** typedefs(not structures) and defined constants **********************************************/
  14 
  15 #define WIDGET(x) ((Widget *)(x))
  16 #define CONST_WIDGET(x) ((const Widget *)(x))
  17 
  18 #define widget_gotoyx(w, _y, _x) tty_gotoyx (CONST_WIDGET(w)->y + (_y), CONST_WIDGET(w)->x + (_x))
  19 /* Sets/clear the specified flag in the options field */
  20 #define widget_want_cursor(w,i) widget_set_options(w, WOP_WANT_CURSOR, i)
  21 #define widget_want_hotkey(w,i) widget_set_options(w, WOP_WANT_HOTKEY, i)
  22 #define widget_want_tab(w,i) widget_set_options(w, WOP_WANT_TAB, i)
  23 #define widget_idle(w,i) widget_set_state(w, WST_IDLE, i)
  24 #define widget_disable(w,i) widget_set_state(w, WST_DISABLED, i)
  25 
  26 /*** enums ***************************************************************************************/
  27 
  28 /* Widget messages */
  29 typedef enum
  30 {
  31     MSG_INIT = 0,               /* Initialize widget */
  32     MSG_FOCUS,                  /* Draw widget in focused state or widget has got focus */
  33     MSG_UNFOCUS,                /* Draw widget in unfocused state or widget has been unfocused */
  34     MSG_CHANGED_FOCUS,          /* Notification to owner about focus state change */
  35     MSG_ENABLE,                 /* Change state to enabled */
  36     MSG_DISABLE,                /* Change state to disabled */
  37     MSG_DRAW,                   /* Draw widget on screen */
  38     MSG_KEY,                    /* Sent to widgets on key press */
  39     MSG_HOTKEY,                 /* Sent to widget to catch preprocess key */
  40     MSG_HOTKEY_HANDLED,         /* A widget has got the hotkey */
  41     MSG_UNHANDLED_KEY,          /* Key that no widget handled */
  42     MSG_POST_KEY,               /* The key has been handled */
  43     MSG_ACTION,                 /* Send to widget to handle command */
  44     MSG_NOTIFY,                 /* Typically sent to dialog to inform it of state-change
  45                                  * of listboxes, check- and radiobuttons. */
  46     MSG_CURSOR,                 /* Sent to widget to position the cursor */
  47     MSG_IDLE,                   /* The idle state is active */
  48     MSG_RESIZE,                 /* Screen size has changed */
  49     MSG_VALIDATE,               /* Dialog is to be closed */
  50     MSG_END,                    /* Shut down dialog */
  51     MSG_DESTROY                 /* Sent to widget at destruction time */
  52 } widget_msg_t;
  53 
  54 /* Widgets are expected to answer to the following messages:
  55    MSG_FOCUS:   MSG_HANDLED if the accept the focus, MSG_NOT_HANDLED if they do not.
  56    MSG_UNFOCUS: MSG_HANDLED if they accept to release the focus, MSG_NOT_HANDLED if they don't.
  57    MSG_KEY:     MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  58    MSG_HOTKEY:  MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
  59  */
  60 
  61 typedef enum
  62 {
  63     MSG_NOT_HANDLED = 0,
  64     MSG_HANDLED = 1
  65 } cb_ret_t;
  66 
  67 /* Widget options */
  68 typedef enum
  69 {
  70     WOP_DEFAULT = (0 << 0),
  71     WOP_WANT_HOTKEY = (1 << 0),
  72     WOP_WANT_CURSOR = (1 << 1),
  73     WOP_WANT_TAB = (1 << 2),    /* Should the tab key be sent to the dialog? */
  74     WOP_IS_INPUT = (1 << 3),
  75     WOP_SELECTABLE = (1 << 4),
  76     WOP_TOP_SELECT = (1 << 5)
  77 } widget_options_t;
  78 
  79 /* Widget state */
  80 typedef enum
  81 {
  82     WST_DEFAULT = (0 << 0),
  83     WST_VISIBLE = (1 << 0),     /* Widget is visible */
  84     WST_DISABLED = (1 << 1),    /* Widget cannot be selected */
  85     WST_IDLE = (1 << 2),
  86     WST_MODAL = (1 << 3),       /* Widget (dialog) is modal */
  87     WST_FOCUSED = (1 << 4),
  88 
  89     WST_CONSTRUCT = (1 << 15),  /* Widget has been constructed but not run yet */
  90     WST_ACTIVE = (1 << 16),     /* Dialog is visible and active */
  91     WST_SUSPENDED = (1 << 17),  /* Dialog is suspended */
  92     WST_CLOSED = (1 << 18)      /* Dialog is closed */
  93 } widget_state_t;
  94 
  95 /* Flags for widget repositioning on dialog resize */
  96 typedef enum
  97 {
  98     WPOS_FULLSCREEN = (1 << 0), /* widget occupies the whole screen */
  99     WPOS_CENTER_HORZ = (1 << 1),        /* center widget in horizontal */
 100     WPOS_CENTER_VERT = (1 << 2),        /* center widget in vertical */
 101     WPOS_CENTER = WPOS_CENTER_HORZ | WPOS_CENTER_VERT,  /* center widget */
 102     WPOS_TRYUP = (1 << 3),      /* try to move two lines up the widget */
 103     WPOS_KEEP_LEFT = (1 << 4),  /* keep widget distance to left border of dialog */
 104     WPOS_KEEP_RIGHT = (1 << 5), /* keep widget distance to right border of dialog */
 105     WPOS_KEEP_TOP = (1 << 6),   /* keep widget distance to top border of dialog */
 106     WPOS_KEEP_BOTTOM = (1 << 7),        /* keep widget distance to bottom border of dialog */
 107     WPOS_KEEP_HORZ = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
 108     WPOS_KEEP_VERT = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
 109     WPOS_KEEP_ALL = WPOS_KEEP_HORZ | WPOS_KEEP_VERT,
 110     WPOS_KEEP_DEFAULT = WPOS_KEEP_LEFT | WPOS_KEEP_TOP
 111 } widget_pos_flags_t;
 112 /* NOTES:
 113  * If WPOS_FULLSCREEN is set then all other position flags are ignored.
 114  * If WPOS_CENTER_HORZ flag is used, other horizontal flags (WPOS_KEEP_LEFT, WPOS_KEEP_RIGHT,
 115  * and WPOS_KEEP_HORZ) are ignored.
 116  * If WPOS_CENTER_VERT flag is used, other horizontal flags (WPOS_KEEP_TOP, WPOS_KEEP_BOTTOM,
 117  * and WPOS_KEEP_VERT) are ignored.
 118  */
 119 
 120 /*** structures declarations (and typedefs of structures)*****************************************/
 121 
 122 /* Widget callback */
 123 typedef cb_ret_t (*widget_cb_fn) (Widget * widget, Widget * sender, widget_msg_t msg, int parm,
 124                                   void *data);
 125 /* Widget mouse callback */
 126 typedef void (*widget_mouse_cb_fn) (Widget * w, mouse_msg_t msg, mouse_event_t * event);
 127 /* translate mouse event and process it */
 128 typedef int (*widget_mouse_handle_fn) (Widget * w, Gpm_Event * event);
 129 
 130 /* Every Widget must have this as its first element */
 131 struct Widget
 132 {
 133     int x, y;
 134     int cols, lines;
 135     widget_pos_flags_t pos_flags;       /* repositioning flags */
 136     widget_options_t options;
 137     widget_state_t state;
 138     unsigned long id;           /* uniq widget ID */
 139     widget_cb_fn callback;
 140     widget_mouse_cb_fn mouse_callback;
 141     WGroup *owner;
 142 
 143     /* Key-related fields */
 144     const global_keymap_t *keymap;      /* main keymap */
 145     const global_keymap_t *ext_keymap;  /* extended keymap */
 146     gboolean ext_mode;          /* use keymap or ext_keymap */
 147 
 148     /* Mouse-related fields. */
 149     widget_mouse_handle_fn mouse_handler;
 150     struct
 151     {
 152         /* Public members: */
 153         gboolean forced_capture;        /* Overrides the 'capture' member. Set explicitly by the programmer. */
 154 
 155         /* Implementation details: */
 156         gboolean capture;       /* Whether the widget "owns" the mouse. */
 157         mouse_msg_t last_msg;   /* The previous event type processed. */
 158         int last_buttons_down;
 159     } mouse;
 160 
 161     GList *(*find) (const Widget * w, const Widget * what);
 162     Widget *(*find_by_type) (const Widget * w, widget_cb_fn cb);
 163     Widget *(*find_by_id) (const Widget * w, unsigned long id);
 164 
 165     /* *INDENT-OFF* */
 166     cb_ret_t (*set_state) (Widget * w, widget_state_t state, gboolean enable);
 167     /* *INDENT-ON* */
 168 
 169     const int *(*get_colors) (const Widget * w);
 170 };
 171 
 172 /* structure for label (caption) with hotkey, if original text does not contain
 173  * hotkey, only start is valid and is equal to original text
 174  * hotkey is defined as char*, but mc support only singlebyte hotkey
 175  */
 176 typedef struct hotkey_t
 177 {
 178     char *start;                /* never NULL */
 179     char *hotkey;               /* can be NULL */
 180     char *end;                  /* can be NULL */
 181 } hotkey_t;
 182 
 183 /*** global variables defined in .c file *********************************************************/
 184 
 185 /*** declarations of public functions ************************************************************/
 186 
 187 /* create hotkey from text */
 188 hotkey_t hotkey_new (const char *text);
 189 /* release hotkey, free all mebers of hotkey_t */
 190 void hotkey_free (const hotkey_t hotkey);
 191 /* return width on terminal of hotkey */
 192 int hotkey_width (const hotkey_t hotkey);
 193 /* compare two hotkeys */
 194 gboolean hotkey_equal (const hotkey_t hotkey1, const hotkey_t hotkey2);
 195 /* draw hotkey of widget */
 196 void hotkey_draw (Widget * w, const hotkey_t hotkey, gboolean focused);
 197 /* get text of hotkey */
 198 char *hotkey_get_text (const hotkey_t hotkey);
 199 
 200 /* widget initialization */
 201 void widget_init (Widget * w, int y, int x, int lines, int cols,
 202                   widget_cb_fn callback, widget_mouse_cb_fn mouse_callback);
 203 void widget_destroy (Widget * w);
 204 /* Default callback for widgets */
 205 cb_ret_t widget_default_callback (Widget * w, Widget * sender, widget_msg_t msg, int parm,
 206                                   void *data);
 207 void widget_set_options (Widget * w, widget_options_t options, gboolean enable);
 208 void widget_adjust_position (widget_pos_flags_t pos_flags, int *y, int *x, int *lines, int *cols);
 209 void widget_set_size (Widget * w, int y, int x, int lines, int cols);
 210 /* select color for widget in dependance of state */
 211 void widget_selectcolor (Widget * w, gboolean focused, gboolean hotkey);
 212 cb_ret_t widget_draw (Widget * w);
 213 void widget_erase (Widget * w);
 214 void widget_set_visibility (Widget * w, gboolean make_visible);
 215 gboolean widget_is_active (const void *w);
 216 gboolean widget_overlapped (const Widget * a, const Widget * b);
 217 void widget_replace (Widget * old, Widget * new);
 218 gboolean widget_is_focusable (const Widget * w);
 219 void widget_select (Widget * w);
 220 void widget_set_bottom (Widget * w);
 221 
 222 long widget_lookup_key (Widget * w, int key);
 223 
 224 GList *widget_default_find (const Widget * w, const Widget * what);
 225 Widget *widget_default_find_by_type (const Widget * w, widget_cb_fn cb);
 226 Widget *widget_default_find_by_id (const Widget * w, unsigned long id);
 227 
 228 cb_ret_t widget_default_set_state (Widget * w, widget_state_t state, gboolean enable);
 229 
 230 /* get mouse pointer location within widget */
 231 Gpm_Event mouse_get_local (const Gpm_Event * global, const Widget * w);
 232 gboolean mouse_global_in_widget (const Gpm_Event * event, const Widget * w);
 233 
 234 /* --------------------------------------------------------------------------------------------- */
 235 /*** inline functions ****************************************************************************/
 236 /* --------------------------------------------------------------------------------------------- */
 237 
 238 static inline cb_ret_t
 239 send_message (void *w, void *sender, widget_msg_t msg, int parm, void *data)
     /* [previous][next][first][last][top][bottom][index][help]  */
 240 {
 241     cb_ret_t ret = MSG_NOT_HANDLED;
 242 
 243 #if 1
 244     if (w != NULL)              /* This must be always true, but... */
 245 #endif
 246         ret = WIDGET (w)->callback (WIDGET (w), WIDGET (sender), msg, parm, data);
 247 
 248     return ret;
 249 }
 250 
 251 /* --------------------------------------------------------------------------------------------- */
 252 /**
 253   * Check whether one or several option flags are set or not.
 254   * @param w widget
 255   * @param options widget option flags
 256   *
 257   * @return TRUE if all requested option flags are set, FALSE otherwise.
 258   */
 259 
 260 static inline gboolean
 261 widget_get_options (const Widget * w, widget_options_t options)
     /* [previous][next][first][last][top][bottom][index][help]  */
 262 {
 263     return ((w->options & options) == options);
 264 }
 265 
 266 /* --------------------------------------------------------------------------------------------- */
 267 
 268 /**
 269   * Check whether one or several state flags are set or not.
 270   * @param w widget
 271   * @param state widget state flags
 272   *
 273   * @return TRUE if all requested state flags are set, FALSE otherwise.
 274   */
 275 
 276 static inline gboolean
 277 widget_get_state (const Widget * w, widget_state_t state)
     /* [previous][next][first][last][top][bottom][index][help]  */
 278 {
 279     return ((w->state & state) == state);
 280 }
 281 
 282 /* --------------------------------------------------------------------------------------------- */
 283 
 284 /**
 285  * Find widget.
 286  *
 287  * @param w widget
 288  * @param what widget to find
 289  *
 290  * @return result of @w->find()
 291  */
 292 
 293 static inline GList *
 294 widget_find (const Widget * w, const Widget * what)
     /* [previous][next][first][last][top][bottom][index][help]  */
 295 {
 296     return w->find (w, what);
 297 }
 298 
 299 /* --------------------------------------------------------------------------------------------- */
 300 
 301 /**
 302  * Find widget by widget type using widget callback.
 303  *
 304  * @param w widget
 305  * @param cb widget callback
 306  *
 307  * @return result of @w->find_by_type()
 308  */
 309 
 310 static inline Widget *
 311 widget_find_by_type (const Widget * w, widget_cb_fn cb)
     /* [previous][next][first][last][top][bottom][index][help]  */
 312 {
 313     return w->find_by_type (w, cb);
 314 }
 315 
 316 /* --------------------------------------------------------------------------------------------- */
 317 /**
 318  * Find widget by widget ID.
 319  *
 320  * @param w widget
 321  * @param id widget ID
 322  *
 323  * @return result of @w->find_by_id()
 324  */
 325 
 326 static inline Widget *
 327 widget_find_by_id (const Widget * w, unsigned long id)
     /* [previous][next][first][last][top][bottom][index][help]  */
 328 {
 329     return w->find_by_id (w, id);
 330 }
 331 
 332 /* --------------------------------------------------------------------------------------------- */
 333 /**
 334  * Modify state of widget.
 335  *
 336  * @param w      widget
 337  * @param state  widget state flag to modify
 338  * @param enable specifies whether to turn the flag on (TRUE) or off (FALSE).
 339  *               Only one flag per call can be modified.
 340  * @return       MSG_HANDLED if set was handled successfully, MSG_NOT_HANDLED otherwise.
 341  */
 342 
 343 static inline cb_ret_t
 344 widget_set_state (Widget * w, widget_state_t state, gboolean enable)
     /* [previous][next][first][last][top][bottom][index][help]  */
 345 {
 346     return w->set_state (w, state, enable);
 347 }
 348 
 349 /* --------------------------------------------------------------------------------------------- */
 350 
 351 /**
 352  * Get color colors of widget.
 353  *
 354  * @param w widget
 355  * @return  color colors
 356  */
 357 static inline const int *
 358 widget_get_colors (const Widget * w)
     /* [previous][next][first][last][top][bottom][index][help]  */
 359 {
 360     return w->get_colors (w);
 361 }
 362 
 363 /* --------------------------------------------------------------------------------------------- */
 364 /**
 365  * Update cursor position in the specified widget.
 366  *
 367  * @param w widget
 368  *
 369  * @return TRUE if cursor was updated successfully, FALSE otherwise
 370  */
 371 
 372 static inline gboolean
 373 widget_update_cursor (Widget * w)
     /* [previous][next][first][last][top][bottom][index][help]  */
 374 {
 375     return (send_message (w, NULL, MSG_CURSOR, 0, NULL) == MSG_HANDLED);
 376 }
 377 
 378 /* --------------------------------------------------------------------------------------------- */
 379 
 380 static inline void
 381 widget_set_size_rect (Widget * w, const WRect * r)
     /* [previous][next][first][last][top][bottom][index][help]  */
 382 {
 383     widget_set_size (w, r->y, r->x, r->lines, r->cols);
 384 }
 385 
 386 /* --------------------------------------------------------------------------------------------- */
 387 
 388 static inline void
 389 widget_show (Widget * w)
     /* [previous][next][first][last][top][bottom][index][help]  */
 390 {
 391     widget_set_visibility (w, TRUE);
 392 }
 393 
 394 /* --------------------------------------------------------------------------------------------- */
 395 
 396 static inline void
 397 widget_hide (Widget * w)
     /* [previous][next][first][last][top][bottom][index][help]  */
 398 {
 399     widget_set_visibility (w, FALSE);
 400 }
 401 
 402 /* --------------------------------------------------------------------------------------------- */
 403 
 404 #endif /* MC__WIDGET_INTERNAL_H */

/* [previous][next][first][last][top][bottom][index][help]  */