summaryrefslogtreecommitdiff
path: root/src/lib/elm_web.eo
blob: f949b017448252e505a88412d53103671deff6f8 (plain) (blame)
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
class Elm_Web (Elm_Widget)
{
   eo_prefix: elm_obj_web;
   properties {
      text_matches_highlight {
         set {
            /*@
            Sets whether to highlight the matched marks

            If enabled, marks set with elm_web_text_matches_mark() will be
            highlighted.

            @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

            @ingroup Web */
            return Eina_Bool;
         }
         get {
            /*@
            Get whether highlighting marks is enabled

            @return @c EINA_TRUE is marks are set to be highlighted, @c EINA_FALSE
            otherwise

            @ingroup Web */
         }
         values {
            Eina_Bool highlight; /*@ Whether to highlight the marks or not */
         }
      }
      useragent {
         set {
            /*@
            Change useragent of a elm_web object

            @ingroup Web */
         }
         get {
            /*@
            Return current useragent of elm_web object

            @return Useragent string

            @ingroup Web */
         }
         values {
            const(char)* user_agent; /*@ String for useragent */
         }
      }
      url {
         set {
            /*@
            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

            @return @c EINA_TRUE if the URL could be set, @c EINA_FALSE if an error occurred.

            @ingroup Web */
            return Eina_Bool;
         }
         get {
            /*@
            Get the current URL for the object

            The returned string must not be freed and is guaranteed to be
            stringshared.

            @return A stringshared internal string with the current URL, or @c NULL on
            failure

            @ingroup Web */
         }
         values {
            const(char)* url; /*@ The URL to set */
         }
      }
      bg_color {
         set {
            /*@
            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.

            @ingroup Web */
         }
         get {
            /*@
            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.

            @ingroup Web */
         }
         values {
            int r; /*@ Red component */
            int g; /*@ Green component */
            int b; /*@ Blue component */
            int a; /*@ Alpha component */
         }
      }
      inwin_mode {
         set {
            /*@
            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.

            @ingroup Web */
         }
         get {
            /*@
            Get whether Inwin mode is set for the current object

            @return @c EINA_TRUE if Inwin mode is set, @c EINA_FALSE otherwise

            @ingroup Web */
         }
         values {
            Eina_Bool value; /*@ @c EINA_TRUE to use Inwin, @c EINA_FALSE to use a normal window */
         }
      }
      tab_propagate {
         set {
            /*@
            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.

            @ingroup Web */
         }
         get {
            /*@
            Get the status of the tab propagation

            @return @c EINA_TRUE if tab propagation is enabled, @c EINA_FALSE otherwise

            @see elm_web_tab_propagate_set()

            @ingroup Web */
         }
         values {
            Eina_Bool propagate; /*@ Whether to propagate Tab keys to Elementary or not */
         }
      }
      history_enabled {
         set {
            /*@
            Enables or disables the browsing history

            @ingroup Web */
         }
         get {
            /*@
            Get whether browsing history is enabled for the given object

            @return @c EINA_TRUE if history is enabled, @c EINA_FALSE otherwise

            @ingroup Web */
         }
         values {
            Eina_Bool enable; /*@ Whether to enable or disable the browsing history */
         }
      }
      zoom_mode {
         set {
            /*@
            Sets the zoom mode to use

            The modes can be any of those defined in .Elm_Web_Zoom_Mode, except
            .ELM_WEB_ZOOM_MODE_LAST. The default is .ELM_WEB_ZOOM_MODE_MANUAL.

            .ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
            with the elm_web_zoom_set() function.
            .ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
            make sure the entirety of the web object's contents are shown.
            .ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
            fit the contents in the web object's size, without leaving any space
            unused.

            @ingroup Web */
         }
         get {
            /*@
            Get the currently set zoom mode

            @return The current zoom mode set for the object,
            or .ELM_WEB_ZOOM_MODE_LAST on error

            @ingroup Web */
         }
         values {
            Elm_Web_Zoom_Mode mode; /*@ The mode to set */
         }
      }
      zoom {
         set {
            /*@
            Sets the zoom level of the web object

            Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
            values meaning zoom in and lower meaning zoom out. This function will
            only affect the zoom level if the mode set with elm_web_zoom_mode_set()
            is .ELM_WEB_ZOOM_MODE_MANUAL.

            @ingroup Web */
         }
         get {
            /*@
            Get the current zoom level set on the web object

            Note that this is the zoom level set on the web object and not that
            of the underlying Webkit one. In the .ELM_WEB_ZOOM_MODE_MANUAL mode,
            the two zoom levels should match, but for the other two modes the
            Webkit zoom is calculated internally to match the chosen mode without
            changing the zoom level set for the web object.

            @return The zoom level set on the object

            @ingroup Web */
         }
         values {
            double zoom; /*@ The zoom level to set */
         }
      }
      console_message_hook {
         set {
            /*@
            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.

            @ingroup Web */
         }
         values {
            Elm_Web_Console_Message func; /*@ The callback function to be used */
            void *data; /*@ User data */
         }
      }
      window_create_hook {
         set {
            /*@
            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 @p func will prevent new windows from
            opening.

            @ingroup Web */
         }
         values {
            Elm_Web_Window_Open func; /*@ The hook function to be called when a window is requested */
            void *data; /*@ User data */
         }
      }
      dialog_file_selector_hook {
         set {
            /*@
            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 @p func, the default
            implementation will take place.

            @see elm_web_inwin_mode_set()

            @ingroup Web */
         }
         values {
            Elm_Web_Dialog_File_Selector func; /*@ The callback function to be used */
            void *data; /*@ User data */
         }
      }
      dialog_confirm_hook {
         set {
            /*@
            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 @p func, the default
            implementation will take place.

            @see elm_web_inwin_mode_set()

            @ingroup Web */
         }
         values {
            Elm_Web_Dialog_Confirm func; /*@ The callback function to be used */
            void *data; /*@ User data */
         }
      }
      popup_selected {
         set {
            /*@
            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.

            @see elm_web_popup_destroy()

            @ingroup Web */
         }
         values {
            int idx; /*@ The index selected */
         }
      }
      dialog_prompt_hook {
         set {
            /*@
            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 @p func, the default
            implementation will take place.

            @see elm_web_inwin_mode_set()

            @ingroup Web */
         }
         values {
            Elm_Web_Dialog_Prompt func; /*@ The callback function to be used */
            void *data; /*@ User data */
         }
      }
      dialog_alert_hook {
         set {
            /*@
            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 @p func, the default
            implementation will take place.

            @see elm_web_inwin_mode_set()

            @ingroup Web */
         }
         values {
            Elm_Web_Dialog_Alert func; /*@ The callback function to be used */
            void *data; /*@ User data */
         }
      }
      forward_possible {
         get {
            /*@
            Queries whether it's possible to go forward in history

            @return @c EINA_TRUE if it's possible to forward in history, @c EINA_FALSE
            otherwise

            @ingroup Web */
            return Eina_Bool;
         }
      }
      webkit_view {
         get {
            /*@
            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.

            @return The internal ewk_view object or @c NULL if it does not
            exist. (Failure to create or Elementary compiled without
            ewebkit)

            @see elm_web_add()

            @ingroup Web */
            return Evas_Object *;
         }
      }
      back_possible {
         get {
            /*@
            Queries whether it's possible to go back in history

            @return @c EINA_TRUE if it's possible to back in history, @c EINA_FALSE
            otherwise

            @ingroup Web */
            return Eina_Bool;
         }
      }
      load_progress {
         get {
            /*@
            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.

            @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
            failure

            @ingroup Web */
            return double;
         }
      }
      selection {
         get {
            /*@
            Get a copy of the currently selected text

            The string returned must be freed by the user when it's done with it.

            @return A newly allocated string, or @c NULL if nothing is selected or an
            error occurred

            @ingroup Web */
            return const(char)*;
         }
      }
      title {
         get {
            /*@
            Get the current title

            The returned string must not be freed and is guaranteed to be
            stringshared.

            @return A stringshared internal string with the current title, or @c NULL on
            failure

            @ingroup Web */
            return const(char)*;
         }
      }
   }
   methods {
      navigate {
         /*@
         Jumps the given number of steps in the browsing history

         The @p steps value can be a negative integer to back in history, or a
         positive to move forward.

         @return @c EINA_TRUE on success, @c EINA_FALSE on error or if not enough
         history exists to jump the given number of steps

         @see elm_web_history_enabled_set()
         @see elm_web_back()
         @see elm_web_forward()

         @ingroup Web */

         return Eina_Bool;
         params {
            @in int steps; /*@ The number of steps to jump */
         }
      }
      back {
         /*@
         Goes back one step in the browsing history

         This is equivalent to calling elm_web_object_navigate(obj, -1);

         @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

         @see elm_web_history_enabled_set()
         @see elm_web_back_possible()
         @see elm_web_forward()
         @see elm_web_navigate()

         @ingroup Web */

         return Eina_Bool;
      }
      html_string_load {
         /*@
         Loads the specified @a html string as the content of the web object

         @return @c EINA_TRUE if it the HTML was successfully loaded, @c EINA_FALSE otherwise

         External objects such as stylesheets or images referenced in the HTML
         document are located relative to @a base_url.

         If an @a 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.

         @since 1.9
         @ingroup Web */

         return Eina_Bool;
         params {
            @in const(char)* html; /*@ HTML data to load */
            @in const(char)* base_url; /*@ Base URL used for relative paths to external objects (optional) */
            @in const(char)* unreachable_url; /*@ URL that could not be reached (optional) */
         }
      }
      text_search {
         /*@
         Searches the given string in a document.

         @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
         or failure

         @ingroup Web */

         const;
         return Eina_Bool;
         params {
            @in const(char)* string; /*@ String to search */
            @in Eina_Bool case_sensitive; /*@ If search should be case sensitive or not */
            @in Eina_Bool forward; /*@ If search is from cursor and on or backwards */
            @in Eina_Bool wrap; /*@ If search should wrap at the end */
         }
      }
      popup_destroy {
         /*@
         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.

         @return @c EINA_TRUE if the menu was successfully destroyed, or @c EINA_FALSE
         if there was no menu to destroy

         @ingroup Web */

         return Eina_Bool;
      }
      region_show {
         /*@
         Shows the given region in the web object

         @ingroup Web */

         params {
            @in int x; /*@ The x coordinate of the region to show */
            @in int y; /*@ The y coordinate of the region to show */
            @in int w; /*@ The width of the region to show */
            @in int h; /*@ The height of the region to show */
         }
      }
      forward {
         /*@
         Goes forward one step in the browsing history

         This is equivalent to calling elm_web_object_navigate(obj, 1);

         @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

         @see elm_web_history_enabled_set()
         @see elm_web_forward_possible_get()
         @see elm_web_back()
         @see elm_web_navigate()

         @ingroup Web */

         return Eina_Bool;
      }
      text_matches_mark {
         /*@
         Marks matches of the given string in a document.

         @return number of matched @a string

         @ingroup Web */

         return uint;
         params {
            @in const(char)* string; /*@ String to match */
            @in Eina_Bool case_sensitive; /*@ If match should be case sensitive or not */
            @in Eina_Bool highlight; /*@ If matches should be highlighted */
            @in uint limit; /*@ Maximum amount of matches, or zero to unlimited */
         }
      }
      region_bring_in {
         /*@
         Brings in the region to the visible area

         Like elm_web_region_show(), but it animates the scrolling of the object
         to show the area

         @ingroup Web */

         params {
            @in int x; /*@ The x coordinate of the region to show */
            @in int y; /*@ The y coordinate of the region to show */
            @in int w; /*@ The width of the region to show */
            @in int h; /*@ The height of the region to show */
         }
      }
      stop {
         /*@
         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 EINA_TRUE.

         @return @c EINA_TRUE if the cancel was successful, @c EINA_FALSE otherwise

         @ingroup Web */

         return Eina_Bool;
      }
      navigate_possible_get {
         /*@
         Queries whether it's possible to jump the given number of steps

         The @p steps value can be a negative integer to back in history, or a
         positive to move forward.

         @return @c EINA_TRUE if enough history exists to perform the given jump,
         @c EINA_FALSE otherwise

         @ingroup Web */

         return Eina_Bool;
         params {
            @in int steps; /*@ The number of steps to check for */
         }
      }
      reload_full {
         /*@
         Requests a reload of the current document, avoiding any existing caches

         @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

         @ingroup Web */

         return Eina_Bool;
      }
      text_matches_unmark_all {
         /*@
         Clears all marked matches in the document

         @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

         @ingroup Web */

         return Eina_Bool;
      }
      reload {
         /*@
         Requests a reload of the current document in the object

         @return @c EINA_TRUE on success, @c EINA_FALSE otherwise

         @ingroup Web */

         return Eina_Bool;
      }
   }
   implements {
      class.constructor;
      Eo_Base.constructor;
      Evas_Object_Smart.add;
      Evas_Object_Smart.del;
      Elm_Widget.theme_apply;
      Elm_Widget.on_focus;
      Elm_Widget.event;
   }
   events {
      uri,changed; /*@ s */
      url,changed; /*@ s */
      focused;
      unfocused;
   }

}