Commit f1e76080 authored by Jonh Wendell's avatar Jonh Wendell
Browse files

Added annotations

parent 30355913
......@@ -179,6 +179,12 @@ vinagre_bookmarks_entry_set_conn (VinagreBookmarksEntry *entry, VinagreConnectio
entry->priv->conn = g_object_ref (conn);
}
/**
* vinagre_bookmarks_entry_get_conn:
* @entry: A BookmarksEntry
*
* Return value: (allow-none) (transfer none):
*/
VinagreConnection *
vinagre_bookmarks_entry_get_conn (VinagreBookmarksEntry *entry)
{
......@@ -248,6 +254,12 @@ vinagre_bookmarks_entry_remove_child (VinagreBookmarksEntry *entry,
return FALSE;
}
/**
* vinagre_bookmarks_entry_get_children:
* @entry: A BookmarksEntry
*
* Return value: (element-type VinagreBookmarksEntry) (transfer none):
*/
GSList *
vinagre_bookmarks_entry_get_children (VinagreBookmarksEntry *entry)
{
......@@ -256,6 +268,12 @@ vinagre_bookmarks_entry_get_children (VinagreBookmarksEntry *entry)
return entry->priv->children;
}
/**
* vinagre_bookmarks_entry_get_parent:
* @entry: A BookmarksEntry
*
* Return value: (transfer none):
*/
VinagreBookmarksEntry *
vinagre_bookmarks_entry_get_parent (VinagreBookmarksEntry *entry)
{
......
......@@ -203,6 +203,11 @@ vinagre_bookmarks_tree_new (void)
return GTK_WIDGET (g_object_new (VINAGRE_TYPE_BOOKMARKS_TREE, NULL));
}
/**
* vinagre_bookmarks_tree_get_selected_entry:
*
* Return value: (allow-none) (transfer full):
*/
VinagreBookmarksEntry *
vinagre_bookmarks_tree_get_selected_entry (VinagreBookmarksTree *tree)
{
......
......@@ -187,6 +187,11 @@ find_conn_by_host (GSList *entries,
return NULL;
}
/**
* vinagre_bookmarks_exists:
*
* Return value: (allow-none) (transfer none):
*/
VinagreConnection *
vinagre_bookmarks_exists (VinagreBookmarks *book,
const gchar *protocol,
......@@ -384,6 +389,11 @@ vinagre_bookmarks_file_changed (GFileMonitor *monitor,
/* Public API */
/**
* vinagre_bookmarks_get_default:
*
* Return value: (transfer full):
*/
VinagreBookmarks *
vinagre_bookmarks_get_default (void)
{
......@@ -393,6 +403,12 @@ vinagre_bookmarks_get_default (void)
return book_singleton;
}
/**
* vinagre_bookmarks_get_all:
* @book: A Bookmarks
*
* Return value: (element-type VinagreBookmarksEntry) (transfer none):
*/
GSList *
vinagre_bookmarks_get_all (VinagreBookmarks *book)
{
......@@ -519,6 +535,11 @@ vinagre_bookmarks_remove_entry (VinagreBookmarks *book,
}
/**
* vinagre_bookmarks_name_exists:
*
* Return value: (allow-none) (transfer none):
*/
VinagreBookmarksEntry *
vinagre_bookmarks_name_exists (VinagreBookmarks *book,
VinagreBookmarksEntry *parent,
......
......@@ -389,7 +389,14 @@ vinagre_connect_find_button_cb (GtkButton *button,
}
#endif
VinagreConnection *vinagre_connect (VinagreWindow *window)
/**
* vinagre_connect:
* @window: A Window
*
* Return value: (allow-none) (transfer full):
*/
VinagreConnection *
vinagre_connect (VinagreWindow *window)
{
VinagreConnection *conn = NULL;
gint result;
......
......@@ -727,6 +727,12 @@ vinagre_notebook_close_active_tab (VinagreNotebook *nb)
vinagre_notebook_close_tab (nb, nb->priv->active_tab);
}
/**
* vinagre_notebook_get_active_tab:
* @nb: A Notebook
*
* Return value: (transfer none):
*/
VinagreTab *
vinagre_notebook_get_active_tab (VinagreNotebook *nb)
{
......@@ -735,6 +741,12 @@ vinagre_notebook_get_active_tab (VinagreNotebook *nb)
return nb->priv->active_tab;
}
/**
* vinagre_notebook_get_tabs:
* @nb: A Notebook
*
* Return value: (transfer none) (element-type VinagreTab):
*/
GSList *
vinagre_notebook_get_tabs (VinagreNotebook *nb)
{
......
......@@ -192,7 +192,11 @@ vinagre_plugins_engine_active_plugins_changed (VinagrePluginsEngine *engine)
g_slist_free (plugins);
}
VinagrePluginsEngine *
/**
* vinagre_plugins_engine_get_default:
*
* Return value: (transfer none):
*/VinagrePluginsEngine *
vinagre_plugins_engine_get_default (void)
{
gchar *tmp, *typelib_dir, **search_paths;
......@@ -248,7 +252,11 @@ vinagre_plugins_engine_get_default (void)
return default_engine;
}
/**
* vinagre_plugins_engine_get_plugin_by_protocol:
*
* Return value: (allow-none) (transfer none):
*/
VinagreProtocol *
vinagre_plugins_engine_get_plugin_by_protocol (VinagrePluginsEngine *engine,
const gchar *protocol)
......@@ -258,6 +266,11 @@ vinagre_plugins_engine_get_plugin_by_protocol (VinagrePluginsEngine *engine,
return g_hash_table_lookup (engine->priv->protocols, (gconstpointer) protocol);
}
/**
* vinagre_plugins_engine_get_plugins_by_protocol:
*
* Return value: (element-type utf8 PeasExtension) (transfer none):
*/
GHashTable *
vinagre_plugins_engine_get_plugins_by_protocol (VinagrePluginsEngine *engine)
{
......
......@@ -54,6 +54,11 @@ G_DEFINE_TYPE (VinagrePrefs, vinagre_prefs, G_TYPE_OBJECT);
static VinagrePrefs *prefs_singleton = NULL;
/**
* vinagre_prefs_get_default:
*
* Return value: (transfer none):
*/
VinagrePrefs *
vinagre_prefs_get_default (void)
{
......
......@@ -131,6 +131,12 @@ vinagre_protocol_get_protocol (VinagreProtocol *protocol)
return NULL;
}
/**
* vinagre_protocol_get_public_description:
* @protocol: A protocol
*
* Return value: (array zero-terminated=1) (element-type utf8) (transfer full):
*/
gchar **
vinagre_protocol_get_public_description (VinagreProtocol *protocol)
{
......@@ -183,10 +189,10 @@ vinagre_protocol_get_mdns_service (VinagreProtocol *protocol)
}
/**
* vinagre_protocol_get_context_groups: blah
* vinagre_protocol_get_context_groups:
* @protocol: A protocol
*
* Return value: (element-type any) (transfer container): blah
* Return value: (allow-none) (element-type any) (transfer container):
*/
GSList *
vinagre_protocol_get_context_groups (VinagreProtocol *protocol)
......@@ -205,6 +211,12 @@ vinagre_protocol_get_context_groups (VinagreProtocol *protocol)
return NULL;
}
/**
* vinagre_protocol_get_file_filter:
* @protocol: A protocol
*
* Return value: (allow-none) (transfer full):
*/
GtkFileFilter *
vinagre_protocol_get_file_filter (VinagreProtocol *protocol)
{
......@@ -222,6 +234,12 @@ vinagre_protocol_get_file_filter (VinagreProtocol *protocol)
return NULL;
}
/**
* vinagre_protocol_new_tab:
* @protocol: A protocol
*
* Return value: (allow-none) (transfer full):
*/
GtkWidget *
vinagre_protocol_new_tab (VinagreProtocol *protocol,
VinagreConnection *conn,
......@@ -241,6 +259,12 @@ vinagre_protocol_new_tab (VinagreProtocol *protocol,
return NULL;
}
/**
* vinagre_protocol_new_connection:
* @protocol: A protocol
*
* Return value: (allow-none) (transfer full):
*/
VinagreConnection *
vinagre_protocol_new_connection (VinagreProtocol *protocol)
{
......@@ -258,6 +282,12 @@ vinagre_protocol_new_connection (VinagreProtocol *protocol)
return NULL;
}
/**
* vinagre_protocol_new_connection_from_file:
* @protocol: A protocol
*
* Return value: (allow-none) (transfer full):
*/
VinagreConnection *
vinagre_protocol_new_connection_from_file (VinagreProtocol *protocol,
const gchar *data,
......@@ -283,7 +313,7 @@ vinagre_protocol_new_connection_from_file (VinagreProtocol *protocol,
*
* @protocol: a protocol
* @initial_settings: (allow-none): bla bla
* Return value: (allow-none): a widget
* Return value: (allow-none) (transfer full): a widget
*/
GtkWidget *
vinagre_protocol_get_connect_widget (VinagreProtocol *protocol,
......@@ -337,6 +367,12 @@ vinagre_protocol_get_icon_name (VinagreProtocol *protocol)
return NULL;
}
/**
* vinagre_protocol_get_icon:
* @protocol: A protocol
*
* Return value: (allow-none) (transfer full):
*/
GdkPixbuf *
vinagre_protocol_get_icon (VinagreProtocol *protocol,
gint size)
......
......@@ -560,6 +560,12 @@ vinagre_tab_get_dimensions (VinagreTab *tab, int *w, int *h)
VINAGRE_TAB_GET_CLASS (tab)->impl_get_dimensions (tab, w, h);
}
/**
* vinagre_tab_get_window:
* @tab: a Tab
*
* Return value: (transfer none):
*/
VinagreWindow *
vinagre_tab_get_window (VinagreTab *tab)
{
......@@ -568,6 +574,12 @@ vinagre_tab_get_window (VinagreTab *tab)
return tab->priv->window;
}
/**
* vinagre_tab_get_conn:
* @tab: a Tab
*
* Return value: (transfer none):
*/
VinagreConnection *
vinagre_tab_get_conn (VinagreTab *tab)
{
......@@ -592,6 +604,12 @@ vinagre_tab_add_view (VinagreTab *tab, GtkWidget *view)
gtk_widget_modify_bg (viewport, GTK_STATE_NORMAL, &color);
}
/**
* vinagre_tab_get_view:
* @tab: a Tab
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_tab_get_view (VinagreTab *tab)
{
......@@ -622,6 +640,12 @@ vinagre_tab_set_notebook (VinagreTab *tab,
tab->priv->nb = nb;
}
/**
* vinagre_tab_get_notebook:
* @tab: a Tab
*
* Return value: (transfer none):
*/
VinagreNotebook *
vinagre_tab_get_notebook (VinagreTab *tab)
{
......@@ -644,6 +668,12 @@ vinagre_tab_set_state (VinagreTab *tab, VinagreTabState state)
tab->priv->state = state;
}
/**
* vinagre_tab_get_toolbar:
* @tab: a Tab
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_tab_get_toolbar (VinagreTab *tab)
{
......@@ -652,6 +682,12 @@ vinagre_tab_get_toolbar (VinagreTab *tab)
return tab->priv->toolbar;
}
/**
* vinagre_tab_get_from_connection:
* @conn: a Connection
*
* Return value: (allow-none) (transfer none):
*/
VinagreTab *
vinagre_tab_get_from_connection (VinagreConnection *conn)
{
......
......@@ -113,7 +113,6 @@ void vinagre_tab_get_dimensions (VinagreTab *tab, int *w, int *h);
const GSList * vinagre_tab_get_always_sensitive_actions(VinagreTab *tab);
const GSList * vinagre_tab_get_connected_actions (VinagreTab *tab);
const GSList * vinagre_tab_get_initialized_actions (VinagreTab *tab);
GtkActionGroup * vinagre_tab_get_action_group (VinagreTab *tab);
gchar * vinagre_tab_get_extra_title (VinagreTab *tab);
GtkWidget * vinagre_tab_get_toolbar (VinagreTab *tab);
......
......@@ -29,6 +29,11 @@
#include <config.h>
#endif
/**
* vinagre_utils_create_small_close_button:
*
* Return value: (transfer full):
*/
GtkWidget *
vinagre_utils_create_small_close_button ()
{
......@@ -128,6 +133,11 @@ vinagre_utils_get_ui_xml_filename (void)
return VINAGRE_DATADIR "/" VINAGRE_UI_XML_FILE;
}
/**
* vinagre_utils_get_builder:
*
* Return value: (allow-none) (transfer full):
*/
GtkBuilder *
vinagre_utils_get_builder (const gchar *filename)
{
......@@ -320,20 +330,6 @@ vinagre_utils_parse_boolean (const gchar* value)
return FALSE;
}
GtkWidget *
vinagre_gtk_button_new_with_stock_icon (const gchar *label,
const gchar *stock_id)
{
GtkWidget *button;
button = gtk_button_new_with_mnemonic (label);
gtk_button_set_image (GTK_BUTTON (button),
gtk_image_new_from_stock (stock_id,
GTK_ICON_SIZE_BUTTON));
return button;
}
/**
* vinagre_utils_ask_question:
* @parent: transient parent, or NULL for none
......
......@@ -57,9 +57,6 @@ void vinagre_utils_help_about (GtkWindow *window);
gboolean vinagre_utils_parse_boolean (const gchar* value);
GtkWidget *vinagre_gtk_button_new_with_stock_icon (const gchar *label,
const gchar *stock_id);
gboolean vinagre_utils_ask_question (GtkWindow *parent,
const char *message,
char **choices,
......
......@@ -843,6 +843,12 @@ vinagre_window_init (VinagreWindow *window)
g_idle_add ((GSourceFunc) vinagre_window_check_first_run, window);
}
/**
* vinagre_window_get_notebook:
* @window: A window
*
* Return value: (transfer none):
*/
VinagreNotebook *
vinagre_window_get_notebook (VinagreWindow *window)
{
......@@ -900,6 +906,12 @@ vinagre_window_toggle_fullscreen (VinagreWindow *window)
gtk_window_fullscreen (GTK_WINDOW (window));
}
/**
* vinagre_window_get_statusbar:
* @window: A window
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_window_get_statusbar (VinagreWindow *window)
{
......@@ -908,6 +920,12 @@ vinagre_window_get_statusbar (VinagreWindow *window)
return window->priv->statusbar;
}
/**
* vinagre_window_get_toolbar:
* @window: A window
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_window_get_toolbar (VinagreWindow *window)
{
......@@ -916,6 +934,12 @@ vinagre_window_get_toolbar (VinagreWindow *window)
return window->priv->toolbar;
}
/**
* vinagre_window_get_menubar:
* @window: A window
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_window_get_menubar (VinagreWindow *window)
{
......@@ -924,6 +948,12 @@ vinagre_window_get_menubar (VinagreWindow *window)
return window->priv->menubar;
}
/**
* vinagre_window_get_initialized_action:
* @window: A window
*
* Return value: (transfer none):
*/
GtkActionGroup *
vinagre_window_get_initialized_action (VinagreWindow *window)
{
......@@ -932,6 +962,12 @@ vinagre_window_get_initialized_action (VinagreWindow *window)
return window->priv->machine_initialized_action_group;
}
/**
* vinagre_window_get_always_sensitive_action:
* @window: A window
*
* Return value: (transfer none):
*/
GtkActionGroup *
vinagre_window_get_always_sensitive_action (VinagreWindow *window)
{
......@@ -940,6 +976,12 @@ vinagre_window_get_always_sensitive_action (VinagreWindow *window)
return window->priv->always_sensitive_action_group;
}
/**
* vinagre_window_get_connected_action:
* @window: A window
*
* Return value: (transfer none):
*/
GtkActionGroup *
vinagre_window_get_connected_action (VinagreWindow *window)
{
......@@ -948,6 +990,12 @@ vinagre_window_get_connected_action (VinagreWindow *window)
return window->priv->machine_connected_action_group;
}
/**
* vinagre_window_get_fav_panel:
* @window: A window
*
* Return value: (transfer none):
*/
GtkWidget *
vinagre_window_get_fav_panel (VinagreWindow *window)
{
......@@ -964,6 +1012,12 @@ vinagre_window_close_active_tab (VinagreWindow *window)
vinagre_notebook_close_active_tab (window->priv->notebook);
}
/**
* vinagre_window_get_active_tab:
* @window: A window
*
* Return value: (allow-none) (transfer none):
*/
VinagreTab *
vinagre_window_get_active_tab (VinagreWindow *window)
{
......@@ -972,6 +1026,12 @@ vinagre_window_get_active_tab (VinagreWindow *window)
return vinagre_notebook_get_active_tab (window->priv->notebook);
}
/**
* vinagre_window_get_ui_manager:
* @window: A window
*
* Return value: (transfer none):
*/
GtkUIManager *
vinagre_window_get_ui_manager (VinagreWindow *window)
{
......@@ -990,7 +1050,12 @@ add_connection (VinagreTab *tab, GList **res)
*res = g_list_prepend (*res, conn);
}
/* Returns a newly allocated list with all the connections in the window */
/**
* vinagre_window_get_connections: Returns a newly allocated
* list with all the connections in the window
*
* Return value: (element-type VinagreConnection) (transfer full):
*/
GList *
vinagre_window_get_connections (VinagreWindow *window)
{
......@@ -1007,6 +1072,12 @@ vinagre_window_get_connections (VinagreWindow *window)
return res;
}
/**
* vinagre_window_conn_exists:
* @window: A window
*
* Return value: (allow-none) (transfer none):
*/
VinagreTab *
vinagre_window_conn_exists (VinagreWindow *window, VinagreConnection *conn)
{
......
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