2 /** \file widget-common.h
3 * \brief Header: shared stuff of widgets
6 #ifndef MC__WIDGET_INTERNAL_H
7 #define MC__WIDGET_INTERNAL_H
9 #include "lib/tty/mouse.h"
11 /*** typedefs(not structures) and defined constants **********************************************/
13 #define WIDGET(x) ((Widget *)(x))
15 #define widget_move(w, _y, _x) tty_gotoyx (WIDGET(w)->y + (_y), WIDGET(w)->x + (_x))
16 /* Sets/clear the specified flag in the options field */
17 #define widget_want_cursor(w,i) widget_set_options(w, W_WANT_CURSOR, i)
18 #define widget_want_hotkey(w,i) widget_set_options(w, W_WANT_HOTKEY, i)
19 #define widget_want_idle(w,i) widget_set_options(w, W_WANT_IDLE, i)
20 #define widget_disable(w,i) widget_set_options(w, W_DISABLED, i)
22 /*** enums ***************************************************************************************/
27 MSG_INIT
= 0, /* Initialize widget */
28 MSG_FOCUS
, /* Draw widget in focused state or widget has got focus */
29 MSG_UNFOCUS
, /* Draw widget in unfocused state or widget has been unfocused */
30 MSG_DRAW
, /* Draw widget on screen */
31 MSG_KEY
, /* Sent to widgets on key press */
32 MSG_HOTKEY
, /* Sent to widget to catch preprocess key */
33 MSG_HOTKEY_HANDLED
, /* A widget has got the hotkey */
34 MSG_UNHANDLED_KEY
, /* Key that no widget handled */
35 MSG_POST_KEY
, /* The key has been handled */
36 MSG_ACTION
, /* Send to widget to handle command or
37 * state of check- and radiobuttons has changed
38 * and listbox current entry has changed */
39 MSG_CURSOR
, /* Sent to widget to position the cursor */
40 MSG_IDLE
, /* The idle state is active */
41 MSG_RESIZE
, /* Screen size has changed */
42 MSG_VALIDATE
, /* Dialog is to be closed */
43 MSG_END
, /* Shut down dialog */
44 MSG_DESTROY
/* Sent to widget at destruction time */
47 /* Widgets are expected to answer to the following messages:
48 MSG_FOCUS: MSG_HANDLED if the accept the focus, MSG_NOT_HANDLED if they do not.
49 MSG_UNFOCUS: MSG_HANDLED if they accept to release the focus, MSG_NOT_HANDLED if they don't.
50 MSG_KEY: MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
51 MSG_HOTKEY: MSG_HANDLED if they actually used the key, MSG_NOT_HANDLED if not.
63 W_WANT_HOTKEY
= (1 << 1),
64 W_WANT_CURSOR
= (1 << 2),
65 W_WANT_IDLE
= (1 << 3),
66 W_IS_INPUT
= (1 << 4),
67 W_DISABLED
= (1 << 5) /* Widget cannot be selected */
70 /* Flags for widget repositioning on dialog resize */
73 WPOS_CENTER_HORZ
= (1 << 0), /* center widget in horizontal */
74 WPOS_CENTER_VERT
= (1 << 1), /* center widget in vertical */
75 WPOS_KEEP_LEFT
= (1 << 2), /* keep widget distance to left border of dialog */
76 WPOS_KEEP_RIGHT
= (1 << 3), /* keep widget distance to right border of dialog */
77 WPOS_KEEP_TOP
= (1 << 4), /* keep widget distance to top border of dialog */
78 WPOS_KEEP_BOTTOM
= (1 << 5), /* keep widget distance to bottom border of dialog */
79 WPOS_KEEP_HORZ
= WPOS_KEEP_LEFT
| WPOS_KEEP_RIGHT
,
80 WPOS_KEEP_VERT
= WPOS_KEEP_TOP
| WPOS_KEEP_BOTTOM
,
81 WPOS_KEEP_ALL
= WPOS_KEEP_HORZ
| WPOS_KEEP_VERT
,
82 WPOS_KEEP_DEFAULT
= WPOS_KEEP_LEFT
| WPOS_KEEP_TOP
84 /* NOTE: if WPOS_CENTER_HORZ flag is used, other horizontal flags (WPOS_KEEP_LEFT, WPOS_KEEP_RIGHT,
85 * and WPOS_KEEP_HORZ are ignored).
86 * If WPOS_CENTER_VERT flag is used, other horizontal flags (WPOS_KEEP_TOP, WPOS_KEEP_BOTTOM,
87 * and WPOS_KEEP_VERT are ignored).
90 /*** structures declarations (and typedefs of structures)*****************************************/
93 typedef cb_ret_t (*widget_cb_fn
) (Widget
* widget
, Widget
* sender
, widget_msg_t msg
, int parm
,
96 /* Every Widget must have this as its first element */
101 widget_options_t options
;
102 widget_pos_flags_t pos_flags
; /* repositioning flags */
103 unsigned int id
; /* Number of the widget, starting with 0 */
104 widget_cb_fn callback
;
106 void (*set_options
) (Widget
*w
, widget_options_t options
, gboolean enable
);
107 struct WDialog
*owner
;
110 /* structure for label (caption) with hotkey, if original text does not contain
111 * hotkey, only start is valid and is equal to original text
112 * hotkey is defined as char*, but mc support only singlebyte hotkey
114 typedef struct hotkey_t
121 /*** global variables defined in .c file *********************************************************/
123 /*** declarations of public functions ************************************************************/
125 /* create hotkey from text */
126 hotkey_t
parse_hotkey (const char *text
);
127 /* release hotkey, free all mebers of hotkey_t */
128 void release_hotkey (const hotkey_t hotkey
);
129 /* return width on terminal of hotkey */
130 int hotkey_width (const hotkey_t hotkey
);
131 /* draw hotkey of widget */
132 void hotkey_draw (Widget
*w
, const hotkey_t hotkey
, gboolean focused
);
134 /* widget initialization */
135 void init_widget (Widget
* w
, int y
, int x
, int lines
, int cols
,
136 widget_cb_fn callback
, mouse_h mouse_handler
);
137 /* Default callback for widgets */
138 cb_ret_t
widget_default_callback (Widget
* w
, Widget
* sender
, widget_msg_t msg
, int parm
, void *data
);
139 void widget_default_set_options_callback (Widget
*w
, widget_options_t options
, gboolean enable
);
140 void widget_set_options (Widget
*w
, widget_options_t options
, gboolean enable
);
141 void widget_set_size (Widget
* widget
, int y
, int x
, int lines
, int cols
);
142 /* select color for widget in dependance of state */
143 void widget_selectcolor (Widget
*w
, gboolean focused
, gboolean hotkey
);
144 void widget_erase (Widget
* w
);
146 /* get mouse pointer location within widget */
147 Gpm_Event
mouse_get_local (const Gpm_Event
* global
, const Widget
* w
);
148 gboolean
mouse_global_in_widget (const Gpm_Event
* event
, const Widget
* w
);
150 /*** inline functions ****************************************************************************/
152 static inline cb_ret_t
153 send_message (void *w
, void *sender
, widget_msg_t msg
, int parm
, void *data
)
155 return WIDGET (w
)->callback (WIDGET (w
), WIDGET (sender
), msg
, parm
, data
);
158 #endif /* MC__WIDGET_INTERNAL_H */