From eaa19fb5739761d835ccaad80f0266affcb971c4 Mon Sep 17 00:00:00 2001 From: Xan Lopez Date: Wed, 30 Dec 2009 21:07:02 +0100 Subject: Revert "docs: remove generated templates" This reverts commit 3deb6e06fd3cccaf26bca8c81bf1f83ef7993dd6. This broke distcheck. --- doc/reference/Makefile.am | 162 +++- doc/reference/tmpl/EphyContentPolicy.sgml | 19 + doc/reference/tmpl/EphySingle.sgml | 64 ++ doc/reference/tmpl/ephy-embed-factory.sgml | 34 + doc/reference/tmpl/ephy-embed-persist.sgml | 235 +++++ doc/reference/tmpl/ephy-embed-single.sgml | 69 ++ doc/reference/tmpl/ephy-embed.sgml | 399 +++++++++ doc/reference/tmpl/ephy-extensions-manager.sgml | 37 + doc/reference/tmpl/ephy-glade.sgml | 25 + doc/reference/tmpl/ephy-icon-entry.sgml | 53 ++ doc/reference/tmpl/ephy-location-entry.sgml | 217 +++++ doc/reference/tmpl/ephy-node-db.sgml | 123 +++ doc/reference/tmpl/ephy-password-manager.sgml | 78 ++ doc/reference/tmpl/ephy-permission-manager.sgml | 78 ++ doc/reference/tmpl/ephy-search-entry.sgml | 49 ++ doc/reference/tmpl/ephy-session.sgml | 84 ++ doc/reference/tmpl/ephy-shell.sgml | 129 +++ doc/reference/tmpl/ephy-spinner.sgml | 58 ++ doc/reference/tmpl/ephy-tab.sgml | 202 +++++ doc/reference/tmpl/ephy-window.sgml | 110 +++ doc/reference/tmpl/ephy-zoom-control.sgml | 56 ++ doc/reference/tmpl/epiphany-unused.sgml | 1043 +++++++++++++++++++++++ doc/reference/tmpl/mozilla-embed-event.sgml | 35 + 23 files changed, 3346 insertions(+), 13 deletions(-) create mode 100644 doc/reference/tmpl/EphyContentPolicy.sgml create mode 100644 doc/reference/tmpl/EphySingle.sgml create mode 100644 doc/reference/tmpl/ephy-embed-factory.sgml create mode 100644 doc/reference/tmpl/ephy-embed-persist.sgml create mode 100644 doc/reference/tmpl/ephy-embed-single.sgml create mode 100644 doc/reference/tmpl/ephy-embed.sgml create mode 100644 doc/reference/tmpl/ephy-extensions-manager.sgml create mode 100644 doc/reference/tmpl/ephy-glade.sgml create mode 100644 doc/reference/tmpl/ephy-icon-entry.sgml create mode 100644 doc/reference/tmpl/ephy-location-entry.sgml create mode 100644 doc/reference/tmpl/ephy-node-db.sgml create mode 100644 doc/reference/tmpl/ephy-password-manager.sgml create mode 100644 doc/reference/tmpl/ephy-permission-manager.sgml create mode 100644 doc/reference/tmpl/ephy-search-entry.sgml create mode 100644 doc/reference/tmpl/ephy-session.sgml create mode 100644 doc/reference/tmpl/ephy-shell.sgml create mode 100644 doc/reference/tmpl/ephy-spinner.sgml create mode 100644 doc/reference/tmpl/ephy-tab.sgml create mode 100644 doc/reference/tmpl/ephy-window.sgml create mode 100644 doc/reference/tmpl/ephy-zoom-control.sgml create mode 100644 doc/reference/tmpl/epiphany-unused.sgml create mode 100644 doc/reference/tmpl/mozilla-embed-event.sgml (limited to 'doc/reference') diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index d8c000c2c..ed9ae2aa5 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -9,21 +9,13 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # documenting functions and macros. DOC_SOURCE_DIR=../.. -# Extra options to pass to gtkdoc-scangobj. Not normally needed. -SCANGOBJ_OPTIONS="--type-init-func=g_thread_init(NULL);g_type_init()" - # Extra options to supply to gtkdoc-scan. SCAN_OPTIONS= # Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS=--sgml-mode --output-format=xml --source-suffixes=h,c - -# Extra options to supply to gtkdoc-mktmpl -# e.g. MKTMPL_OPTIONS=--only-section-tmpl -MKTMPL_OPTIONS= +MKDB_OPTIONS=--sgml-mode --output-format=xml -# Extra options to supply to gtkdoc-fixref. Not normally needed. -# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +# Extra options to supply to gtkdoc-fixref. FIXXREF_OPTIONS= # Used for dependencies. @@ -134,7 +126,7 @@ GTKDOC_LIBS = \ $(top_builddir)/lib/widgets/libephywidgets.la \ $(top_builddir)/lib/libephymisc.la \ $(top_builddir)/lib/egg/libegg.la \ - $(DEPENDENCIES_LIBS) \ + $(DEPENDENCIES_LIBS) \ $(DBUS_LIBS) \ $(LIBINTL) @@ -152,5 +144,149 @@ endif # $(DOC_MODULE)-overrides.txt file and uncomment the second line here. DOC_OVERRIDES = -# This includes the standard gtk-doc make rules, copied by gtkdocize. -include $(top_srcdir)/gtk-doc.make +# include common portion ... +# include $(top_srcdir)/gtk-doc.make +# We need to copy/paste this to be able to change LD_LIBRARY_PATH + +if GTK_DOC_USE_LIBTOOL +GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) +GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) +else +GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) +GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) +endif + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) + +TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) + +EXTRA_DIST = \ + $(content_files) \ + $(HTML_IMAGES) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE).types \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + +DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \ + $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-scan.o $(DOC_MODULE)-unused.txt $(DOC_STAMPS) + +if ENABLE_GTK_DOC +all-local: html-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) + @echo '*** Scanning header files ***' + @-chmod -R u+w $(srcdir) + if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ + else \ + cd $(srcdir) ; \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo '*** Rebuilding template files ***' + @-chmod -R u+w $(srcdir) + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml + @echo '*** Building XML ***' + @-chmod -R u+w $(srcdir) + cd $(srcdir) && \ + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml $(MKDB_OPTIONS) + touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo '*** Building HTML ***' + @-chmod -R u+w $(srcdir) + rm -rf $(srcdir)/html + mkdir $(srcdir)/html + cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) + @echo '-- Fixing Crossreferences' + cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + touch html-build.stamp +endif + +############## + +clean-local: + rm -f *~ *.bak + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +install-data-local: + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*`; \ + if test "$$installfiles" = '$(srcdir)/html/*'; \ + then echo '-- Nothing to install' ; \ + else \ + for i in $$installfiles; do \ + echo '-- Installing '$$i ; \ + $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ + done; \ + echo '-- Installing $(srcdir)/html/index.sgml' ; \ + $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \ + fi) + +uninstall-local: + rm -f $(DESTDIR)$(TARGET_DIR)/* + +# +# Require gtk-doc when making dist +# +if ENABLE_GTK_DOC +dist-check-gtkdoc: +else +dist-check-gtkdoc: + @echo "*** gtk-doc must be installed and enabled in order to make dist" + @false +endif + +dist-hook: dist-check-gtkdoc dist-hook-local + mkdir $(distdir)/tmpl + mkdir $(distdir)/xml + mkdir $(distdir)/html + -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + -cp $(srcdir)/xml/*.xml $(distdir)/xml + -cp $(srcdir)/html/* $(distdir)/html + +.PHONY : dist-hook-local diff --git a/doc/reference/tmpl/EphyContentPolicy.sgml b/doc/reference/tmpl/EphyContentPolicy.sgml new file mode 100644 index 000000000..5cd2d4f61 --- /dev/null +++ b/doc/reference/tmpl/EphyContentPolicy.sgml @@ -0,0 +1,19 @@ + +EphyContentPolicy + + + + + + + + + + + + + + + + + diff --git a/doc/reference/tmpl/EphySingle.sgml b/doc/reference/tmpl/EphySingle.sgml new file mode 100644 index 000000000..5ecfb7239 --- /dev/null +++ b/doc/reference/tmpl/EphySingle.sgml @@ -0,0 +1,64 @@ + +EphySingle + + + + + + + + + + + + + + + + + + + + + + +@aOwner: +@Returns: + + + + + + + +@Returns: + + + + + + + +@name: +@aSubject: +@Returns: + + + + + + + +@cookie: +@Returns: + + + + + + + +@perm: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-embed-factory.sgml b/doc/reference/tmpl/ephy-embed-factory.sgml new file mode 100644 index 000000000..eda17fe3a --- /dev/null +++ b/doc/reference/tmpl/ephy-embed-factory.sgml @@ -0,0 +1,34 @@ + +EphyEmbedFactory + + +Factory for creating new embed objects + + + +#EphyEmbed, #EphyEmbedPersist and #EphyEmbedSingle are all interfaces. In the +interest of abstraction, the only recommended way to create new instances of +the objects which implement these interfaces is to use #EphyEmbedFactory. + + +To create a new instance of an #EphyEmbed, #EphyEmbedPersist or +#EphyEmbedSingle, use ephy_embed_factory_new_object(). + + + + + + + + + + + + + + + +@type: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-embed-persist.sgml b/doc/reference/tmpl/ephy-embed-persist.sgml new file mode 100644 index 000000000..32fa72e63 --- /dev/null +++ b/doc/reference/tmpl/ephy-embed-persist.sgml @@ -0,0 +1,235 @@ + +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 %]]> + + + + + + + + + + + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@persist: +@value: + + + + + + + +@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: + + diff --git a/doc/reference/tmpl/ephy-embed-single.sgml b/doc/reference/tmpl/ephy-embed-single.sgml new file mode 100644 index 000000000..e49aa628b --- /dev/null +++ b/doc/reference/tmpl/ephy-embed-single.sgml @@ -0,0 +1,69 @@ + +EphyEmbedSingle + + +An interface to the global embedded browser + + + +While Epiphany is running, its global embed_shell variable (an #EphyEmbedShell) +holds a reference to an #EphyEmbedSingle. The only class which implements +#EphyEmbedSingle is #MozillaEmbedSingle, so the two types are interchangeable +via casting. + + + +Acquiring an <structname>EphyEmbedSingle</structname> +#]]> +# + +EphyEmbedSingle *ephy_single; + +/* embed_shell is a global variable, initialized as Epiphany starts */ +ephy_single = ephy_embed_shell_get_embed_single (embed_shell); +]]> + + + +Since there is only one #EphyEmbedShell, there is only one #EphyEmbedSingle. It +is used to perform browser-related actions which do not refer to an individual +#EphyEmbed. + + + + + + + + + + + + + + + +@single: + + + + + + + +@single: + + + + + + + +@single: +@parent: +@address: +@name: +@features: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml new file mode 100644 index 000000000..bfa4157ee --- /dev/null +++ b/doc/reference/tmpl/ephy-embed.sgml @@ -0,0 +1,399 @@ + +EphyEmbed + + +An interface to the widget displaying web pages + + + +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. + + +#EphyEmbed's most important functions can be divided into sets: + + +Functions which affect navigation +Functions which return information about the displayed web +page +Functions which manipulate the session history + +The first two sets of functions are self-explanitory. +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. + + + +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). + + + + + + + + + + + + + + + + +@ephyembed: the object which received the signal. +@Returns: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@Returns: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@Returns: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@Returns: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@arg2: +@arg3: + + + + + + +@ephyembed: the object which received the signal. +@Returns: + + + + + + +@ephyembed: the object which received the signal. + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@arg2: +@arg3: + + + + + + +@ephyembed: the object which received the signal. +@event: +@Returns: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@arg2: +@arg3: + + + + + + +@ephyembed: the object which received the signal. +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@: +@Param2: + + + + + + +@base_iface: +@context_menu: +@favicon: +@feed_link: +@search_link: +@dom_mouse_click: +@dom_mouse_down: +@dom_content_loaded: +@popup_blocked: +@content_blocked: +@modal_alert: +@modal_alert_closed: +@document_type: +@new_window: +@search_key_press: +@close_request: +@new_document_now: +@load_url: +@load: +@can_go_up: +@get_go_up_list: +@go_up: +@get_title: +@get_location: +@get_link_message: +@get_js_status: +@get_security_level: +@show_page_certificate: +@set_print_preview_mode: +@print_preview_n_pages: +@print_preview_navigate: +@has_modified_forms: +@get_document_type: +@get_load_percent: +@get_load_status: +@get_navigation_flags: +@get_typed_address: +@set_typed_address: +@get_address: +@get_status_message: +@get_icon: +@get_icon_address: +@get_is_blank: +@get_loading_title: +@get_visibility: + + + +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. + + +@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: + + + + + + +@embed: +@url: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: +@toplevel: +@Returns: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: + + + + + + + +@embed: +@level: +@description: + + + + + + + +@embed: +@Returns: + + + + + + + +@embed: +@type: +@page: + + + + + + + +@embed: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-extensions-manager.sgml b/doc/reference/tmpl/ephy-extensions-manager.sgml new file mode 100644 index 000000000..e7d7c7bae --- /dev/null +++ b/doc/reference/tmpl/ephy-extensions-manager.sgml @@ -0,0 +1,37 @@ + +EphyExtensionsManager + + + + + + + + + + + + + + + + + + + + + + +@manager: +@identifier: + + + + + + + +@manager: +@identifier: + + diff --git a/doc/reference/tmpl/ephy-glade.sgml b/doc/reference/tmpl/ephy-glade.sgml new file mode 100644 index 000000000..96c99456f --- /dev/null +++ b/doc/reference/tmpl/ephy-glade.sgml @@ -0,0 +1,25 @@ + +EphyGlade + + +Load a glade XML definition + + + +Epiphany has its own convenience wrapper around glade_xml_new() which will +automatically connect all a widget's signals and return the #GtkWidget root +object. + + +After retrieving a #GladeXML object from ephy_glade_widget_new(), regular +#GladeXML functions can be called on that object. + + + + + + + + + + diff --git a/doc/reference/tmpl/ephy-icon-entry.sgml b/doc/reference/tmpl/ephy-icon-entry.sgml new file mode 100644 index 000000000..6ed857e9f --- /dev/null +++ b/doc/reference/tmpl/ephy-icon-entry.sgml @@ -0,0 +1,53 @@ + +EphyIconEntry + + + + + + + + + + + + + + + + + + + + + + +@entry: + + + + + + +@Returns: + + + + + + + +@entry: +@widget: +@start: + + + + + + + +@entry: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-location-entry.sgml b/doc/reference/tmpl/ephy-location-entry.sgml new file mode 100644 index 000000000..c9c7e42c6 --- /dev/null +++ b/doc/reference/tmpl/ephy-location-entry.sgml @@ -0,0 +1,217 @@ + +EphyLocationEntry + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@ephylocationentry: the object which received the signal. +@Returns: + + + + + + +@ephylocationentry: the object which received the signal. +@Returns: + + + + + + +@ephylocationentry: the object which received the signal. + + + + + + +@ephylocationentry: the object which received the signal. + + + + + + + + + + + + + + + + +@entry: +@address: +@typed_address: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: + + + + + + + +@entry: +@Returns: + + + + + + + +@entry: + + + + + + + +@entry: +@pixbuf: + + + + + + + +@entry: +@secure: + + + + + + + +@entry: +@show_lock: + + + + + + + +@entry: +@stock_id: + + + + + + + +@entry: +@tooltip: + + + + + + + +@entry: +@model: +@text_col: +@action_col: +@keywords_col: +@relevance_col: +@url_col: +@extra_col: +@favicon_col: + + + + + + + +@entry: +@match_func: +@user_data: +@notify: + + diff --git a/doc/reference/tmpl/ephy-node-db.sgml b/doc/reference/tmpl/ephy-node-db.sgml new file mode 100644 index 000000000..49bc95913 --- /dev/null +++ b/doc/reference/tmpl/ephy-node-db.sgml @@ -0,0 +1,123 @@ + +EphyNodeDb + + +Data tree + + + +An #EphyNodeDb is a database for arbitrary data organized in a tree. + + +Each database is stored along with its name in a global set of databases. +Databases can be created using ephy_node_db_new() and retrieved using +ephy_node_db_get_by_name(). + + +Each #EphyNode inside an #EphyNodeDb is identified by a unique node ID. By +keeping a handle on the ID, one can use ephy_node_db_get_node_from_id() to +retrieve its corresponding #EphyNode. + + +#EphyNodeDbs can be saved to disk using ephy_node_db_write_to_xml_safe() +and restored using ephy_node_db_load_from_file(). + + + + + + + + + + + + + + + + + + +%TRUE if no #EphyNodes can be added, removed or modified from this +#EphyNodeDb + + + + +A string identifier unique to this #EphyNodeDb + + + + + + + +@name: +@Returns: + + + + + + + +@db: +@xml_file: +@xml_root: +@xml_version: +@Returns: + + + + + + + +@db: +@filename: +@root: +@version: +@comment: +@node: +@Varargs: +@Returns: + + + + + + + +@db: +@Returns: + + + + + + + +@db: +@Returns: + + + + + + + +@db: +@immutable: + + + + + + + +@db: +@id: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-password-manager.sgml b/doc/reference/tmpl/ephy-password-manager.sgml new file mode 100644 index 000000000..bfb3f287a --- /dev/null +++ b/doc/reference/tmpl/ephy-password-manager.sgml @@ -0,0 +1,78 @@ + +ephy-password-manager + + + + + + + + + + + + + + + + + + + + + + +@k: + + + + + + + +@k: + + + + + + + + + + + + + + +@host: +@username: +@password: +@Returns: + + + + + + + +@info: +@Returns: + + + + + + + +@info: + + + + + + + +@Returns: + + diff --git a/doc/reference/tmpl/ephy-permission-manager.sgml b/doc/reference/tmpl/ephy-permission-manager.sgml new file mode 100644 index 000000000..ded9a0742 --- /dev/null +++ b/doc/reference/tmpl/ephy-permission-manager.sgml @@ -0,0 +1,78 @@ + +EphyPermissionManager + + +Sets webpages' cookie, image and popup permissions. + + + +The #EphyPermissionManager keeps a list of websites and their permissions. For +example, the user may want a certain website to display images but block +cookies and popup windows; this could correspond to three entries in the +#EphyPermissionManager. + + +Use ephy_permission_manager_add() to set permissions for a website, +ephy_permission_manager_remove() to remove the permissions, and +ephy_permission_manager_test() to test them. Note that +ephy_permission_manager_test() may return %EPHY_PERMISSION_DEFAULT, which +means the caller might need to find the default permission some other way. + + +The #EphyPermissionManager stores a list of site-specific permissions, but not +defaults. For popups, the default permission is determined by the GConf key +/apps/epiphany/web/allow_popups, which in turn determines Mozilla's +dom.disable_open_during_load preference. For cookies, the GConf key +/apps/epiphany/web/cookie_accept determines Mozilla's +network.cookie.cookieBehavior preference. For images, the default is determined +by Mozilla's network.image.imageBehavior preference. + + +The predefined permission types are EPT_COOKIE ("cookie"), EPT_IMAGE ("image") +and EPT_POPUP ("popup"). You can also make up your own type string. + + +Though the word "host" is used in many function descriptions, Mozilla +does not act as one would expect. Always pass a URL to any functions which +need have a "host" parameter. However, the "host" in an +#EphyPermissionInfo is a simple DNS hostname. + + + + + + + + + + + + +Details a specific permission of a specific website. + + +@host: The hostname of the website to which this permission applies. +@qtype: +@permission: An #EphyPermission (either allow or deny). + + + +Determines whether the website is allowed or denied access. + + +@EPHY_PERMISSION_ALLOWED: + The website is unconditionally allowed to perform the desired action. +@EPHY_PERMISSION_DENIED: + The website is unconditionally denied to perform the desired action. +@EPHY_PERMISSION_DEFAULT: + The user has not set a preference for this particular website; the + caller should therefore fall back to default settings. + + + + + + +@info: + + diff --git a/doc/reference/tmpl/ephy-search-entry.sgml b/doc/reference/tmpl/ephy-search-entry.sgml new file mode 100644 index 000000000..d0b12203a --- /dev/null +++ b/doc/reference/tmpl/ephy-search-entry.sgml @@ -0,0 +1,49 @@ + +EphySearchEntry + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@ephysearchentry: the object which received the signal. +@arg1: + + + + + + +@Returns: + + + + + + + +@entry: + + diff --git a/doc/reference/tmpl/ephy-session.sgml b/doc/reference/tmpl/ephy-session.sgml new file mode 100644 index 000000000..ce97b6371 --- /dev/null +++ b/doc/reference/tmpl/ephy-session.sgml @@ -0,0 +1,84 @@ + +ephy-session + + + + + + + + + + + + + + + + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@filename: +@Returns: + + + + + + + +@session: +@filename: +@user_time: +@Returns: + + + + + + + +@session: + + + + + + + +@session: +@Returns: + + + + + + + +@session: +@window: + + + + + + + +@session: +@window: + + diff --git a/doc/reference/tmpl/ephy-shell.sgml b/doc/reference/tmpl/ephy-shell.sgml new file mode 100644 index 000000000..f50e4bcfa --- /dev/null +++ b/doc/reference/tmpl/ephy-shell.sgml @@ -0,0 +1,129 @@ + +ephy-shell + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@EPHY_NEW_TAB_HOME_PAGE: +@EPHY_NEW_TAB_NEW_PAGE: +@EPHY_NEW_TAB_OPEN_PAGE: +@EPHY_NEW_TAB_FULLSCREEN_MODE: +@EPHY_NEW_TAB_DONT_SHOW_WINDOW: +@EPHY_NEW_TAB_APPEND_LAST: +@EPHY_NEW_TAB_APPEND_AFTER: +@EPHY_NEW_TAB_JUMP: +@EPHY_NEW_TAB_IN_NEW_WINDOW: +@EPHY_NEW_TAB_IN_EXISTING_WINDOW: +@EPHY_NEW_TAB_ALLOW_FIXUP: +@EPHY_NEW_TAB_FROM_EXTERNAL: + + + + + + +@shell: +@parent_window: +@previous_embed: +@url: +@flags: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@fullscreen: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@Returns: + + + + + + + +@shell: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-spinner.sgml b/doc/reference/tmpl/ephy-spinner.sgml new file mode 100644 index 000000000..170eeb0c1 --- /dev/null +++ b/doc/reference/tmpl/ephy-spinner.sgml @@ -0,0 +1,58 @@ + +EphySpinner + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@throbber: + + + + + + + +@throbber: + + + + + + + +@spinner: +@size: + + diff --git a/doc/reference/tmpl/ephy-tab.sgml b/doc/reference/tmpl/ephy-tab.sgml new file mode 100644 index 000000000..7b9bf485f --- /dev/null +++ b/doc/reference/tmpl/ephy-tab.sgml @@ -0,0 +1,202 @@ + +EphyTab + + +Represents an Epiphany tab + + + +Each #EphyWindow contains a #GtkNotebook which holds one or more #EphyTab:s. +An #EphyTab is basically a container for an #EphyEmbed. + + +To retrieve an #EphyTab's parent #EphyWindow, use gtk_widget_get_toplevel(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@embed: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + + + + + + +@tab: +@Returns: + + diff --git a/doc/reference/tmpl/ephy-window.sgml b/doc/reference/tmpl/ephy-window.sgml new file mode 100644 index 000000000..23c9b1e2d --- /dev/null +++ b/doc/reference/tmpl/ephy-window.sgml @@ -0,0 +1,110 @@ + +EphyWindow + + +Represents an Epiphany window. + + + +An #EphyWindow is what the user sees when opening Epiphany. Think of each +#EphyWindow as a giant container which holds many useful items: + + +A toolbar, available from ephy_window_get_toolbar(). +An #EphyStatusbar, available from +ephy_window_get_statusbar(). +A #GtkNotebook for holding #EphyTabs. Use ephy_window_get_notebook(), +ephy_window_get_tabs() and ephy_window_get_active_tab() to reach +them. Manipulate tabs using ephy_window_add_tab(), ephy_window_remove_tab() +and ephy_window_jump_to_tab(). + + +You can also perform simple manipulations of an #EphyWindow's active #EphyEmbed. +These are restricted to ephy_window_set_zoom() and ephy_window_load_url(). + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@chrome: +@is_popup: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@zoom: + + + + + + + +@window: + + + + + + + +@window: +@url: + + diff --git a/doc/reference/tmpl/ephy-zoom-control.sgml b/doc/reference/tmpl/ephy-zoom-control.sgml new file mode 100644 index 000000000..fcad1c60a --- /dev/null +++ b/doc/reference/tmpl/ephy-zoom-control.sgml @@ -0,0 +1,56 @@ + +EphyZoomControl + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@ephyzoomcontrol: the object which received the signal. +@arg1: + + + + + + + + + + + +@control: +@zoom: + + + + + + + +@control: +@Returns: + + diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml new file mode 100644 index 000000000..ff95f58a9 --- /dev/null +++ b/doc/reference/tmpl/epiphany-unused.sgml @@ -0,0 +1,1043 @@ + + + + + + + + + + + + + + + + + + + + + +EphySingle + + + + +Each #EphyWindow contains a #GtkNotebook which holds one or more #EphyTab:s. +An #EphyTab is basically a container for an #EphyEmbed. + + +To retrieve an #EphyTab's parent #EphyWindow, use gtk_widget_get_toplevel(). + + + + + + + + + + +Represents an Epiphany tab + + + + + + + +EphyTab + + + + + + + + + + + + + + + + + + + + + + + +mozilla-embed-event + + + + + + + +@Returns: + + + + + + +@k: + + + + + + +@object: + + + + + + +@klass: + + + + + + +@obj: + + + + + + +@k: + + + + + + +@object: + + + + + + +@klass: + + + + + + + + + + + + + + + + + + + + + +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(). +@EMBED_PERSIST_DO_CONVERSION: + + + +Specifies the action to perform in ephy_embed_print_preview_navigate(). + + +@PRINTPREVIEW_GOTO_PAGENUM: +@PRINTPREVIEW_PREV_PAGE: +@PRINTPREVIEW_NEXT_PAGE: +@PRINTPREVIEW_HOME: +@PRINTPREVIEW_END: + + + + + + +@EMBED_RELOAD_NORMAL: +@EMBED_RELOAD_FORCE: Bypass cache and proxy while reloading a web page + + + +Represents the security status of an #EphyEmbed. For example, a page with an +invalid SSL certificate will have an #EmbedSecurityLevel of %STATE_IS_BROKEN. + + +@STATE_IS_UNKNOWN: +@STATE_IS_INSECURE: +@STATE_IS_BROKEN: +@STATE_IS_SECURE_MED: +@STATE_IS_SECURE_LOW: +@STATE_IS_SECURE_HIGH: + + + +Represents the state of an #EphyEmbed with regards to networking negotiations. + + +@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: + + + + + + +@name: +@aSubject: +@Returns: + + + + + + +@name: +@aSubject: +@Returns: + + + + + + +@EPHY_COOKIE_P3P_POLICY_UNKNOWN: +@EPHY_COOKIE_P3P_POLICY_NONE: +@EPHY_COOKIE_P3P_POLICY_NO_CONSENT: +@EPHY_COOKIE_P3P_POLICY_IMPLICIT_CONSENT: +@EPHY_COOKIE_P3P_POLICY_EXPLICIT_CONSENT: +@EPHY_COOKIE_P3P_POLICY_NO_II: + + + + + + +@EPHY_COOKIE_P3P_STATE_UNKNOWN: +@EPHY_COOKIE_P3P_STATE_ACCEPTED: +@EPHY_COOKIE_P3P_STATE_DOWNGRADED: +@EPHY_COOKIE_P3P_STATE_FLAGGED: +@EPHY_COOKIE_P3P_STATE_REJECTED: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: +@arg2: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembed: the object which received the signal. +@arg1: + + + + + + +@ephyembedpersist: the object which received the signal. + + + + + + +@ephyembedpersist: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@EPHY_SHELL_ERROR_MISSING_SERVER: +@EPHY_SHELL_ERROR_OBJECT_REG_FAILED: +@EPHY_SHELL_ERROR_FACTORY_REG_FAILED: + + + + + + +@EPHY_SHELL_STARTUP_TABS: +@EPHY_SHELL_STARTUP_EXISTING_WINDOW: +@EPHY_SHELL_STARTUP_FULLSCREEN: +@EPHY_SHELL_STARTUP_BOOKMARKS_EDITOR: +@EPHY_SHELL_STARTUP_SESSION: +@EPHY_SHELL_STARTUP_IMPORT_BOOKMARKS: +@EPHY_SHELL_STARTUP_ADD_BOOKMARK: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@aOwner: +@Returns: + + + + + + +@embed: + + + + + + +@embed: +@Returns: + + + + + + +@embed: +@Returns: + + + + + + +@embed: +@backwards: +@Returns: + + + + + + +@find: +@search_string: +@case_sensitive: + + + + + + +@embed: +@Returns: + + + + + + +@Returns: + + + + + + +@embed: +@Returns: + + + + + + +@embed: + + + + + + +@embed: + + + + + + +@embed: + + + + + + +@embed: + + + + + + +@embed: +@force: + + + + + + +@embed: +@zoom: + + + + + + +@single: +@url: +@shell: + + + + + + +@single: +@offline: +@shell: + + + + + + +@embed: + + + + + + +@manager: +@type: +@Returns: + + + + + + +@manager: +@path: + + + + + + +@Returns: + + + + + + +@file: +@widget_name: +@root: +@data: +@domain: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@manager: +@info: + + + + + + +@manager: +@Returns: + + + + + + +@manager: +@info: + + + + + + +@manager: +@host: +@type: +@permission: + + + + + + +@manager: + + + + + + +@manager: +@type: +@Returns: + + + + + + +@manager: +@host: +@type: + + + + + + +@manager: +@host: +@type: +@Returns: + + + + + + +@session: +@user_time: +@Returns: + + + + + + +@shell: +@path: +@gs: + + + + + + +@Returns: + + + + + + +@shell: +@Returns: + + + + + + +@shell: +@Returns: + + + + + + +@Returns: + + + + + + +@shell: +@flags: +@user_time: +@args: +@string_arg: +@error: +@Returns: +@startup_id: + + + + + + +@embed: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@tab: +@Returns: + + + + + + +@Returns: + + + + + + +@window: +@tab: +@position: +@jump_to: + + + + + + +@window: + + + + + + +@window: +@Returns: + + + + + + +@window: +@Returns: + + + + + + +@window: +@Returns: + + + + + + +@window: +@tab: + + + + + + +@window: + + + + + + +@window: +@tab: + + + + + + +@window: +@enabled: + + + + + + +@cookie: +@Returns: + + + + + + +@dom_event: +@Returns: + + + + + + +@event: +@name: +@value: + + + + + + +@perm: +@Returns: + diff --git a/doc/reference/tmpl/mozilla-embed-event.sgml b/doc/reference/tmpl/mozilla-embed-event.sgml new file mode 100644 index 000000000..d8aa00dd3 --- /dev/null +++ b/doc/reference/tmpl/mozilla-embed-event.sgml @@ -0,0 +1,35 @@ + +mozilla-embed-event + + + + + + + + + + + + + + + + + + + +@dom_event: +@Returns: + + + + + + + +@event: +@name: +@value: + + -- cgit