aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDiego Escalante Urrelo <diegoe@src.gnome.org>2008-09-29 13:54:00 +0800
committerDiego Escalante Urrelo <diegoe@src.gnome.org>2008-09-29 13:54:00 +0800
commit5e8354c9b2d7f8826148f2c8e341af14cdf87f8c (patch)
treedc0dba8120a56acd6c075cc112cf57c7b2c01205 /doc
parent829422676119b9409fab423f481a5a43d9838e45 (diff)
downloadgsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar.gz
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar.bz2
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar.lz
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar.xz
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.tar.zst
gsoc2013-epiphany-5e8354c9b2d7f8826148f2c8e341af14cdf87f8c.zip
Enable documentation build for ephy-location-entry
Conflicts: doc/reference/epiphany-sections.txt doc/reference/tmpl/EphySingle.sgml doc/reference/tmpl/ephy-embed.sgml doc/reference/tmpl/epiphany-unused.sgml svn path=/trunk/; revision=8558
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/Makefile.am1
-rw-r--r--doc/reference/epiphany-docs.sgml1
-rw-r--r--doc/reference/epiphany-sections.txt20
-rw-r--r--doc/reference/tmpl/EphySingle.sgml2
-rw-r--r--doc/reference/tmpl/ephy-embed.sgml115
-rw-r--r--doc/reference/tmpl/ephy-location-entry.sgml171
-rw-r--r--doc/reference/tmpl/epiphany-unused.sgml94
7 files changed, 341 insertions, 63 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 1314c1c6b..18ccdf608 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -42,7 +42,6 @@ IGNORE_HFILES = \
ephy-stock-icons.h \
ephy-string.h \
ephy-zoom.h \
- ephy-location-entry.h \
ephy-node-view.h \
ephy-search-entry.h \
ephy-spinner.h \
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index ba3b13b3c..dd19bdefe 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -19,6 +19,7 @@
<xi:include href="xml/ephy-node-db.xml"/>
<xi:include href="xml/ephy-glade.xml"/>
<xi:include href="xml/ephy-extensions-manager.xml"/>
+ <xi:include href="xml/ephy-location-entry.xml"/>
</chapter>
<chapter>
<title>Incomplete</title>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index fe8a9e580..7755f29ff 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -321,3 +321,23 @@ EPHY_CONTENT_POLICY_CONTRACTID
EPHY_CONTENT_POLICY_CLASSNAME
EPHY_CONTENT_POLICY_CID
</SECTION>
+
+<SECTION>
+<FILE>ephy-location-entry</FILE>
+ephy_location_entry_set_location
+ephy_location_entry_get_location
+ephy_location_entry_get_can_undo
+ephy_location_entry_get_can_redo
+ephy_location_entry_get_entry
+ephy_location_entry_get_regex
+ephy_location_entry_activate
+ephy_location_entry_reset
+ephy_location_entry_undo_reset
+ephy_location_entry_set_favicon
+ephy_location_entry_set_secure
+ephy_location_entry_set_show_lock
+ephy_location_entry_set_lock_stock
+ephy_location_entry_set_lock_tooltip
+ephy_location_entry_set_completion
+ephy_location_entry_set_match_func
+</SECTION>
diff --git a/doc/reference/tmpl/EphySingle.sgml b/doc/reference/tmpl/EphySingle.sgml
index 34ed07e52..5ecfb7239 100644
--- a/doc/reference/tmpl/EphySingle.sgml
+++ b/doc/reference/tmpl/EphySingle.sgml
@@ -22,7 +22,7 @@ EphySingle
</para>
-@aHistory:
+@aOwner:
@Returns:
diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml
index 7ca391b43..1bf03ce71 100644
--- a/doc/reference/tmpl/ephy-embed.sgml
+++ b/doc/reference/tmpl/ephy-embed.sgml
@@ -174,6 +174,14 @@ be done by casting).
@arg2:
@arg3:
+<!-- ##### SIGNAL EphyEmbed::ge-zoom-change ##### -->
+<para>
+
+</para>
+
+@ephyembed: the object which received the signal.
+@arg1:
+
<!-- ##### SIGNAL EphyEmbed::new-document-now ##### -->
<para>
@@ -241,20 +249,6 @@ be done by casting).
@:
@:
@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
-@:
@:
@Param2:
@@ -272,6 +266,7 @@ be done by casting).
@dom_mouse_down:
@dom_content_loaded:
@popup_blocked:
+@zoom_change:
@content_blocked:
@modal_alert:
@modal_alert_closed:
@@ -282,8 +277,14 @@ be done by casting).
@new_document_now:
@load_url:
@load:
+@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:
@@ -292,16 +293,20 @@ be done by casting).
@shistory_copy:
@get_security_level:
@show_page_certificate:
+@set_zoom:
+@get_zoom:
@scroll_lines:
@scroll_pages:
@scroll_pixels:
@get_encoding:
@has_automatic_encoding:
@set_encoding:
+@print:
@set_print_preview_mode:
@print_preview_n_pages:
@print_preview_navigate:
@has_modified_forms:
+@close:
@get_document_type:
@get_load_percent:
@get_load_status:
@@ -315,6 +320,11 @@ be done by casting).
@get_is_blank:
@get_loading_title:
@get_visibility:
+@get_backward_history:
+@get_forward_history:
+@get_next_history_item:
+@get_previous_history_item:
+@go_to_history_item:
<!-- ##### ENUM EphyEmbedChrome ##### -->
<para>
@@ -340,6 +350,23 @@ windows opened with JavaScript often use a nonstandard chrome.
@url:
+<!-- ##### FUNCTION ephy_embed_stop_load ##### -->
+<para>
+
+</para>
+
+@embed:
+
+
+<!-- ##### FUNCTION ephy_embed_reload ##### -->
+<para>
+
+</para>
+
+@embed:
+@force:
+
+
<!-- ##### FUNCTION ephy_embed_get_title ##### -->
<para>
@@ -377,6 +404,24 @@ windows opened with JavaScript often use a nonstandard chrome.
@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>
@@ -395,6 +440,22 @@ windows opened with JavaScript often use a nonstandard chrome.
@Returns:
+<!-- ##### FUNCTION ephy_embed_go_back ##### -->
+<para>
+
+</para>
+
+@embed:
+
+
+<!-- ##### FUNCTION ephy_embed_go_forward ##### -->
+<para>
+
+</para>
+
+@embed:
+
+
<!-- ##### FUNCTION ephy_embed_go_up ##### -->
<para>
@@ -413,6 +474,24 @@ windows opened with JavaScript often use a nonstandard chrome.
@description:
+<!-- ##### FUNCTION ephy_embed_set_zoom ##### -->
+<para>
+
+</para>
+
+@embed:
+@zoom:
+
+
+<!-- ##### FUNCTION ephy_embed_get_zoom ##### -->
+<para>
+
+</para>
+
+@embed:
+@Returns:
+
+
<!-- ##### FUNCTION ephy_embed_find_set_properties ##### -->
<para>
@@ -432,6 +511,14 @@ windows opened with JavaScript often use a nonstandard chrome.
@encoding:
+<!-- ##### FUNCTION ephy_embed_print ##### -->
+<para>
+
+</para>
+
+@embed:
+
+
<!-- ##### FUNCTION ephy_embed_print_preview_n_pages ##### -->
<para>
diff --git a/doc/reference/tmpl/ephy-location-entry.sgml b/doc/reference/tmpl/ephy-location-entry.sgml
new file mode 100644
index 000000000..14a636e77
--- /dev/null
+++ b/doc/reference/tmpl/ephy-location-entry.sgml
@@ -0,0 +1,171 @@
+<!-- ##### SECTION Title ##### -->
+ephy-location-entry
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_location ##### -->
+<para>
+
+</para>
+
+@entry:
+@address:
+@typed_address:
+
+
+<!-- ##### FUNCTION ephy_location_entry_get_location ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_get_can_undo ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_get_can_redo ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_get_entry ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_get_regex ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_activate ##### -->
+<para>
+
+</para>
+
+@entry:
+
+
+<!-- ##### FUNCTION ephy_location_entry_reset ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_location_entry_undo_reset ##### -->
+<para>
+
+</para>
+
+@entry:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_favicon ##### -->
+<para>
+
+</para>
+
+@entry:
+@pixbuf:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_secure ##### -->
+<para>
+
+</para>
+
+@entry:
+@secure:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_show_lock ##### -->
+<para>
+
+</para>
+
+@entry:
+@show_lock:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_lock_stock ##### -->
+<para>
+
+</para>
+
+@entry:
+@stock_id:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_lock_tooltip ##### -->
+<para>
+
+</para>
+
+@entry:
+@tooltip:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_completion ##### -->
+<para>
+
+</para>
+
+@entry:
+@model:
+@text_col:
+@action_col:
+@keywords_col:
+@relevance_col:
+@url_col:
+@extra_col:
+@favicon_col:
+
+
+<!-- ##### FUNCTION ephy_location_entry_set_match_func ##### -->
+<para>
+
+</para>
+
+@entry:
+@match_func:
+@user_data:
+@notify:
+
+
diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml
index 5845cba32..3f3a7d006 100644
--- a/doc/reference/tmpl/epiphany-unused.sgml
+++ b/doc/reference/tmpl/epiphany-unused.sgml
@@ -1,25 +1,25 @@
-<!-- ##### SECTION ./tmpl/EphySingle.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/ephy-icon-entry.sgml:Long_Description ##### -->
<para>
</para>
-<!-- ##### SECTION ./tmpl/EphySingle.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/ephy-icon-entry.sgml:See_Also ##### -->
<para>
</para>
-<!-- ##### SECTION ./tmpl/EphySingle.sgml:Short_Description ##### -->
+<!-- ##### SECTION ./tmpl/ephy-icon-entry.sgml:Short_Description ##### -->
-<!-- ##### SECTION ./tmpl/EphySingle.sgml:Stability_Level ##### -->
+<!-- ##### SECTION ./tmpl/ephy-icon-entry.sgml:Stability_Level ##### -->
-<!-- ##### SECTION ./tmpl/EphySingle.sgml:Title ##### -->
-EphySingle
+<!-- ##### SECTION ./tmpl/ephy-icon-entry.sgml:Title ##### -->
+EphyIconEntry
<!-- ##### SECTION ./tmpl/ephy-tab.sgml:Long_Description ##### -->
@@ -74,44 +74,54 @@ EphyTab
mozilla-embed-event
-<!-- ##### FUNCTION Detach ##### -->
+<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
<para>
</para>
-@Returns:
+@k:
-<!-- ##### MACRO EPHY_CONTENT_POLICY_CID ##### -->
+<!-- ##### MACRO EPHY_ICON_ENTRY ##### -->
<para>
</para>
+@object:
-<!-- ##### MACRO EPHY_CONTENT_POLICY_CLASSNAME ##### -->
+<!-- ##### MACRO EPHY_ICON_ENTRY_CLASS ##### -->
<para>
</para>
+@klass:
-<!-- ##### MACRO EPHY_CONTENT_POLICY_CONTRACTID ##### -->
+<!-- ##### MACRO EPHY_ICON_ENTRY_GET_CLASS ##### -->
<para>
</para>
+@obj:
-<!-- ##### MACRO EPHY_EMBED_SINGLE_IFACE ##### -->
+<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
<para>
</para>
@k:
-<!-- ##### MACRO EPHY_IS_EMBED_SINGLE_IFACE ##### -->
+<!-- ##### MACRO EPHY_IS_ICON_ENTRY ##### -->
<para>
</para>
-@k:
+@object:
+
+<!-- ##### MACRO EPHY_IS_ICON_ENTRY_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
<!-- ##### MACRO EPHY_SHELL_ERROR ##### -->
<para>
@@ -125,6 +135,12 @@ mozilla-embed-event
</para>
+<!-- ##### MACRO EPHY_TYPE_ICON_ENTRY ##### -->
+<para>
+
+</para>
+
+
<!-- ##### ENUM EmbedPersistFlags ##### -->
<para>
Determines how the #EphyEmbedPersist should act.
@@ -205,15 +221,6 @@ Represents the state of an #EphyEmbed with regards to networking negotiations.
@aSubject:
@Returns:
-<!-- ##### FUNCTION EmitPermissionNotification ##### -->
-<para>
-
-</para>
-
-@name:
-@aSubject:
-@Returns:
-
<!-- ##### ENUM EphyCookieP3PPolicy ##### -->
<para>
@@ -486,14 +493,6 @@ Represents the state of an #EphyEmbed with regards to networking negotiations.
</para>
-<!-- ##### FUNCTION Init ##### -->
-<para>
-
-</para>
-
-@aHistory:
-@Returns:
-
<!-- ##### FUNCTION ephy_embed_activate ##### -->
<para>
@@ -621,6 +620,23 @@ Represents the state of an #EphyEmbed with regards to networking negotiations.
@domain:
@Returns:
+<!-- ##### FUNCTION ephy_icon_entry_get_entry ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+<!-- ##### FUNCTION ephy_icon_entry_pack_widget ##### -->
+<para>
+
+</para>
+
+@entry:
+@widget:
+@start:
+
<!-- ##### FUNCTION ephy_node_db_get_by_name ##### -->
<para>
@@ -935,14 +951,6 @@ Represents the state of an #EphyEmbed with regards to networking negotiations.
@window:
@enabled:
-<!-- ##### FUNCTION mozilla_cookie_to_ephy_cookie ##### -->
-<para>
-
-</para>
-
-@cookie:
-@Returns:
-
<!-- ##### FUNCTION mozilla_embed_event_new ##### -->
<para>
@@ -960,11 +968,3 @@ Represents the state of an #EphyEmbed with regards to networking negotiations.
@name:
@value:
-<!-- ##### FUNCTION mozilla_permission_to_ephy_permission ##### -->
-<para>
-
-</para>
-
-@perm:
-@Returns:
-