diff options
Diffstat (limited to 'doc/reference')
6 files changed, 346 insertions, 0 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 8ac97d0f8f..b596aa20ed 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1,6 +1,7 @@ NULL = SUBDIRS = \ + evolution-mail-composer \ evolution-mail-formatter \ evolution-shell \ evolution-util \ diff --git a/doc/reference/evolution-mail-composer/Makefile.am b/doc/reference/evolution-mail-composer/Makefile.am new file mode 100644 index 0000000000..580dc63a3b --- /dev/null +++ b/doc/reference/evolution-mail-composer/Makefile.am @@ -0,0 +1,40 @@ +# The name of the module. +DOC_MODULE=evolution-mail-composer + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +DOC_SOURCE_DIR=$(top_srcdir)/composer + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB=$(top_srcdir)/composer/*.h +CFILE_GLOB=$(top_srcdir)/composer/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + e-composer-actions.h \ + e-composer-private.h \ + $(NULL) + +GTKDOC_CFLAGS= \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(EVOLUTION_DATA_SERVER_CFLAGS) \ + $(GNOME_PLATFORM_CFLAGS) \ + $(GTKHTML_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS= \ + $(top_builddir)/composer/libevolution-mail-composer.la \ + $(EVOLUTION_DATA_SERVER_LIBS) \ + $(GNOME_PLATFORM_LIBS) \ + $(GTKHTML_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +#TESTS = $(GTKDOC_CHECK) + +-include $(top_srcdir)/git.mk diff --git a/doc/reference/evolution-mail-composer/evolution-mail-composer-docs.sgml b/doc/reference/evolution-mail-composer/evolution-mail-composer-docs.sgml new file mode 100644 index 0000000000..becbfd678f --- /dev/null +++ b/doc/reference/evolution-mail-composer/evolution-mail-composer-docs.sgml @@ -0,0 +1,40 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIoS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> +]> +<book id="index"> + <bookinfo> + <title>Evolution Mail Composer Reference Manual</title> + <releaseinfo> + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://developer.gnome.org/evolution-mail-composer/">http://developer.gnome.org/evolution-mail-composer/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>Mail Composition</title> + <xi:include href="xml/e-msg-composer.xml"/> + <xi:include href="xml/e-composer-activity.xml"/> + <xi:include href="xml/e-composer-header-table.xml"/> + <xi:include href="xml/e-composer-header.xml"/> + <xi:include href="xml/e-composer-from-header.xml"/> + <xi:include href="xml/e-composer-name-header.xml"/> + <xi:include href="xml/e-composer-post-header.xml"/> + <xi:include href="xml/e-composer-spell-header.xml"/> + <xi:include href="xml/e-composer-text-header.xml"/> + </chapter> + + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/doc/reference/evolution-mail-composer/evolution-mail-composer-overrides.txt b/doc/reference/evolution-mail-composer/evolution-mail-composer-overrides.txt new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/doc/reference/evolution-mail-composer/evolution-mail-composer-overrides.txt diff --git a/doc/reference/evolution-mail-composer/evolution-mail-composer-sections.txt b/doc/reference/evolution-mail-composer/evolution-mail-composer-sections.txt new file mode 100644 index 0000000000..24090de34d --- /dev/null +++ b/doc/reference/evolution-mail-composer/evolution-mail-composer-sections.txt @@ -0,0 +1,246 @@ +<SECTION> +<FILE>e-composer-activity</FILE> +<TITLE>EComposerActivity</TITLE> +EComposerActivity +e_composer_activity_new +e_composer_activity_get_composer +<SUBSECTION Standard> +E_COMPOSER_ACTIVITY +E_IS_COMPOSER_ACTIVITY +E_TYPE_COMPOSER_ACTIVITY +E_COMPOSER_ACTIVITY_CLASS +E_IS_COMPOSER_ACTIVITY_CLASS +E_COMPOSER_ACTIVITY_GET_CLASS +EComposerActivityClass +e_composer_activity_get_type +<SUBSECTION Private> +EComposerActivityPrivate +</SECTION> + +<SECTION> +<FILE>e-composer-from-header</FILE> +<TITLE>EComposerFromHeader</TITLE> +EComposerFromHeader +e_composer_from_header_new +e_composer_from_header_get_active_id +e_composer_from_header_set_active_id +<SUBSECTION Standard> +E_COMPOSER_FROM_HEADER +E_IS_COMPOSER_FROM_HEADER +E_TYPE_COMPOSER_FROM_HEADER +E_COMPOSER_FROM_HEADER_CLASS +E_IS_COMPOSER_FROM_HEADER_CLASS +E_COMPOSER_FROM_HEADER_GET_CLASS +EComposerFromHeaderClass +e_composer_from_header_get_type +</SECTION> + +<SECTION> +<FILE>e-composer-header-table</FILE> +<TITLE>EComposerHeaderTable</TITLE> +EComposerHeaderTable +e_composer_header_table_new +e_composer_header_table_get_shell +e_composer_header_table_get_registry +EComposerHeaderType +e_composer_header_table_get_header +e_composer_header_table_get_signature_combo_box +e_composer_header_table_get_destinations +e_composer_header_table_get_destinations_bcc +e_composer_header_table_add_destinations_bcc +e_composer_header_table_set_destinations_bcc +e_composer_header_table_get_destinations_cc +e_composer_header_table_add_destinations_cc +e_composer_header_table_set_destinations_cc +e_composer_header_table_get_destinations_to +e_composer_header_table_add_destinations_to +e_composer_header_table_set_destinations_to +e_composer_header_table_get_identity_uid +e_composer_header_table_set_identity_uid +e_composer_header_table_get_post_to +e_composer_header_table_set_post_to_base +e_composer_header_table_set_post_to_list +e_composer_header_table_get_reply_to +e_composer_header_table_set_reply_to +e_composer_header_table_get_signature_uid +e_composer_header_table_set_signature_uid +e_composer_header_table_get_subject +e_composer_header_table_set_subject +e_composer_header_table_set_header_visible +<SUBSECTION Standard> +E_COMPOSER_HEADER_TABLE +E_IS_COMPOSER_HEADER_TABLE +E_TYPE_COMPOSER_HEADER_TABLE +E_COMPOSER_HEADER_TABLE_CLASS +E_IS_COMPOSER_HEADER_TABLE_CLASS +E_COMPOSER_HEADER_TABLE_GET_CLASS +EComposerHeaderTableClass +e_composer_header_table_get_type +<SUBSECTION Private> +EComposerHeaderTablePrivate +</SECTION> + +<SECTION> +<FILE>e-composer-header</FILE> +<TITLE>EComposerHeader</TITLE> +EComposerHeader +e_composer_header_get_label +e_composer_header_get_registry +e_composer_header_get_sensitive +e_composer_header_set_sensitive +e_composer_header_get_visible +e_composer_header_set_visible +e_composer_header_set_title_tooltip +e_composer_header_set_input_tooltip +<SUBSECTION Standard> +E_COMPOSER_HEADER +E_IS_COMPOSER_HEADER +E_TYPE_COMPOSER_HEADER +E_COMPOSER_HEADER_CLASS +E_IS_COMPOSER_HEADER_CLASS +E_COMPOSER_HEADER_GET_CLASS +EComposerHeaderClass +e_composer_header_get_type +<SUBSECTION Private> +EComposerHeaderPrivate +</SECTION> + +<SECTION> +<FILE>e-composer-name-header</FILE> +<TITLE>EComposerNameHeader</TITLE> +EComposerNameHeader +e_composer_name_header_new +e_composer_name_header_get_name_selector +e_composer_name_header_get_destinations +e_composer_name_header_add_destinations +e_composer_name_header_set_destinations +<SUBSECTION Standard> +E_COMPOSER_NAME_HEADER +E_IS_COMPOSER_NAME_HEADER +E_TYPE_COMPOSER_NAME_HEADER +E_COMPOSER_NAME_HEADER_CLASS +E_IS_COMPOSER_NAME_HEADER_CLASS +E_COMPOSER_NAME_HEADER_GET_CLASS +EComposerNameHeaderClass +e_composer_name_header_get_type +<SUBSECTION Private> +EComposerNameHeaderPrivate +</SECTION> + +<SECTION> +<FILE>e-composer-post-header</FILE> +<TITLE>EComposerPostHeader</TITLE> +EComposerPostHeader +e_composer_post_header_new +e_composer_post_header_get_folders +e_composer_post_header_set_folders +e_composer_post_header_set_folders_base +e_composer_post_header_get_mail_account +e_composer_post_header_set_mail_account +<SUBSECTION Standard> +E_COMPOSER_POST_HEADER +E_IS_COMPOSER_POST_HEADER +E_TYPE_COMPOSER_POST_HEADER +E_COMPOSER_POST_HEADER_CLASS +E_IS_COMPOSER_POST_HEADER_CLASS +E_COMPOSER_POST_HEADER_GET_CLASS +EComposerPostHeaderClass +e_composer_post_header_get_type +<SUBSECTION Private> +EComposerPostHeaderPrivate +</SECTION> + +<SECTION> +<FILE>e-composer-spell-header</FILE> +<TITLE>EComposerSpellHeader</TITLE> +EComposerSpellHeader +e_composer_spell_header_new_label +e_composer_spell_header_new_button +e_composer_spell_header_set_languages +<SUBSECTION Standard> +E_COMPOSER_SPELL_HEADER +E_IS_COMPOSER_SPELL_HEADER +E_TYPE_COMPOSER_SPELL_HEADER +E_COMPOSER_SPELL_HEADER_CLASS +E_IS_COMPOSER_SPELL_HEADER_CLASS +E_COMPOSER_SPELL_HEADER_GET_CLASS +EComposerSpellHeaderClass +e_composer_spell_header_get_type +</SECTION> + +<SECTION> +<FILE>e-composer-text-header</FILE> +<TITLE>EComposerTextHeader</TITLE> +EComposerTextHeader +e_composer_text_header_new_label +e_composer_text_header_new_button +e_composer_text_header_get_text +e_composer_text_header_set_text +<SUBSECTION Standard> +E_COMPOSER_TEXT_HEADER +E_IS_COMPOSER_TEXT_HEADER +E_TYPE_COMPOSER_TEXT_HEADER +E_COMPOSER_TEXT_HEADER_CLASS +E_IS_COMPOSER_TEXT_HEADER_CLASS +E_COMPOSER_TEXT_HEADER_GET_CLASS +EComposerTextHeaderClass +e_composer_text_header_get_type +</SECTION> + +<SECTION> +<FILE>e-msg-composer</FILE> +<TITLE>EMsgComposer</TITLE> +EMsgComposer +e_msg_composer_new +e_msg_composer_new_with_message +e_msg_composer_new_from_url +e_msg_composer_new_redirect +e_msg_composer_get_focus_tracker +e_msg_composer_ref_session +e_msg_composer_get_shell +e_msg_composer_get_web_view +e_msg_composer_send +e_msg_composer_save_to_drafts +e_msg_composer_save_to_outbox +e_msg_composer_print +e_msg_composer_set_body_text +e_msg_composer_set_body +e_msg_composer_add_header +e_msg_composer_set_header +e_msg_composer_remove_header +e_msg_composer_set_draft_headers +e_msg_composer_set_source_headers +e_msg_composer_attach +e_msg_composer_add_inline_image_from_file +e_msg_composer_add_inline_image_from_mime_part +e_msg_composer_get_message +e_msg_composer_get_message_finish +e_msg_composer_get_message_print +e_msg_composer_get_message_print_finish +e_msg_composer_get_message_draft +e_msg_composer_get_message_draft_finish +e_msg_composer_get_from +e_msg_composer_get_reply_to +e_msg_composer_clear_inlined_table +e_msg_composer_add_message_attachments +e_msg_composer_request_close +e_msg_composer_can_close +e_msg_composer_reply_indent +e_msg_composer_get_header_table +e_msg_composer_get_attachment_view +e_msg_composer_get_raw_message_text +e_msg_composer_is_exiting +e_load_spell_languages +e_save_spell_languages +<SUBSECTION Standard> +E_MSG_COMPOSER +E_IS_MSG_COMPOSER +E_TYPE_MSG_COMPOSER +E_MSG_COMPOSER_CLASS +E_IS_MSG_COMPOSER_CLASS +E_MSG_COMPOSER_GET_CLASS +EMsgComposerClass +e_msg_composer_get_type +<SUBSECTION Private> +EMsgComposerPrivate +</SECTION> diff --git a/doc/reference/evolution-mail-composer/evolution-mail-composer.types b/doc/reference/evolution-mail-composer/evolution-mail-composer.types new file mode 100644 index 0000000000..bf4ab7c4d6 --- /dev/null +++ b/doc/reference/evolution-mail-composer/evolution-mail-composer.types @@ -0,0 +1,19 @@ +#include <composer/e-composer-activity.h> +#include <composer/e-composer-from-header.h> +#include <composer/e-composer-header-table.h> +#include <composer/e-composer-header.h> +#include <composer/e-composer-name-header.h> +#include <composer/e-composer-post-header.h> +#include <composer/e-composer-spell-header.h> +#include <composer/e-composer-text-header.h> +#include <composer/e-msg-composer.h> + +e_composer_activity_get_type +e_composer_from_header_get_type +e_composer_header_get_type +e_composer_header_table_get_type +e_composer_name_header_get_type +e_composer_post_header_get_type +e_composer_spell_header_get_type +e_composer_text_header_get_type +e_msg_composer_get_type |