From d3cea4a501d33f5b747f4a54381660bdc1fac5a5 Mon Sep 17 00:00:00 2001 From: Adam Hooper Date: Tue, 23 Mar 2004 17:31:42 +0000 Subject: API documentation --- doc/plan.xml | 9 +- doc/reference-howto.txt | 2 +- doc/reference/Makefile.am | 1 - doc/reference/tmpl/ephy-permission-manager.sgml | 88 +++++------ doc/reference/tmpl/ephy-window.sgml | 198 ++++++++++++++++++++++++ 5 files changed, 245 insertions(+), 53 deletions(-) create mode 100644 doc/reference/tmpl/ephy-window.sgml (limited to 'doc') diff --git a/doc/plan.xml b/doc/plan.xml index 18326e01e..c850afa7a 100644 --- a/doc/plan.xml +++ b/doc/plan.xml @@ -79,9 +79,14 @@ - Extensions: Loading/Unloading + Extensions Lifecycle - Dynamic loading/unloading of extensions. + Right now the startup process is: "startup -> get session -> + get extensions manager -> load extensions -> get session". We + should make the extensions manager load extensions *later*, so that the + session is created for them by the time they need it. + + This should pave the way for dynamic loading/unloading of extensions. Adam Hooper diff --git a/doc/reference-howto.txt b/doc/reference-howto.txt index 743b636aa..66dc14f22 100644 --- a/doc/reference-howto.txt +++ b/doc/reference-howto.txt @@ -11,7 +11,7 @@ For example: * * Resume a crashed session when necessary (interactive) * - * Return value: TRUE if at least a window has been opened + * Return value: %TRUE if at least a window has been opened **/ gboolean ephy_session_autoresume (EphySession *session) diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 5da5f7d7f..bf39bae09 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -138,7 +138,6 @@ IGNORE_HFILES = \ ephy-tab.h \ ephy-tabs-menu.h \ ephy-toolbars-model.h \ - ephy-window.h \ language-editor.h \ pdm-dialog.h \ popup-commands.h \ diff --git a/doc/reference/tmpl/ephy-permission-manager.sgml b/doc/reference/tmpl/ephy-permission-manager.sgml index 516bfac21..f62bd4de1 100644 --- a/doc/reference/tmpl/ephy-permission-manager.sgml +++ b/doc/reference/tmpl/ephy-permission-manager.sgml @@ -1,79 +1,77 @@ -ephy-permission-manager +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. - -@k: - - - - +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. -@k: - - - + + + +Details a specific permission of a specific website. + +@host: The hostname of the website to which this permission applies. +@type: An #EphyPermissionType. +@permission: An #EphyPermission (either allow or deny). - +Determines what permission we're dealing with. @EPT_COOKIE: + Permission for the website to store cookies on the user's computer. @EPT_IMAGE: + Permission for the website to show images to the user. @EPT_POPUP: + Permission for the website to open popup windows (using JavaScript). - +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: - - - - - - -@host: -@type: -@permission: -@Returns: - - - - - - - -@info: -@Returns: - + The user has not set a preference for this particular website; the + caller should therefore fall back to default settings. @@ -83,14 +81,6 @@ ephy-permission-manager @info: - - - - - -@Returns: - - diff --git a/doc/reference/tmpl/ephy-window.sgml b/doc/reference/tmpl/ephy-window.sgml new file mode 100644 index 000000000..391abd920 --- /dev/null +++ b/doc/reference/tmpl/ephy-window.sgml @@ -0,0 +1,198 @@ + +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(). + + + + + + + + + + + + +@ui_merge: The #GtkUIManager this window uses to merge user interfaces + + + + + + +@Returns: + + + + + + + +@chrome: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@tab: +@position: +@jump_to: + + + + + + + +@window: +@tab: + + + + + + + +@window: +@tab: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: +@Returns: + + + + + + + +@window: + + + + + + + +@window: + + + + + + + +@window: +@enabled: + + + + + + + +@window: +@zoom: + + + + + + + +@window: + + + + + + + +@window: +@url: + + + + + + + + + + + + -- cgit