Commit b60ae4ba authored by Iain Nicol's avatar Iain Nicol Committed by Xan Lopez

Add GObject introspection annotations to many *_get_* functions

Partial fix for bug #599757.
Signed-off-by: 's avatarXan Lopez <xan@gnome.org>
parent dedbad48
......@@ -150,7 +150,7 @@ ephy_embed_container_remove_child (EphyEmbedContainer *container,
*
* Returns @container's active #EphyEmbed.
*
* Return value: @container's active child
* Return value: (transfer none): @container's active child
**/
EphyEmbed *
ephy_embed_container_get_active_child (EphyEmbedContainer *container)
......@@ -169,7 +169,8 @@ ephy_embed_container_get_active_child (EphyEmbedContainer *container)
*
* Returns the list of #EphyEmbed:s in the container.
*
* Return value: a newly-allocated list of #EphyEmbed:s
* Return value: (element-type EphyEmbed) (transfer container):
* a newly-allocated list of #EphyEmbed:s
*/
GList *
ephy_embed_container_get_children (EphyEmbedContainer *container)
......
......@@ -256,7 +256,8 @@ ephy_embed_persist_get_dest (EphyEmbedPersist *persist)
*
* Returns the #EphyEmbed from which @persist will download.
*
* Return value: the #EphyEmbed from which @persist will download
* Return value: (transfer none): the #EphyEmbed from which @persist
* will download
**/
EphyEmbed *
ephy_embed_persist_get_embed (EphyEmbedPersist *persist)
......@@ -289,7 +290,8 @@ ephy_embed_persist_get_fc_title (EphyEmbedPersist *persist)
* Returns the #EphyWindow which should serve as a parent for @persist's
* filechooser.
*
* Return value: the #EphyWindow parent for @persist's filechooser
* Return value: (transfer none): the #EphyWindow parent for @persist's
* filechooser
**/
GtkWindow *
ephy_embed_persist_get_fc_parent (EphyEmbedPersist *persist)
......
......@@ -156,7 +156,7 @@ ephy_embed_shell_finalize (GObject *object)
*
* Returns the favicons cache.
*
* Return value: the favicons cache
* Return value: (transfer none): the favicons cache
**/
GObject *
ephy_embed_shell_get_favicon_cache (EphyEmbedShell *shell)
......@@ -171,6 +171,11 @@ ephy_embed_shell_get_favicon_cache (EphyEmbedShell *shell)
return G_OBJECT (shell->priv->favicon_cache);
}
/**
* ephy_embed_shell_get_global_history:
*
* Return value: (transfer none):
**/
GObject *
ephy_embed_shell_get_global_history (EphyEmbedShell *shell)
{
......@@ -184,6 +189,11 @@ ephy_embed_shell_get_global_history (EphyEmbedShell *shell)
return G_OBJECT (shell->priv->global_history);
}
/**
* ephy_embed_shell_get_downloader_view:
*
* Return value: (transfer none):
**/
GObject *
ephy_embed_shell_get_downloader_view (EphyEmbedShell *shell)
{
......@@ -202,6 +212,11 @@ ephy_embed_shell_get_downloader_view (EphyEmbedShell *shell)
return G_OBJECT (shell->priv->downloader_view);
}
/**
* ephy_embed_shell_get_downloader_view_nocreate:
*
* Return value: (transfer none):
**/
GObject *
ephy_embed_shell_get_downloader_view_nocreate (EphyEmbedShell *shell)
{
......@@ -254,6 +269,11 @@ impl_get_embed_single (EphyEmbedShell *shell)
return G_OBJECT (shell->priv->embed_single);
}
/**
* ephy_embed_shell_get_embed_single:
*
* Return value: (transfer none):
**/
GObject *
ephy_embed_shell_get_embed_single (EphyEmbedShell *shell)
{
......@@ -262,6 +282,11 @@ ephy_embed_shell_get_embed_single (EphyEmbedShell *shell)
return klass->get_embed_single (shell);
}
/**
* ephy_embed_shell_get_encodings:
*
* Return value: (transfer none):
**/
GObject *
ephy_embed_shell_get_encodings (EphyEmbedShell *shell)
{
......@@ -345,7 +370,7 @@ ephy_embed_shell_class_init (EphyEmbedShellClass *klass)
*
* Retrieves the default #EphyEmbedShell object
*
* Return value: the default #EphyEmbedShell
* Return value: (transfer none): the default #EphyEmbedShell
**/
EphyEmbedShell *
ephy_embed_shell_get_default (void)
......@@ -359,7 +384,7 @@ ephy_embed_shell_get_default (void)
*
* Returns the adblock manager.
*
* Return value: the adblock manager
* Return value: (transfer none): the adblock manager
**/
GObject *
ephy_embed_shell_get_adblock_manager (EphyEmbedShell *shell)
......@@ -404,7 +429,12 @@ ephy_embed_shell_set_page_setup (EphyEmbedShell *shell,
gtk_page_setup_to_file (page_setup, path, NULL);
g_free (path);
}
/**
* ephy_embed_shell_get_page_setup:
*
* Return value: (transfer none):
**/
GtkPageSetup *
ephy_embed_shell_get_page_setup (EphyEmbedShell *shell)
{
......@@ -481,7 +511,12 @@ ephy_embed_shell_set_print_settings (EphyEmbedShell *shell,
gtk_print_settings_to_file (settings, path, NULL);
g_free (path);
}
/**
* ephy_embed_shell_get_print_gettings:
*
* Return value: (transfer none):
**/
GtkPrintSettings *
ephy_embed_shell_get_print_settings (EphyEmbedShell *shell)
{
......
......@@ -882,7 +882,7 @@ ephy_embed_init (EphyEmbed *embed)
*
* Returns the #EphyWebView wrapped by @embed.
*
* Returns: an #EphyWebView
* Returns: (transfer none): an #EphyWebView
**/
EphyWebView*
ephy_embed_get_web_view (EphyEmbed *embed)
......
......@@ -740,6 +740,11 @@ internal_get_host (EphyHistory *eh, const char *url, gboolean create)
return host;
}
/**
* ephy_history_get_host:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_history_get_host (EphyHistory *eh, const char *url)
{
......@@ -875,6 +880,11 @@ impl_add_page (EphyHistory *eb,
return TRUE;
}
/**
* ephy_history_get_page:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_history_get_page (EphyHistory *eb,
const char *url)
......@@ -975,12 +985,22 @@ ephy_history_clear (EphyHistory *gh)
g_signal_emit (gh, signals[CLEARED], 0);
}
/**
* ephy_history_get_hosts:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_history_get_hosts (EphyHistory *eb)
{
return eb->priv->hosts;
}
/**
* ephy_history_get_pages:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_history_get_pages (EphyHistory *eb)
{
......
......@@ -1739,7 +1739,7 @@ ephy_web_view_get_icon_address (EphyWebView *view)
* Returns the view's site icon as a #GdkPixbuf,
* or %NULL if it is not available.
*
* Return value: a the view's site icon
* Return value: (transfer none): a the view's site icon
**/
GdkPixbuf *
ephy_web_view_get_icon (EphyWebView *view)
......@@ -2008,8 +2008,8 @@ ephy_web_view_get_js_status (EphyWebView *view)
/**
* ephy_web_view_get_security_level:
* @view: an #EphyWebView
* @level: return value of security level
* @description: return value of the description of the security level
* @level: (out): return value of security level
* @description: (out): return value of the description of the security level
*
* Fetches the #EphyWebViewSecurityLevel and a string description of the
* security state of @view. The description will be a newly-allocated
......
......@@ -1263,6 +1263,11 @@ ephy_dialog_run (EphyDialog *dialog)
return gtk_dialog_run (GTK_DIALOG (dialog->priv->dialog));
}
/**
* ephy_dialog_get_control:
*
* Return value: (transfer none):
**/
GtkWidget *
ephy_dialog_get_control (EphyDialog *dialog,
const char *property_id)
......@@ -1379,6 +1384,11 @@ ephy_dialog_finalize (GObject *object)
G_OBJECT_CLASS (parent_class)->finalize (object);
}
/**
* ephy_dialog_get_parent:
*
* Return value: (transfer none):
**/
GtkWidget *
ephy_dialog_get_parent (EphyDialog *dialog)
{
......
......@@ -197,7 +197,7 @@ ephy_node_db_set_immutable (EphyNodeDb *db, gboolean immutable)
*
* Returns the #EphyNode with id @id from @db, or %NULL if no such id exists.
*
* Return value: an #EphyNode
* Return value: (transfer none): an #EphyNode
**/
EphyNode *
ephy_node_db_get_node_from_id (EphyNodeDb *db, guint id)
......
......@@ -380,6 +380,11 @@ ephy_node_new_with_id (EphyNodeDb *db, guint reserved_id)
return node;
}
/**
* ephy_node_get_db:
*
* Return value: (transfer none):
**/
EphyNodeDb *
ephy_node_get_db (EphyNode *node)
{
......@@ -758,6 +763,11 @@ ephy_node_get_property_float (EphyNode *node,
return retval;
}
/**
* ephy_node_get_property_node:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_node_get_property_node (EphyNode *node,
guint property_id)
......@@ -1208,6 +1218,11 @@ ephy_node_reorder_children (EphyNode *node,
ephy_node_emit_signal (node, EPHY_NODE_CHILDREN_REORDERED, new_order);
}
/**
* ephy_node_get_children:
*
* Return value: (array) (element-type EphyNode) (transfer none):
**/
GPtrArray *
ephy_node_get_children (EphyNode *node)
{
......@@ -1228,6 +1243,11 @@ ephy_node_get_n_children (EphyNode *node)
return ret;
}
/**
* ephy_node_get_nth_child:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_node_get_nth_child (EphyNode *node,
guint n)
......@@ -1276,6 +1296,11 @@ ephy_node_get_child_index (EphyNode *node,
return ret;
}
/**
* ephy_node_get_next_child:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_node_get_next_child (EphyNode *node,
EphyNode *child)
......@@ -1297,6 +1322,11 @@ ephy_node_get_next_child (EphyNode *node,
return ret;
}
/**
* ephy_node_get_previous_child:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_node_get_previous_child (EphyNode *node,
EphyNode *child)
......
......@@ -1937,30 +1937,55 @@ ephy_bookmarks_unset_keyword (EphyBookmarks *eb,
g_signal_emit (G_OBJECT (eb), ephy_bookmarks_signals[TREE_CHANGED], 0);
}
/**
* ephy_bookmarks_get_smart_bookmarks:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_smart_bookmarks (EphyBookmarks *eb)
{
return eb->priv->smartbookmarks;
}
/**
* ephy_bookmarks_get_keywords:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_keywords (EphyBookmarks *eb)
{
return eb->priv->keywords;
}
/**
* ephy_bookmarks_get_bookmarks:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_bookmarks (EphyBookmarks *eb)
{
return eb->priv->bookmarks;
}
/**
* ephy_bookmarks_get_favorites:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_favorites (EphyBookmarks *eb)
{
return eb->priv->favorites;
}
/**
* ephy_bookmarks_get_local:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_local (EphyBookmarks *eb)
{
......@@ -1971,12 +1996,22 @@ ephy_bookmarks_get_local (EphyBookmarks *eb)
#endif
}
/**
* ephy_bookmarks_get_not_categorized:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_not_categorized (EphyBookmarks *eb)
{
return eb->priv->notcategorized;
}
/**
* ephy_bookmarks_get_from_id:
*
* Return value: (transfer none):
**/
EphyNode *
ephy_bookmarks_get_from_id (EphyBookmarks *eb, long id)
{
......
......@@ -230,7 +230,8 @@ ephy_extensions_manager_register (EphyExtensionsManager *manager,
*
* Returns the list of known extensions.
*
* Returns: a list of #EphyExtensionInfo
* Returns: (element-type EphyEmbed) (transfer container): a list of
* #EphyExtensionInfo
**/
GList *
ephy_extensions_manager_get_extensions (EphyExtensionsManager *manager)
......
......@@ -679,6 +679,11 @@ ephy_notebook_set_show_tabs (EphyNotebook *nb,
update_tabs_visibility (nb, FALSE);
}
/**
* ephy_notebook_get_focused_pages:
*
* Return value: (transfer none):
**/
GList *
ephy_notebook_get_focused_pages (EphyNotebook *nb)
{
......
......@@ -1601,7 +1601,8 @@ ephy_session_load (EphySession *session,
* ephy_session_get_windows:
* @session: the #EphySession
*
* Returns: the list of open #EphyWindow:s.
* Returns: (element-type EphyWindow) (transfer container): the list of
* open #EphyWindow:s.
**/
GList *
ephy_session_get_windows (EphySession *session)
......@@ -1659,7 +1660,8 @@ ephy_session_remove_window (EphySession *session,
* need to take an action (like opening an url) on
* a window but you dont have a target window.
*
* Return value: the current active non-popup browser window, or NULL of there is none.
* Return value: (transfer none): the current active non-popup browser
* window, or NULL of there is none.
**/
EphyWindow *
ephy_session_get_active_window (EphySession *session)
......
......@@ -359,7 +359,7 @@ ephy_shell_finalize (GObject *object)
*
* Retrieve the default #EphyShell object
*
* Return value: the default #EphyShell
* Return value: (transfer none): the default #EphyShell
**/
EphyShell *
ephy_shell_get_default (void)
......@@ -589,7 +589,7 @@ ephy_shell_new_tab (EphyShell *shell,
*
* Returns current session.
*
* Return value: the current session.
* Return value: (transfer none): the current session.
**/
GObject *
ephy_shell_get_session (EphyShell *shell)
......@@ -639,6 +639,11 @@ ephy_shell_get_lockdown (EphyShell *shell)
return G_OBJECT (shell->priv->session);
}
/**
* ephy_shell_get_bookmarks:
*
* Return value: (transfer none):
**/
EphyBookmarks *
ephy_shell_get_bookmarks (EphyShell *shell)
{
......@@ -650,6 +655,11 @@ ephy_shell_get_bookmarks (EphyShell *shell)
return shell->priv->bookmarks;
}
/**
* ephy_shell_get_toolbars_model:
*
* Return value: (transfer none):
**/
GObject *
ephy_shell_get_toolbars_model (EphyShell *shell, gboolean fullscreen)
{
......@@ -696,6 +706,11 @@ ephy_shell_get_toolbars_model (EphyShell *shell, gboolean fullscreen)
}
}
/**
* ephy_shell_get_extensions_manager:
*
* Return value: (transfer none):
**/
GObject *
ephy_shell_get_extensions_manager (EphyShell *es)
{
......@@ -717,6 +732,11 @@ ephy_shell_get_extensions_manager (EphyShell *es)
return G_OBJECT (es->priv->extensions_manager);
}
/**
* ephy_shell_get_net_monitor:
*
* Return value: (transfer none):
**/
GObject *
ephy_shell_get_net_monitor (EphyShell *shell)
{
......@@ -760,6 +780,11 @@ toolwindow_hide_cb (GtkWidget *widget, EphyShell *es)
g_object_unref (ephy_shell);
}
/**
* ephy_shell_get_bookmarks_editor:
*
* Return value: (transfer none):
**/
GtkWidget *
ephy_shell_get_bookmarks_editor (EphyShell *shell)
{
......@@ -780,6 +805,11 @@ ephy_shell_get_bookmarks_editor (EphyShell *shell)
return shell->priv->bme;
}
/**
* ephy_shell_get_history_window:
*
* Return value: (transfer none):
**/
GtkWidget *
ephy_shell_get_history_window (EphyShell *shell)
{
......@@ -801,6 +831,11 @@ ephy_shell_get_history_window (EphyShell *shell)
return shell->priv->history_window;
}
/**
* ephy_shell_get_pdm_dialog:
*
* Return value: (transfer none):
**/
GObject *
ephy_shell_get_pdm_dialog (EphyShell *shell)
{
......@@ -819,6 +854,11 @@ ephy_shell_get_pdm_dialog (EphyShell *shell)
return shell->priv->pdm_dialog;
}
/**
* ephy_shell_get_prefs_dialog:
*
* Return value: (transfer none):
**/
GObject *
ephy_shell_get_prefs_dialog (EphyShell *shell)
{
......
......@@ -342,7 +342,7 @@ ephy_statusbar_remove_widget (EphyStatusbar *statusbar,
* ephy_statusbar_get_security_frame:
* @statusbar: an #EphyStatusbar
*
* Return value: the statusbar's lock icon frame
* Return value: (transfer none): the statusbar's lock icon frame
*/
GtkWidget *
ephy_statusbar_get_security_frame (EphyStatusbar *statusbar)
......
......@@ -358,6 +358,11 @@ ephy_toolbar_set_window (EphyToolbar *toolbar,
/* public functions */
/**
* ephy_toolbar_get_action_group
*
* Return value: (transfer none):
**/
GtkActionGroup *
ephy_toolbar_get_action_group (EphyToolbar *toolbar)
{
......
......@@ -3884,7 +3884,7 @@ ephy_window_new_with_chrome (EphyWebViewChrome chrome,
*
* Returns this window's UI manager.
*
* Return value: an #GtkUIManager
* Return value: (transfer none): an #GtkUIManager
**/
GObject *
ephy_window_get_ui_manager (EphyWindow *window)
......@@ -3900,7 +3900,7 @@ ephy_window_get_ui_manager (EphyWindow *window)
*
* Returns this window's toolbar as an #EggEditableToolbar.
*
* Return value: an #EggEditableToolbar
* Return value: (transfer none): an #EggEditableToolbar
**/
GtkWidget *
ephy_window_get_toolbar (EphyWindow *window)
......@@ -3916,7 +3916,7 @@ ephy_window_get_toolbar (EphyWindow *window)
*
* Returns the #GtkNotebook used by this window.
*
* Return value: the @window's #GtkNotebook
* Return value: (transfer none): the @window's #GtkNotebook
**/
GtkWidget *
ephy_window_get_notebook (EphyWindow *window)
......@@ -3932,7 +3932,7 @@ ephy_window_get_notebook (EphyWindow *window)
*
* Returns the #EphyFindToolbar used by this window.
*
* Return value: the @window's #EphyFindToolbar
* Return value: (transfer none): the @window's #EphyFindToolbar
**/
GtkWidget *
ephy_window_get_find_toolbar (EphyWindow *window)
......@@ -3948,7 +3948,7 @@ ephy_window_get_find_toolbar (EphyWindow *window)
*
* Returns this window's statusbar as an #EphyStatusbar.
*
* Return value: This window's statusbar
* Return value: (transfer none): This window's statusbar
**/
GtkWidget *
ephy_window_get_statusbar (EphyWindow *window)
......@@ -4196,7 +4196,7 @@ ephy_window_get_is_print_preview (EphyWindow *window)
* Returns the #EphyEmbedEvent for the current context menu.
* Use this to get the event from the action callback.
*
* Return value: an #EphyEmbedEvent, or %NULL
* Return value: (transfer none): an #EphyEmbedEvent, or %NULL
**/
EphyEmbedEvent *
ephy_window_get_context_event (EphyWindow *window)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment