diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/reference/epiphany-docs.sgml | 1 | ||||
| -rw-r--r-- | doc/reference/epiphany-sections.txt | 80 | ||||
| -rw-r--r-- | doc/reference/epiphany.types | 2 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-embed.sgml | 515 | ||||
| -rw-r--r-- | doc/reference/tmpl/ephy-tab.sgml | 9 | ||||
| -rw-r--r-- | doc/reference/tmpl/epiphany-unused.sgml | 22 |
7 files changed, 621 insertions, 12 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index c1026de81..cf981f0b6 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1,6 +1,9 @@ ## Process this file with automake to produce Makefile.in AUTOMAKE_OPTIONS = 1.6 +INCLUDES = $(MOZILLA_COMPONENT_CFLAGS) \ + -include $(MOZILLA_INCLUDE_ROOT)/mozilla-config.h + # The name of the module DOC_MODULE=epiphany @@ -66,7 +69,6 @@ IGNORE_HFILES = \ ephy-download.h \ ephy-embed-dialog.h \ ephy-embed-event.h \ - ephy-embed.h \ ephy-embed-persist.h \ ephy-embed-popup-control.h \ ephy-embed-prefs.h \ diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml index 7adab1ca0..92185ba87 100644 --- a/doc/reference/epiphany-docs.sgml +++ b/doc/reference/epiphany-docs.sgml @@ -11,6 +11,7 @@ <xi:include href="xml/ephy-permission-manager.xml"/> <xi:include href="xml/ephy-window.xml"/> <xi:include href="xml/ephy-tab.xml"/> + <xi:include href="xml/ephy-embed.xml"/> </chapter> <chapter> <title>Incomplete</title> diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt index f77ba5439..5d6d8bda3 100644 --- a/doc/reference/epiphany-sections.txt +++ b/doc/reference/epiphany-sections.txt @@ -10,6 +10,16 @@ ephy_permission_manager_remove ephy_permission_manager_clear ephy_permission_manager_test ephy_permission_manager_list +<SUBSECTION Standard> +EPHY_PERMISSION_MANAGER +EPHY_IS_PERMISSION_MANAGER +EPHY_TYPE_PERMISSION_MANAGER +EPHY_TYPE_PERMISSION_INFO +ephy_permission_info_get_type +EPHY_PERMISSION_MANAGER_GET_IFACE +EPHY_IS_PERMISSION_MANAGER_IFACE +EPHY_PERMISSION_MANAGER_IFACE +ephy_permission_manager_get_type </SECTION> <SECTION> @@ -18,7 +28,6 @@ ephy_permission_manager_list EphyWindow ephy_window_new ephy_window_new_with_chrome - ephy_window_get_notebook ephy_window_add_tab ephy_window_remove_tab @@ -34,6 +43,14 @@ ephy_window_set_print_preview ephy_window_set_zoom ephy_window_activate_location ephy_window_load_url +<SUBSECTION Standard> +EPHY_WINDOW +EPHY_IS_WINDOW +EPHY_TYPE_WINDOW +ephy_window_get_type +EPHY_WINDOW_CLASS +EPHY_IS_WINDOW_CLASS +EPHY_WINDOW_GET_CLASS </SECTION> <SECTION> @@ -41,7 +58,6 @@ ephy_window_load_url <TITLE>EphyTab</TITLE> EphyTab ephy_tab_new -ephy_tab_get_window ephy_tab_get_embed ephy_tab_for_embed ephy_tab_get_icon_address @@ -53,8 +69,68 @@ ephy_tab_get_load_status ephy_tab_get_load_percent ephy_tab_get_link_message ephy_tab_get_status_message +<SUBSECTION Standard> +EPHY_TAB +EPHY_IS_TAB +EPHY_TYPE_TAB +ephy_tab_get_type +EPHY_TAB_CLASS +EPHY_IS_TAB_CLASS +EPHY_TAB_GET_CLASS </SECTION> +<SECTION> +<FILE>ephy-embed</FILE> +<TITLE>EphyEmbed</TITLE> +EphyEmbed +EphyEmbedIface +EmbedState +EphyEmbedChrome +EmbedReloadFlags +EmbedPrintPreviewNavType +EmbedSecurityLevel +ephy_embed_load_url +ephy_embed_stop_load +ephy_embed_reload +ephy_embed_get_title +ephy_embed_get_location +ephy_embed_get_link_message +ephy_embed_get_js_status +ephy_embed_can_go_back +ephy_embed_can_go_forward +ephy_embed_can_go_up +ephy_embed_get_go_up_list +ephy_embed_go_back +ephy_embed_go_forward +ephy_embed_go_up +ephy_embed_shistory_n_items +ephy_embed_shistory_get_nth +ephy_embed_shistory_get_pos +ephy_embed_shistory_go_nth +ephy_embed_get_security_level +ephy_embed_set_zoom +ephy_embed_get_zoom +ephy_embed_find_set_properties +ephy_embed_find_next +ephy_embed_set_encoding +ephy_embed_get_encoding_info +ephy_embed_print +ephy_embed_print_preview_close +ephy_embed_print_preview_n_pages +ephy_embed_print_preview_navigate +ephy_embed_activate +ephy_embed_has_modified_forms +<SUBSECTION Standard> +ephy_embed_get_type +EPHY_EMBED +EPHY_IS_EMBED +EPHY_TYPE_EMBED +ephy_embed_chrome_get_type +EPHY_EMBED_GET_IFACE +EPHY_EMBED_IFACE +EPHY_IS_EMBED_IFACE +EPHY_TYPE_EMBED_CHROME_MASK +</SECTION> diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types index 69a003fff..dffbaa6f0 100644 --- a/doc/reference/epiphany.types +++ b/doc/reference/epiphany.types @@ -29,6 +29,7 @@ ephy_cell_renderer_progress_get_type #include <ephy-cookie-manager.h> #include <ephy-password-manager.h> #include <ephy-permission-manager.h> +#include <mozilla-embed.h> ephy_embed_get_type downloader_view_get_type @@ -41,6 +42,7 @@ ephy_embed_single_get_type ephy_cookie_manager_get_type ephy_permission_manager_get_type ephy_password_manager_get_type +mozilla_embed_get_type #include <ephy-window.h> #include <ephy-shell.h> diff --git a/doc/reference/tmpl/ephy-embed.sgml b/doc/reference/tmpl/ephy-embed.sgml new file mode 100644 index 000000000..c57e5cf98 --- /dev/null +++ b/doc/reference/tmpl/ephy-embed.sgml @@ -0,0 +1,515 @@ +<!-- ##### 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. + +<!-- ##### 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: + diff --git a/doc/reference/tmpl/ephy-tab.sgml b/doc/reference/tmpl/ephy-tab.sgml index c598e77a8..94d71bb1f 100644 --- a/doc/reference/tmpl/ephy-tab.sgml +++ b/doc/reference/tmpl/ephy-tab.sgml @@ -29,15 +29,6 @@ An #EphyTab is basically a container for an #EphyEmbed. @Returns: -<!-- ##### FUNCTION ephy_tab_get_window ##### --> -<para> - -</para> - -@tab: -@Returns: - - <!-- ##### FUNCTION ephy_tab_get_embed ##### --> <para> diff --git a/doc/reference/tmpl/epiphany-unused.sgml b/doc/reference/tmpl/epiphany-unused.sgml index c984df54a..5fcda58b0 100644 --- a/doc/reference/tmpl/epiphany-unused.sgml +++ b/doc/reference/tmpl/epiphany-unused.sgml @@ -24,6 +24,20 @@ mozilla-embed-event </para> +<!-- ##### SIGNAL EphyEmbed::ge-popup-blocked ##### --> +<para> + +</para> + +@ephyembed: the object which received the signal. + +<!-- ##### FUNCTION ephy_embed_get_type ##### --> +<para> + +</para> + +@Returns: + <!-- ##### FUNCTION ephy_shell_delete_on_exit ##### --> <para> @@ -33,6 +47,14 @@ mozilla-embed-event @path: @gs: +<!-- ##### FUNCTION ephy_tab_get_window ##### --> +<para> + +</para> + +@tab: +@Returns: + <!-- ##### FUNCTION mozilla_embed_event_new ##### --> <para> |