diff options
Diffstat (limited to 'doc/reference/shell/tmpl')
20 files changed, 2322 insertions, 9 deletions
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: + + |