aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/tmpl/ephy-embed.sgml
blob: 1fd4d6784cbe2784c94f0b0c711baa5fc1b5ee4d (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
<!-- ##### SECTION Title ##### -->
EphyEmbed

<!-- ##### SECTION Short_Description ##### -->
An interface to the widget displaying web pages

<!-- ##### SECTION Long_Description ##### -->
<para>
Each #EphyTab contains an #EphyEmbed. An #EphyEmbed is an interface; right now
it is only implemented by #MozillaEmbed, but whenever possible, #EphyEmbed's
functions should be used instead of their #MozillaEmbed equivalents.
</para>
<para>
#EphyEmbed's most important functions can be divided into sets:
</para>
<itemizedlist>
<listitem>Functions which affect navigation</listitem>
<listitem>Functions which return information about the displayed web
page</listitem>
<listitem>Functions which manipulate the session history</listitem>
</itemizedlist>
<para>The first two sets of functions are self-explanitory.</para>
<para>The session history functions are used to traverse the embedded browser's
history. Each #EphyEmbed remembers a history of the web pages it has visited.
There can be a maximum limit, however; for #MozillaEmbed, this limit is
determined by Mozilla's browser.sessionhistory.max_entries preference. Because
of this limit, ephy_embed_shistory_n_items() will not necessarily return the
number of web pages visited in the embed's lifetime; likewise,
ephy_embed_shistory_go_nth() will not always return to the user's home page
when called with a 0 argument.</para>

<!-- ##### SECTION See_Also ##### -->
<para>
Using #EphyEmbed instead of #MozillaEmbed is good practice. However, using a
#MozillaEmbed or even a #GtkMozEmbed may be necessary in certain cases (this can
be done by casting).
</para>

<!-- ##### STRUCT EphyEmbed ##### -->
<para>

</para>


<!-- ##### STRUCT EphyEmbedIface ##### -->
<para>

</para>

@base_iface: 
@context_menu: 
@favicon: 
@location: 
@net_state: 
@new_window: 
@dom_mouse_click: 
@dom_mouse_down: 
@popup_blocked: 
@security_change: 
@zoom_change: 
@load_url: 
@stop_load: 
@reload: 
@can_go_back: 
@can_go_forward: 
@can_go_up: 
@get_go_up_list: 
@go_back: 
@go_forward: 
@go_up: 
@get_title: 
@get_location: 
@get_link_message: 
@get_js_status: 
@shistory_n_items: 
@shistory_get_nth: 
@shistory_get_pos: 
@shistory_go_nth: 
@get_security_level: 
@set_zoom: 
@get_zoom: 
@find_set_properties: 
@find_next: 
@set_encoding: 
@get_encoding_info: 
@print: 
@print_preview_close: 
@print_preview_n_pages: 
@print_preview_navigate: 
@activate: 
@has_modified_forms: 

<!-- ##### ENUM EmbedState ##### -->
<para>
Represents the state of an #EphyEmbed with regards to networking negotiations.
</para>

@EMBED_STATE_UNKNOWN: 
@EMBED_STATE_START: 
@EMBED_STATE_REDIRECTING: 
@EMBED_STATE_TRANSFERRING: 
@EMBED_STATE_NEGOTIATING: 
@EMBED_STATE_STOP: 
@EMBED_STATE_IS_REQUEST: 
@EMBED_STATE_IS_DOCUMENT: 
@EMBED_STATE_IS_NETWORK: 
@EMBED_STATE_IS_WINDOW: 

<!-- ##### ENUM EphyEmbedChrome ##### -->
<para>
Determines which aspects of the user interface should be displayed. Most of the
time, an #EphyEmbed's chrome will simply be %EPHY_EMBED_CHROME_DEFAULT. However,
windows opened with JavaScript often use a nonstandard chrome.
</para>

@EPHY_EMBED_CHROME_DEFAULT: 
@EPHY_EMBED_CHROME_MENUBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
                to display its menubar.
@EPHY_EMBED_CHROME_TOOLBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
                to display its toolbars.
@EPHY_EMBED_CHROME_STATUSBAR: %TRUE for the #EphyEmbed's containing #EphyWindow
                  to display its statusbar.
