summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_web_eo.h
blob: 0407b40188794b04191022c777f7da81d3c8a117 (plain)
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
#ifndef _ELM_WEB_EO_H_
#define _ELM_WEB_EO_H_

#ifndef _ELM_WEB_EO_CLASS_TYPE
#define _ELM_WEB_EO_CLASS_TYPE

typedef Eo Elm_Web;

#endif

#ifndef _ELM_WEB_EO_TYPES
#define _ELM_WEB_EO_TYPES


#endif
/** Elementary web view class
 *
 * @ingroup Elm_Web
 */
#define ELM_WEB_CLASS elm_web_class_get()

EWAPI const Efl_Class *elm_web_class_get(void);

/**
 * @brief Sets whether to highlight the matched marks.
 *
 * If enabled, marks set with @ref elm_obj_web_text_matches_mark will be
 * highlighted.
 *
 * @param[in] obj The object.
 * @param[in] highlight Whether to highlight the marks or not.
 *
 * @return @c true on success, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_text_matches_highlight_set(Eo *obj, Eina_Bool highlight);

/**
 * @brief Get whether highlighting marks is enabled.
 *
 * @param[in] obj The object.
 *
 * @return Whether to highlight the marks or not.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_text_matches_highlight_get(const Eo *obj);

/**
 * @brief Change useragent of a elm_web object.
 *
 * @param[in] obj The object.
 * @param[in] user_agent String for useragent.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_useragent_set(Eo *obj, const char *user_agent);

/**
 * @brief Return current useragent of elm_web object.
 *
 * @param[in] obj The object.
 *
 * @return String for useragent.
 *
 * @ingroup Elm_Web
 */
EOAPI const char *elm_obj_web_useragent_get(const Eo *obj);

/**
 * @brief Sets the URL for the web object.
 *
 * It must be a full URL, with resource included, in the form
 * http://www.enlightenment.org or file:///tmp/something.html
 *
 * @param[in] obj The object.
 * @param[in] url The URL to set.
 *
 * @return @c true on success, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_url_set(Eo *obj, const char *url);

/**
 * @brief Get the current URL for the object.
 *
 * The returned string must not be freed and is guaranteed to be stringshared.
 *
 * @param[in] obj The object.
 *
 * @return The URL to set.
 *
 * @ingroup Elm_Web
 */
EOAPI const char *elm_obj_web_url_get(const Eo *obj);

