diff options
Diffstat (limited to 'doc')
61 files changed, 5811 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 000000000..2053a4567 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,2 @@ +SUBDIRS = libempathy libempathy-gtk + diff --git a/doc/libempathy-gtk/Makefile.am b/doc/libempathy-gtk/Makefile.am new file mode 100644 index 000000000..13c7db649 --- /dev/null +++ b/doc/libempathy-gtk/Makefile.am @@ -0,0 +1,69 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libempathy-gtk + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../libempathy-gtk + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.h +CFILE_GLOB=$(top_srcdir)/libempathy-gtk/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES=-I$(top_srcdir) $(EMPATHY_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libempathy-gtk/libempathy-gtk.la $(EMPATHY_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += diff --git a/doc/libempathy-gtk/libempathy-gtk-docs.sgml b/doc/libempathy-gtk/libempathy-gtk-docs.sgml new file mode 100644 index 000000000..715a18bf4 --- /dev/null +++ b/doc/libempathy-gtk/libempathy-gtk-docs.sgml @@ -0,0 +1,46 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libempathy-gtk Reference Manual</title> + </bookinfo> + + <chapter> + <title>libempathy-gtk API reference</title> + <xi:include href="xml/empathy-about-dialog.xml"/> + <xi:include href="xml/empathy-cell-renderer-text.xml"/> + <xi:include href="xml/empathy-contact-list-store.xml"/> + <xi:include href="xml/empathy-main-window.xml"/> + <xi:include href="xml/empathy-spell.xml"/> + <xi:include href="xml/empathy-account-chooser.xml"/> + <xi:include href="xml/empathy-chat.xml"/> + <xi:include href="xml/empathy-contact-list-view.xml"/> + <xi:include href="xml/empathy-new-chatroom-dialog.xml"/> + <xi:include href="xml/empathy-status-icon.xml"/> + <xi:include href="xml/empathy-accounts-dialog.xml"/> + <xi:include href="xml/empathy-chatrooms-window.xml"/> + <xi:include href="xml/empathy-contact-widget.xml"/> + <xi:include href="xml/empathy-preferences.xml"/> + <xi:include href="xml/empathy-status-presets.xml"/> + <xi:include href="xml/empathy-account-widget-generic.xml"/> + <xi:include href="xml/empathy-chat-view.xml"/> + <xi:include href="xml/empathy-geometry.xml"/> + <xi:include href="xml/empathy-presence-chooser.xml"/> + <xi:include href="xml/empathy-theme-manager.xml"/> + <xi:include href="xml/empathy-account-widget-jabber.xml"/> + <xi:include href="xml/empathy-chat-window.xml"/> + <xi:include href="xml/empathy-group-chat.xml"/> + <xi:include href="xml/empathy-private-chat.xml"/> + <xi:include href="xml/empathy-ui-utils.xml"/> + <xi:include href="xml/empathy-account-widget-msn.xml"/> + <xi:include href="xml/empathy-contact-dialogs.xml"/> + <xi:include href="xml/empathy-images.xml"/> + <xi:include href="xml/empathy-profile-chooser.xml"/> + <xi:include href="xml/ephy-spinner.xml"/> + <xi:include href="xml/empathy-cell-renderer-expander.xml"/> + <xi:include href="xml/empathy-contact-groups.xml"/> + <xi:include href="xml/empathy-log-window.xml"/> + <xi:include href="xml/empathy-spell-dialog.xml"/> + </chapter> +</book> diff --git a/doc/libempathy-gtk/libempathy-gtk.types b/doc/libempathy-gtk/libempathy-gtk.types new file mode 100644 index 000000000..56a9982e9 --- /dev/null +++ b/doc/libempathy-gtk/libempathy-gtk.types @@ -0,0 +1,28 @@ +#include <libempathy-gtk/empathy-cell-renderer-text.h> +#include <libempathy-gtk/empathy-contact-list-store.h> +#include <libempathy-gtk/empathy-chat.h> +#include <libempathy-gtk/empathy-chat-window.h> +#include <libempathy-gtk/empathy-contact-list-view.h> +#include <libempathy-gtk/empathy-status-icon.h> +#include <libempathy-gtk/empathy-chat-view.h> +#include <libempathy-gtk/empathy-presence-chooser.h> +#include <libempathy-gtk/empathy-theme-manager.h> +#include <libempathy-gtk/empathy-group-chat.h> +#include <libempathy-gtk/empathy-private-chat.h> +#include <libempathy-gtk/ephy-spinner.h> +#include <libempathy-gtk/empathy-cell-renderer-expander.h> + +empathy_cell_renderer_text_get_type +empathy_contact_list_store_get_type +empathy_chat_get_type +empathy_chat_window_get_type +empathy_contact_list_view_get_type +empathy_status_icon_get_type +empathy_chat_view_get_type +empathy_presence_chooser_get_type +empathy_theme_manager_get_type +empathy_group_chat_get_type +empathy_private_chat_get_type +ephy_spinner_get_type +empathy_cell_renderer_expander_get_type + diff --git a/doc/libempathy-gtk/tmpl/empathy-about-dialog.sgml b/doc/libempathy-gtk/tmpl/empathy-about-dialog.sgml new file mode 100644 index 000000000..05dd8668e --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-about-dialog.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +empathy-about-dialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_about_dialog_new ##### --> +<para> + +</para> + +@parent: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-account-chooser.sgml b/doc/libempathy-gtk/tmpl/empathy-account-chooser.sgml new file mode 100644 index 000000000..73f07db43 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-account-chooser.sgml @@ -0,0 +1,89 @@ +<!-- ##### SECTION Title ##### --> +EmpathyAccountChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyAccountChooser ##### --> +<para> + +</para> + +@parent: + +<!-- ##### FUNCTION empathy_account_chooser_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_account_chooser_get_account ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION empathy_account_chooser_set_account ##### --> +<para> + +</para> + +@chooser: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_account_chooser_get_can_select_all ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION empathy_account_chooser_set_can_select_all ##### --> +<para> + +</para> + +@chooser: +@can_select_all: + + +<!-- ##### FUNCTION empathy_account_chooser_get_has_all_option ##### --> +<para> + +</para> + +@chooser: +@Returns: + + +<!-- ##### FUNCTION empathy_account_chooser_set_has_all_option ##### --> +<para> + +</para> + +@chooser: +@has_all_option: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-account-widget-generic.sgml b/doc/libempathy-gtk/tmpl/empathy-account-widget-generic.sgml new file mode 100644 index 000000000..21e9f6f5c --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-account-widget-generic.sgml @@ -0,0 +1,29 @@ +<!-- ##### SECTION Title ##### --> +empathy-account-widget-generic + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_account_widget_generic_new ##### --> +<para> + +</para> + +@account: +@label_name: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-account-widget-jabber.sgml b/doc/libempathy-gtk/tmpl/empathy-account-widget-jabber.sgml new file mode 100644 index 000000000..9b95ff6db --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-account-widget-jabber.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +empathy-account-widget-jabber + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_account_widget_jabber_new ##### --> +<para> + +</para> + +@account: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-account-widget-msn.sgml b/doc/libempathy-gtk/tmpl/empathy-account-widget-msn.sgml new file mode 100644 index 000000000..2a870c54a --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-account-widget-msn.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +empathy-account-widget-msn + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_account_widget_msn_new ##### --> +<para> + +</para> + +@account: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-accounts-dialog.sgml b/doc/libempathy-gtk/tmpl/empathy-accounts-dialog.sgml new file mode 100644 index 000000000..c2c71dd67 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-accounts-dialog.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +empathy-accounts-dialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_accounts_dialog_show ##### --> +<para> + +</para> + +@parent: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-cell-renderer-expander.sgml b/doc/libempathy-gtk/tmpl/empathy-cell-renderer-expander.sgml new file mode 100644 index 000000000..db4b651af --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-cell-renderer-expander.sgml @@ -0,0 +1,48 @@ +<!-- ##### SECTION Title ##### --> +EmpathyCellRendererExpander + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyCellRendererExpander ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyCellRendererExpander:activatable ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyCellRendererExpander:expander-size ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyCellRendererExpander:expander-style ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_cell_renderer_expander_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-cell-renderer-text.sgml b/doc/libempathy-gtk/tmpl/empathy-cell-renderer-text.sgml new file mode 100644 index 000000000..78e9bf3ec --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-cell-renderer-text.sgml @@ -0,0 +1,59 @@ +<!-- ##### SECTION Title ##### --> +EmpathyCellRendererText + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyCellRendererTextPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyCellRendererText ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyCellRendererText:is-group ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyCellRendererText:name ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyCellRendererText:show-status ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyCellRendererText:status ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_cell_renderer_text_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-chat-view.sgml b/doc/libempathy-gtk/tmpl/empathy-chat-view.sgml new file mode 100644 index 000000000..9377fee7a --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-chat-view.sgml @@ -0,0 +1,253 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChatView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyChatViewPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyChatView ##### --> +<para> + +</para> + + +<!-- ##### ENUM EmpathySmiley ##### --> +<para> + +</para> + +@EMPATHY_SMILEY_NORMAL: +@EMPATHY_SMILEY_WINK: +@EMPATHY_SMILEY_BIGEYE: +@EMPATHY_SMILEY_NOSE: +@EMPATHY_SMILEY_CRY: +@EMPATHY_SMILEY_SAD: +@EMPATHY_SMILEY_SCEPTICAL: +@EMPATHY_SMILEY_BIGSMILE: +@EMPATHY_SMILEY_INDIFFERENT: +@EMPATHY_SMILEY_TOUNGE: +@EMPATHY_SMILEY_SHOCKED: +@EMPATHY_SMILEY_COOL: +@EMPATHY_SMILEY_SORRY: +@EMPATHY_SMILEY_KISS: +@EMPATHY_SMILEY_SHUTUP: +@EMPATHY_SMILEY_YAWN: +@EMPATHY_SMILEY_CONFUSED: +@EMPATHY_SMILEY_ANGEL: +@EMPATHY_SMILEY_OOOH: +@EMPATHY_SMILEY_LOOKAWAY: +@EMPATHY_SMILEY_BLUSH: +@EMPATHY_SMILEY_COOLBIGSMILE: +@EMPATHY_SMILEY_ANGRY: +@EMPATHY_SMILEY_BOSS: +@EMPATHY_SMILEY_MONKEY: +@EMPATHY_SMILEY_SILLY: +@EMPATHY_SMILEY_SICK: +@EMPATHY_SMILEY_COUNT: + +<!-- ##### FUNCTION empathy_chat_view_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_append_message ##### --> +<para> + +</para> + +@view: +@msg: + + +<!-- ##### FUNCTION empathy_chat_view_append_event ##### --> +<para> + +</para> + +@view: +@str: + + +<!-- ##### FUNCTION empathy_chat_view_append_button ##### --> +<para> + +</para> + +@view: +@message: +@button1: +@button2: + + +<!-- ##### FUNCTION empathy_chat_view_set_margin ##### --> +<para> + +</para> + +@view: +@margin: + + +<!-- ##### FUNCTION empathy_chat_view_scroll ##### --> +<para> + +</para> + +@view: +@allow_scrolling: + + +<!-- ##### FUNCTION empathy_chat_view_scroll_down ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION empathy_chat_view_get_selection_bounds ##### --> +<para> + +</para> + +@view: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_clear ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION empathy_chat_view_find_previous ##### --> +<para> + +</para> + +@view: +@search_criteria: +@new_search: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_find_next ##### --> +<para> + +</para> + +@view: +@search_criteria: +@new_search: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_find_abilities ##### --> +<para> + +</para> + +@view: +@search_criteria: +@can_do_previous: +@can_do_next: + + +<!-- ##### FUNCTION empathy_chat_view_highlight ##### --> +<para> + +</para> + +@view: +@text: + + +<!-- ##### FUNCTION empathy_chat_view_copy_clipboard ##### --> +<para> + +</para> + +@view: + + +<!-- ##### FUNCTION empathy_chat_view_get_irc_style ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_set_irc_style ##### --> +<para> + +</para> + +@view: +@irc_style: + + +<!-- ##### FUNCTION empathy_chat_view_get_smiley_image ##### --> +<para> + +</para> + +@smiley: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_get_smiley_text ##### --> +<para> + +</para> + +@smiley: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_get_smiley_menu ##### --> +<para> + +</para> + +@callback: +@user_data: +@tooltips: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_view_set_is_group_chat ##### --> +<para> + +</para> + +@view: +@is_group_chat: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-chat-window.sgml b/doc/libempathy-gtk/tmpl/empathy-chat-window.sgml new file mode 100644 index 000000000..477d4b1cb --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-chat-window.sgml @@ -0,0 +1,112 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChatWindow + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyChatWindowPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyChatWindow ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_chat_window_get_default ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_chat_window_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_chat_window_get_dialog ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_window_add_chat ##### --> +<para> + +</para> + +@window: +@chat: + + +<!-- ##### FUNCTION empathy_chat_window_remove_chat ##### --> +<para> + +</para> + +@window: +@chat: + + +<!-- ##### FUNCTION empathy_chat_window_move_chat ##### --> +<para> + +</para> + +@old_window: +@new_window: +@chat: + + +<!-- ##### FUNCTION empathy_chat_window_switch_to_chat ##### --> +<para> + +</para> + +@window: +@chat: + + +<!-- ##### FUNCTION empathy_chat_window_has_focus ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_window_find_chat ##### --> +<para> + +</para> + +@account: +@id: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-chat.sgml b/doc/libempathy-gtk/tmpl/empathy-chat.sgml new file mode 100644 index 000000000..1becb16bc --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-chat.sgml @@ -0,0 +1,272 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyChatPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyChat ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyChat::composing ##### --> +<para> + +</para> + +@empathychat: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EmpathyChat::name-changed ##### --> +<para> + +</para> + +@empathychat: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EmpathyChat::new-message ##### --> +<para> + +</para> + +@empathychat: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL EmpathyChat::status-changed ##### --> +<para> + +</para> + +@empathychat: the object which received the signal. + +<!-- ##### FUNCTION empathy_chat_get_view ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_get_window ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_set_window ##### --> +<para> + +</para> + +@chat: +@window: + + +<!-- ##### FUNCTION empathy_chat_present ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_clear ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_scroll_down ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_cut ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_copy ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_paste ##### --> +<para> + +</para> + +@chat: + + +<!-- ##### FUNCTION empathy_chat_get_name ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_get_tooltip ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_get_status_icon_name ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_get_widget ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_is_group_chat ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_is_connected ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_save_geometry ##### --> +<para> + +</para> + +@chat: +@x: +@y: +@w: +@h: + + +<!-- ##### FUNCTION empathy_chat_load_geometry ##### --> +<para> + +</para> + +@chat: +@x: +@y: +@w: +@h: + + +<!-- ##### FUNCTION empathy_chat_set_tp_chat ##### --> +<para> + +</para> + +@chat: +@tp_chat: + + +<!-- ##### FUNCTION empathy_chat_get_id ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_get_is_command ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_correct_word ##### --> +<para> + +</para> + +@chat: +@start: +@end: +@new_word: + + +<!-- ##### FUNCTION empathy_chat_should_play_sound ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_chat_should_highlight_nick ##### --> +<para> + +</para> + +@message: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-chatrooms-window.sgml b/doc/libempathy-gtk/tmpl/empathy-chatrooms-window.sgml new file mode 100644 index 000000000..c3b7e2d72 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-chatrooms-window.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +empathy-chatrooms-window + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_chatrooms_window_show ##### --> +<para> + +</para> + +@parent: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-contact-dialogs.sgml b/doc/libempathy-gtk/tmpl/empathy-contact-dialogs.sgml new file mode 100644 index 000000000..1a02958b7 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-contact-dialogs.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +empathy-contact-dialogs + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_subscription_dialog_show ##### --> +<para> + +</para> + +@contact: +@parent: + + +<!-- ##### FUNCTION empathy_contact_information_dialog_show ##### --> +<para> + +</para> + +@contact: +@parent: +@edit: + + +<!-- ##### FUNCTION empathy_new_contact_dialog_show ##### --> +<para> + +</para> + +@parent: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-contact-groups.sgml b/doc/libempathy-gtk/tmpl/empathy-contact-groups.sgml new file mode 100644 index 000000000..4d3d93ce5 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-contact-groups.sgml @@ -0,0 +1,44 @@ +<!-- ##### SECTION Title ##### --> +empathy-contact-groups + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_contact_groups_get_all ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION empathy_contact_group_get_expanded ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_group_set_expanded ##### --> +<para> + +</para> + +@group: +@expanded: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-contact-list-store.sgml b/doc/libempathy-gtk/tmpl/empathy-contact-list-store.sgml new file mode 100644 index 000000000..3e764ffea --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-contact-list-store.sgml @@ -0,0 +1,228 @@ +<!-- ##### SECTION Title ##### --> +EmpathyContactListStore + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_TYPE_CONTACT_LIST_STORE_SORT ##### --> +<para> + +</para> + + + +<!-- ##### ENUM EmpathyContactListStoreSort ##### --> +<para> + +</para> + +@EMPATHY_CONTACT_LIST_STORE_SORT_STATE: +@EMPATHY_CONTACT_LIST_STORE_SORT_NAME: + +<!-- ##### STRUCT EmpathyContactListStorePriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyContactListStore ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyContactListStore:is-compact ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContactListStore:show-avatars ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContactListStore:show-offline ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContactListStore:sort-criterium ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION EmpathyContactGroupsFunc ##### --> +<para> + +</para> + +@contact: +@user_data: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_type ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_new ##### --> +<para> + +</para> + +@list_iface: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_list_iface ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_show_offline ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_set_show_offline ##### --> +<para> + +</para> + +@store: +@show_offline: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_show_avatars ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_set_show_avatars ##### --> +<para> + +</para> + +@store: +@show_avatars: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_is_compact ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_set_is_compact ##### --> +<para> + +</para> + +@store: +@is_compact: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_sort_criterium ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_set_sort_criterium ##### --> +<para> + +</para> + +@store: +@sort_criterium: + + +<!-- ##### FUNCTION empathy_contact_list_store_row_separator_func ##### --> +<para> + +</para> + +@model: +@iter: +@data: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_get_parent_group ##### --> +<para> + +</para> + +@model: +@path: +@path_is_group: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_search_equal_func ##### --> +<para> + +</para> + +@model: +@column: +@key: +@iter: +@search_data: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_store_set_contact_groups_func ##### --> +<para> + +</para> + +@store: +@func: +@user_data: + + +<!-- ##### FUNCTION empathy_contact_list_store_update_contact_groups ##### --> +<para> + +</para> + +@store: +@contact: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-contact-list-view.sgml b/doc/libempathy-gtk/tmpl/empathy-contact-list-view.sgml new file mode 100644 index 000000000..ad7a1ff71 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-contact-list-view.sgml @@ -0,0 +1,123 @@ +<!-- ##### SECTION Title ##### --> +EmpathyContactListView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyContactListViewPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyContactListView ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyContactListView::drag-contact-received ##### --> +<para> + +</para> + +@empathycontactlistview: the object which received the signal. +@arg1: +@arg2: +@arg3: + +<!-- ##### ARG EmpathyContactListView:filter ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION EmpathyContactListViewDragReceivedFunc ##### --> +<para> + +</para> + +@contact: +@action: +@old_group: +@new_group: +@user_data: + + +<!-- ##### FUNCTION empathy_contact_list_view_new ##### --> +<para> + +</para> + +@store: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_view_get_selected ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_view_get_selected_group ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_view_get_contact_menu ##### --> +<para> + +</para> + +@view: +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_view_get_group_menu ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_view_set_filter ##### --> +<para> + +</para> + +@view: +@filter: + + +<!-- ##### FUNCTION empathy_contact_list_view_set_drag_received_func ##### --> +<para> + +</para> + +@view: +@func: +@user_data: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-contact-widget.sgml b/doc/libempathy-gtk/tmpl/empathy-contact-widget.sgml new file mode 100644 index 000000000..bdba0d8f5 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-contact-widget.sgml @@ -0,0 +1,38 @@ +<!-- ##### SECTION Title ##### --> +empathy-contact-widget + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_contact_widget_new ##### --> +<para> + +</para> + +@contact: +@editable: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_widget_get_contact ##### --> +<para> + +</para> + +@widget: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-geometry.sgml b/doc/libempathy-gtk/tmpl/empathy-geometry.sgml new file mode 100644 index 000000000..d90493150 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-geometry.sgml @@ -0,0 +1,43 @@ +<!-- ##### SECTION Title ##### --> +empathy-geometry + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_geometry_save ##### --> +<para> + +</para> + +@name: +@x: +@y: +@w: +@h: + + +<!-- ##### FUNCTION empathy_geometry_load ##### --> +<para> + +</para> + +@name: +@x: +@y: +@w: +@h: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-group-chat.sgml b/doc/libempathy-gtk/tmpl/empathy-group-chat.sgml new file mode 100644 index 000000000..550a89a6d --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-group-chat.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +EmpathyGroupChat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyGroupChatPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyGroupChat ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_group_chat_new ##### --> +<para> + +</para> + +@account: +@tp_chan: +@Returns: + + +<!-- ##### FUNCTION empathy_group_chat_get_show_contacts ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_group_chat_set_show_contacts ##### --> +<para> + +</para> + +@chat: +@show: + + +<!-- ##### FUNCTION empathy_group_chat_set_topic ##### --> +<para> + +</para> + +@chat: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-images.sgml b/doc/libempathy-gtk/tmpl/empathy-images.sgml new file mode 100644 index 000000000..354bc81a4 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-images.sgml @@ -0,0 +1,96 @@ +<!-- ##### SECTION Title ##### --> +empathy-images + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_IMAGE_OFFLINE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_AVAILABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_BUSY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_AWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_EXT_AWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_PENDING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_MESSAGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_NEW_MESSAGE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_TYPING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_CONTACT_INFORMATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_IMAGE_GROUP_MESSAGE ##### --> +<para> + +</para> + + + diff --git a/doc/libempathy-gtk/tmpl/empathy-log-window.sgml b/doc/libempathy-gtk/tmpl/empathy-log-window.sgml new file mode 100644 index 000000000..f8cfb67af --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-log-window.sgml @@ -0,0 +1,30 @@ +<!-- ##### SECTION Title ##### --> +empathy-log-window + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_log_window_show ##### --> +<para> + +</para> + +@account: +@chat_id: +@chatroom: +@parent: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-main-window.sgml b/doc/libempathy-gtk/tmpl/empathy-main-window.sgml new file mode 100644 index 000000000..d76fc260f --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-main-window.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +empathy-main-window + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_main_window_show ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-new-chatroom-dialog.sgml b/doc/libempathy-gtk/tmpl/empathy-new-chatroom-dialog.sgml new file mode 100644 index 000000000..fb8a7a527 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-new-chatroom-dialog.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +empathy-new-chatroom-dialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_new_chatroom_dialog_show ##### --> +<para> + +</para> + +@parent: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-preferences.sgml b/doc/libempathy-gtk/tmpl/empathy-preferences.sgml new file mode 100644 index 000000000..0b7a7d27a --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-preferences.sgml @@ -0,0 +1,154 @@ +<!-- ##### SECTION Title ##### --> +empathy-preferences + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_PREFS_PATH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_SOUNDS_FOR_MESSAGES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_SOUNDS_WHEN_AWAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_SOUNDS_WHEN_BUSY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_POPUPS_WHEN_AVAILABLE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CHAT_SHOW_SMILEYS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CHAT_THEME ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CHAT_THEME_CHAT_ROOM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CHAT_SPELL_CHECKER_LANGUAGES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CHAT_SPELL_CHECKER_ENABLED ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_UI_SEPARATE_CHAT_WINDOWS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_UI_MAIN_WINDOW_HIDDEN ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_UI_AVATAR_DIRECTORY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_UI_SHOW_AVATARS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_UI_COMPACT_CONTACT_LIST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CONTACTS_SHOW_OFFLINE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_CONTACTS_SORT_CRITERIUM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_PREFS_HINTS_CLOSE_MAIN_WINDOW ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION empathy_preferences_show ##### --> +<para> + +</para> + +@parent: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-presence-chooser.sgml b/doc/libempathy-gtk/tmpl/empathy-presence-chooser.sgml new file mode 100644 index 000000000..e83400ed9 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-presence-chooser.sgml @@ -0,0 +1,41 @@ +<!-- ##### SECTION Title ##### --> +EmpathyPresenceChooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyPresenceChooser ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_presence_chooser_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_presence_chooser_create_menu ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-private-chat.sgml b/doc/libempathy-gtk/tmpl/empathy-private-chat.sgml new file mode 100644 index 000000000..3e698110a --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-private-chat.sgml @@ -0,0 +1,59 @@ +<!-- ##### SECTION Title ##### --> +EmpathyPrivateChat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyPrivateChatPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyPrivateChat ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_private_chat_new ##### --> +<para> + +</para> + +@account: +@tp_chan: +@Returns: + + +<!-- ##### FUNCTION empathy_private_chat_new_with_contact ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_private_chat_get_contact ##### --> +<para> + +</para> + +@chat: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-profile-chooser.sgml b/doc/libempathy-gtk/tmpl/empathy-profile-chooser.sgml new file mode 100644 index 000000000..6fa0fdf50 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-profile-chooser.sgml @@ -0,0 +1,36 @@ +<!-- ##### SECTION Title ##### --> +empathy-profile-chooser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_profile_chooser_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_profile_chooser_get_selected ##### --> +<para> + +</para> + +@widget: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-spell-dialog.sgml b/doc/libempathy-gtk/tmpl/empathy-spell-dialog.sgml new file mode 100644 index 000000000..e752bf772 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-spell-dialog.sgml @@ -0,0 +1,30 @@ +<!-- ##### SECTION Title ##### --> +empathy-spell-dialog + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_spell_dialog_show ##### --> +<para> + +</para> + +@chat: +@start: +@end: +@word: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-spell.sgml b/doc/libempathy-gtk/tmpl/empathy-spell.sgml new file mode 100644 index 000000000..b54967b07 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-spell.sgml @@ -0,0 +1,78 @@ +<!-- ##### SECTION Title ##### --> +empathy-spell + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_spell_supported ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_spell_get_language_name ##### --> +<para> + +</para> + +@code: +@Returns: + + +<!-- ##### FUNCTION empathy_spell_get_language_codes ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_spell_free_language_codes ##### --> +<para> + +</para> + +@codes: + + +<!-- ##### FUNCTION empathy_spell_check ##### --> +<para> + +</para> + +@word: +@Returns: + + +<!-- ##### FUNCTION empathy_spell_get_suggestions ##### --> +<para> + +</para> + +@word: +@Returns: + + +<!-- ##### FUNCTION empathy_spell_free_suggestions ##### --> +<para> + +</para> + +@suggestions: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-status-icon.sgml b/doc/libempathy-gtk/tmpl/empathy-status-icon.sgml new file mode 100644 index 000000000..54b5095e7 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-status-icon.sgml @@ -0,0 +1,40 @@ +<!-- ##### SECTION Title ##### --> +EmpathyStatusIcon + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyStatusIconPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyStatusIcon ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_status_icon_new ##### --> +<para> + +</para> + +@window: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-status-presets.sgml b/doc/libempathy-gtk/tmpl/empathy-status-presets.sgml new file mode 100644 index 000000000..e40cf81e8 --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-status-presets.sgml @@ -0,0 +1,84 @@ +<!-- ##### SECTION Title ##### --> +empathy-status-presets + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION empathy_status_presets_get_all ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION empathy_status_presets_get ##### --> +<para> + +</para> + +@state: +@max_number: +@Returns: + + +<!-- ##### FUNCTION empathy_status_presets_set_last ##### --> +<para> + +</para> + +@state: +@status: + + +<!-- ##### FUNCTION empathy_status_presets_reset ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION empathy_status_presets_get_default_state ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_status_presets_get_default_status ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_status_presets_set_default ##### --> +<para> + +</para> + +@state: +@status: + + +<!-- ##### FUNCTION empathy_status_presets_clear_default ##### --> +<para> + +</para> + + + diff --git a/doc/libempathy-gtk/tmpl/empathy-theme-manager.sgml b/doc/libempathy-gtk/tmpl/empathy-theme-manager.sgml new file mode 100644 index 000000000..04d2f24ae --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-theme-manager.sgml @@ -0,0 +1,77 @@ +<!-- ##### SECTION Title ##### --> +EmpathyThemeManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyThemeManager ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyThemeManager::theme-changed ##### --> +<para> + +</para> + +@empathythememanager: the object which received the signal. + +<!-- ##### FUNCTION empathy_theme_manager_get ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_theme_manager_get_themes ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_theme_manager_apply ##### --> +<para> + +</para> + +@manager: +@view: +@theme: + + +<!-- ##### FUNCTION empathy_theme_manager_apply_saved ##### --> +<para> + +</para> + +@manager: +@view: + + +<!-- ##### FUNCTION empathy_theme_manager_update_show_avatars ##### --> +<para> + +</para> + +@manager: +@view: +@show: + + diff --git a/doc/libempathy-gtk/tmpl/empathy-ui-utils.sgml b/doc/libempathy-gtk/tmpl/empathy-ui-utils.sgml new file mode 100644 index 000000000..3597a859d --- /dev/null +++ b/doc/libempathy-gtk/tmpl/empathy-ui-utils.sgml @@ -0,0 +1,243 @@ +<!-- ##### SECTION Title ##### --> +empathy-ui-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO G_STR_EMPTY ##### --> +<para> + +</para> + +@x: + + +<!-- ##### FUNCTION empathy_glade_get_file_simple ##### --> +<para> + +</para> + +@filename: +@root: +@domain: +@first_required_widget: +@Varargs: + + +<!-- ##### FUNCTION empathy_glade_get_file ##### --> +<para> + +</para> + +@filename: +@root: +@domain: +@first_required_widget: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION empathy_glade_connect ##### --> +<para> + +</para> + +@gui: +@user_data: +@first_widget: +@Varargs: + + +<!-- ##### FUNCTION empathy_glade_setup_size_group ##### --> +<para> + +</para> + +@gui: +@mode: +@first_widget: +@Varargs: + + +<!-- ##### FUNCTION empathy_pixbuf_from_icon_name ##### --> +<para> + +</para> + +@icon_name: +@icon_size: +@Returns: + + +<!-- ##### FUNCTION empathy_pixbuf_from_smiley ##### --> +<para> + +</para> + +@type: +@icon_size: +@Returns: + + +<!-- ##### FUNCTION empathy_icon_name_from_account ##### --> +<para> + +</para> + +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_icon_name_for_presence_state ##### --> +<para> + +</para> + +@state: +@Returns: + + +<!-- ##### FUNCTION empathy_icon_name_for_presence ##### --> +<para> + +</para> + +@presence: +@Returns: + + +<!-- ##### FUNCTION empathy_icon_name_for_contact ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_pixbuf_from_avatar_scaled ##### --> +<para> + +</para> + +@avatar: +@width: +@height: +@Returns: + + +<!-- ##### FUNCTION empathy_pixbuf_avatar_from_contact ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_pixbuf_avatar_from_contact_scaled ##### --> +<para> + +</para> + +@contact: +@width: +@height: +@Returns: + + +<!-- ##### FUNCTION empathy_text_iter_forward_search ##### --> +<para> + +</para> + +@iter: +@str: +@match_start: +@match_end: +@limit: +@Returns: + + +<!-- ##### FUNCTION empathy_text_iter_backward_search ##### --> +<para> + +</para> + +@iter: +@str: +@match_start: +@match_end: +@limit: +@Returns: + + +<!-- ##### FUNCTION empathy_window_get_is_visible ##### --> +<para> + +</para> + +@window: +@Returns: + + +<!-- ##### FUNCTION empathy_window_present ##### --> +<para> + +</para> + +@window: +@steal_focus: + + +<!-- ##### FUNCTION empathy_get_toplevel_window ##### --> +<para> + +</para> + +@widget: +@Returns: + + +<!-- ##### FUNCTION empathy_url_show ##### --> +<para> + +</para> + +@url: + + +<!-- ##### FUNCTION empathy_toggle_button_set_state_quietly ##### --> +<para> + +</para> + +@widget: +@callback: +@user_data: +@active: + + +<!-- ##### FUNCTION empathy_link_button_new ##### --> +<para> + +</para> + +@url: +@title: +@Returns: + + diff --git a/doc/libempathy-gtk/tmpl/ephy-spinner.sgml b/doc/libempathy-gtk/tmpl/ephy-spinner.sgml new file mode 100644 index 000000000..5d8319fab --- /dev/null +++ b/doc/libempathy-gtk/tmpl/ephy-spinner.sgml @@ -0,0 +1,64 @@ +<!-- ##### SECTION Title ##### --> +EphySpinner + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EphySpinnerDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EphySpinner ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION ephy_spinner_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION ephy_spinner_start ##### --> +<para> + +</para> + +@throbber: + + +<!-- ##### FUNCTION ephy_spinner_stop ##### --> +<para> + +</para> + +@throbber: + + +<!-- ##### FUNCTION ephy_spinner_set_size ##### --> +<para> + +</para> + +@spinner: +@size: + + diff --git a/doc/libempathy/Makefile.am b/doc/libempathy/Makefile.am new file mode 100644 index 000000000..d725ff649 --- /dev/null +++ b/doc/libempathy/Makefile.am @@ -0,0 +1,69 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libempathy + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../libempathy + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/libempathy/*.h +CFILE_GLOB=$(top_srcdir)/libempathy/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES=empathy-filter-glue.h empathy-debug.h empathy-marshal.h + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES=-I$(top_srcdir) $(LIBEMPATHY_CFLAGS) +GTKDOC_LIBS=$(top_builddir)/libempathy/libempathy.la $(LIBEMPATHY_LIBS) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += diff --git a/doc/libempathy/libempathy-docs.sgml b/doc/libempathy/libempathy-docs.sgml new file mode 100644 index 000000000..354c5921c --- /dev/null +++ b/doc/libempathy/libempathy-docs.sgml @@ -0,0 +1,31 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libempathy Reference Manual</title> + </bookinfo> + + <chapter> + <title>libempathy API reference</title> + <xi:include href="xml/empathy-tp-group.xml"/> + <xi:include href="xml/empathy-tp-contact-list.xml"/> + <xi:include href="xml/empathy-tp-chat.xml"/> + <xi:include href="xml/empathy-tp-chatroom.xml"/> + <xi:include href="xml/empathy-avatar.xml"/> + <xi:include href="xml/empathy-conf.xml"/> + <xi:include href="xml/empathy-message.xml"/> + <xi:include href="xml/empathy-contact-list.xml"/> + <xi:include href="xml/empathy-filter.xml"/> + <xi:include href="xml/empathy-presence.xml"/> + <xi:include href="xml/empathy-chandler.xml"/> + <xi:include href="xml/empathy-contact-manager.xml"/> + <xi:include href="xml/empathy-idle.xml"/> + <xi:include href="xml/empathy-time.xml"/> + <xi:include href="xml/empathy-utils.xml"/> + <xi:include href="xml/empathy-chatroom-manager.xml"/> + <xi:include href="xml/empathy-contact.xml"/> + <xi:include href="xml/empathy-log-manager.xml"/> + <xi:include href="xml/empathy-chatroom.xml"/> + </chapter> +</book> diff --git a/doc/libempathy/libempathy.types b/doc/libempathy/libempathy.types new file mode 100644 index 000000000..0211e40b1 --- /dev/null +++ b/doc/libempathy/libempathy.types @@ -0,0 +1,36 @@ +#include <libempathy/empathy-avatar.h> +#include <libempathy/empathy-chatroom-manager.h> +#include <libempathy/empathy-contact-manager.h> +#include <libempathy/empathy-idle.h> +#include <libempathy/empathy-presence.h> +#include <libempathy/empathy-tp-contact-list.h> +#include <libempathy/empathy-conf.h> +#include <libempathy/empathy-log-manager.h> +#include <libempathy/empathy-tp-group.h> +#include <libempathy/empathy-chandler.h> +#include <libempathy/empathy-contact.h> +#include <libempathy/empathy-tp-chat.h> +#include <libempathy/empathy-chatroom.h> +#include <libempathy/empathy-contact-list.h> +#include <libempathy/empathy-filter.h> +#include <libempathy/empathy-message.h> +#include <libempathy/empathy-tp-chatroom.h> + +empathy_avatar_get_gtype +empathy_chatroom_manager_get_type +empathy_contact_manager_get_type +empathy_idle_get_type +empathy_presence_get_type +empathy_tp_contact_list_get_type +empathy_conf_get_type +empathy_log_manager_get_type +empathy_tp_group_get_type +empathy_chandler_get_type +empathy_contact_get_gtype +empathy_tp_chat_get_type +empathy_chatroom_get_type +empathy_contact_list_get_type +empathy_filter_get_type +empathy_message_get_gtype +empathy_tp_chatroom_get_type + diff --git a/doc/libempathy/tmpl/empathy-avatar.sgml b/doc/libempathy/tmpl/empathy-avatar.sgml new file mode 100644 index 000000000..44035517e --- /dev/null +++ b/doc/libempathy/tmpl/empathy-avatar.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +empathy-avatar + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_TYPE_AVATAR ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EmpathyAvatar ##### --> +<para> + +</para> + +@data: +@len: +@format: +@refcount: + +<!-- ##### FUNCTION empathy_avatar_get_gtype ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_avatar_new ##### --> +<para> + +</para> + +@avatar: +@len: +@format: +@Returns: + + +<!-- ##### FUNCTION empathy_avatar_ref ##### --> +<para> + +</para> + +@avatar: +@Returns: + + +<!-- ##### FUNCTION empathy_avatar_unref ##### --> +<para> + +</para> + +@avatar: + + diff --git a/doc/libempathy/tmpl/empathy-chandler-glue.sgml b/doc/libempathy/tmpl/empathy-chandler-glue.sgml new file mode 100644 index 000000000..3887466ca --- /dev/null +++ b/doc/libempathy/tmpl/empathy-chandler-glue.sgml @@ -0,0 +1,176 @@ +<!-- ##### SECTION Title ##### --> +empathy-chandler-glue + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO g_marshal_value_peek_boolean ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_char ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_uchar ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_int ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_uint ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_long ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_ulong ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_int64 ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_uint64 ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_enum ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_flags ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_float ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_double ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_string ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_param ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_boxed ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_pointer ##### --> +<para> + +</para> + +@v: + + +<!-- ##### MACRO g_marshal_value_peek_object ##### --> +<para> + +</para> + +@v: + + +<!-- ##### FUNCTION dbus_glib_marshal_empathy_chandler_BOOLEAN__STRING_BOXED_STRING_BOXED_UINT_UINT_POINTER ##### --> +<para> + +</para> + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + diff --git a/doc/libempathy/tmpl/empathy-chandler.sgml b/doc/libempathy/tmpl/empathy-chandler.sgml new file mode 100644 index 000000000..bc7e059c6 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-chandler.sgml @@ -0,0 +1,44 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChandler + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyChandler ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyChandler::new-channel ##### --> +<para> + +</para> + +@empathychandler: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### FUNCTION empathy_chandler_new ##### --> +<para> + +</para> + +@bus_name: +@object_path: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-chatroom-manager.sgml b/doc/libempathy/tmpl/empathy-chatroom-manager.sgml new file mode 100644 index 000000000..28123f5da --- /dev/null +++ b/doc/libempathy/tmpl/empathy-chatroom-manager.sgml @@ -0,0 +1,113 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChatroomManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyChatroomManagerPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyChatroomManager ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyChatroomManager::chatroom-added ##### --> +<para> + +</para> + +@empathychatroommanager: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EmpathyChatroomManager::chatroom-removed ##### --> +<para> + +</para> + +@empathychatroommanager: the object which received the signal. +@arg1: + +<!-- ##### FUNCTION empathy_chatroom_manager_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_manager_add ##### --> +<para> + +</para> + +@manager: +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_manager_remove ##### --> +<para> + +</para> + +@manager: +@chatroom: + + +<!-- ##### FUNCTION empathy_chatroom_manager_find ##### --> +<para> + +</para> + +@manager: +@account: +@room: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_manager_get_chatrooms ##### --> +<para> + +</para> + +@manager: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_manager_get_count ##### --> +<para> + +</para> + +@manager: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_manager_store ##### --> +<para> + +</para> + +@manager: + + diff --git a/doc/libempathy/tmpl/empathy-chatroom.sgml b/doc/libempathy/tmpl/empathy-chatroom.sgml new file mode 100644 index 000000000..f5213d7e2 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-chatroom.sgml @@ -0,0 +1,162 @@ +<!-- ##### SECTION Title ##### --> +EmpathyChatroom + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_TYPE_CHATROOM_INVITE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT EmpathyChatroomPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyChatroom ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyChatroom:account ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyChatroom:auto-connect ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyChatroom:name ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyChatroom:room ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_chatroom_new ##### --> +<para> + +</para> + +@account: +@room: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_new_full ##### --> +<para> + +</para> + +@account: +@room: +@name: +@auto_connect: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_get_account ##### --> +<para> + +</para> + +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_set_account ##### --> +<para> + +</para> + +@chatroom: +@account: + + +<!-- ##### FUNCTION empathy_chatroom_get_room ##### --> +<para> + +</para> + +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_set_room ##### --> +<para> + +</para> + +@chatroom: +@room: + + +<!-- ##### FUNCTION empathy_chatroom_get_name ##### --> +<para> + +</para> + +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_set_name ##### --> +<para> + +</para> + +@chatroom: +@name: + + +<!-- ##### FUNCTION empathy_chatroom_get_auto_connect ##### --> +<para> + +</para> + +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_chatroom_set_auto_connect ##### --> +<para> + +</para> + +@chatroom: +@auto_connect: + + +<!-- ##### FUNCTION empathy_chatroom_equal ##### --> +<para> + +</para> + +@v1: +@v2: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-conf.sgml b/doc/libempathy/tmpl/empathy-conf.sgml new file mode 100644 index 000000000..da5d673e2 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-conf.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +EmpathyConf + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyConf ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION EmpathyConfNotifyFunc ##### --> +<para> + +</para> + +@conf: +@key: +@user_data: + + +<!-- ##### FUNCTION empathy_conf_get ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_conf_shutdown ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION empathy_conf_notify_add ##### --> +<para> + +</para> + +@conf: +@key: +@func: +@data: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_notify_remove ##### --> +<para> + +</para> + +@conf: +@id: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_set_int ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_get_int ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_set_bool ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_get_bool ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_set_string ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_get_string ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_set_string_list ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_conf_get_string_list ##### --> +<para> + +</para> + +@conf: +@key: +@value: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-contact-list.sgml b/doc/libempathy/tmpl/empathy-contact-list.sgml new file mode 100644 index 000000000..1a2839fc7 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-contact-list.sgml @@ -0,0 +1,156 @@ +<!-- ##### SECTION Title ##### --> +empathy-contact-list + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyContactList ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyContactList::contact-added ##### --> +<para> + +</para> + +@empathycontactlist: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EmpathyContactList::contact-removed ##### --> +<para> + +</para> + +@empathycontactlist: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL EmpathyContactList::local-pending ##### --> +<para> + +</para> + +@empathycontactlist: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### STRUCT EmpathyContactListIface ##### --> +<para> + +</para> + +@base_iface: +@setup: +@find: +@add: +@remove: +@get_members: +@get_local_pending: +@process_pending: + +<!-- ##### STRUCT EmpathyContactListInfo ##### --> +<para> + +</para> + +@contact: +@message: + +<!-- ##### FUNCTION empathy_contact_list_info_new ##### --> +<para> + +</para> + +@contact: +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_info_free ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION empathy_contact_list_setup ##### --> +<para> + +</para> + +@list: + + +<!-- ##### FUNCTION empathy_contact_list_find ##### --> +<para> + +</para> + +@list: +@id: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_add ##### --> +<para> + +</para> + +@list: +@contact: +@message: + + +<!-- ##### FUNCTION empathy_contact_list_remove ##### --> +<para> + +</para> + +@list: +@contact: +@message: + + +<!-- ##### FUNCTION empathy_contact_list_get_members ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_get_local_pending ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_list_process_pending ##### --> +<para> + +</para> + +@list: +@contact: +@accept: + + diff --git a/doc/libempathy/tmpl/empathy-contact-manager.sgml b/doc/libempathy/tmpl/empathy-contact-manager.sgml new file mode 100644 index 000000000..0defe4840 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-contact-manager.sgml @@ -0,0 +1,89 @@ +<!-- ##### SECTION Title ##### --> +EmpathyContactManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyContactManagerPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyContactManager ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_contact_manager_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_contact_manager_get_list ##### --> +<para> + +</para> + +@manager: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_manager_get_user ##### --> +<para> + +</para> + +@manager: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_manager_create ##### --> +<para> + +</para> + +@manager: +@account: +@id: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_manager_rename_group ##### --> +<para> + +</para> + +@manager: +@old_group: +@new_group: + + +<!-- ##### FUNCTION empathy_contact_manager_get_groups ##### --> +<para> + +</para> + +@manager: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-contact.sgml b/doc/libempathy/tmpl/empathy-contact.sgml new file mode 100644 index 000000000..1ab2321af --- /dev/null +++ b/doc/libempathy/tmpl/empathy-contact.sgml @@ -0,0 +1,335 @@ +<!-- ##### SECTION Title ##### --> +EmpathyContact + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyContact ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyContact:account ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:avatar ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:groups ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:handle ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:id ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:is-user ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:name ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:presence ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyContact:subscription ##### --> +<para> + +</para> + +<!-- ##### ENUM EmpathySubscription ##### --> +<para> + +</para> + +@EMPATHY_SUBSCRIPTION_NONE: +@EMPATHY_SUBSCRIPTION_TO: +@EMPATHY_SUBSCRIPTION_FROM: +@EMPATHY_SUBSCRIPTION_BOTH: + +<!-- ##### FUNCTION empathy_contact_get_gtype ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_contact_new ##### --> +<para> + +</para> + +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_new_full ##### --> +<para> + +</para> + +@account: +@id: +@name: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_id ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_name ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_avatar ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_account ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_presence ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_groups ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_subscription ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_handle ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_is_user ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_set_id ##### --> +<para> + +</para> + +@contact: +@id: + + +<!-- ##### FUNCTION empathy_contact_set_name ##### --> +<para> + +</para> + +@contact: +@name: + + +<!-- ##### FUNCTION empathy_contact_set_avatar ##### --> +<para> + +</para> + +@contact: +@avatar: + + +<!-- ##### FUNCTION empathy_contact_set_account ##### --> +<para> + +</para> + +@contact: +@account: + + +<!-- ##### FUNCTION empathy_contact_set_presence ##### --> +<para> + +</para> + +@contact: +@presence: + + +<!-- ##### FUNCTION empathy_contact_set_groups ##### --> +<para> + +</para> + +@contact: +@categories: + + +<!-- ##### FUNCTION empathy_contact_set_subscription ##### --> +<para> + +</para> + +@contact: +@subscription: + + +<!-- ##### FUNCTION empathy_contact_set_handle ##### --> +<para> + +</para> + +@contact: +@handle: + + +<!-- ##### FUNCTION empathy_contact_set_is_user ##### --> +<para> + +</para> + +@contact: +@is_user: + + +<!-- ##### FUNCTION empathy_contact_add_group ##### --> +<para> + +</para> + +@contact: +@group: + + +<!-- ##### FUNCTION empathy_contact_remove_group ##### --> +<para> + +</para> + +@contact: +@group: + + +<!-- ##### FUNCTION empathy_contact_is_online ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_is_in_group ##### --> +<para> + +</para> + +@contact: +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_get_status ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_equal ##### --> +<para> + +</para> + +@v1: +@v2: +@Returns: + + +<!-- ##### FUNCTION empathy_contact_hash ##### --> +<para> + +</para> + +@key: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-filter.sgml b/doc/libempathy/tmpl/empathy-filter.sgml new file mode 100644 index 000000000..5ef4b5bcd --- /dev/null +++ b/doc/libempathy/tmpl/empathy-filter.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +EmpathyFilter + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyFilterPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyFilter ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyFilter::new-channel ##### --> +<para> + +</para> + +@empathyfilter: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL EmpathyFilter::process ##### --> +<para> + +</para> + +@empathyfilter: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### FUNCTION empathy_filter_new ##### --> +<para> + +</para> + +@bus_name: +@object_path: +@channel_type: +@priority: +@flags: +@Returns: + + +<!-- ##### FUNCTION empathy_filter_process ##### --> +<para> + +</para> + +@filter: +@tp_chan: +@process: + + diff --git a/doc/libempathy/tmpl/empathy-idle.sgml b/doc/libempathy/tmpl/empathy-idle.sgml new file mode 100644 index 000000000..8971b783f --- /dev/null +++ b/doc/libempathy/tmpl/empathy-idle.sgml @@ -0,0 +1,118 @@ +<!-- ##### SECTION Title ##### --> +EmpathyIdle + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyIdlePriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyIdle ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyIdle:flash-state ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyIdle:state ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyIdle:status ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_idle_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_idle_get_state ##### --> +<para> + +</para> + +@idle: +@Returns: + + +<!-- ##### FUNCTION empathy_idle_set_state ##### --> +<para> + +</para> + +@idle: +@state: + + +<!-- ##### FUNCTION empathy_idle_get_status ##### --> +<para> + +</para> + +@idle: +@Returns: + + +<!-- ##### FUNCTION empathy_idle_set_status ##### --> +<para> + +</para> + +@idle: +@status: + + +<!-- ##### FUNCTION empathy_idle_get_flash_state ##### --> +<para> + +</para> + +@idle: +@Returns: + + +<!-- ##### FUNCTION empathy_idle_set_flash_state ##### --> +<para> + +</para> + +@idle: +@state: + + +<!-- ##### FUNCTION empathy_idle_set_presence ##### --> +<para> + +</para> + +@idle: +@state: +@status: + + diff --git a/doc/libempathy/tmpl/empathy-log-manager.sgml b/doc/libempathy/tmpl/empathy-log-manager.sgml new file mode 100644 index 000000000..1576b419a --- /dev/null +++ b/doc/libempathy/tmpl/empathy-log-manager.sgml @@ -0,0 +1,157 @@ +<!-- ##### SECTION Title ##### --> +EmpathyLogManager + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyLogManagerPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyLogSearchHit ##### --> +<para> + +</para> + +@account: +@chat_id: +@is_chatroom: +@filename: +@date: + +<!-- ##### STRUCT EmpathyLogManager ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_log_manager_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_add_message ##### --> +<para> + +</para> + +@manager: +@chat_id: +@chatroom: +@message: + + +<!-- ##### FUNCTION empathy_log_manager_exists ##### --> +<para> + +</para> + +@manager: +@account: +@chat_id: +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_get_dates ##### --> +<para> + +</para> + +@manager: +@account: +@chat_id: +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_get_messages_for_file ##### --> +<para> + +</para> + +@manager: +@filename: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_get_messages_for_date ##### --> +<para> + +</para> + +@manager: +@account: +@chat_id: +@chatroom: +@date: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_get_last_messages ##### --> +<para> + +</para> + +@manager: +@account: +@chat_id: +@chatroom: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_get_chats ##### --> +<para> + +</para> + +@manager: +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_search_new ##### --> +<para> + +</para> + +@manager: +@text: +@Returns: + + +<!-- ##### FUNCTION empathy_log_manager_search_free ##### --> +<para> + +</para> + +@hits: + + +<!-- ##### FUNCTION empathy_log_manager_get_date_readable ##### --> +<para> + +</para> + +@date: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-message.sgml b/doc/libempathy/tmpl/empathy-message.sgml new file mode 100644 index 000000000..35ec26770 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-message.sgml @@ -0,0 +1,159 @@ +<!-- ##### SECTION Title ##### --> +EmpathyMessage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyMessage ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyMessage:body ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyMessage:receiver ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyMessage:sender ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyMessage:timestamp ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyMessage:type ##### --> +<para> + +</para> + +<!-- ##### ENUM EmpathyMessageType ##### --> +<para> + +</para> + +@EMPATHY_MESSAGE_TYPE_NORMAL: +@EMPATHY_MESSAGE_TYPE_ACTION: +@EMPATHY_MESSAGE_TYPE_NOTICE: +@EMPATHY_MESSAGE_TYPE_AUTO_REPLY: +@EMPATHY_MESSAGE_TYPE_LAST: + +<!-- ##### FUNCTION empathy_message_get_gtype ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_message_new ##### --> +<para> + +</para> + +@body: +@Returns: + + +<!-- ##### FUNCTION empathy_message_set_type ##### --> +<para> + +</para> + +@message: +@type: + + +<!-- ##### FUNCTION empathy_message_get_sender ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_message_set_sender ##### --> +<para> + +</para> + +@message: +@contact: + + +<!-- ##### FUNCTION empathy_message_get_receiver ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_message_set_receiver ##### --> +<para> + +</para> + +@message: +@contact: + + +<!-- ##### FUNCTION empathy_message_get_body ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_message_set_body ##### --> +<para> + +</para> + +@message: +@body: + + +<!-- ##### FUNCTION empathy_message_get_timestamp ##### --> +<para> + +</para> + +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_message_set_timestamp ##### --> +<para> + +</para> + +@message: +@timestamp: + + diff --git a/doc/libempathy/tmpl/empathy-presence.sgml b/doc/libempathy/tmpl/empathy-presence.sgml new file mode 100644 index 000000000..ac1f93929 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-presence.sgml @@ -0,0 +1,126 @@ +<!-- ##### SECTION Title ##### --> +EmpathyPresence + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyPresence ##### --> +<para> + +</para> + + +<!-- ##### ARG EmpathyPresence:state ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyPresence:status ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_presence_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_presence_new_full ##### --> +<para> + +</para> + +@state: +@status: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_get_state ##### --> +<para> + +</para> + +@presence: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_get_status ##### --> +<para> + +</para> + +@presence: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_set_state ##### --> +<para> + +</para> + +@presence: +@state: + + +<!-- ##### FUNCTION empathy_presence_set_status ##### --> +<para> + +</para> + +@presence: +@status: + + +<!-- ##### FUNCTION empathy_presence_sort_func ##### --> +<para> + +</para> + +@a: +@b: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_state_get_default_status ##### --> +<para> + +</para> + +@state: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_state_to_str ##### --> +<para> + +</para> + +@state: +@Returns: + + +<!-- ##### FUNCTION empathy_presence_state_from_str ##### --> +<para> + +</para> + +@str: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-time.sgml b/doc/libempathy/tmpl/empathy-time.sgml new file mode 100644 index 000000000..512e7751d --- /dev/null +++ b/doc/libempathy/tmpl/empathy-time.sgml @@ -0,0 +1,95 @@ +<!-- ##### SECTION Title ##### --> +empathy-time + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO EMPATHY_TIME_FORMAT_DISPLAY_SHORT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO EMPATHY_TIME_FORMAT_DISPLAY_LONG ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF EmpathyTime ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_time_get_current ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_time_get_local_time ##### --> +<para> + +</para> + +@tm: +@Returns: + + +<!-- ##### FUNCTION empathy_time_parse ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### FUNCTION empathy_time_parse_format ##### --> +<para> + +</para> + +@str: +@format: +@Returns: + + +<!-- ##### FUNCTION empathy_time_to_string_utc ##### --> +<para> + +</para> + +@t: +@format: +@Returns: + + +<!-- ##### FUNCTION empathy_time_to_string_local ##### --> +<para> + +</para> + +@t: +@format: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-tp-chat.sgml b/doc/libempathy/tmpl/empathy-tp-chat.sgml new file mode 100644 index 000000000..3422be653 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-tp-chat.sgml @@ -0,0 +1,222 @@ +<!-- ##### SECTION Title ##### --> +EmpathyTpChat + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyTpChatPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyTpChat ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyTpChat::chat-state-changed ##### --> +<para> + +</para> + +@empathytpchat: the object which received the signal. +@arg1: +@arg2: + +<!-- ##### SIGNAL EmpathyTpChat::destroy ##### --> +<para> + +</para> + +@empathytpchat: the object which received the signal. + +<!-- ##### SIGNAL EmpathyTpChat::message-received ##### --> +<para> + +</para> + +@empathytpchat: the object which received the signal. +@arg1: + +<!-- ##### ARG EmpathyTpChat:account ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:acknowledge ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:anonymous ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:description ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:invite-only ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:limit ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:limited ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:moderated ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:name ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:password ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:password-required ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:persistent ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:private ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:subject ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:subject-contact ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:subject-timestamp ##### --> +<para> + +</para> + +<!-- ##### ARG EmpathyTpChat:tp-chan ##### --> +<para> + +</para> + +<!-- ##### FUNCTION empathy_tp_chat_new ##### --> +<para> + +</para> + +@account: +@tp_chan: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chat_new_with_contact ##### --> +<para> + +</para> + +@contact: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chat_get_acknowledge ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chat_set_acknowledge ##### --> +<para> + +</para> + +@chat: +@acknowledge: + + +<!-- ##### FUNCTION empathy_tp_chat_get_channel ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chat_get_pendings ##### --> +<para> + +</para> + +@chat: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chat_send ##### --> +<para> + +</para> + +@chat: +@message: + + +<!-- ##### FUNCTION empathy_tp_chat_set_state ##### --> +<para> + +</para> + +@chat: +@state: + + +<!-- ##### FUNCTION empathy_tp_chat_get_id ##### --> +<para> + +</para> + +@chat: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-tp-chatroom.sgml b/doc/libempathy/tmpl/empathy-tp-chatroom.sgml new file mode 100644 index 000000000..15d441cf8 --- /dev/null +++ b/doc/libempathy/tmpl/empathy-tp-chatroom.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +EmpathyTpChatroom + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyTpChatroomPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyTpChatroom ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION empathy_tp_chatroom_new ##### --> +<para> + +</para> + +@account: +@tp_chan: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chatroom_get_invitation ##### --> +<para> + +</para> + +@chatroom: +@contact: +@message: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_chatroom_accept_invitation ##### --> +<para> + +</para> + +@chatroom: + + +<!-- ##### FUNCTION empathy_tp_chatroom_set_topic ##### --> +<para> + +</para> + +@chatroom: +@topic: + + diff --git a/doc/libempathy/tmpl/empathy-tp-contact-list.sgml b/doc/libempathy/tmpl/empathy-tp-contact-list.sgml new file mode 100644 index 000000000..3420151db --- /dev/null +++ b/doc/libempathy/tmpl/empathy-tp-contact-list.sgml @@ -0,0 +1,114 @@ +<!-- ##### SECTION Title ##### --> +EmpathyTpContactList + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyTpContactListPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyTpContactList ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyTpContactList::destroy ##### --> +<para> + +</para> + +@empathytpcontactlist: the object which received the signal. + +<!-- ##### FUNCTION empathy_tp_contact_list_new ##### --> +<para> + +</para> + +@account: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_account ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_user ##### --> +<para> + +</para> + +@list: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_from_id ##### --> +<para> + +</para> + +@list: +@id: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_from_handle ##### --> +<para> + +</para> + +@list: +@handle: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_from_handles ##### --> +<para> + +</para> + +@list: +@handles: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_contact_list_rename_group ##### --> +<para> + +</para> + +@list: +@old_group: +@new_group: + + +<!-- ##### FUNCTION empathy_tp_contact_list_get_groups ##### --> +<para> + +</para> + +@list: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-tp-group.sgml b/doc/libempathy/tmpl/empathy-tp-group.sgml new file mode 100644 index 000000000..56fcca10f --- /dev/null +++ b/doc/libempathy/tmpl/empathy-tp-group.sgml @@ -0,0 +1,209 @@ +<!-- ##### SECTION Title ##### --> +EmpathyTpGroup + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EmpathyTpGroupPriv ##### --> +<para> + +</para> + + +<!-- ##### STRUCT EmpathyTpGroup ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL EmpathyTpGroup::local-pending ##### --> +<para> + +</para> + +@empathytpgroup: the object which received the signal. +@arg1: +@arg2: +@arg3: +@arg4: + +<!-- ##### SIGNAL EmpathyTpGroup::members-added ##### --> +<para> + +</para> + +@empathytpgroup: the object which received the signal. +@arg1: +@arg2: +@arg3: +@arg4: + +<!-- ##### SIGNAL EmpathyTpGroup::members-removed ##### --> +<para> + +</para> + +@empathytpgroup: the object which received the signal. +@arg1: +@arg2: +@arg3: +@arg4: + +<!-- ##### SIGNAL EmpathyTpGroup::remote-pending ##### --> +<para> + +</para> + +@empathytpgroup: the object which received the signal. +@arg1: +@arg2: +@arg3: +@arg4: + +<!-- ##### STRUCT EmpathyTpGroupInfo ##### --> +<para> + +</para> + +@member: +@actor: +@reason: +@message: + +<!-- ##### FUNCTION empathy_tp_group_new ##### --> +<para> + +</para> + +@tp_chan: +@tp_conn: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_add_members ##### --> +<para> + +</para> + +@group: +@handles: +@message: + + +<!-- ##### FUNCTION empathy_tp_group_add_member ##### --> +<para> + +</para> + +@group: +@handle: +@message: + + +<!-- ##### FUNCTION empathy_tp_group_remove_members ##### --> +<para> + +</para> + +@group: +@handle: +@message: + + +<!-- ##### FUNCTION empathy_tp_group_remove_member ##### --> +<para> + +</para> + +@group: +@handle: +@message: + + +<!-- ##### FUNCTION empathy_tp_group_get_members ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_get_all_members ##### --> +<para> + +</para> + +@group: +@members: +@local_pending: +@remote_pending: + + +<!-- ##### FUNCTION empathy_tp_group_get_local_pending_members_with_info ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_info_list_free ##### --> +<para> + +</para> + +@infos: + + +<!-- ##### FUNCTION empathy_tp_group_get_name ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_get_self_handle ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_get_object_path ##### --> +<para> + +</para> + +@group: +@Returns: + + +<!-- ##### FUNCTION empathy_tp_group_is_member ##### --> +<para> + +</para> + +@group: +@handle: +@Returns: + + diff --git a/doc/libempathy/tmpl/empathy-utils.sgml b/doc/libempathy/tmpl/empathy-utils.sgml new file mode 100644 index 000000000..2e3927f7f --- /dev/null +++ b/doc/libempathy/tmpl/empathy-utils.sgml @@ -0,0 +1,207 @@ +<!-- ##### SECTION Title ##### --> +empathy-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO G_STR_EMPTY ##### --> +<para> + +</para> + +@x: + + +<!-- ##### ENUM EmpathyRegExType ##### --> +<para> + +</para> + +@EMPATHY_REGEX_AS_IS: +@EMPATHY_REGEX_BROWSER: +@EMPATHY_REGEX_EMAIL: +@EMPATHY_REGEX_OTHER: +@EMPATHY_REGEX_ALL: + +<!-- ##### FUNCTION empathy_substring ##### --> +<para> + +</para> + +@str: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION empathy_regex_match ##### --> +<para> + +</para> + +@type: +@msg: +@start: +@end: +@Returns: + + +<!-- ##### FUNCTION empathy_strcasecmp ##### --> +<para> + +</para> + +@s1: +@s2: +@Returns: + + +<!-- ##### FUNCTION empathy_strncasecmp ##### --> +<para> + +</para> + +@s1: +@s2: +@n: +@Returns: + + +<!-- ##### FUNCTION empathy_xml_validate ##### --> +<para> + +</para> + +@doc: +@dtd_filename: +@Returns: + + +<!-- ##### FUNCTION empathy_xml_node_get_child ##### --> +<para> + +</para> + +@node: +@child_name: +@Returns: + + +<!-- ##### FUNCTION empathy_xml_node_get_child_content ##### --> +<para> + +</para> + +@node: +@child_name: +@Returns: + + +<!-- ##### FUNCTION empathy_xml_node_find_child_prop_value ##### --> +<para> + +</para> + +@node: +@prop_name: +@prop_value: +@Returns: + + +<!-- ##### FUNCTION empathy_dbus_type_to_g_type ##### --> +<para> + +</para> + +@dbus_type_string: +@Returns: + + +<!-- ##### FUNCTION empathy_g_type_to_dbus_type ##### --> +<para> + +</para> + +@g_type: +@Returns: + + +<!-- ##### FUNCTION empathy_g_value_to_string ##### --> +<para> + +</para> + +@value: +@Returns: + + +<!-- ##### FUNCTION empathy_string_to_g_value ##### --> +<para> + +</para> + +@str: +@type: +@Returns: + + +<!-- ##### FUNCTION empathy_g_value_equal ##### --> +<para> + +</para> + +@value1: +@value2: +@Returns: + + +<!-- ##### FUNCTION empathy_account_hash ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION empathy_account_equal ##### --> +<para> + +</para> + +@a: +@b: +@Returns: + + +<!-- ##### FUNCTION empathy_mission_control_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION empathy_get_channel_id ##### --> +<para> + +</para> + +@account: +@tp_chan: +@Returns: + + |