diff options
| author | Matthew Barnes <mbarnes@redhat.com> | 2009-09-23 09:06:45 +0800 |
|---|---|---|
| committer | Matthew Barnes <mbarnes@redhat.com> | 2009-09-23 09:26:54 +0800 |
| commit | 5b771a75004ddbd6bfa29b50cdb7a0e188eafbb9 (patch) | |
| tree | 9cc98eedb4934fd6e380596caf6caaf95d13cb9f | |
| parent | 785c9829b8312649e28ec412696a9e3a8732ef19 (diff) | |
| download | gsoc2013-evolution-5b771a75004ddbd6bfa29b50cdb7a0e188eafbb9.tar.gz gsoc2013-evolution-5b771a75004ddbd6bfa29b50cdb7a0e188eafbb9.tar.zst gsoc2013-evolution-5b771a75004ddbd6bfa29b50cdb7a0e188eafbb9.zip | |
Developer documentation improvements.
35 files changed, 2808 insertions, 54 deletions
diff --git a/doc/reference/shell/Makefile.am b/doc/reference/shell/Makefile.am index 370fd53b99..037ad06b52 100644 --- a/doc/reference/shell/Makefile.am +++ b/doc/reference/shell/Makefile.am @@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # 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=../../../shell +DOC_SOURCE_DIR=../../../ # Extra options to pass to gtkdoc-scangobj. Not normally needed. SCANGOBJ_OPTIONS= @@ -82,6 +82,7 @@ GTKDOC_LIBS= \ $(top_builddir)/shell/.libs/es-event.o \ $(top_builddir)/e-util/.libs/e-bconf-map.o \ $(top_builddir)/e-util/.libs/e-binding.o \ + $(top_builddir)/e-util/.libs/e-bit-array.o \ $(top_builddir)/e-util/.libs/e-dialog-utils.o \ $(top_builddir)/e-util/.libs/e-error.o \ $(top_builddir)/e-util/.libs/e-event.o \ @@ -95,6 +96,9 @@ GTKDOC_LIBS= \ $(top_builddir)/e-util/.libs/e-plugin.o \ $(top_builddir)/e-util/.libs/e-plugin-ui.o \ $(top_builddir)/e-util/.libs/e-print.o \ + $(top_builddir)/e-util/.libs/e-signature.o \ + $(top_builddir)/e-util/.libs/e-signature-list.o \ + $(top_builddir)/e-util/.libs/e-signature-utils.o \ $(top_builddir)/e-util/.libs/e-unicode.o \ $(top_builddir)/e-util/.libs/e-util.o \ $(top_builddir)/e-util/.libs/e-xml-utils.o \ diff --git a/doc/reference/shell/eshell-docs.sgml b/doc/reference/shell/eshell-docs.sgml index 3d7bdcd36e..c01c399cb3 100644 --- a/doc/reference/shell/eshell-docs.sgml +++ b/doc/reference/shell/eshell-docs.sgml @@ -26,6 +26,28 @@ url="http://mbarnes.fedorapeople.org/docs/eshell/">http://mbarnes.fedorapeople.o </chapter> <chapter> + <title>Basic Utility Functions</title> + <xi:include href="xml/e-account-utils.xml"/> + <xi:include href="xml/e-bit-array.xml"/> + <xi:include href="xml/e-binding.xml"/> + <xi:include href="xml/e-categories-config.xml"/> + <xi:include href="xml/e-datetime-format.xml"/> + <xi:include href="xml/e-dialog-utils.xml"/> + <xi:include href="xml/e-error.xml"/> + <xi:include href="xml/e-html-utils.xml"/> + <xi:include href="xml/e-icon-factory.xml"/> + <xi:include href="xml/e-logger.xml"/> + <xi:include href="xml/e-module.xml"/> + <xi:include href="xml/e-print.xml"/> + <xi:include href="xml/e-signature.xml"/> + <xi:include href="xml/e-signature-list.xml"/> + <xi:include href="xml/e-signature-utils.xml"/> + <xi:include href="xml/e-util.xml"/> + <xi:include href="xml/e-xml-utils.xml"/> + <xi:include href="xml/gconf-bridge.xml"/> + </chapter> + + <chapter> <title>Actions</title> <xi:include href="xml/shell-actions.xml"/> <xi:include href="xml/action-groups.xml"/> diff --git a/doc/reference/shell/eshell-sections.txt b/doc/reference/shell/eshell-sections.txt index 52217cb9c4..afce147581 100644 --- a/doc/reference/shell/eshell-sections.txt +++ b/doc/reference/shell/eshell-sections.txt @@ -45,7 +45,6 @@ EShellBackend e_shell_backend_compare e_shell_backend_get_config_dir e_shell_backend_get_data_dir -e_shell_backend_get_filename e_shell_backend_get_shell e_shell_backend_add_activity e_shell_backend_start @@ -293,6 +292,351 @@ e_shell_importer_start_import </SECTION> <SECTION> +<FILE>e-account-utils</FILE> +<TITLE>Mail Account Functions</TITLE> +e_get_account_list +e_get_default_account +e_set_default_account +e_get_account_by_name +e_get_account_by_uid +</SECTION> + +<SECTION> +<FILE>e-binding</FILE> +<TITLE>GObject Property Bindings</TITLE> +e_binding_new +e_binding_new_full +e_binding_new_with_negation +e_binding_unbind +e_mutual_binding_new +e_mutual_binding_new_full +e_mutual_binding_new_with_negation +e_mutual_binding_unbind +e_binding_transform_color_to_string +e_binding_transform_string_to_color +</SECTION> + +<SECTION> +<FILE>e-bit-array</FILE> +<TITLE>Bit Arrays (Legacy)</TITLE> +EBitArray +e_bit_array_new +e_bit_array_value_at +e_bit_array_foreach +e_bit_array_selected_count +e_bit_array_select_all +e_bit_array_invert_selection +e_bit_array_bit_count +e_bit_array_change_one_row +e_bit_array_change_range +e_bit_array_select_single_row +e_bit_array_toggle_single_row +e_bit_array_insert +e_bit_array_delete +e_bit_array_delete_single_mode +e_bit_array_move_row +<SUBSECTION Standard> +E_BIT_ARRAY +E_IS_BIT_ARRAY +E_BIT_ARRAY_TYPE +E_BIT_ARRAY_CLASS +E_IS_BIT_ARRAY_CLASS +EBitArrayClass +e_bit_array_get_type +</SECTION> + +<SECTION> +<FILE>e-categories-config</FILE> +<TITLE>Category Functions</TITLE> +e_categories_config_get_icon_for +e_categories_config_open_dialog_for_entry +</SECTION> + +<SECTION> +<FILE>e-datetime-format</FILE> +<TITLE>Date and Time Formatting Functions</TITLE> +DTFormatKind +e_datetime_format_add_setup_widget +e_datetime_format_format +e_datetime_format_format_tm +</SECTION> + +<SECTION> +<FILE>e-dialog-utils</FILE> +<TITLE>Dialog Window Functions (Legacy)</TITLE> +e_notice +e_file_dialog_save +e_file_get_save_filesel +e_file_can_save +e_file_check_local +e_dialog_editable_set +e_dialog_editable_get +e_dialog_combo_box_set +e_dialog_combo_box_get +</SECTION> + +<SECTION> +<FILE>e-error</FILE> +<TITLE>Error Dialog Functions</TITLE> +E_ERROR_INFO +E_ERROR_INFO_PRIMARY +E_ERROR_WARNING +E_ERROR_WARNING_PRIMARY +E_ERROR_ERROR +E_ERROR_ERROR_PRIMARY +E_ERROR_ASK_FILE_EXISTS_OVERWRITE +E_ERROR_NO_SAVE_FILE +E_ERROR_NO_LOAD_FILE +e_error_new +e_error_newv +e_error_run +e_error_runv +e_error_count_buttons +</SECTION> + +<SECTION> +<FILE>e-html-utils</FILE> +<TITLE>Text to HTML Conversion</TITLE> +E_TEXT_TO_HTML_PRE +E_TEXT_TO_HTML_CONVERT_NL +E_TEXT_TO_HTML_CONVERT_SPACES +E_TEXT_TO_HTML_CONVERT_URLS +E_TEXT_TO_HTML_MARK_CITATION +E_TEXT_TO_HTML_CONVERT_ADDRESSES +E_TEXT_TO_HTML_ESCAPE_8BIT +E_TEXT_TO_HTML_CITE +e_text_to_html_full +e_text_to_html +</SECTION> + +<SECTION> +<FILE>e-icon-factory</FILE> +<TITLE>Icon Functions (Legacy)</TITLE> +e_icon_factory_init +e_icon_factory_shutdown +e_icon_factory_get_icon_filename +e_icon_factory_get_icon +e_icon_factory_pixbuf_scale +e_icon_factory_create_thumbnail +</SECTION> + +<SECTION> +<FILE>e-logger</FILE> +<TITLE>Error Logging</TITLE> +ELogger +ELogFunction +ELogLevel +e_logger_new +e_logger_get_name +e_logger_log +e_logger_get_logs +<SUBSECTION Standard> +E_LOGGER +E_IS_LOGGER +E_TYPE_LOGGER +E_LOGGER_CLASS +E_IS_LOGGER_CLASS +E_LOGGER_GET_CLASS +ELoggerClass +e_logger_get_type +<SUBSECTION Private> +ELoggerPrivate +</SECTION> + +<SECTION> +<FILE>e-module</FILE> +<TITLE>Generic Module Loader</TITLE> +EModule +e_module_new +e_module_get_filename +e_module_load_all_in_directory +<SUBSECTION Standard> +E_MODULE +E_IS_MODULE +E_TYPE_MODULE +E_MODULE_CLASS +E_IS_MODULE_CLASS +E_MODULE_GET_CLASS +EModuleClass +e_module_get_type +<SUBSECTION Private> +EModulePrivate +</SECTION> + +<SECTION> +<FILE>e-print</FILE> +<TITLE>Printing Functions</TITLE> +e_print_operation_new +e_print_run_page_setup_dialog +</SECTION> + +<SECTION> +<FILE>e-signature</FILE> +<TITLE>Personalized Signatures</TITLE> +ESignature +e_signature_new +e_signature_new_from_xml +e_signature_uid_from_xml +e_signature_set_from_xml +e_signature_to_xml +e_signature_is_equal +e_signature_get_autogenerated +e_signature_set_autogenerated +e_signature_get_filename +e_signature_set_filename +e_signature_get_is_html +e_signature_set_is_html +e_signature_get_is_script +e_signature_set_is_script +e_signature_get_name +e_signature_set_name +e_signature_get_uid +e_signature_set_uid +<SUBSECTION Standard> +E_SIGNATURE +E_IS_SIGNATURE +E_TYPE_SIGNATURE +E_SIGNATURE_CLASS +E_IS_SIGNATURE_CLASS +E_SIGNATURE_GET_CLASS +ESignatureClass +e_signature_get_type +<SUBSECTION Private> +ESignaturePrivate +</SECTION> + +<SECTION> +<FILE>e-signature-list</FILE> +<TITLE>Container for Signatures</TITLE> +ESignatureList +e_signature_list_new +e_signature_list_construct +e_signature_list_save +e_signature_list_add +e_signature_list_change +e_signature_list_remove +e_signature_list_find +<SUBSECTION Standard> +E_SIGNATURE_LIST +E_IS_SIGNATURE_LIST +E_TYPE_SIGNATURE_LIST +E_SIGNATURE_LIST_CLASS +E_IS_SIGNATURE_LIST_CLASS +ESignatureListClass +e_signature_list_get_type +<SUBSECTION Private> +ESignatureListPrivate +</SECTION> + +<SECTION> +<FILE>e-signature-utils</FILE> +<TITLE>More Signature Functions</TITLE> +e_get_signature_list +e_get_signature_by_name +e_get_signature_by_uid +e_create_signature_file +e_read_signature_file +e_run_signature_script +</SECTION> + +<SECTION> +<FILE>e-util</FILE> +<TITLE>Miscellaneous Utility Functions</TITLE> +e_get_user_data_dir +e_get_accels_filename +e_show_uri +e_display_help +e_lookup_action +e_lookup_action_group +e_load_ui_definition +e_action_compare_by_label +e_action_group_remove_all_actions +e_radio_action_get_current_action +e_categories_add_change_hook +e_type_traverse +e_str_without_underscores +e_str_compare +e_str_case_compare +e_collate_compare +e_int_compare +e_write_file_uri +e_color_to_value +e_format_number +ESortCompareFunc +e_bsearch +e_strftime_fix_am_pm +e_utf8_strftime_fix_am_pm +e_get_month_name +e_get_weekday_name +e_flexible_strtod +e_ascii_dtostr +get_font_options +e_file_update_save_path +e_file_get_save_path +e_file_lock_create +e_file_lock_destroy +e_file_lock_exists +e_util_guess_mime_type +e_util_filename_to_uri +e_util_uri_to_filename +e_util_read_file +e_util_get_category_filter_options +e_charset_add_radio_actions +ECursorType +e_cursor_set +e_folder_map_local_folders +e_fsutils_usage +e_fsutils_avail +e_mktemp +e_mkstemp +e_mkdtemp +<SUBSECTION Standard> +E_TYPE_CAMEL_OBJECT +e_camel_object_get_type +</SECTION> + +<SECTION> +<FILE>e-xml-utils</FILE> +<TITLE>Reading and Writing XML</TITLE> +e_xml_get_child_by_name_by_lang +e_xml_get_child_by_name_by_lang_list +e_xml_get_child_by_name_no_lang +e_xml_get_integer_prop_by_name +e_xml_get_integer_prop_by_name_with_default +e_xml_set_integer_prop_by_name +e_xml_get_uint_prop_by_name +e_xml_get_uint_prop_by_name_with_default +e_xml_set_uint_prop_by_name +e_xml_get_bool_prop_by_name +e_xml_get_bool_prop_by_name_with_default +e_xml_set_bool_prop_by_name +e_xml_get_double_prop_by_name +e_xml_get_double_prop_by_name_with_default +e_xml_set_double_prop_by_name +e_xml_get_string_prop_by_name +e_xml_get_string_prop_by_name_with_default +e_xml_set_string_prop_by_name +e_xml_get_translated_string_prop_by_name +</SECTION> + +<SECTION> +<FILE>gconf-bridge</FILE> +<TITLE>GConf Bridge</TITLE> +GConfBridge +gconf_bridge_install_default_error_handler +gconf_bridge_get +gconf_bridge_get_client +gconf_bridge_bind_property_full +gconf_bridge_bind_property +gconf_bridge_bind_property_delayed +gconf_bridge_bind_window +gconf_bridge_bind_window_size +gconf_bridge_bind_window_pos +gconf_bridge_bind_string_list_store +gconf_bridge_unbind +</SECTION> + +<SECTION> <FILE>shell-actions</FILE> <TITLE>Shell Actions</TITLE> E_SHELL_WINDOW_ACTION_ABOUT diff --git a/doc/reference/shell/eshell.types b/doc/reference/shell/eshell.types index 7ad399f7c9..e03302f8d5 100644 --- a/doc/reference/shell/eshell.types +++ b/doc/reference/shell/eshell.types @@ -1,3 +1,8 @@ +e_bit_array_get_type +e_logger_get_type +e_module_get_type +e_signature_get_type +e_signature_list_get_type e_shell_get_type e_shell_backend_get_type e_shell_content_get_type diff --git a/doc/reference/shell/tmpl/e-account-utils.sgml b/doc/reference/shell/tmpl/e-account-utils.sgml new file mode 100644 index 0000000000..656afb3324 --- /dev/null +++ b/doc/reference/shell/tmpl/e-account-utils.sgml @@ -0,0 +1,61 @@ +<!-- ##### SECTION Title ##### --> +Mail Account Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_get_account_list ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_get_default_account ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_set_default_account ##### --> +<para> + +</para> + +@account: + + +<!-- ##### FUNCTION e_get_account_by_name ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION e_get_account_by_uid ##### --> +<para> + +</para> + +@uid: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-binding.sgml b/doc/reference/shell/tmpl/e-binding.sgml new file mode 100644 index 0000000000..f2c4ca66fb --- /dev/null +++ b/doc/reference/shell/tmpl/e-binding.sgml @@ -0,0 +1,136 @@ +<!-- ##### SECTION Title ##### --> +GObject Property Bindings + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_binding_new ##### --> +<para> + +</para> + +@src_object: +@src_property: +@dst_object: +@dst_property: +@Returns: + + +<!-- ##### FUNCTION e_binding_new_full ##### --> +<para> + +</para> + +@src_object: +@src_property: +@dst_object: +@dst_property: +@transform: +@destroy_notify: +@user_data: +@Returns: + + +<!-- ##### FUNCTION e_binding_new_with_negation ##### --> +<para> + +</para> + +@src_object: +@src_property: +@dst_object: +@dst_property: +@Returns: + + +<!-- ##### FUNCTION e_binding_unbind ##### --> +<para> + +</para> + +@binding: + + +<!-- ##### FUNCTION e_mutual_binding_new ##### --> +<para> + +</para> + +@object1: +@property1: +@object2: +@property2: +@Returns: + + +<!-- ##### FUNCTION e_mutual_binding_new_full ##### --> +<para> + +</para> + +@object1: +@property1: +@object2: +@property2: +@transform: +@reverse_transform: +@destroy_notify: +@user_data: +@Returns: + + +<!-- ##### FUNCTION e_mutual_binding_new_with_negation ##### --> +<para> + +</para> + +@object1: +@property1: +@object2: +@property2: +@Returns: + + +<!-- ##### FUNCTION e_mutual_binding_unbind ##### --> +<para> + +</para> + +@binding: + + +<!-- ##### FUNCTION e_binding_transform_color_to_string ##### --> +<para> + +</para> + +@src_value: +@dst_value: +@user_data: +@Returns: + + +<!-- ##### FUNCTION e_binding_transform_string_to_color ##### --> +<para> + +</para> + +@src_value: +@dst_value: +@user_data: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-bit-array.sgml b/doc/reference/shell/tmpl/e-bit-array.sgml new file mode 100644 index 0000000000..01714047c9 --- /dev/null +++ b/doc/reference/shell/tmpl/e-bit-array.sgml @@ -0,0 +1,167 @@ +<!-- ##### SECTION Title ##### --> +Bit Arrays (Legacy) + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EBitArray ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION e_bit_array_new ##### --> +<para> + +</para> + +@count: +@Returns: + + +<!-- ##### FUNCTION e_bit_array_value_at ##### --> +<para> + +</para> + +@selection: +@n: +@Returns: + + +<!-- ##### FUNCTION e_bit_array_foreach ##### --> +<para> + +</para> + +@selection: +@callback: +@closure: + + +<!-- ##### FUNCTION e_bit_array_selected_count ##### --> +<para> + +</para> + +@selection: +@Returns: + + +<!-- ##### FUNCTION e_bit_array_select_all ##### --> +<para> + +</para> + +@selection: + + +<!-- ##### FUNCTION e_bit_array_invert_selection ##### --> +<para> + +</para> + +@selection: + + +<!-- ##### FUNCTION e_bit_array_bit_count ##### --> +<para> + +</para> + +@selection: +@Returns: + + +<!-- ##### FUNCTION e_bit_array_change_one_row ##### --> +<para> + +</para> + +@selection: +@row: +@grow: + + +<!-- ##### FUNCTION e_bit_array_change_range ##### --> +<para> + +</para> + +@selection: +@start: +@end: +@grow: + + +<!-- ##### FUNCTION e_bit_array_select_single_row ##### --> +<para> + +</para> + +@eba: +@row: + + +<!-- ##### FUNCTION e_bit_array_toggle_single_row ##### --> +<para> + +</para> + +@eba: +@row: + + +<!-- ##### FUNCTION e_bit_array_insert ##### --> +<para> + +</para> + +@esm: +@row: +@count: + + +<!-- ##### FUNCTION e_bit_array_delete ##### --> +<para> + +</para> + +@esm: +@row: +@count: + + +<!-- ##### FUNCTION e_bit_array_delete_single_mode ##### --> +<para> + +</para> + +@esm: +@row: +@count: + + +<!-- ##### FUNCTION e_bit_array_move_row ##### --> +<para> + +</para> + +@esm: +@old_row: +@new_row: + + diff --git a/doc/reference/shell/tmpl/e-categories-config.sgml b/doc/reference/shell/tmpl/e-categories-config.sgml new file mode 100644 index 0000000000..8ee544ec23 --- /dev/null +++ b/doc/reference/shell/tmpl/e-categories-config.sgml @@ -0,0 +1,37 @@ +<!-- ##### SECTION Title ##### --> +Category Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_categories_config_get_icon_for ##### --> +<para> + +</para> + +@category: +@pixbuf: +@Returns: + + +<!-- ##### FUNCTION e_categories_config_open_dialog_for_entry ##### --> +<para> + +</para> + +@entry: + + diff --git a/doc/reference/shell/tmpl/e-datetime-format.sgml b/doc/reference/shell/tmpl/e-datetime-format.sgml new file mode 100644 index 0000000000..1dd1c7f24a --- /dev/null +++ b/doc/reference/shell/tmpl/e-datetime-format.sgml @@ -0,0 +1,66 @@ +<!-- ##### SECTION Title ##### --> +Date and Time Formatting Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### ENUM DTFormatKind ##### --> +<para> + +</para> + +@DTFormatKindDate: +@DTFormatKindTime: +@DTFormatKindDateTime: +@DTFormatKindShortDate: + +<!-- ##### FUNCTION e_datetime_format_add_setup_widget ##### --> +<para> + +</para> + +@table: +@row: +@component: +@part: +@kind: +@caption: + + +<!-- ##### FUNCTION e_datetime_format_format ##### --> +<para> + +</para> + +@component: +@part: +@kind: +@value: +@Returns: + + +<!-- ##### FUNCTION e_datetime_format_format_tm ##### --> +<para> + +</para> + +@component: +@part: +@kind: +@tm_time: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-dialog-utils.sgml b/doc/reference/shell/tmpl/e-dialog-utils.sgml new file mode 100644 index 0000000000..08bac749fe --- /dev/null +++ b/doc/reference/shell/tmpl/e-dialog-utils.sgml @@ -0,0 +1,109 @@ +<!-- ##### SECTION Title ##### --> +Dialog Window Functions (Legacy) + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_notice ##### --> +<para> + +</para> + +@parent: +@type: +@format: +@Varargs: + + +<!-- ##### FUNCTION e_file_dialog_save ##### --> +<para> + +</para> + +@title: +@fname: +@Returns: + + +<!-- ##### FUNCTION e_file_get_save_filesel ##### --> +<para> + +</para> + +@parent: +@title: +@name: +@action: +@Returns: + + +<!-- ##### FUNCTION e_file_can_save ##### --> +<para> + +</para> + +@parent: +@uri: +@Returns: + + +<!-- ##### FUNCTION e_file_check_local ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION e_dialog_editable_set ##### --> +<para> + +</para> + +@widget: +@value: + + +<!-- ##### FUNCTION e_dialog_editable_get ##### --> +<para> + +</para> + +@widget: +@Returns: + + +<!-- ##### FUNCTION e_dialog_combo_box_set ##### --> +<para> + +</para> + +@widget: +@value: +@value_map: + + +<!-- ##### FUNCTION e_dialog_combo_box_get ##### --> +<para> + +</para> + +@widget: +@value_map: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-error.sgml b/doc/reference/shell/tmpl/e-error.sgml new file mode 100644 index 0000000000..21055001f5 --- /dev/null +++ b/doc/reference/shell/tmpl/e-error.sgml @@ -0,0 +1,139 @@ +<!-- ##### SECTION Title ##### --> +Error Dialog Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_ERROR_INFO ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_INFO_PRIMARY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_WARNING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_WARNING_PRIMARY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_ERROR_PRIMARY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_ASK_FILE_EXISTS_OVERWRITE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_NO_SAVE_FILE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_ERROR_NO_LOAD_FILE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_error_new ##### --> +<para> + +</para> + +@parent: +@tag: +@arg0: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION e_error_newv ##### --> +<para> + +</para> + +@parent: +@tag: +@arg0: +@ap: +@Returns: + + +<!-- ##### FUNCTION e_error_run ##### --> +<para> + +</para> + +@parent: +@tag: +@arg0: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION e_error_runv ##### --> +<para> + +</para> + +@parent: +@tag: +@arg0: +@ap: +@Returns: + + +<!-- ##### FUNCTION e_error_count_buttons ##### --> +<para> + +</para> + +@dialog: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-html-utils.sgml b/doc/reference/shell/tmpl/e-html-utils.sgml new file mode 100644 index 0000000000..0588b32c5b --- /dev/null +++ b/doc/reference/shell/tmpl/e-html-utils.sgml @@ -0,0 +1,96 @@ +<!-- ##### SECTION Title ##### --> +Text to HTML Conversion + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO E_TEXT_TO_HTML_PRE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_CONVERT_NL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_CONVERT_SPACES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_CONVERT_URLS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_MARK_CITATION ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_CONVERT_ADDRESSES ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_ESCAPE_8BIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO E_TEXT_TO_HTML_CITE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_text_to_html_full ##### --> +<para> + +</para> + +@input: +@flags: +@color: +@Returns: + + +<!-- ##### FUNCTION e_text_to_html ##### --> +<para> + +</para> + +@input: +@flags: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-icon-factory.sgml b/doc/reference/shell/tmpl/e-icon-factory.sgml new file mode 100644 index 0000000000..66d8008060 --- /dev/null +++ b/doc/reference/shell/tmpl/e-icon-factory.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> +Icon Functions (Legacy) + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_icon_factory_init ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_icon_factory_shutdown ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_icon_factory_get_icon_filename ##### --> +<para> + +</para> + +@icon_name: +@icon_size: +@Returns: + + +<!-- ##### FUNCTION e_icon_factory_get_icon ##### --> +<para> + +</para> + +@icon_name: +@icon_size: +@Returns: + + +<!-- ##### FUNCTION e_icon_factory_pixbuf_scale ##### --> +<para> + +</para> + +@pixbuf: +@width: +@height: +@Returns: + + +<!-- ##### FUNCTION e_icon_factory_create_thumbnail ##### --> +<para> + +</para> + +@filename: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-logger.sgml b/doc/reference/shell/tmpl/e-logger.sgml new file mode 100644 index 0000000000..95145bd709 --- /dev/null +++ b/doc/reference/shell/tmpl/e-logger.sgml @@ -0,0 +1,87 @@ +<!-- ##### SECTION Title ##### --> +Error Logging + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT ELogger ##### --> +<para> + +</para> + + +<!-- ##### ARG ELogger:name ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION ELogFunction ##### --> +<para> + +</para> + +@line: +@data: + + +<!-- ##### ENUM ELogLevel ##### --> +<para> + +</para> + +@E_LOG_ERROR: +@E_LOG_WARNING: +@E_LOG_DEBUG: + +<!-- ##### FUNCTION e_logger_new ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION e_logger_get_name ##### --> +<para> + +</para> + +@logger: +@Returns: + + +<!-- ##### FUNCTION e_logger_log ##### --> +<para> + +</para> + +@logger: +@level: +@primary: +@secondary: + + +<!-- ##### FUNCTION e_logger_get_logs ##### --> +<para> + +</para> + +@logger: +@func: +@user_data: + + diff --git a/doc/reference/shell/tmpl/e-module.sgml b/doc/reference/shell/tmpl/e-module.sgml new file mode 100644 index 0000000000..b27b5b3c90 --- /dev/null +++ b/doc/reference/shell/tmpl/e-module.sgml @@ -0,0 +1,57 @@ +<!-- ##### SECTION Title ##### --> +Generic Module Loader + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT EModule ##### --> +<para> + +</para> + + +<!-- ##### ARG EModule:filename ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_module_new ##### --> +<para> + +</para> + +@filename: +@Returns: + + +<!-- ##### FUNCTION e_module_get_filename ##### --> +<para> + +</para> + +@module: +@Returns: + + +<!-- ##### FUNCTION e_module_load_all_in_directory ##### --> +<para> + +</para> + +@dirname: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-print.sgml b/doc/reference/shell/tmpl/e-print.sgml new file mode 100644 index 0000000000..59a7795843 --- /dev/null +++ b/doc/reference/shell/tmpl/e-print.sgml @@ -0,0 +1,35 @@ +<!-- ##### SECTION Title ##### --> +Printing Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_print_operation_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_print_run_page_setup_dialog ##### --> +<para> + +</para> + +@parent: + + diff --git a/doc/reference/shell/tmpl/e-shell-backend.sgml b/doc/reference/shell/tmpl/e-shell-backend.sgml index 10e2845d59..79456dcfea 100644 --- a/doc/reference/shell/tmpl/e-shell-backend.sgml +++ b/doc/reference/shell/tmpl/e-shell-backend.sgml @@ -64,15 +64,6 @@ EShellBackend @Returns: -<!-- ##### FUNCTION e_shell_backend_get_filename ##### --> -<para> - -</para> - -@shell_backend: -@Returns: - - <!-- ##### FUNCTION e_shell_backend_get_shell ##### --> <para> diff --git a/doc/reference/shell/tmpl/e-signature-list.sgml b/doc/reference/shell/tmpl/e-signature-list.sgml new file mode 100644 index 0000000000..42e7f5d042 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature-list.sgml @@ -0,0 +1,113 @@ +<!-- ##### SECTION Title ##### --> +Container for Signatures + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT ESignatureList ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL ESignatureList::signature-added ##### --> +<para> + +</para> + +@esignaturelist: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL ESignatureList::signature-changed ##### --> +<para> + +</para> + +@esignaturelist: the object which received the signal. +@arg1: + +<!-- ##### SIGNAL ESignatureList::signature-removed ##### --> +<para> + +</para> + +@esignaturelist: the object which received the signal. +@arg1: + +<!-- ##### FUNCTION e_signature_list_new ##### --> +<para> + +</para> + +@gconf: +@Returns: + + +<!-- ##### FUNCTION e_signature_list_construct ##### --> +<para> + +</para> + +@signature_list: +@gconf: + + +<!-- ##### FUNCTION e_signature_list_save ##### --> +<para> + +</para> + +@signature_list: + + +<!-- ##### FUNCTION e_signature_list_add ##### --> +<para> + +</para> + +@signature_list: +@signature: + + +<!-- ##### FUNCTION e_signature_list_change ##### --> +<para> + +</para> + +@signature_list: +@signature: + + +<!-- ##### FUNCTION e_signature_list_remove ##### --> +<para> + +</para> + +@signature_list: +@signature: + + +<!-- ##### FUNCTION e_signature_list_find ##### --> +<para> + +</para> + +@signature_list: +@type: +@key: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-signature-utils.sgml b/doc/reference/shell/tmpl/e-signature-utils.sgml new file mode 100644 index 0000000000..a5a04475e9 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature-utils.sgml @@ -0,0 +1,74 @@ +<!-- ##### SECTION Title ##### --> +More Signature Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_get_signature_list ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_get_signature_by_name ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION e_get_signature_by_uid ##### --> +<para> + +</para> + +@uid: +@Returns: + + +<!-- ##### FUNCTION e_create_signature_file ##### --> +<para> + +</para> + +@error: +@Returns: + + +<!-- ##### FUNCTION e_read_signature_file ##### --> +<para> + +</para> + +@signature: +@convert_to_html: +@error: +@Returns: + + +<!-- ##### FUNCTION e_run_signature_script ##### --> +<para> + +</para> + +@filename: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-signature.sgml b/doc/reference/shell/tmpl/e-signature.sgml new file mode 100644 index 0000000000..19e07bae87 --- /dev/null +++ b/doc/reference/shell/tmpl/e-signature.sgml @@ -0,0 +1,218 @@ +<!-- ##### SECTION Title ##### --> +Personalized Signatures + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT ESignature ##### --> +<para> + +</para> + + +<!-- ##### ARG ESignature:autogenerated ##### --> +<para> + +</para> + +<!-- ##### ARG ESignature:filename ##### --> +<para> + +</para> + +<!-- ##### ARG ESignature:is-html ##### --> +<para> + +</para> + +<!-- ##### ARG ESignature:is-script ##### --> +<para> + +</para> + +<!-- ##### ARG ESignature:name ##### --> +<para> + +</para> + +<!-- ##### ARG ESignature:uid ##### --> +<para> + +</para> + +<!-- ##### FUNCTION e_signature_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_signature_new_from_xml ##### --> +<para> + +</para> + +@xml: +@Returns: + + +<!-- ##### FUNCTION e_signature_uid_from_xml ##### --> +<para> + +</para> + +@xml: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_from_xml ##### --> +<para> + +</para> + +@signature: +@xml: +@Returns: + + +<!-- ##### FUNCTION e_signature_to_xml ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_is_equal ##### --> +<para> + +</para> + +@signature1: +@signature2: +@Returns: + + +<!-- ##### FUNCTION e_signature_get_autogenerated ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_autogenerated ##### --> +<para> + +</para> + +@signature: +@autogenerated: + + +<!-- ##### FUNCTION e_signature_get_filename ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_filename ##### --> +<para> + +</para> + +@signature: +@filename: + + +<!-- ##### FUNCTION e_signature_get_is_html ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_is_html ##### --> +<para> + +</para> + +@signature: +@is_html: + + +<!-- ##### FUNCTION e_signature_get_is_script ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_is_script ##### --> +<para> + +</para> + +@signature: +@is_script: + + +<!-- ##### FUNCTION e_signature_get_name ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_name ##### --> +<para> + +</para> + +@signature: +@name: + + +<!-- ##### FUNCTION e_signature_get_uid ##### --> +<para> + +</para> + +@signature: +@Returns: + + +<!-- ##### FUNCTION e_signature_set_uid ##### --> +<para> + +</para> + +@signature: +@uid: + + diff --git a/doc/reference/shell/tmpl/e-util.sgml b/doc/reference/shell/tmpl/e-util.sgml new file mode 100644 index 0000000000..7d2fde14a7 --- /dev/null +++ b/doc/reference/shell/tmpl/e-util.sgml @@ -0,0 +1,493 @@ +<!-- ##### SECTION Title ##### --> +Miscellaneous Utility Functions + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_get_user_data_dir ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_get_accels_filename ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_show_uri ##### --> +<para> + +</para> + +@parent: +@uri: + + +<!-- ##### FUNCTION e_display_help ##### --> +<para> + +</para> + +@parent: +@link_id: + + +<!-- ##### FUNCTION e_lookup_action ##### --> +<para> + +</para> + +@ui_manager: +@action_name: +@Returns: + + +<!-- ##### FUNCTION e_lookup_action_group ##### --> +<para> + +</para> + +@ui_manager: +@group_name: +@Returns: + + +<!-- ##### FUNCTION e_load_ui_definition ##### --> +<para> + +</para> + +@ui_manager: +@basename: +@Returns: + + +<!-- ##### FUNCTION e_action_compare_by_label ##### --> +<para> + +</para> + +@action1: +@action2: +@Returns: + + +<!-- ##### FUNCTION e_action_group_remove_all_actions ##### --> +<para> + +</para> + +@action_group: + + +<!-- ##### FUNCTION e_radio_action_get_current_action ##### --> +<para> + +</para> + +@radio_action: +@Returns: + + +<!-- ##### FUNCTION e_categories_add_change_hook ##### --> +<para> + +</para> + +@func: +@object: + + +<!-- ##### FUNCTION e_type_traverse ##### --> +<para> + +</para> + +@parent_type: +@func: +@user_data: + + +<!-- ##### FUNCTION e_str_without_underscores ##### --> +<para> + +</para> + +@s: +@Returns: + + +<!-- ##### FUNCTION e_str_compare ##### --> +<para> + +</para> + +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION e_str_case_compare ##### --> +<para> + +</para> + +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION e_collate_compare ##### --> +<para> + +</para> + +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION e_int_compare ##### --> +<para> + +</para> + +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION e_write_file_uri ##### --> +<para> + +</para> + +@filename: +@data: +@Returns: + + +<!-- ##### FUNCTION e_color_to_value ##### --> +<para> + +</para> + +@color: +@Returns: + + +<!-- ##### FUNCTION e_format_number ##### --> +<para> + +</para> + +@number: +@Returns: + + +<!-- ##### USER_FUNCTION ESortCompareFunc ##### --> +<para> + +</para> + +@first: +@second: +@closure: +@Returns: + + +<!-- ##### FUNCTION e_bsearch ##### --> +<para> + +</para> + +@key: +@base: +@nmemb: +@size: +@compare: +@closure: +@start: +@end: + + +<!-- ##### FUNCTION e_strftime_fix_am_pm ##### --> +<para> + +</para> + +@str: +@max: +@fmt: +@tm: +@Returns: + + +<!-- ##### FUNCTION e_utf8_strftime_fix_am_pm ##### --> +<para> + +</para> + +@str: +@max: +@fmt: +@tm: +@Returns: + + +<!-- ##### FUNCTION e_get_month_name ##### --> +<para> + +</para> + +@month: +@abbreviated: +@Returns: + + +<!-- ##### FUNCTION e_get_weekday_name ##### --> +<para> + +</para> + +@weekday: +@abbreviated: +@Returns: + + +<!-- ##### FUNCTION e_flexible_strtod ##### --> +<para> + +</para> + +@nptr: +@endptr: +@Returns: + + +<!-- ##### FUNCTION e_ascii_dtostr ##### --> +<para> + +</para> + +@buffer: +@buf_len: +@format: +@d: +@Returns: + + +<!-- ##### FUNCTION get_font_options ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_file_update_save_path ##### --> +<para> + +</para> + +@uri: +@free: + + +<!-- ##### FUNCTION e_file_get_save_path ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_file_lock_create ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_file_lock_destroy ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION e_file_lock_exists ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_util_guess_mime_type ##### --> +<para> + +</para> + +@filename: +@localfile: +@Returns: + + +<!-- ##### FUNCTION e_util_filename_to_uri ##### --> +<para> + +</para> + +@filename: +@Returns: + + +<!-- ##### FUNCTION e_util_uri_to_filename ##### --> +<para> + +</para> + +@uri: +@Returns: + + +<!-- ##### FUNCTION e_util_read_file ##### --> +<para> + +</para> + +@filename: +@filename_is_uri: +@buffer: +@read: +@error: +@Returns: + + +<!-- ##### FUNCTION e_util_get_category_filter_options ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION e_charset_add_radio_actions ##### --> +<para> + +</para> + +@action_group: +@action_prefix: +@default_charset: +@callback: +@user_data: +@Returns: + + +<!-- ##### ENUM ECursorType ##### --> +<para> + +</para> + +@E_CURSOR_FAT_CROSS: +@E_CURSOR_THIN_CROSS: +@E_CURSOR_ARROW: +@E_CURSOR_MOVE: +@E_CURSOR_ZOOM_IN: +@E_CURSOR_ZOOM_OUT: +@E_CURSOR_SIZE_X: +@E_CURSOR_SIZE_Y: +@E_CURSOR_SIZE_TL: +@E_CURSOR_SIZE_TR: +@E_CURSOR_PRESS: +@E_CURSOR_HAND_OPEN: +@E_CURSOR_HAND_CLOSED: +@E_CURSOR_XTERM: +@E_CURSOR_NUM_CURSORS: + +<!-- ##### FUNCTION e_cursor_set ##### --> +<para> + +</para> + +@widget: +@cursor: + + +<!-- ##### FUNCTION e_folder_map_local_folders ##### --> +<para> + +</para> + +@local_dir: +@type: +@Returns: + + +<!-- ##### FUNCTION e_fsutils_usage ##### --> +<para> + +</para> + +@path: +@Returns: + + +<!-- ##### FUNCTION e_fsutils_avail ##### --> +<para> + +</para> + +@path: +@Returns: + + +<!-- ##### FUNCTION e_mktemp ##### --> +<para> + +</para> + +@template: +@Returns: + + +<!-- ##### FUNCTION e_mkstemp ##### --> +<para> + +</para> + +@template: +@Returns: + + +<!-- ##### FUNCTION e_mkdtemp ##### --> +<para> + +</para> + +@template: +@Returns: + + diff --git a/doc/reference/shell/tmpl/e-xml-utils.sgml b/doc/reference/shell/tmpl/e-xml-utils.sgml new file mode 100644 index 0000000000..e9c17a0b35 --- /dev/null +++ b/doc/reference/shell/tmpl/e-xml-utils.sgml @@ -0,0 +1,216 @@ +<!-- ##### SECTION Title ##### --> +Reading and Writing XML + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION e_xml_get_child_by_name_by_lang ##### --> +<para> + +</para> + +@parent: +@child_name: +@lang: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_child_by_name_by_lang_list ##### --> +<para> + +</para> + +@parent: +@name: +@lang_list: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_child_by_name_no_lang ##### --> +<para> + +</para> + +@parent: +@name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_integer_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_integer_prop_by_name_with_default ##### --> +<para> + +</para> + +@parent: +@prop_name: +@def: +@Returns: + + +<!-- ##### FUNCTION e_xml_set_integer_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@value: + + +<!-- ##### FUNCTION e_xml_get_uint_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_uint_prop_by_name_with_default ##### --> +<para> + +</para> + +@parent: +@prop_name: +@def: +@Returns: + + +<!-- ##### FUNCTION e_xml_set_uint_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@value: + + +<!-- ##### FUNCTION e_xml_get_bool_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_bool_prop_by_name_with_default ##### --> +<para> + +</para> + +@parent: +@prop_name: +@def: +@Returns: + + +<!-- ##### FUNCTION e_xml_set_bool_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@value: + + +<!-- ##### FUNCTION e_xml_get_double_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_double_prop_by_name_with_default ##### --> +<para> + +</para> + +@parent: +@prop_name: +@def: +@Returns: + + +<!-- ##### FUNCTION e_xml_set_double_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@value: + + +<!-- ##### FUNCTION e_xml_get_string_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION e_xml_get_string_prop_by_name_with_default ##### --> +<para> + +</para> + +@parent: +@prop_name: +@def: +@Returns: + + +<!-- ##### FUNCTION e_xml_set_string_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@value: + + +<!-- ##### FUNCTION e_xml_get_translated_string_prop_by_name ##### --> +<para> + +</para> + +@parent: +@prop_name: +@Returns: + + diff --git a/doc/reference/shell/tmpl/eshell-unused.sgml b/doc/reference/shell/tmpl/eshell-unused.sgml index 5f6b668d65..23bee36db2 100644 --- a/doc/reference/shell/tmpl/eshell-unused.sgml +++ b/doc/reference/shell/tmpl/eshell-unused.sgml @@ -1850,6 +1850,14 @@ intelligent @revision: @Returns: +<!-- ##### FUNCTION e_shell_backend_get_filename ##### --> +<para> + +</para> + +@shell_backend: +@Returns: + <!-- ##### FUNCTION e_shell_backend_is_busy ##### --> <para> diff --git a/doc/reference/shell/tmpl/gconf-bridge.sgml b/doc/reference/shell/tmpl/gconf-bridge.sgml new file mode 100644 index 0000000000..e7b43dac52 --- /dev/null +++ b/doc/reference/shell/tmpl/gconf-bridge.sgml @@ -0,0 +1,137 @@ +<!-- ##### SECTION Title ##### --> +GConf Bridge + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GConfBridge ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION gconf_bridge_install_default_error_handler ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION gconf_bridge_get ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION gconf_bridge_get_client ##### --> +<para> + +</para> + +@bridge: +@Returns: + + +<!-- ##### FUNCTION gconf_bridge_bind_property_full ##### --> +<para> + +</para> + +@bridge: +@key: +@object: +@prop: +@delayed_sync: +@Returns: + + +<!-- ##### MACRO gconf_bridge_bind_property ##### --> +<para> + +</para> + +@bridge: +@key: +@object: +@prop: + + +<!-- ##### MACRO gconf_bridge_bind_property_delayed ##### --> +<para> + +</para> + +@bridge: +@key: +@object: +@prop: + + +<!-- ##### FUNCTION gconf_bridge_bind_window ##### --> +<para> + +</para> + +@bridge: +@key_prefix: +@window: +@bind_size: +@bind_pos: +@Returns: + + +<!-- ##### MACRO gconf_bridge_bind_window_size ##### --> +<para> + +</para> + +@bridge: +@key_prefix: +@window: + + +<!-- ##### MACRO gconf_bridge_bind_window_pos ##### --> +<para> + +</para> + +@bridge: +@key_prefix: +@window: + + +<!-- ##### FUNCTION gconf_bridge_bind_string_list_store ##### --> +<para> + +</para> + +@bridge: +@key: +@list_store: +@Returns: + + +<!-- ##### FUNCTION gconf_bridge_unbind ##### --> +<para> + +</para> + +@bridge: +@binding_id: + + diff --git a/e-util/e-account-utils.c b/e-util/e-account-utils.c index 5fdffd8be2..4d169d956a 100644 --- a/e-util/e-account-utils.c +++ b/e-util/e-account-utils.c @@ -21,6 +21,13 @@ static EAccountList *global_account_list; +/** + * e_get_account_list: + * + * Returns the global #EAccountList. + * + * Returns: the global #EAccountList + **/ EAccountList * e_get_account_list (void) { @@ -37,6 +44,13 @@ e_get_account_list (void) return global_account_list; } +/** + * e_get_default_account: + * + * Returns the #EAccount marked as the default mail account. + * + * Returns: the default #EAccount + **/ EAccount * e_get_default_account (void) { @@ -50,6 +64,12 @@ e_get_default_account (void) return (EAccount *) account; } +/** + * e_set_default_account: + * @account: an #EAccount + * + * Marks @account as the default mail account. + **/ void e_set_default_account (EAccount *account) { @@ -61,6 +81,15 @@ e_set_default_account (EAccount *account) e_account_list_set_default (account_list, account); } +/** + * e_get_account_by_name: + * @name: a mail account name + * + * Returns the #EAccount with the given name, or %NULL if no such + * account exists. + * + * Returns: an #EAccount having the given account name, or %NULL + **/ EAccount * e_get_account_by_name (const gchar *name) { @@ -78,6 +107,15 @@ e_get_account_by_name (const gchar *name) return (EAccount *) account; } +/** + * e_get_account_by_uid: + * @uid: a mail account UID + * + * Returns the #EAccount with the given unique ID, or %NULL if no such + * account exists. + * + * Returns: an #EAccount having the given unique ID, or %NULL + **/ EAccount * e_get_account_by_uid (const gchar *uid) { diff --git a/e-util/e-account-utils.h b/e-util/e-account-utils.h index f2ae8fc5dc..ca184404ef 100644 --- a/e-util/e-account-utils.h +++ b/e-util/e-account-utils.h @@ -15,6 +15,11 @@ * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com) */ +/** + * SECTION: e-account-utils + * @include: e-util/e-account-utils.h + **/ + #ifndef E_ACCOUNT_UTILS_H #define E_ACCOUNT_UTILS_H diff --git a/e-util/e-charset.c b/e-util/e-charset.c index 329f513ec7..ffee5a8f4a 100644 --- a/e-util/e-charset.c +++ b/e-util/e-charset.c @@ -123,6 +123,8 @@ static ECharset charsets[] = { * US-ASCII). Any other character sets of the same language class as * the default will be added next, followed by the remaining character * sets. + * + * Returns: the radio action group **/ GSList * e_charset_add_radio_actions (GtkActionGroup *action_group, diff --git a/e-util/e-html-utils.c b/e-util/e-html-utils.c index b80ee17891..03e5b73fc0 100644 --- a/e-util/e-html-utils.c +++ b/e-util/e-html-utils.c @@ -178,14 +178,15 @@ is_citation (const guchar *c, gboolean saw_citation) * * The set of possible flags is: * - * - E_TEXT_TO_HTML_PRE: wrap the output HTML in <PRE> and </PRE>. - * Should only be used if @input is the entire buffer to be - * converted. If e_text_to_html is being called with small pieces - * of data, you should wrap the entire result in <PRE> yourself. + * - E_TEXT_TO_HTML_PRE: wrap the output HTML in <PRE> and + * </PRE> Should only be used if @input is the entire + * buffer to be converted. If e_text_to_html is being called with + * small pieces of data, you should wrap the entire result in + * <PRE> yourself. * - * - E_TEXT_TO_HTML_CONVERT_NL: convert "\n" to "<BR>\n" on output. - * (should not be used with E_TEXT_TO_HTML_PRE, since that would - * result in double-newlines). + * - E_TEXT_TO_HTML_CONVERT_NL: convert "\n" to "<BR>n" on + * output. (Should not be used with E_TEXT_TO_HTML_PRE, since + * that would result in double-newlines.) * * - E_TEXT_TO_HTML_CONVERT_SPACES: convert a block of N spaces * into N-1 non-breaking spaces and one normal space. A space @@ -197,14 +198,14 @@ is_citation (const guchar *c, gboolean saw_citation) * If E_TEXT_TO_HTML_CONVERT_NL and E_TEXT_TO_HTML_CONVERT_SPACES * are both defined, then TABs will also be converted to spaces. * - * - E_TEXT_TO_HTML_CONVERT_URLS: wrap <a href="..."> </a> around - * strings that look like URLs. + * - E_TEXT_TO_HTML_CONVERT_URLS: wrap <a href="..."> </a> + * around strings that look like URLs. * - * - E_TEXT_TO_HTML_CONVERT_ADDRESSES: wrap <a href="mailto:..."> </a> around - * strings that look like mail addresses. + * - E_TEXT_TO_HTML_CONVERT_ADDRESSES: wrap <a href="mailto:..."> + * </a> around strings that look like mail addresses. * - * - E_TEXT_TO_HTML_MARK_CITATION: wrap <font color="..."> </font> around - * citations (lines beginning with "> ", etc). + * - E_TEXT_TO_HTML_MARK_CITATION: wrap <font color="..."> + * </font> around citations (lines beginning with "> ", etc). * * - E_TEXT_TO_HTML_ESCAPE_8BIT: flatten everything to US-ASCII * diff --git a/e-util/e-module.h b/e-util/e-module.h index a8120563d3..6f99fc0515 100644 --- a/e-util/e-module.h +++ b/e-util/e-module.h @@ -21,7 +21,6 @@ /** * SECTION: e-module - * @short_description: generic module loader * @include: e-util/e-module.h **/ diff --git a/e-util/e-util.c b/e-util/e-util.c index 4e954a1c6c..f4bf144c5d 100644 --- a/e-util/e-util.c +++ b/e-util/e-util.c @@ -523,22 +523,25 @@ e_type_traverse (GType parent_type, /** * e_str_without_underscores: - * @s: the string to strip underscores from. + * @string: the string to strip underscores from * - * Strips underscores from a string in the same way @gtk_label_new_with_mnemonis does. - * The returned string should be freed. + * Strips underscores from a string in the same way + * @gtk_label_new_with_mnemonics does. The returned string should be freed + * using g_free(). + * + * Returns: a newly-allocated string without underscores */ gchar * -e_str_without_underscores (const gchar *s) +e_str_without_underscores (const gchar *string) { gchar *new_string; const gchar *sp; gchar *dp; - new_string = g_malloc (strlen (s) + 1); + new_string = g_malloc (strlen (string) + 1); dp = new_string; - for (sp = s; *sp != '\0'; sp ++) { + for (sp = string; *sp != '\0'; sp ++) { if (*sp != '_') { *dp = *sp; dp ++; @@ -614,7 +617,8 @@ e_int_compare (gconstpointer x, gconstpointer y) } gboolean -e_write_file_uri (const gchar *filename, const gchar *data) +e_write_file_uri (const gchar *filename, + const gchar *data) { gboolean res; gsize length; @@ -1051,7 +1055,7 @@ e_get_weekday_name (GDateWeekday weekday, * To convert from a double to a string in a locale-insensitive way, use * @g_ascii_dtostr. * - * Return value: the gdouble value. + * Returns: the gdouble value **/ gdouble e_flexible_strtod (const gchar *nptr, gchar **endptr) @@ -1188,7 +1192,7 @@ e_flexible_strtod (const gchar *nptr, gchar **endptr) * of the resulting string will never be larger than * @G_ASCII_DTOSTR_BUF_SIZE bytes. * - * Return value: The pointer to the buffer with the converted string. + * Returns: the pointer to the buffer with the converted string **/ gchar * e_ascii_dtostr (gchar *buffer, gint buf_len, const gchar *format, gdouble d) @@ -1448,11 +1452,14 @@ e_file_lock_exists () /** * e_util_guess_mime_type: - * @filename: it's a local file name, or URI. - * @localfile: set to TRUE if can check the local file content, FALSE to check only based on the filename itself. - * Returns: NULL or newly allocated string with a mime_type of the given file. Free with g_free. + * @filename: a local file name, or URI + * @localfile: %TRUE to check the file content, FALSE to check only the name + * + * Tries to determine the MIME type for @filename. Free the returned + * string with g_free(). * - * Guesses mime_type for the given filename. + * Returns: the MIME type of @filename, or %NULL if the the MIME type could + * not be determined **/ gchar * e_util_guess_mime_type (const gchar *filename, gboolean localfile) @@ -1501,9 +1508,11 @@ e_util_guess_mime_type (const gchar *filename, gboolean localfile) /** * e_util_filename_to_uri: * @filename: local file name. - * Returns: either newly allocated string or NULL. Free with g_free. * - * Converts local file name to URI. + * Converts a local file name to a URI. Free the returned string with + * g_free(). + * + * Returns: a newly allocated string or %NULL **/ gchar * e_util_filename_to_uri (const gchar *filename) @@ -1525,10 +1534,12 @@ e_util_filename_to_uri (const gchar *filename) /** * e_util_uri_to_filename: - * @uri: uri. - * Returns: either newly allocated string or NULL. Free with g_free. + * @uri: a URI + * + * Converts a URI to a local file name. %NULL indicates no such + * local file name exists. Free the returned string with g_free(). * - * Converts URI to local file name. NULL indicates no such local file name exists. + * Returns: either newly allocated string or %NULL **/ gchar * e_util_uri_to_filename (const gchar *uri) @@ -1555,10 +1566,11 @@ e_util_uri_to_filename (const gchar *uri) * @buffer: Read content or the file. Should not be NULL. Returned value should be freed with g_free. * @read: Number of actually read bytes. Should not be NULL. * @error: Here will be returned an error from reading operations. Can be NULL. Not every time is set when returned FALSE. - * Returns: Whether was reading successful or not. * * Reads synchronously content of the file, to which is pointed either by path or by URI. * Mount point should be already mounted when calling this function. + * + * Returns: Whether was reading successful or not. **/ gboolean e_util_read_file (const gchar *filename, gboolean filename_is_uri, gchar **buffer, gsize *read, GError **error) diff --git a/e-util/e-util.h b/e-util/e-util.h index 68abcd4cba..16b3373279 100644 --- a/e-util/e-util.h +++ b/e-util/e-util.h @@ -20,8 +20,13 @@ * */ -#ifndef _E_UTIL_H_ -#define _E_UTIL_H_ +/** + * SECTION: e-util + * @include: e-util/e-util.h + **/ + +#ifndef E_UTIL_H +#define E_UTIL_H #include <sys/types.h> #include <gtk/gtk.h> @@ -154,4 +159,4 @@ GType e_camel_object_get_type (void); G_END_DECLS -#endif /* _E_UTIL_H_ */ +#endif /* E_UTIL_H */ diff --git a/shell/e-shell-backend.c b/shell/e-shell-backend.c index c996d8ab01..f3c35c687c 100644 --- a/shell/e-shell-backend.c +++ b/shell/e-shell-backend.c @@ -370,7 +370,7 @@ e_shell_backend_start (EShellBackend *shell_backend) } /** - * e_shell_migrate: + * e_shell_backend_migrate: * @shell_backend: an #EShellBackend * @major: major part of version to migrate from * @minor: minor part of version to migrate from diff --git a/shell/e-shell-backend.h b/shell/e-shell-backend.h index 026a0358a4..ad1b1294fb 100644 --- a/shell/e-shell-backend.h +++ b/shell/e-shell-backend.h @@ -123,7 +123,6 @@ gint e_shell_backend_compare (EShellBackend *shell_backend_a, EShellBackend *shell_backend_b); const gchar * e_shell_backend_get_config_dir (EShellBackend *shell_backend); const gchar * e_shell_backend_get_data_dir (EShellBackend *shell_backend); -const gchar * e_shell_backend_get_filename (EShellBackend *shell_backend); struct _EShell *e_shell_backend_get_shell (EShellBackend *shell_backend); void e_shell_backend_add_activity (EShellBackend *shell_backend, EActivity *activity); diff --git a/shell/e-shell-content.c b/shell/e-shell-content.c index 0d787749f8..821f683d96 100644 --- a/shell/e-shell-content.c +++ b/shell/e-shell-content.c @@ -820,6 +820,11 @@ shell_content_class_init (EShellContentClass *class) G_PARAM_READWRITE | G_PARAM_CONSTRUCT)); + /** + * EShellContent:shell-view + * + * The #EShellView to which the content widget belongs. + **/ g_object_class_install_property ( object_class, PROP_SHELL_VIEW, diff --git a/shell/e-shell-sidebar.c b/shell/e-shell-sidebar.c index 4fb01e358d..517999bad5 100644 --- a/shell/e-shell-sidebar.c +++ b/shell/e-shell-sidebar.c @@ -317,13 +317,13 @@ shell_sidebar_class_init (EShellSidebarClass *class) * EShellSidebar:icon-name * * The named icon is displayed at the top of the sidebar. - */ + **/ g_object_class_install_property ( object_class, PROP_ICON_NAME, g_param_spec_string ( "icon-name", - NULL, + "Icon Name", NULL, NULL, G_PARAM_READWRITE)); @@ -338,7 +338,7 @@ shell_sidebar_class_init (EShellSidebarClass *class) PROP_PRIMARY_TEXT, g_param_spec_string ( "primary-text", - NULL, + "Primary Text", NULL, NULL, G_PARAM_READWRITE)); @@ -354,7 +354,7 @@ shell_sidebar_class_init (EShellSidebarClass *class) PROP_SECONDARY_TEXT, g_param_spec_string ( "secondary-text", - NULL, + "Secondary Text", NULL, NULL, G_PARAM_READWRITE)); @@ -369,7 +369,7 @@ shell_sidebar_class_init (EShellSidebarClass *class) PROP_SHELL_VIEW, g_param_spec_object ( "shell-view", - NULL, + "Shell View", NULL, E_TYPE_SHELL_VIEW, G_PARAM_READWRITE | |