124 lines
3.6 KiB
C
124 lines
3.6 KiB
C
/*
|
|
* File : rtgui_app.h
|
|
* This file is part of RT-Thread GUI Engine
|
|
* COPYRIGHT (C) 2006 - 2017, RT-Thread Development Team
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Change Logs:
|
|
* Date Author Notes
|
|
* 2012-01-13 Grissiom first version
|
|
*/
|
|
|
|
#ifndef __RTGUI_APP_H__
|
|
#define __RTGUI_APP_H__
|
|
|
|
#include <rtthread.h>
|
|
#include <rtgui/rtgui.h>
|
|
#include <rtgui/event.h>
|
|
#include <rtgui/rtgui_system.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
DECLARE_CLASS_TYPE(application);
|
|
|
|
/** Gets the type of a application */
|
|
#define RTGUI_APP_TYPE (RTGUI_TYPE(application))
|
|
/** Casts the object to an rtgui_workbench */
|
|
#define RTGUI_APP(obj) (RTGUI_OBJECT_CAST((obj), RTGUI_APP_TYPE, struct rtgui_app))
|
|
/** Checks if the object is an rtgui_workbench */
|
|
#define RTGUI_IS_APP(obj) (RTGUI_OBJECT_CHECK_TYPE((obj), RTGUI_APP_TYPE))
|
|
|
|
enum rtgui_app_flag
|
|
{
|
|
RTGUI_APP_FLAG_EXITED = 0x04,
|
|
RTGUI_APP_FLAG_SHOWN = 0x08,
|
|
RTGUI_APP_FLAG_KEEP = 0x80,
|
|
};
|
|
|
|
typedef void (*rtgui_idle_func_t)(struct rtgui_object *obj, struct rtgui_event *event);
|
|
|
|
struct rtgui_app
|
|
{
|
|
struct rtgui_object parent;
|
|
|
|
/* application name */
|
|
unsigned char *name;
|
|
struct rtgui_image *icon;
|
|
|
|
enum rtgui_app_flag state_flag;
|
|
|
|
rt_uint16_t ref_count;
|
|
rt_uint16_t exit_code;
|
|
|
|
/* the thread id */
|
|
rt_thread_t tid;
|
|
/* the message queue of thread */
|
|
rt_mq_t mq;
|
|
/* event buffer */
|
|
rt_uint8_t event_buffer[sizeof(union rtgui_event_generic)];
|
|
|
|
/* if not RT_NULL, the main_object is the one will be activated when the
|
|
* app recieves activate event. By default, it is the first window shown in
|
|
* the app. */
|
|
struct rtgui_object *main_object;
|
|
|
|
/* on idle event handler */
|
|
rtgui_idle_func_t on_idle;
|
|
|
|
unsigned int window_cnt;
|
|
|
|
void *user_data;
|
|
};
|
|
|
|
/**
|
|
* create an application named @myname on current thread.
|
|
*
|
|
* @param name the name of the application
|
|
*
|
|
* @return a pointer to struct rtgui_app on success. RT_NULL on failure.
|
|
*/
|
|
struct rtgui_app *rtgui_app_create(const char *name);
|
|
void rtgui_app_destroy(struct rtgui_app *app);
|
|
rt_bool_t rtgui_app_event_handler(struct rtgui_object *obj, rtgui_event_t *event);
|
|
|
|
rt_base_t rtgui_app_run(struct rtgui_app *app);
|
|
void rtgui_app_exit(struct rtgui_app *app, rt_uint16_t code);
|
|
void rtgui_app_activate(struct rtgui_app *app);
|
|
void rtgui_app_close(struct rtgui_app *app);
|
|
void rtgui_app_sleep(struct rtgui_app *app, int millisecond);
|
|
|
|
void rtgui_app_set_onidle(struct rtgui_app *app, rtgui_idle_func_t onidle);
|
|
rtgui_idle_func_t rtgui_app_get_onidle(struct rtgui_app *app);
|
|
|
|
/**
|
|
* return the rtgui_app struct on current thread
|
|
*/
|
|
struct rtgui_app *rtgui_app_self(void);
|
|
|
|
rt_err_t rtgui_app_set_as_wm(struct rtgui_app *app);
|
|
|
|
void rtgui_app_set_main_win(struct rtgui_app *app, struct rtgui_win *win);
|
|
struct rtgui_win* rtgui_app_get_main_win(struct rtgui_app *app);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* end of include guard: __RTGUI_APP_H__ */
|
|
|