@EPHY_EMBED_CHROME_BOOKMARKSBAR: 

<!-- ##### ENUM EmbedReloadFlags ##### -->
<para>

</para>

@EMBED_RELOAD_NORMAL: 
@EMBED_RELOAD_FORCE: Bypass cache and proxy while reloading a web page

<!-- ##### ENUM EmbedPrintPreviewNavType ##### -->
<para>
Specifies the action to perform in ephy_embed_print_preview_navigate().
</para>

@PRINTPREVIEW_GOTO_PAGENUM: 
@PRINTPREVIEW_PREV_PAGE: 
@PRINTPREVIEW_NEXT_PAGE: 
@PRINTPREVIEW_HOME: 
@PRINTPREVIEW_END: 

<!-- ##### ENUM EmbedSecurityLevel ##### -->
<para>
Represents the security status of an #EphyEmbed. For example, a page with an
invalid SSL certificate will have an #EmbedSecurityLevel of %STATE_IS_BROKEN.
</para>

@STATE_IS_UNKNOWN: 
@STATE_IS_INSECURE: 
@STATE_IS_BROKEN: 
@STATE_IS_SECURE_MED: 
@STATE_IS_SECURE_LOW: 
@STATE_IS_SECURE_HIGH: 

<!-- ##### FUNCTION ephy_embed_load_url ##### -->
<para>

</para>

@embed: 
@url: 


<!-- ##### FUNCTION ephy_embed_stop_load ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_reload ##### -->
<para>

</para>

@embed: 
@flags: 


<!-- ##### FUNCTION ephy_embed_get_title ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_get_location ##### -->
<para>

</para>

@embed: 
@toplevel: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_get_link_message ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_get_js_status ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_can_go_back ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_can_go_forward ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_can_go_up ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_get_go_up_list ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_go_back ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_go_forward ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_go_up ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_shistory_n_items ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_shistory_get_nth ##### -->
<para>

</para>

@embed: 
@nth: 
@is_relative: 
@url: 
@title: 


<!-- ##### FUNCTION ephy_embed_shistory_get_pos ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_shistory_go_nth ##### -->
<para>

</para>

@embed: 
@nth: 


<!-- ##### FUNCTION ephy_embed_get_security_level ##### -->
<para>

</para>

@embed: 
@level: 
@description: 


<!-- ##### FUNCTION ephy_embed_set_zoom ##### -->
<para>

</para>

@embed: 
@zoom: 
@reflow: 


<!-- ##### FUNCTION ephy_embed_get_zoom ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_find_set_properties ##### -->
<para>

</para>

@embed: 
@search_string: 
@case_sensitive: 
@wrap_around: 


<!-- ##### FUNCTION ephy_embed_find_next ##### -->
<para>

</para>

@embed: 
@backwards: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_set_encoding ##### -->
<para>

</para>

@embed: 
@encoding: 


<!-- ##### FUNCTION ephy_embed_get_encoding_info ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_print ##### -->
<para>

</para>

@embed: 
@info: 


<!-- ##### FUNCTION ephy_embed_print_preview_close ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_print_preview_n_pages ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### FUNCTION ephy_embed_print_preview_navigate ##### -->
<para>

</para>

@embed: 
@type: 
@page: 


<!-- ##### FUNCTION ephy_embed_activate ##### -->
<para>

</para>

@embed: 


<!-- ##### FUNCTION ephy_embed_has_modified_forms ##### -->
<para>

</para>

@embed: 
@Returns: 


<!-- ##### SIGNAL EphyEmbed::ge-context-menu ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 
@Returns: 

<!-- ##### SIGNAL EphyEmbed::ge-dom-mouse-click ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 
@Returns: 

<!-- ##### SIGNAL EphyEmbed::ge-dom-mouse-down ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 
@Returns: 

<!-- ##### SIGNAL EphyEmbed::ge-favicon ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL EphyEmbed::ge-location ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL EphyEmbed::ge-net-state ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL EphyEmbed::ge-new-window ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 
@arg2: 

<!-- ##### SIGNAL EphyEmbed::ge-security-change ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL EphyEmbed::ge-zoom-change ##### -->
<para>

</para>

@ephyembed: the object which received the signal.
@arg1: