aboutsummaryrefslogblamecommitdiffstats
path: root/doc/reference/shell/eshell-sections.txt
blob: b69e65f3fd92ff5eb8a0ec0cb58ae3649efc16cd (plain) (tree)
1
2
3
4
5
6
7
8
9
         


                     
                   
                          
                          

                             
                          
                        
                           


                           
                    

                             

                  
                              
             
            
                   

                       



                     


                 

                

                    
                           


          


                            


                              
                         

                            
                       













                         



                            
                           
                              





                                  
                                           

                                          

                               



                               












                                          
                             
                     







                         
                    



                    



                                 
                                         
                             





                            

                           

                            













                          



                            
                           
                              

                             














                                  
















                             


                          

                         





                                      



                            



                              



                     


                         

                        




                    











                         
                         
                           
                              



                              

                               
                           

                            
                              
                     






                      
                    
                 


          



                           
                        
                             
                                    



                                 

                              

                            
                               





                                          


                        

                       

                    

                           


          




























































































































































































































































































                                                 

























































                                           

                            

                           
                              




                                          








                                     
                                    
                                  






                                    
                                      
                                         
                                          

                                         


                                  






                                    

                                      

                                        
                                                         


                                                 
          
<SECTION>
<FILE>e-shell</FILE>
<TITLE>EShell</TITLE>
EShell
e_shell_get_default
e_shell_get_shell_backends
e_shell_get_canonical_name
e_shell_get_backend_by_name
e_shell_get_backend_by_scheme
e_shell_get_shell_settings
e_shell_get_gconf_client
e_shell_create_shell_window
e_shell_handle_uris
e_shell_watch_window
e_shell_get_watched_windows
e_shell_send_receive
e_shell_get_network_available
e_shell_set_network_available
e_shell_get_online
e_shell_set_online
e_shell_get_preferences_window
e_shell_event
e_shell_quit
e_shell_cancel_quit
E_SHELL_MIGRATE_ERROR
e_shell_migrate_attempt
<SUBSECTION Standard>
E_SHELL
E_IS_SHELL
E_TYPE_SHELL
E_SHELL_CLASS
E_IS_SHELL_CLASS
E_SHELL_GET_CLASS
EShellClass
e_shell_get_type
<SUBSECTION Private>
EShellPrivate
e_shell_migrate_error_quark
</SECTION>

<SECTION>
<FILE>e-shell-backend</FILE>
<TITLE>EShellBackend</TITLE>
EShellBackend
e_shell_backend_compare
e_shell_backend_get_config_dir
e_shell_backend_get_data_dir
e_shell_backend_get_shell
e_shell_backend_add_activity
e_shell_backend_start
e_shell_backend_migrate
<SUBSECTION Standard>
E_SHELL_BACKEND
E_IS_SHELL_BACKEND
E_TYPE_SHELL_BACKEND
E_SHELL_BACKEND_CLASS
E_IS_SHELL_BACKEND_CLASS
E_SHELL_BACKEND_GET_CLASS
EShellBackendClass
e_shell_backend_get_type
<SUBSECTION Private>
EShellBackendPrivate
</SECTION>

<SECTION>
<FILE>e-shell-content</FILE>
<TITLE>EShellContent</TITLE>
EShellContent
e_shell_content_new
e_shell_content_check_state
e_shell_content_get_shell_view
e_shell_content_get_filter_action
e_shell_content_set_filter_action
e_shell_content_get_filter_value
e_shell_content_set_filter_value
e_shell_content_get_filter_visible
e_shell_content_set_filter_visible
e_shell_content_add_filter_separator_before
e_shell_content_add_filter_separator_after
e_shell_content_get_search_context
e_shell_content_get_search_hint
e_shell_content_set_search_hint
e_shell_content_get_search_rule
e_shell_content_set_search_rule
e_shell_content_get_search_text
e_shell_content_set_search_text
e_shell_content_get_search_visible
e_shell_content_set_search_visible
e_shell_content_get_scope_action
e_shell_content_set_scope_action
e_shell_content_get_scope_value
e_shell_content_set_scope_value
e_shell_content_get_scope_visible
e_shell_content_set_scope_visible
e_shell_content_get_view_id
e_shell_content_set_view_id
e_shell_content_run_advanced_search_dialog
e_shell_content_run_edit_searches_dialog
e_shell_content_run_save_search_dialog
e_shell_content_restore_state
<SUBSECTION Standard>
E_SHELL_CONTENT
E_IS_SHELL_CONTENT
E_TYPE_SHELL_CONTENT
E_SHELL_CONTENT_CLASS
E_IS_SHELL_CONTENT_CLASS
E_SHELL_CONTENT_GET_CLASS
EShellContentClass
e_shell_content_get_type
<SUBSECTION Private>
EShellContentPrivate
</SECTION>

<SECTION>
<FILE>e-shell-settings</FILE>
<TITLE>EShellSettings</TITLE>
EShellSettings
e_shell_settings_install_property
e_shell_settings_install_property_for_key
e_shell_settings_enable_debug
e_shell_settings_get_boolean
e_shell_settings_set_boolean
e_shell_settings_get_int
e_shell_settings_set_int
e_shell_settings_get_string
e_shell_settings_set_string
e_shell_settings_get_object
e_shell_settings_set_object
e_shell_settings_get_pointer
e_shell_settings_set_pointer
<SUBSECTION Standard>
E_SHELL_SETTINGS
E_IS_SHELL_SETTINGS
E_TYPE_SHELL_SETTINGS
E_SHELL_SETTINGS_CLASS
E_IS_SHELL_SETTINGS_CLASS
E_SHELL_SETTINGS_GET_CLASS
EShellSettingsClass
e_shell_settings_get_type
<SUBSECTION Private>
EShellSettingsPrivate
</SECTION>

<SECTION>
<FILE>e-shell-sidebar</FILE>
<TITLE>EShellSidebar</TITLE>
EShellSidebar
e_shell_sidebar_new
e_shell_sidebar_check_state
e_shell_sidebar_get_shell_view
e_shell_sidebar_get_icon_name
e_shell_sidebar_set_icon_name
e_shell_sidebar_get_primary_text
e_shell_sidebar_set_primary_text
e_shell_sidebar_get_secondary_text
e_shell_sidebar_set_secondary_text
<SUBSECTION Standard>
E_SHELL_SIDEBAR
E_IS_SHELL_SIDEBAR
E_TYPE_SHELL_SIDEBAR
E_SHELL_SIDEBAR_CLASS
E_IS_SHELL_SIDEBAR_CLASS
E_SHELL_SIDEBAR_GET_CLASS
EShellSidebarClass
e_shell_sidebar_get_type
<SUBSECTION Private>
EShellSidebarPrivate
</SECTION>

<SECTION>
<FILE>e-shell-switcher</FILE>
<TITLE>EShellSwitcher</TITLE>
EShellSwitcher
e_shell_switcher_new
e_shell_switcher_add_action
e_shell_switcher_get_style
e_shell_switcher_set_style
e_shell_switcher_unset_style
e_shell_switcher_get_visible
e_shell_switcher_set_visible
<SUBSECTION Standard>
E_SHELL_SWITCHER
E_IS_SHELL_SWITCHER
E_TYPE_SHELL_SWITCHER
E_SHELL_SWITCHER_CLASS
E_IS_SHELL_SWITCHER_CLASS
E_SHELL_SWITCHER_GET_CLASS
EShellSwitcherClass
e_shell_switcher_get_type
<SUBSECTION Private>
EShellSwitcherPrivate
E_SHELL_SWITCHER_DEFAULT_TOOLBAR_STYLE
</SECTION>

<SECTION>
<FILE>e-shell-taskbar</FILE>
<TITLE>EShellTaskbar</TITLE>
EShellTaskbar
e_shell_taskbar_new
e_shell_taskbar_get_shell_view
e_shell_taskbar_get_message
e_shell_taskbar_set_message
e_shell_taskbar_unset_message
<SUBSECTION Standard>
E_SHELL_TASKBAR
E_IS_SHELL_TASKBAR
E_TYPE_SHELL_TASKBAR
E_SHELL_TASKBAR_CLASS
E_IS_SHELL_TASKBAR_CLASS
E_SHELL_TASKBAR_GET_CLASS
EShellTaskbarClass
e_shell_taskbar_get_type
<SUBSECTION Private>
EShellTaskbarPrivate
</SECTION>

<SECTION>
<FILE>e-shell-view</FILE>
<TITLE>EShellView</TITLE>
EShellView
EShellViewClass
e_shell_view_get_name
e_shell_view_get_action
e_shell_view_get_title
e_shell_view_set_title
e_shell_view_get_view_id
e_shell_view_set_view_id
e_shell_view_is_active
e_shell_view_get_page_num
e_shell_view_set_page_num
e_shell_view_get_size_group
e_shell_view_get_shell_backend
e_shell_view_get_shell_content
e_shell_view_get_shell_sidebar
e_shell_view_get_shell_taskbar
e_shell_view_get_shell_window
e_shell_view_get_state_key_file
e_shell_view_set_state_dirty
e_shell_view_execute_search
e_shell_view_update_actions
e_shell_view_show_popup_menu
e_shell_view_new_view_instance
<SUBSECTION Standard>
E_SHELL_VIEW
E_IS_SHELL_VIEW
E_TYPE_SHELL_VIEW
E_SHELL_VIEW_CLASS
E_IS_SHELL_VIEW_CLASS
E_SHELL_VIEW_GET_CLASS
e_shell_view_get_type
<SUBSECTION Private>
EShellViewPrivate
</SECTION>

