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
|
<!-- ##### SECTION Title ##### -->
EphyEmbedPersist
<!-- ##### SECTION Short_Description ##### -->
A class to download files
<!-- ##### SECTION Long_Description ##### -->
<para>
An #EphyEmbedPersist is a relatively simple way to save a web page or file to
disk. It is an abstract class, implemented by #MozillaEmbedPersist.
</para>
<para>
To create an #EphyEmbedPersist, use ephy_embed_factory_new_object(). Next, call
ephy_embed_persist_set_flags() and ephy_embed_persist_set_embed(). Depending
on the flags, you may also want to call ephy_embed_persist_set_dest() or
ephy_embed_persist_set_source(). Finally, call ephy_embed_persist_save() to
save the file.
</para>
<para>
<example>
<title>Saving the current web page to disk</title>
<programlisting>#<![CDATA[include <epiphany/ephy-embed-persist.h>]]>
#<![CDATA[include <epiphany/ephy-embed.h>
static void
save_source_completed_cb (EphyEmbedPersist *persist,
gpointer dummy)
{
g_print ("Download to %]]><![CDATA[s complete.\n",
ephy_embed_persist_get_dest (persist));
}
void
save_page (EphyEmbed *embed,
const char *filename)
{
EphyEmbedPersist *persist;
persist = EPHY_EMBED_PERSIST
(ephy_embed_factory_new_object ("EphyEmbedPersist"));
ephy_embed_persist_set_embed (persist, embed);
ephy_embed_persist_set_flags (persist, EMBED_PERSIST_NO_VIEW |
EMBED_PERSIST_COPY_PAGE);
ephy_embed_persist_set_dest (persist, filename);
g_signal_connect (persist, "completed",
G_CALLBACK (save_source_completed_cb), NULL);
ephy_embed_persist_save (persist);
g_object_unref (persist);
}]]>
</programlisting>
</example>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM EmbedPersistFlags ##### -->
<para>
Determines how the #EphyEmbedPersist should act.
</para>
@EMBED_PERSIST_COPY_PAGE: If set, download a copy of the page being browsed by
the #EphyEmbedPersist's #EphyEmbed. This should be
specified with ephy_embed_persist_set_embed(). If
unset, ephy_embed_persist_set_source() must have been
called.
@EMBED_PERSIST_MAINDOC: If set and %EMBED_PERSIST_COPY_PAGE is set, download the
#EphyEmbedPersist's #EphyEmbed's page's frameset. If
unset, download the currently-focused frame.
@EMBED_PERSIST_NO_VIEW: If set, do not display this download in the download
manager.
@EMBED_PERSIST_ASK_DESTINATION: If set, display a filechooser dialog. You must
call ephy_embed_persist_set_fc_title() and
ephy_embed_persist_set_fc_parent() before
ephy_embed_persist_save() if this is the case.
If unset, use the destination specified with
ephy_embed_persist_set_dest().
<!-- ##### FUNCTION ephy_embed_persist_set_dest ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_embed ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_fc_title ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_fc_parent ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_flags ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_max_size ##### -->
<para>
</para>
@persist:
@Param2:
<!-- # Unused Parameters # -->
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_persist_key ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_set_source ##### -->
<para>
</para>
@persist:
@value:
<!-- ##### FUNCTION ephy_embed_persist_get_dest ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_embed ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_fc_title ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_fc_parent ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_flags ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_max_size ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_persist_key ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_get_source ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_save ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### FUNCTION ephy_embed_persist_cancel ##### -->
<para>
</para>
@persist:
<!-- ##### FUNCTION ephy_embed_persist_to_string ##### -->
<para>
</para>
@persist:
@Returns:
<!-- ##### SIGNAL EphyEmbedPersist::cancelled ##### -->
<para>
</para>
@ephyembedpersist: the object which received the signal.
<!-- ##### SIGNAL EphyEmbedPersist::completed ##### -->
<para>
</para>
@ephyembedpersist: the object which received the signal.
<!-- ##### ARG EphyEmbedPersist:dest ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:embed ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:filechooser-parent ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:filechooser-title ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:flags ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:max-size ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:persist-key ##### -->
<para>
</para>
<!-- ##### ARG EphyEmbedPersist:source ##### -->
<para>
</para>
|
