rt-thread/components/rtgui/include/rtgui/event.h

/*
 * File      : event.h
 * This file is part of RTGUI in RT-Thread RTOS
 * COPYRIGHT (C) 2006 - 2009, RT-Thread Development Team
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rt-thread.org/license/LICENSE
 *
 * Change Logs:
 * Date           Author       Notes
 * 2009-10-04     Bernard      first version
 */
#ifndef __RTGUI_EVENT_H__
#define __RTGUI_EVENT_H__

#include <rtgui/rtgui.h>
#include <rtgui/kbddef.h>

enum _rtgui_event_type
{
	/* panel event */
	RTGUI_EVENT_PANEL_ATTACH = 0,	/* attach to a panel	*/
	RTGUI_EVENT_PANEL_DETACH,		/* detach from a panel	*/
	RTGUI_EVENT_PANEL_SHOW,			/* show in a panel		*/
	RTGUI_EVENT_PANEL_HIDE,			/* hide from a panel	*/
	RTGUI_EVENT_PANEL_INFO,			/* panel information 	*/
	RTGUI_EVENT_PANEL_RESIZE,		/* resize panel 		*/
	RTGUI_EVENT_PANEL_FULLSCREEN,	/* to full screen 		*/
	RTGUI_EVENT_PANEL_NORMAL,		/* to normal screen 	*/

	/* window event */
	RTGUI_EVENT_WIN_CREATE,			/* create a window 		*/
	RTGUI_EVENT_WIN_DESTROY,		/* destroy a window 	*/
	RTGUI_EVENT_WIN_SHOW,			/* show a window 		*/
	RTGUI_EVENT_WIN_HIDE,			/* hide a window 		*/
	RTGUI_EVENT_WIN_ACTIVATE, 		/* activate a window 	*/
	RTGUI_EVENT_WIN_DEACTIVATE,		/* deactivate a window 	*/
	RTGUI_EVENT_WIN_CLOSE,			/* close a window 		*/
	RTGUI_EVENT_WIN_MOVE,			/* move a window 		*/
	RTGUI_EVENT_WIN_RESIZE, 		/* resize a window 		*/

	/* WM event */
	RTGUI_EVENT_SET_WM,				/* set window manager   */

	RTGUI_EVENT_UPDATE_BEGIN,		/* update a rect 		*/
	RTGUI_EVENT_UPDATE_END,			/* update a rect 		*/
	RTGUI_EVENT_MONITOR_ADD,		/* add a monitor rect 	*/
	RTGUI_EVENT_MONITOR_REMOVE,		/* remove a monitor rect*/
	RTGUI_EVENT_PAINT,				/* paint on screen 		*/
	RTGUI_EVENT_TIMER,				/* timer 				*/

	/* clip rect information */
	RTGUI_EVENT_CLIP_INFO,			/* clip rect info		*/

	/* mouse and keyboard event */
	RTGUI_EVENT_MOUSE_MOTION,		/* mouse motion */
	RTGUI_EVENT_MOUSE_BUTTON,		/* mouse button info 	*/
	RTGUI_EVENT_KBD,				/* keyboard info		*/

	/* user command event */
	RTGUI_EVENT_COMMAND,			/* user command 		*/

	/* widget event */
	RTGUI_EVENT_FOCUSED,			/* widget focused       */
	RTGUI_EVENT_SCROLLED,           /* scroll bar scrolled  */
	RTGUI_EVENT_RESIZE,				/* widget resize 		*/
};
typedef enum _rtgui_event_type rtgui_event_type;

enum {
	RTGUI_STATUS_OK = 0,		/* status ok 		*/
	RTGUI_STATUS_ERROR,			/* generic error 	*/
	RTGUI_STATUS_NRC,			/* no resource 		*/
};

struct rtgui_event
{
	/* the event type */
	rt_uint16_t type;
	/* user field of event */
	rt_uint16_t user;

	/* the event sender */
	rt_thread_t sender;

	/* mailbox to acknowledge request */
	rt_mailbox_t ack;
};
typedef struct rtgui_event rtgui_event_t;
#define RTGUI_EVENT(e)	((struct rtgui_event*)(e))

#define RTGUI_EVENT_INIT(e, t)	do		\
{										\
	(e)->type = (t);					\
	(e)->user = 0;						\
	(e)->sender = rt_thread_self();		\
	(e)->ack = RT_NULL;					\
} while (0)

/*
 * RTGUI Panel Event
 */
struct rtgui_event_panel_attach
{
	struct rtgui_event parent;

	/* the panel name to be attached */
	char panel_name[RTGUI_NAME_MAX];

	/* workbench, wm field */
	rtgui_workbench_t* workbench;
};

struct rtgui_event_panel_detach
{
	struct rtgui_event parent;