/**
 * @brief Sets the background color to be used by the web object.
 *
 * This is the color that will be used by default when the loaded page does not
 * set it's own. Color values are pre-multiplied.
 *
 * @param[in] obj The object.
 * @param[in] r Red component.
 * @param[in] g Green component.
 * @param[in] b Blue component.
 * @param[in] a Alpha component.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_bg_color_set(Eo *obj, int r, int g, int b, int a);

/**
 * @brief Get the background color to be used by the web object.
 *
 * This is the color that will be used by default when the loaded page does not
 * set it's own. Color values are pre-multiplied.
 *
 * @param[in] obj The object.
 * @param[out] r Red component.
 * @param[out] g Green component.
 * @param[out] b Blue component.
 * @param[out] a Alpha component.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_bg_color_get(const Eo *obj, int *r, int *g, int *b, int *a);

/**
 * @brief Sets the default dialogs to use an Inwin instead of a normal window.
 *
 * If set, then the default implementation for the JavaScript dialogs and file
 * selector will be opened in an Inwin. Otherwise they will use a normal
 * separated window.
 *
 * @param[in] obj The object.
 * @param[in] value @c true if dialog will be opened as Inwin, @c false
 * otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_inwin_mode_set(Eo *obj, Eina_Bool value);

/**
 * @brief Get whether Inwin mode is set for the current object.
 *
 * @param[in] obj The object.
 *
 * @return @c true if dialog will be opened as Inwin, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_inwin_mode_get(const Eo *obj);

/**
 * @brief Sets whether to use tab propagation.
 *
 * If tab propagation is enabled, whenever the user presses the Tab key,
 * Elementary will handle it and switch focus to the next widget. The default
 * value is disabled, where WebKit will handle the Tab key to cycle focus
 * though its internal objects, jumping to the next widget only when that cycle
 * ends.
 *
 * @param[in] obj The object.
 * @param[in] propagate Whether to propagate Tab keys to Elementary or not.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_tab_propagate_set(Eo *obj, Eina_Bool propagate);

/**
 * @brief Get the status of the tab propagation.
 *
 * @param[in] obj The object.
 *
 * @return Whether to propagate Tab keys to Elementary or not.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_tab_propagate_get(const Eo *obj);

/**
 * @brief Enables or disables the browsing history.
 *
 * @param[in] obj The object.
 * @param[in] enable Whether to enable or disable the browsing history.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_history_enabled_set(Eo *obj, Eina_Bool enable);

/**
 * @brief Get whether browsing history is enabled for the given object.
 *
 * @param[in] obj The object.
 *
 * @return Whether to enable or disable the browsing history.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_history_enabled_get(const Eo *obj);

/**
 * @brief Sets the function to call when a console message is emitted from JS.
 *
 * This hook will be called when a console message is emitted from JavaScript.
 * There is no default implementation for this feature.
 *
 * @param[in] obj The object.
 * @param[in] func The callback function to be used.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_console_message_hook_set(Eo *obj, Elm_Web_Console_Message func, void *data);

/**
 * @brief Sets the function to call when a new window is requested.
 *
 * This hook will be called when a request to create a new window is issued
 * from the web page loaded. There is no default implementation for this
 * feature, so leaving this unset or passing @c null in @c func will prevent
 * new windows from opening.
 *
 * @param[in] obj The object.
 * @param[in] func The hook function to be called when a window is requested.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_window_create_hook_set(Eo *obj, Elm_Web_Window_Open func, void *data);

/**
 * @brief Sets the function to call when an file selector dialog.
 *
 * This hook will be called when a JavaScript file selector dialog is
 * requested. If no function is set or @c null is passed in @c func, the
 * default implementation will take place.
 *
 * @param[in] obj The object.
 * @param[in] func The callback function to be used.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_dialog_file_selector_hook_set(Eo *obj, Elm_Web_Dialog_File_Selector func, void *data);

/**
 * @brief Sets the function to call when an confirm dialog.
 *
 * This hook will be called when a JavaScript confirm dialog is requested. If
 * no function is set or @c null is passed in @c func, the default
 * implementation will take place.
 *
 * @param[in] obj The object.
 * @param[in] func The callback function to be used.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_dialog_confirm_hook_set(Eo *obj, Elm_Web_Dialog_Confirm func, void *data);

/**
 * @brief Tells the web object which index in the currently open popup was
 * selected.
 *
 * When the user handles the popup creation from the "popup,created" signal, it
 * needs to tell the web object which item was selected by calling this
 * function with the index corresponding to the item.
 *
 * @param[in] obj The object.
 * @param[in] idx The index selected.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_popup_selected_set(Eo *obj, int idx);

/**
 * @brief Sets the function to call when an prompt dialog.
 *
 * This hook will be called when a JavaScript prompt dialog is requested. If no
 * function is set or @c null is passed in @c func, the default implementation
 * will take place.
 *
 * @param[in] obj The object.
 * @param[in] func The callback function to be used.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_dialog_prompt_hook_set(Eo *obj, Elm_Web_Dialog_Prompt func, void *data);

/**
 * @brief Sets the function to call when an alert dialog.
 *
 * This hook will be called when a JavaScript alert dialog is requested. If no
 * function is set or @c null is passed in @c func, the default implementation
 * will take place.
 *
 * @param[in] obj The object.
 * @param[in] func Callback function to be used.
 * @param[in] data User data.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_dialog_alert_hook_set(Eo *obj, Elm_Web_Dialog_Alert func, void *data);

/**
 * @brief Queries whether it's possible to go forward in history.
 *
 * @param[in] obj The object.
 *
 * @return @c true if it is possible to go forward, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_forward_possible_get(const Eo *obj);

/**
 * @brief Get internal ewk_view object from web object.
 *
 * Elementary may not provide some low level features of EWebKit, instead of
 * cluttering the API with proxy methods we opted to return the internal
 * reference. Be careful using it as it may interfere with elm_web behavior.
 *
 * @param[in] obj The object.
 *
 * @return The internal ewk_view object or @c null if it does not exist.
 * (Failure to create or Elementary compiled without ewebkit)
 *
 * @ingroup Elm_Web
 */
EOAPI Efl_Canvas_Object *elm_obj_web_webkit_view_get(const Eo *obj);

/**
 * @brief Queries whether it's possible to go back in history.
 *
 * @param[in] obj The object.
 *
 * @return @c true if it is possible to go back, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_back_possible_get(const Eo *obj);

/**
 * @brief Get the overall loading progress of the page.
 *
 * Returns the estimated loading progress of the page, with a value between 0.0
 * and 1.0. This is an estimated progress accounting for all the frames
 * included in the page.
 *
 * @param[in] obj The object.
 *
 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
 * failure.
 *
 * @ingroup Elm_Web
 */
EOAPI double elm_obj_web_load_progress_get(const Eo *obj);

/**
 * @brief Get a copy of the currently selected text.
 *
 * The string returned must be freed by the user when it's done with it.
 *
 * @param[in] obj The object.
 *
 * @return A newly allocated string, or @c null if nothing is selected or an
 * error occurred.
 *
 * @ingroup Elm_Web
 */
EOAPI char *elm_obj_web_selection_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;

