mirror of https://github.com/MidnightCommander/mc
136 lines
5.0 KiB
C
136 lines
5.0 KiB
C
|
|
/** \file widget-common.h
|
|
* \brief Header: shared stuff of widgets
|
|
*/
|
|
|
|
#ifndef MC__WIDGET_INTERNAL_H
|
|
#define MC__WIDGET_INTERNAL_H
|
|
|
|
#include "lib/tty/mouse.h" /* mouse_h */
|
|
|
|
/*** typedefs(not structures) and defined constants **********************************************/
|
|
|
|
#define widget_move(w, _y, _x) tty_gotoyx (((Widget *)(w))->y + _y, ((Widget *)(w))->x + _x)
|
|
/* Sets/clear the specified flag in the options field */
|
|
#define widget_option(w,f,i) \
|
|
w.options = ((i) ? ((w).options | (f)) : ((w).options & (~(f))))
|
|
#define widget_want_cursor(w,i) widget_option((w), W_WANT_CURSOR, (i))
|
|
#define widget_want_hotkey(w,i) widget_option((w), W_WANT_HOTKEY, (i))
|
|
#define widget_disable(w,i) widget_option((w), W_DISABLED, (i))
|
|
|
|
/*** enums ***************************************************************************************/
|
|
|
|
/* Widget messages */
|
|
typedef enum
|
|
{
|
|
WIDGET_INIT, /* Initialize widget */
|
|
WIDGET_FOCUS, /* Draw widget in focused state */
|
|
WIDGET_UNFOCUS, /* Draw widget in unfocused state */
|
|
WIDGET_DRAW, /* Sent to widget to draw themselves */
|
|
WIDGET_KEY, /* Sent to widgets on key press */
|
|
WIDGET_HOTKEY, /* Sent to widget to catch preprocess key */
|
|
WIDGET_COMMAND, /* Send to widget to handle command */
|
|
WIDGET_DESTROY, /* Sent to widget at destruction time */
|
|
WIDGET_CURSOR, /* Sent to widget to position the cursor */
|
|
WIDGET_IDLE, /* Sent to widgets with options & W_WANT_IDLE */
|
|
WIDGET_RESIZED /* Sent after a widget has been resized */
|
|
} widget_msg_t;
|
|
|
|
/* Widgets are expected to answer to the following messages:
|
|
|
|
WIDGET_FOCUS: 1 if the accept the focus, 0 if they do not.
|
|
WIDGET_UNFOCUS: 1 if they accept to release the focus, 0 if they don't.
|
|
WIDGET_KEY: 1 if they actually used the key, 0 if not.
|
|
WIDGET_HOTKEY: 1 if they actually used the key, 0 if not.
|
|
*/
|
|
|
|
typedef enum
|
|
{
|
|
MSG_NOT_HANDLED = 0,
|
|
MSG_HANDLED = 1
|
|
} cb_ret_t;
|
|
|
|
/* Widget options */
|
|
typedef enum
|
|
{
|
|
W_WANT_HOTKEY = (1 << 1),
|
|
W_WANT_CURSOR = (1 << 2),
|
|
W_WANT_IDLE = (1 << 3),
|
|
W_IS_INPUT = (1 << 4),
|
|
W_DISABLED = (1 << 5) /* Widget cannot be selected */
|
|
} widget_options_t;
|
|
|
|
/* Flags for widget repositioning on dialog resize */
|
|
typedef enum
|
|
{
|
|
WPOS_KEEP_LEFT = (1 << 0), /* keep widget distance to left border of dialog */
|
|
WPOS_KEEP_RIGHT = (1 << 1), /* keep widget distance to right border of dialog */
|
|
WPOS_KEEP_TOP = (1 << 2), /* keep widget distance to top border of dialog */
|
|
WPOS_KEEP_BOTTOM = (1 << 3), /* keep widget distance to bottom border of dialog */
|
|
WPOS_KEEP_HORZ = WPOS_KEEP_LEFT | WPOS_KEEP_RIGHT,
|
|
WPOS_KEEP_VERT = WPOS_KEEP_TOP | WPOS_KEEP_BOTTOM,
|
|
WPOS_KEEP_ALL = WPOS_KEEP_HORZ | WPOS_KEEP_VERT
|
|
} widget_pos_flags_t;
|
|
|
|
/*** structures declarations (and typedefs of structures)*****************************************/
|
|
|
|
/* Widget callback */
|
|
typedef cb_ret_t (*callback_fn) (struct Widget * widget, widget_msg_t msg, int parm);
|
|
|
|
/* Every Widget must have this as its first element */
|
|
struct Widget
|
|
{
|
|
int x, y;
|
|
int cols, lines;
|
|
widget_options_t options;
|
|
widget_pos_flags_t pos_flags; /* repositioning flags */
|
|
unsigned int id; /* Number of the widget, starting with 0 */
|
|
callback_fn callback;
|
|
mouse_h mouse;
|
|
struct Dlg_head *owner;
|
|
};
|
|
|
|
/* structure for label (caption) with hotkey, if original text does not contain
|
|
* hotkey, only start is valid and is equal to original text
|
|
* hotkey is defined as char*, but mc support only singlebyte hotkey
|
|
*/
|
|
typedef struct hotkey_t
|
|
{
|
|
char *start;
|
|
char *hotkey;
|
|
char *end;
|
|
} hotkey_t;
|
|
|
|
/*** global variables defined in .c file *********************************************************/
|
|
|
|
/*** declarations of public functions ************************************************************/
|
|
|
|
/* create hotkey from text */
|
|
hotkey_t parse_hotkey (const char *text);
|
|
/* release hotkey, free all mebers of hotkey_t */
|
|
void release_hotkey (const hotkey_t hotkey);
|
|
/* return width on terminal of hotkey */
|
|
int hotkey_width (const hotkey_t hotkey);
|
|
/* draw hotkey of widget */
|
|
void hotkey_draw (struct Widget *w, const hotkey_t hotkey, gboolean focused);
|
|
|
|
/* widget initialization */
|
|
void init_widget (Widget * w, int y, int x, int lines, int cols,
|
|
callback_fn callback, mouse_h mouse_handler);
|
|
/* Default callback for widgets */
|
|
cb_ret_t default_proc (widget_msg_t msg, int parm);
|
|
void widget_set_size (Widget * widget, int y, int x, int lines, int cols);
|
|
/* select color for widget in dependance of state */
|
|
void widget_selectcolor (struct Widget *w, gboolean focused, gboolean hotkey);
|
|
void widget_erase (Widget * w);
|
|
|
|
/*** inline functions ****************************************************************************/
|
|
|
|
static inline cb_ret_t
|
|
send_message (Widget * w, widget_msg_t msg, int parm)
|
|
{
|
|
return w->callback (w, msg, parm);
|
|
}
|
|
|
|
#endif /* MC__WIDGET_INTERNAL_H */
|