<SECTION>
<FILE>e-shell-window</FILE>
<TITLE>EShellWindow</TITLE>
EShellWindow
e_shell_window_new
e_shell_window_get_shell
e_shell_window_get_shell_view
e_shell_window_get_shell_view_action
e_shell_window_get_ui_manager
e_shell_window_get_action
e_shell_window_get_action_group
e_shell_window_get_managed_widget
e_shell_window_get_active_view
e_shell_window_set_active_view
e_shell_window_get_safe_mode
e_shell_window_set_safe_mode
e_shell_window_add_action_group
e_shell_window_register_new_item_actions
e_shell_window_register_new_source_actions
<SUBSECTION Standard>
E_SHELL_WINDOW
E_IS_SHELL_WINDOW
E_TYPE_SHELL_WINDOW
E_SHELL_WINDOW_CLASS
E_IS_SHELL_WINDOW_CLASS
E_SHELL_WINDOW_GET_CLASS
EShellWindowClass
e_shell_window_get_type
<SUBSECTION Private>
EShellWindowPrivate
E_SHELL_WINDOW_ACTION
E_SHELL_WINDOW_ACTION_GROUP
</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_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
E_SHELL_WINDOW_ACTION_CLOSE
E_SHELL_WINDOW_ACTION_CONTENTS
E_SHELL_WINDOW_ACTION_FAQ
E_SHELL_WINDOW_ACTION_FORGET_PASSWORDS
E_SHELL_WINDOW_ACTION_GAL_CUSTOM_VIEW
E_SHELL_WINDOW_ACTION_GAL_DEFINE_VIEWS
E_SHELL_WINDOW_ACTION_GAL_SAVE_CUSTOM_VIEW
E_SHELL_WINDOW_ACTION_IMPORT
E_SHELL_WINDOW_ACTION_NEW_WINDOW
E_SHELL_WINDOW_ACTION_PAGE_SETUP
E_SHELL_WINDOW_ACTION_PREFERENCES
E_SHELL_WINDOW_ACTION_QUICK_REFERENCE
E_SHELL_WINDOW_ACTION_QUIT
E_SHELL_WINDOW_ACTION_SEARCH_ADVANCED
E_SHELL_WINDOW_ACTION_SEARCH_CLEAR
E_SHELL_WINDOW_ACTION_SEARCH_EDIT
E_SHELL_WINDOW_ACTION_SEARCH_OPTIONS
E_SHELL_WINDOW_ACTION_SEARCH_QUICK
E_SHELL_WINDOW_ACTION_SEARCH_SAVE
E_SHELL_WINDOW_ACTION_SEND_RECEIVE
E_SHELL_WINDOW_ACTION_SHOW_SIDEBAR
E_SHELL_WINDOW_ACTION_SHOW_STATUSBAR
E_SHELL_WINDOW_ACTION_SHOW_SWITCHER
E_SHELL_WINDOW_ACTION_SHOW_TOOLBAR
E_SHELL_WINDOW_ACTION_SUBMIT_BUG
E_SHELL_WINDOW_ACTION_SWITCHER_INITIAL
E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_BOTH
E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_ICONS
E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_TEXT
E_SHELL_WINDOW_ACTION_SWITCHER_STYLE_USER
E_SHELL_WINDOW_ACTION_SYNC_OPTIONS
E_SHELL_WINDOW_ACTION_WORK_OFFLINE
E_SHELL_WINDOW_ACTION_WORK_ONLINE
</SECTION>

<SECTION>
<FILE>action-groups</FILE>
<TITLE>Action Groups</TITLE>
E_SHELL_WINDOW_ACTION_GROUP_SHELL
E_SHELL_WINDOW_ACTION_GROUP_SWITCHER
E_SHELL_WINDOW_ACTION_GROUP_NEW_ITEM
E_SHELL_WINDOW_ACTION_GROUP_NEW_SOURCE
E_SHELL_WINDOW_ACTION_GROUP_CUSTOM_RULES
E_SHELL_WINDOW_ACTION_GROUP_GAL_VIEW
E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_APPLICATION_HANDLERS
E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINTING
E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_PRINT_SETUP
E_SHELL_WINDOW_ACTION_GROUP_LOCKDOWN_SAVE_TO_DISK
</SECTION>