	/* the panel which thread belong to */
	rtgui_panel_t* panel;

	/* workbench, wm field */
	rtgui_workbench_t* workbench;
};

struct rtgui_event_panel_show
{
	struct rtgui_event parent;

	/* the panel which thread belong to */
	rtgui_panel_t* panel;

	/* workbench, wm field */
	rtgui_workbench_t* workbench;
};

struct rtgui_event_panel_hide
{
	struct rtgui_event parent;

	/* the panel which thread belong to */
	rtgui_panel_t* panel;

	/* workbench, wm field */
	rtgui_workbench_t* workbench;
};

struct rtgui_event_panel_info
{
	struct rtgui_event parent;

	/* panel info */
	rtgui_panel_t* panel;
	rtgui_rect_t extent;
};

#define RTGUI_EVENT_PANEL_ATTACH_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PANEL_ATTACH)
#define RTGUI_EVENT_PANEL_DETACH_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PANEL_DETACH)
#define RTGUI_EVENT_PANEL_SHOW_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PANEL_SHOW)
#define RTGUI_EVENT_PANEL_HIDE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PANEL_HIDE)
#define RTGUI_EVENT_PANEL_INFO_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PANEL_INFO)

/*
 * RTGUI Window Event
 */
struct rtgui_event_win
{
	struct rtgui_event parent;

	/* the window id */
	rtgui_win_t* wid;
};

struct rtgui_event_win_create
{
	struct rtgui_event parent;

#ifndef RTGUI_USING_SMALL_SIZE
	/* the window title */
	rt_uint8_t title[RTGUI_NAME_MAX];
	/* the window extent */
	struct rtgui_rect extent;
#endif

	/* the window id */
	rtgui_win_t* wid;
};

struct rtgui_event_win_move
{
	struct rtgui_event parent;

	/* the window id */
	rtgui_win_t* wid;

	rt_int16_t x, y;
};

struct rtgui_event_win_resize
{
	struct rtgui_event parent;

	/* the window id */
	rtgui_win_t* wid;

	rtgui_rect_t rect;
};

#define	rtgui_event_win_destroy 	rtgui_event_win
#define	rtgui_event_win_show 		rtgui_event_win
#define	rtgui_event_win_hide 		rtgui_event_win
#define	rtgui_event_win_activate	rtgui_event_win
#define rtgui_event_win_deactivate 	rtgui_event_win
#define rtgui_event_win_close 		rtgui_event_win

/* window event init */
#define RTGUI_EVENT_WIN_CREATE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_CREATE)
#define RTGUI_EVENT_WIN_DESTROY_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_DESTROY)
#define RTGUI_EVENT_WIN_SHOW_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_SHOW)
#define RTGUI_EVENT_WIN_HIDE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_HIDE)
#define RTGUI_EVENT_WIN_ACTIVATE_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_ACTIVATE)
#define RTGUI_EVENT_WIN_DEACTIVATE_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_DEACTIVATE)
#define RTGUI_EVENT_WIN_CLOSE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_CLOSE)
#define RTGUI_EVENT_WIN_MOVE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_MOVE)
#define RTGUI_EVENT_WIN_RESIZE_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_WIN_RESIZE)

/*
 * RTGUI Workbench Manager Event
 */
struct rtgui_event_set_wm
{
	struct rtgui_event parent;

	/* the panel name to be managed */
	char panel_name[RTGUI_NAME_MAX];
};
/* window event init */
#define RTGUI_EVENT_SET_WM_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_SET_WM)

/*
 * RTGUI Other Event
 */
struct rtgui_event_update_begin
{
	struct rtgui_event parent;

	/* the update rect */
	rtgui_rect_t rect;
};

struct rtgui_event_update_end
{
	struct rtgui_event parent;

	/* the update rect */
	rtgui_rect_t rect;
};

struct rtgui_event_monitor
{
	struct rtgui_event parent;

	/* the monitor rect */
	rtgui_rect_t rect;

	/* under panel */
	rtgui_panel_t* panel;

	/* or under window */
	rtgui_win_t* wid;
};

struct rtgui_event_paint
{
	struct rtgui_event parent;

	rtgui_win_t* wid;		/* destination window */
};

struct rtgui_timer;
struct rtgui_event_timer
{
	struct rtgui_event parent;

	struct rtgui_timer *timer;
};

struct rtgui_event_clip_info
{
	struct rtgui_event parent;

	/* destination window */
	rtgui_win_t* wid;

	/* the number of rects */
	rt_uint32_t num_rect;

	/* rtgui_rect_t *rects */
};
#define RTGUI_EVENT_GET_RECT(e, i)			&(((rtgui_rect_t*)(e + 1))[i])