/**
 * @brief Get the current title.
 *
 * The returned string must not be freed and is guaranteed to be stringshared.
 *
 * @param[in] obj The object.
 *
 * @return A stringshared internal string with the current title, or @c null on
 * failure.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Stringshare *elm_obj_web_title_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;

/**
 * @brief Jumps the given number of steps in the browsing history.
 *
 * The @c steps value can be a negative integer to back in history, or a
 * positive to move forward.
 *
 * @param[in] obj The object.
 * @param[in] steps The number of steps to jump.
 *
 * @return @c true on success, @c false on error or if not enough history
 * exists to jump the given number of steps
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_navigate(Eo *obj, int steps);

/**
 * @brief Goes back one step in the browsing history.
 *
 * This is equivalent to calling elm_web_object_navigate(obj, -1);
 *
 * @param[in] obj The object.
 *
 * @return @c true on success, @c false otherwise
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_back(Eo *obj);

/**
 * @brief Loads the specified @c html string as the content of the web object.
 *
 * External objects such as stylesheets or images referenced in the HTML
 * document are located relative to @c base_url.
 *
 * If an @c unreachable_url is passed it is used as the url for the loaded
 * content. This is typically used to display error pages for a failed load.
 *
 * @param[in] obj The object.
 * @param[in] html HTML data to load.
 * @param[in] base_url Base URL used for relative paths to external objects
 * (optional).
 * @param[in] unreachable_url URL that could not be reached (optional).
 *
 * @return @c true on success, @c false otherwise
 *
 * @since 1.9
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_html_string_load(Eo *obj, const char *html, const char *base_url, const char *unreachable_url);

/**
 * @brief Searches the given string in a document.
 *
 * @param[in] obj The object.
 * @param[in] string String to search.
 * @param[in] case_sensitive If search should be case sensitive or not.
 * @param[in] forward If search is from cursor and on or backwards.
 * @param[in] wrap If search should wrap at the end.
 *
 * @return @c true if the given string was found, @c false if not or failure.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_text_search(const Eo *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);

/**
 * @brief Dismisses an open dropdown popup
 *
 * When the popup from a dropdown widget is to be dismissed, either after
 * selecting an option or to cancel it, this function must be called, which
 * will later emit an "popup,willdelete" signal to notify the user that any
 * memory and objects related to this popup can be freed.
 *
 * @param[in] obj The object.
 *
 * @return @c true if the menu was successfully destroyed, or @c false if there
 * was no menu to destroy.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_popup_destroy(Eo *obj);

/**
 * @brief Shows the given region in the web object.
 *
 * @param[in] obj The object.
 * @param[in] x The x coordinate of the region to show.
 * @param[in] y The y coordinate of the region to show.
 * @param[in] w The width of the region to show.
 * @param[in] h The height of the region to show.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_region_show(Eo *obj, int x, int y, int w, int h);

/**
 * @brief Goes forward one step in the browsing history.
 *
 * This is equivalent to calling elm_web_object_navigate(obj, 1);
 *
 * See also @ref elm_obj_web_history_enabled_set,
 * @ref elm_obj_web_forward_possible_get, @ref elm_obj_web_back,
 * @ref elm_obj_web_navigate.
 *
 * @param[in] obj The object.
 *
 * @return @c true on success, @c false otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_forward(Eo *obj);

/**
 * @brief Marks matches of the given string in a document.
 *
 * @param[in] obj The object.
 * @param[in] string String to match.
 * @param[in] case_sensitive If match should be case sensitive or not.
 * @param[in] highlight If matches should be highlighted.
 * @param[in] limit Maximum amount of matches, or zero to unlimited.
 *
 * @return Number of matched @c string.
 *
 * @ingroup Elm_Web
 */
EOAPI unsigned int elm_obj_web_text_matches_mark(Eo *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);

/**
 * @brief Brings in the region to the visible area.
 *
 * Like @ref elm_obj_web_region_show, but it animates the scrolling of the
 * object to show the area.
 *
 * @param[in] obj The object.
 * @param[in] x The x coordinate of the region to show.
 * @param[in] y The y coordinate of the region to show.
 * @param[in] w The width of the region to show.
 * @param[in] h The height of the region to show.
 *
 * @ingroup Elm_Web
 */
EOAPI void elm_obj_web_region_bring_in(Eo *obj, int x, int y, int w, int h);

/**
 * @brief Stops loading the current page.
 *
 * Cancels the loading of the current page in the web object. This will cause a
 * "load,error" signal to be emitted, with the is_cancellation flag set to
 * @c true.
 *
 * @param[in] obj The object.
 *
 * @return @c true if the cancel was successful, @c false otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_stop(Eo *obj);

/**
 * @brief Queries whether it's possible to jump the given number of steps.
 *
 * The @c steps value can be a negative integer to back in history, or positive
 * to move forward.
 *
 * @param[in] obj The object.
 * @param[in] steps The number of steps to check for.
 *
 * @return @c true if enough history exists to perform the given jump, @c false
 * otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_navigate_possible_get(Eo *obj, int steps);

/**
 * @brief Requests a reload of the current document, avoiding any existing
 * caches.
 *
 * @param[in] obj The object.
 *
 * @return @c true on success, @c false otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_reload_full(Eo *obj);

/**
 * @brief Clears all marked matches in the document.
 *
 * @param[in] obj The object.
 *
 * @return @c true on success, @c false otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_text_matches_unmark_all(Eo *obj);

/**
 * @brief Requests a reload of the current document in the object.
 *
 * @param[in] obj The object.
 *
 * @return @c true on success, @c false otherwise.
 *
 * @ingroup Elm_Web
 */
EOAPI Eina_Bool elm_obj_web_reload(Eo *obj);

#endif