From e140d51204deb9868887ad2ccb3431973448f8a5 Mon Sep 17 00:00:00 2001 From: Adam Hooper Date: Sat, 27 Mar 2004 21:51:59 +0000 Subject: EphyEmbedPersist documentation --- doc/reference/Makefile.am | 1 - doc/reference/epiphany-docs.sgml | 1 + doc/reference/epiphany-sections.txt | 33 ++++ doc/reference/epiphany.types | 2 + doc/reference/tmpl/ephy-embed-persist.sgml | 308 +++++++++++++++++++++++++++++ 5 files changed, 344 insertions(+), 1 deletion(-) create mode 100644 doc/reference/tmpl/ephy-embed-persist.sgml (limited to 'doc') diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index cf981f0b6..0b0df505d 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -69,7 +69,6 @@ IGNORE_HFILES = \ ephy-download.h \ ephy-embed-dialog.h \ ephy-embed-event.h \ - ephy-embed-persist.h \ ephy-embed-popup-control.h \ ephy-embed-prefs.h \ ephy-embed-shell.h \ diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml index aa8abfa73..1d399f151 100644 --- a/doc/reference/epiphany-docs.sgml +++ b/doc/reference/epiphany-docs.sgml @@ -13,6 +13,7 @@ + Incomplete diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt index 3cb40f04e..398ef5c83 100644 --- a/doc/reference/epiphany-sections.txt +++ b/doc/reference/epiphany-sections.txt @@ -150,6 +150,39 @@ EPHY_EMBED_SINGLE_IFACE EPHY_IS_EMBED_SINGLE_IFACE +
+ephy-embed-persist +EphyEmbedPersist +EmbedPersistFlags +ephy_embed_persist_set_dest +ephy_embed_persist_set_embed +ephy_embed_persist_set_fc_title +ephy_embed_persist_set_fc_parent +ephy_embed_persist_set_flags +ephy_embed_persist_set_max_size +ephy_embed_persist_set_persist_key +ephy_embed_persist_set_source +ephy_embed_persist_get_dest +ephy_embed_persist_get_embed +ephy_embed_persist_get_fc_title +ephy_embed_persist_get_fc_parent +ephy_embed_persist_get_flags +ephy_embed_persist_get_max_size +ephy_embed_persist_get_persist_key +ephy_embed_persist_get_source +ephy_embed_persist_save +ephy_embed_persist_cancel +ephy_embed_persist_to_string + +EPHY_EMBED_PERSIST +EPHY_IS_EMBED_PERSIST +EPHY_TYPE_EMBED_PERSIST +ephy_embed_persist_get_type +EPHY_EMBED_PERSIST_CLASS +EPHY_IS_EMBED_PERSIST_CLASS +EPHY_EMBED_PERSIST_GET_CLASS +
+ diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types index 098dc3f66..58dd8ba78 100644 --- a/doc/reference/epiphany.types +++ b/doc/reference/epiphany.types @@ -30,6 +30,7 @@ ephy_cell_renderer_progress_get_type #include #include #include +#include ephy_embed_get_type downloader_view_get_type @@ -43,6 +44,7 @@ ephy_cookie_manager_get_type ephy_permission_manager_get_type ephy_password_manager_get_type mozilla_embed_get_type +mozilla_embed_persist_get_type #include #include diff --git a/doc/reference/tmpl/ephy-embed-persist.sgml b/doc/reference/tmpl/ephy-embed-persist.sgml new file mode 100644 index 000000000..be75437c8 --- /dev/null +++ b/doc/reference/tmpl/ephy-embed-persist.sgml @@ -0,0 +1,308 @@ + +EphyEmbedPersist + + +A class to download files + + + +An #EphyEmbedPersist is a relatively simple way to save a web page or file to +disk. It is an abstract class, implemented by #MozillaEmbedPersist. + + +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. + + + +Saving the current web page to disk +#]]> +# + +static void +save_source_completed_cb (EphyEmbedPersist *persist, + gpointer dummy) +{ + g_print ("Download to %]]> + + + + + + + + + + + +Determines how the #EphyEmbedPersist should act. + + +@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(). + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@Param2: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: +@Returns: + + + + + + + +@persist: + + + + + + + +@persist: +@Returns: + + + + + + + +@ephyembedpersist: the object which received the signal. + + + + + + +@ephyembedpersist: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + -- cgit v1.2.3