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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
#ifndef _ISF_REMOTE_CONTROL_H_
#define _ISF_REMOTE_CONTROL_H_
/**
* @file isf_remote_control.h
* @brief This file contains remote control APIs for TV profile.
*/
#include <Ecore_IMF.h>
#include <scim_visibility.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @brief Enumeration for remote control function error.
*
* @since_tizen @if TV 3.0 @endif
*/
typedef enum {
REMOTE_CONTROL_ERROR_NONE = 0, /**< Successful */
REMOTE_CONTROL_INVALID_PARAMETER, /**< Invalid parameter */
REMOTE_CONTROL_INVALID_OPERATION, /**< Invalid operation */
REMOTE_CONTROL_PERMISSION_DENIED, /**< Permission denied */
REMOTE_CONTROL_REPLY_TIMEOUT, /**< Reply timeout */
} remote_control_error_e;
/**
* @brief Enumeration for key types.
*
* @since_tizen @if TV 3.0 @endif
*
* @see remote_control_send_key_event()
*/
typedef enum {
REMOTE_CONTROL_KEY_ENTER = 0, /**< Enter key */
REMOTE_CONTROL_KEY_SPACE, /**< Space key */
REMOTE_CONTROL_KEY_BACKSPACE, /**< Backspace key */
REMOTE_CONTROL_KEY_ESC, /**< Escape key */
REMOTE_CONTROL_KEY_UP, /**< Up key */
REMOTE_CONTROL_KEY_DOWN, /**< Down key */
REMOTE_CONTROL_KEY_LEFT, /**< LEFT key */
REMOTE_CONTROL_KEY_RIGHT, /**< Right key */
REMOTE_CONTROL_KEY_PAGE_UP, /**< Page up key */
REMOTE_CONTROL_KEY_PAGE_DOWN, /**< Page down key */
} remote_control_key_type_e;
/**
* @brief The structure type to contain the attributes of text field.
*
* @since_tizen @if TV 3.0 @endif
*
* @see remote_control_entry_metadata_cb
*/
typedef struct {
Ecore_IMF_Input_Hints hint; /**< The input hint information */
Ecore_IMF_Input_Panel_Layout layout; /**< The layout information */
int variation; /**< The layout variation information */
Ecore_IMF_Autocapital_Type autocapital_type; /**< The autocapital type information */
} remote_control_entry_metadata_s;
/**
* @brief A structure type to contain the attributes for socket and callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @see remote_control_connect()
*/
typedef struct _remote_control_client remote_control_client;
/**
* @brief Creates a new remote control client.
*
* @details This function provides socket connection and register a fd_handler for the callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @return The remote control client on success, otherwise NULL
*
* @see remote_control_disconnect()
*/
EXAPI remote_control_client * remote_control_connect(void);
/**
* @brief Destroys a remote control client.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_connect()
*/
EXAPI int remote_control_disconnect(remote_control_client *client);
/**
* @brief Called when an associated text field has focus.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] user_data User data to be passed from the callback registration function
*
* @pre The callback can be registered using remote_control_focus_in_callback_set() function.
*
* @see remote_control_focus_in_callback_set()
* @see remote_control_focus_in_callback_unset()
*/
typedef void (*remote_control_focus_in_cb)(void *user_data);
/**
* @brief Register a callback function to be called when an associated text field has focus.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] func focus_in event callback function
* @param[in] user_data User data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_focus_in_cb()
* @see remote_control_focus_in_callback_unset()
*/
EXAPI int remote_control_focus_in_callback_set(remote_control_client *client, remote_control_focus_in_cb func, void *user_data);
/**
* @brief Remove a remote_control_focus_in_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_focus_in_cb()
* @see remote_control_focus_in_callback_set()
*/
EXAPI int remote_control_focus_in_callback_unset(remote_control_client *client);
/**
* @brief Called when an associated text field loses focus.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] user_data User data to be passed from the callback registration function
*
* @pre The callback can be registered using remote_control_focus_out_callback_set() function.
*
* @see remote_control_focus_out_callback_set()
* @see remote_control_focus_out_callback_unset()
*/
typedef void (*remote_control_focus_out_cb)(void *user_data);
/**
* @brief Register a callback function to be called when an associated text field loses focus.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] func focus_out event callback function
* @param[in] user_data User data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_focus_out_cb()
* @see remote_control_focus_out_callback_unset()
*/
EXAPI int remote_control_focus_out_callback_set(remote_control_client *client, remote_control_focus_out_cb func , void *user_data);
/**
* @brief Remove a remote_control_focus_out_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_focus_out_cb()
* @see remote_control_focus_out_callback_set()
*/
EXAPI int remote_control_focus_out_callback_unset(remote_control_client *client);
/**
* @brief Called when an associated text field requests the input panel to set its attributes.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @remarks remote_control_entry_metadata_cb() called after focus_in event.
*
* @param[in] user_data User data to be passed from the callback registration function
* @param[in] data The structure pointer of text field attributes
*
* @pre The callback can be registered using remote_control_entry_metadata_callback_set() function.
*
* @see remote_control_entry_metadata_callback_set()
* @see remote_control_entry_metadata_callback_unset()
*/
typedef void (*remote_control_entry_metadata_cb)(void *user_data, remote_control_entry_metadata_s *data);
/**
* @brief Register a remote_control_entry_metadata_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] func remote_control_entry_metadata_cb() callback function
* @param[in] user_data User data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_entry_metadata_cb()
* @see remote_control_entry_metadata_callback_unset()
*/
EXAPI int remote_control_entry_metadata_callback_set(remote_control_client *client, remote_control_entry_metadata_cb func, void *user_data);
/**
* @brief Remove a remote_control_entry_metadata_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_entry_metadata_cb()
* @see remote_control_entry_metadata_callback_set()
*/
EXAPI int remote_control_entry_metadata_callback_unset(remote_control_client *client);
/**
* @brief Called when an associated text field responds to a request with the surrounding text.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @remarks remote_control_default_text_cb() called after remote_control_entry_metadata_cb()
*
* @param[in] user_data User data to be passed from the callback registration function
* @param[in] default_text The UTF-8 string requested
* @param[in] cursor_pos The cursor position
*
* @pre The callback can be registered using remote_control_default_text_callback_set() function.
*
* @see remote_control_default_text_callback_set()
* @see remote_control_default_text_callback_unset()
*/
typedef void (*remote_control_default_text_cb)(void *user_data, char *default_text, int cursor_pos);
/**
* @brief Register a remote_control_default_text_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] func remote_control_default_text_cb() callback function
* @param[in] user_data User data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_default_text_cb()
* @see remote_control_default_text_callback_unset()
*/
EXAPI int remote_control_default_text_callback_set(remote_control_client *client, remote_control_default_text_cb func, void *user_data);
/**
* @brief Remove a remote_control_default_text_cb() callback function.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_default_text_cb()
* @see remote_control_default_text_callback_set()
*/
EXAPI int remote_control_default_text_callback_unset(remote_control_client *client);
/**
* @brief Sends the key event to the associated text field.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] key The remote_control_key_type_e information
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_OPERATION Invalid operation
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_key_type_e
*/
EXAPI int remote_control_send_key_event(remote_control_client *client, remote_control_key_type_e key);
/**
* @brief Sends the text to the associated text field.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] text The UTF-8 string to be committed
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_OPERATION Invalid operation
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_update_preedit_string()
*/
EXAPI int remote_control_send_commit_string(remote_control_client *client, const char *text);
/**
* @brief Updates a new preedit string to the associated text field.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] text The UTF-8 string to be updated in preedit
* @param[in] attrs An Eina_List of attributes
* @param[in] cursor_pos The cursor position
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_OPERATION Invalid operation
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*
* @see remote_control_send_commit_string()
*/
EXAPI int remote_control_update_preedit_string(remote_control_client *client, const char *text, Eina_List *attrs, int cursor_pos);
/**
* @brief Requests to delete surrounding text.
*
* @since_tizen @if TV 3.0 @endif
*
* @privlevel platform
*
* @privilege %http://tizen.org/privilege/imemanager
*
* @param[in] client The remote control client
* @param[in] offset The offset value from the cursor position
* @param[in] len The length of the text to delete
*
* @return 0 on success, otherwise a negative error value
* @retval #REMOTE_CONTROL_ERROR_NONE No error
* @retval #REMOTE_CONTROL_PERMISSION_DENIED The application does not have the privilege to call this function
* @retval #REMOTE_CONTROL_INVALID_OPERATION Invalid operation
* @retval #REMOTE_CONTROL_INVALID_PARAMETER Invalid parameter
* @retval #REMOTE_CONTROL_REPLY_TIMEOUT Socket connection failed
*/
EXAPI int remote_control_delete_surrounding_text(remote_control_client *client, int offset, int len);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif
|
