1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*
* Copyright (c) 2011 - 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef __TIZEN_APPFW_APP_INTERNAL_H__
#define __TIZEN_APPFW_APP_INTERNAL_H__
#include <app.h>
/* GNU gettext macro is already defined at appcore-common.h */
#ifdef _
#undef _
#endif
#ifdef __cplusplus
extern "C" {
#endif
typedef void *appcore_context_h;
/**
* @internal
* @brief Called when the system memory is running low.
*
* @details When a low memory event is dispatched, the application should immediately save state and release resources to save as much memory as possible. \n
* If enough memory is not reclaimed during low memory conditions, the system will terminate some of the applications to reclaim the memory.
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_low_memory_cb) (void *user_data);
/**
* @internal
* @brief Called when the battery power is running low.
* @details When the battery level falls below 5%, it is called.
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_low_battery_cb) (void *user_data);
/**
* @internal
* @brief Called when the orientation of the device changes.
*
* @since_tizen 2.3
* @param[in] orientation The orientation of the device
* @param[in] user_data The user data passed from the callback registration function
* @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_device_orientation_cb) (app_device_orientation_e orientation, void *user_data);
/**
* @internal
* @brief Called when language setting changes.
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_language_changed_cb) (void *user_data);
/**
* @internal
* @brief Called when region format setting changes.
*
* @since_tizen 2.3
* @param[in] user_data The user data passed from the callback registration function
* @see app_main()
* @see #app_event_callback_s
*/
typedef void (*app_region_format_changed_cb) (void *user_data);
/**
* @internal
* @brief The structure type containing the set of callback functions for handling application events.
* @details It is one of the input parameters of the app_main() function.
*
* @since_tizen 2.3
* @see app_main()
* @see app_create_cb()
* @see app_pause_cb()
* @see app_resume_cb()
* @see app_terminate_cb()
* @see app_control_cb()
* @see app_low_memory_cb()
* @see app_low_battery_cb()
* @see app_device_orientation_cb()
* @see app_language_changed_cb()
* @see app_region_format_changed_cb()
*/
typedef struct {
app_create_cb create; /**< This callback function is called at the start of the application. */
app_terminate_cb terminate; /**< This callback function is called once after the main loop of the application exits. */
app_pause_cb pause; /**< This callback function is called each time the application is completely obscured by another application and becomes invisible to the user. */
app_resume_cb resume; /**< This callback function is called each time the application becomes visible to the user. */
app_control_cb app_control; /**< This callback function is called when another application sends the launch request to the application. */
app_low_memory_cb low_memory; /**< The registered callback function is called when the system runs low on memory. */
app_low_battery_cb low_battery; /**< The registered callback function is called when the battery is low. */
app_device_orientation_cb device_orientation; /**< The registered callback function is called when the orientation of the device changes */
app_language_changed_cb language_changed; /**< The registered callback function is called when language setting changes. */
app_region_format_changed_cb region_format_changed; /**< The registered callback function is called when region format setting changes. */
} app_event_callback_s;
/**
* @internal
* @brief Runs the application's main loop until app_exit() is called.
*
* @details This function is the main entry point of the Tizen application.
* The app_create_cb() callback function is called to initialize the application before the main loop of application starts up.
* After the app_create_cb() callback function returns true, the main loop starts up and the app_control_cb() callback function is subsequently called.
* If the app_create_cb() callback function returns false, the main loop doesn't start up and app_terminate_cb() callback function is called.
*
* @since_tizen 2.3
* @param[in] argc The argument count
* @param[in] argv The argument vector
* @param[in] callback The set of callback functions to handle application events
* @param[in] user_data The user data to be passed to the callback functions
*
* @return 0 on success, otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system
* @retval #APP_ERROR_ALREADY_RUNNING The main loop already starts
*
* @see app_create_cb()
* @see app_terminate_cb()
* @see app_pause_cb()
* @see app_resume_cb()
* @see app_control_cb()
* @see app_low_memory_cb()
* @see app_low_battery_cb()
* @see app_device_orientation_cb()
* @see app_language_changed_cb()
* @see app_region_format_changed_cb()
* @see app_exit()
* @see #app_event_callback_s
*/
int app_main(int argc, char **argv, app_event_callback_s *callback, void *user_data);
/**
* @internal
* @brief Runs the application's main loop until app_efl_exit() is called.
*
* @details This function is the main entry point of the Tizen application.
* The app_create_cb() callback function is called to initialize the application before the main loop of the application starts up.
* After the app_create_cb() callback function returns @c true, the main loop starts up and the app_control_cb() callback function is subsequently called.
* If the app_create_cb() callback function returns @c false, the main loop doesn't start up and the app_terminate_cb() callback function is called.
*
* @since_tizen 2.3
* @param[in] argc The argument count
* @param[in] argv The argument vector
* @param[in] callback The set of callback functions to handle application events
* @param[in] user_data The user data to be passed to the callback functions
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system
* @retval #APP_ERROR_ALREADY_RUNNING The main loop has already started
*
* @see app_create_cb()
* @see app_terminate_cb()
* @see app_pause_cb()
* @see app_resume_cb()
* @see app_control_cb()
* @see app_low_memory_cb()
* @see app_low_battery_cb()
* @see app_device_orientation_cb()
* @see app_language_changed_cb()
* @see app_region_format_changed_cb()
* @see app_efl_exit()
* @see #app_event_callback_s
*/
int app_efl_main(int *argc, char ***argv, app_event_callback_s *callback, void *user_data);
/**
* @internal
* @brief Exits the main loop of application.
*
* @details The main loop of application stops and app_terminate_cb() is invoked.
* @since_tizen 2.3
* @see app_main()
* @see app_terminate_cb()
*/
void app_exit(void);
/**
* @internal
* @brief Exits the main loop of the application.
*
* @details The main loop of the application stops and app_terminate_cb() is invoked.
* @since_tizen 2.3
* @see app_efl_main()
* @see app_terminate_cb()
*/
void app_efl_exit(void);
/**
* @brief Initialize the application main loop.
*
* @details After calling this function, the application main loop doesn't run.
* @since_tizen 3.0
* @param[in] argc The argument count
* @param[in] argv The argument vector
* @param[in] callback The set of callback functions to handle application lifecycle events
* @param[in] user_data The user data to be passed to the callback functions
* @param[out] handle The appcore_context handle to be newly created on success
*
* @return 0 on success, otherwise a negative error value
* @retval #APP_ERROR_NONE Successful
* @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system
* @retval #APP_ERROR_ALREADY_RUNNING The main loop already starts
* @sett ui_app_fini()
*/
int ui_app_init(int argc, char **argv, ui_app_lifecycle_callback_s *callback, void *user_data, appcore_context_h *handle);
/**
* @brief Finalize the application main loop.
*
* @since_tizen 3.0
* @param[in] handle The handle of appcore context
*
* @see ui_app_init()
*/
void ui_app_fini(appcore_context_h handle);
#ifdef __cplusplus
}
#endif
#endif /* __TIZEN_APPFW_APP_INTERNAL_H__ */
|