#define RTGUI_EVENT_UPDATE_BEGIN_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_UPDATE_BEGIN)
#define RTGUI_EVENT_UPDATE_END_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_UPDATE_END)
#define RTGUI_EVENT_MONITOR_ADD_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_MONITOR_ADD)
#define RTGUI_EVENT_MONITOR_REMOVE_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_MONITOR_REMOVE)
#define RTGUI_EVENT_CLIP_INFO_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_CLIP_INFO)
#define RTGUI_EVENT_PAINT_INIT(e)			RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_PAINT)
#define RTGUI_EVENT_TIMER_INIT(e)			RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_TIMER)

/*
 * RTGUI Mouse and Keyboard Event
 */
struct rtgui_event_mouse
{
	struct rtgui_event parent;

	rtgui_win_t* wid;		/* destination window */

	rt_uint16_t x, y;
	rt_uint16_t button;
};
#define RTGUI_MOUSE_BUTTON_LEFT			0x01
#define RTGUI_MOUSE_BUTTON_RIGHT		0x02
#define RTGUI_MOUSE_BUTTON_MIDDLE		0x03
#define RTGUI_MOUSE_BUTTON_WHEELUP		0x04
#define RTGUI_MOUSE_BUTTON_WHEELDOWN	0x08

#define RTGUI_MOUSE_BUTTON_DOWN			0x10
#define RTGUI_MOUSE_BUTTON_UP			0x20

struct rtgui_event_kbd
{
	struct rtgui_event parent;

	rtgui_win_t* wid;		/* destination window */

	rt_uint16_t type;		/* key down or up */
	rt_uint16_t key;		/* current key */
	rt_uint16_t mod;		/* current key modifiers */
	rt_uint16_t unicode;	/* translated character */
};
#define RTGUI_KBD_IS_SET_CTRL(e)	((e)->mod & (RTGUI_KMOD_LCTRL | RTGUI_KMOD_RCTRL)))
#define RTGUI_KBD_IS_SET_ALT(e)		((e)->mod & (RTGUI_KMOD_LALT  | RTGUI_KMOD_RALT))
#define RTGUI_KBD_IS_SET_SHIFT(e)	((e)->mod & (RTGUI_KMOD_LSHIFT| RTGUI_KMOD_RSHIFT))
#define RTGUI_KBD_IS_UP(e)			((e)->type == RTGUI_KEYUP)
#define RTGUI_KBD_IS_DOWN(e)		((e)->type == RTGUI_KEYDOWN)

#define RTGUI_EVENT_MOUSE_MOTION_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_MOUSE_MOTION)
#define RTGUI_EVENT_MOUSE_BUTTON_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_MOUSE_BUTTON)
#define RTGUI_EVENT_KBD_INIT(e)				RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_KBD)

struct rtgui_event_command
{
	struct rtgui_event parent;

	/* command type */
	rt_int32_t type;

	/* command id */
	rt_int32_t command_id;

	/* command string */
	char command_string[RTGUI_NAME_MAX];
};
#define RTGUI_EVENT_COMMAND_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_COMMAND)

#define RTGUI_CMD_UNKNOWN		0x00
#define RTGUI_CMD_WM_CLOSE		0x10

#define RTGUI_CMD_USER_INT		0x20
#define RTGUI_CMD_USER_STRING	0x21

/************************************************************************/
/* Widget Event                                                         */
/************************************************************************/
#define RTGUI_WIDGET_EVENT_INIT(e, t)	do		\
{										\
	(e)->type = (t);					\
	(e)->sender = RT_NULL;				\
	(e)->ack = RT_NULL;					\
} while (0)

/*
 * RTGUI Scrollbar Event
 */
struct rtgui_event_scrollbar
{
    struct rtgui_event parent;

    rt_uint8_t event;
};
#define RTGUI_SCROLL_LINEUP             0x01
#define RTGUI_SCROLL_LINEDOWN           0x02
#define RTGUI_SCROLL_PAGEUP             0x03
#define RTGUI_SCROLL_PAGEDOWN           0x04
#define RTGUI_EVENT_SCROLLED_INIT(e)	RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_SCROLLED)

/*
 * RTGUI Widget Focused Event
 */
struct rtgui_event_focused
{
    struct rtgui_event parent;

	struct rtgui_widget* widget;
};
#define RTGUI_EVENT_FOCUSED_INIT(e)		RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_FOCUSED)

/*
 * RTGUI Widget Resize Event
 */
struct rtgui_event_resize
{
	struct rtgui_event parent;
	rt_int16_t x, y;
	rt_int16_t w, h;
};
#define RTGUI_EVENT_RESIZE_INIT(e) RTGUI_EVENT_INIT(&((e)->parent), RTGUI_EVENT_RESIZE)

#endif