diff options
Diffstat (limited to 'docs/reference/libcaja-extension/tmpl')
12 files changed, 1005 insertions, 0 deletions
diff --git a/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml new file mode 100644 index 00000000..815284de --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml @@ -0,0 +1,45 @@ +<!-- ##### SECTION Title ##### --> +caja-column-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaColumnProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaColumnProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_columns: + +<!-- ##### FUNCTION caja_column_provider_get_columns ##### --> +<para> + +</para> + +@provider: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-column.sgml b/docs/reference/libcaja-extension/tmpl/caja-column.sgml new file mode 100644 index 00000000..a55b63ba --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-column.sgml @@ -0,0 +1,76 @@ +<!-- ##### SECTION Title ##### --> +CajaColumn + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaColumnDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaColumn ##### --> +<para> + +</para> + + +<!-- ##### ARG CajaColumn:attribute ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:attribute-q ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:description ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:xalign ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_column_new ##### --> +<para> + +</para> + +@name: +@attribute: +@label: +@description: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml b/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml new file mode 100644 index 00000000..1fba8e67 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml @@ -0,0 +1,78 @@ +<!-- ##### SECTION Title ##### --> +caja-extension-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_TYPE_OPERATION_RESULT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT CajaOperationHandle ##### --> +<para> + +</para> + + +<!-- ##### ENUM CajaOperationResult ##### --> +<para> + +</para> + +@CAJA_OPERATION_COMPLETE: +@CAJA_OPERATION_FAILED: +@CAJA_OPERATION_IN_PROGRESS: + +<!-- ##### FUNCTION caja_operation_result_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_module_initialize ##### --> +<para> + +</para> + +@module: + + +<!-- ##### FUNCTION caja_module_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION caja_module_list_types ##### --> +<para> + +</para> + +@types: +@num_types: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml b/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml new file mode 100644 index 00000000..201be36a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml @@ -0,0 +1,257 @@ +<!-- ##### SECTION Title ##### --> +caja-file-info + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_FILE_DEFINED ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF CajaFile ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF CajaFileInfo ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaFileInfoIface ##### --> +<para> + +</para> + +@g_iface: +@is_gone: +@get_name: +@get_uri: +@get_parent_uri: +@get_uri_scheme: +@get_mime_type: +@is_mime_type: +@is_directory: +@add_emblem: +@get_string_attribute: +@add_string_attribute: +@invalidate_extension_info: +@get_activation_uri: +@get_file_type: +@get_location: +@get_parent_location: +@get_parent_info: +@get_mount: +@can_write: + +<!-- ##### FUNCTION caja_file_info_list_copy ##### --> +<para> + +</para> + +@files: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_list_free ##### --> +<para> + +</para> + +@files: + + +<!-- ##### FUNCTION caja_file_info_is_gone ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_file_type ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_location ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_name ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_activation_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_location ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_mount ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_uri_scheme ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_info ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_mime_type ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_is_mime_type ##### --> +<para> + +</para> + +@file: +@mime_type: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_is_directory ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_can_write ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_add_emblem ##### --> +<para> + +</para> + +@file: +@emblem_name: + + +<!-- ##### FUNCTION caja_file_info_get_string_attribute ##### --> +<para> + +</para> + +@file: +@attribute_name: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_add_string_attribute ##### --> +<para> + +</para> + +@file: +@attribute_name: +@value: + + +<!-- ##### FUNCTION caja_file_info_invalidate_extension_info ##### --> +<para> + +</para> + +@file: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml new file mode 100644 index 00000000..75b0e0f7 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml @@ -0,0 +1,80 @@ +<!-- ##### SECTION Title ##### --> +caja-info-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaInfoProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaInfoProviderIface ##### --> +<para> + +</para> + +@g_iface: +@update_file_info: +@cancel_update: + +<!-- ##### USER_FUNCTION CajaInfoProviderUpdateComplete ##### --> +<para> + +</para> + +@provider: +@handle: +@result: +@user_data: + + +<!-- ##### FUNCTION caja_info_provider_update_file_info ##### --> +<para> + +</para> + +@provider: +@file: +@update_complete: +@handle: +@Returns: + + +<!-- ##### FUNCTION caja_info_provider_cancel_update ##### --> +<para> + +</para> + +@provider: +@handle: + + +<!-- ##### FUNCTION caja_info_provider_update_complete_invoke ##### --> +<para> + +</para> + +@update_complete: +@provider: +@handle: +@result: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml new file mode 100644 index 00000000..d6effd30 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml @@ -0,0 +1,47 @@ +<!-- ##### SECTION Title ##### --> +caja-location-widget-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaLocationWidgetProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaLocationWidgetProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_widget: + +<!-- ##### FUNCTION caja_location_widget_provider_get_widget ##### --> +<para> + +</para> + +@provider: +@uri: +@window: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml new file mode 100644 index 00000000..627f4a4a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml @@ -0,0 +1,22 @@ +<!-- ##### SECTION Title ##### --> +caja-menu-item + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml new file mode 100644 index 00000000..9be2de5a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml @@ -0,0 +1,86 @@ +<!-- ##### SECTION Title ##### --> +caja-menu-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaMenuProvider ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL CajaMenuProvider::items-updated ##### --> +<para> + +</para> + +@cajamenuprovider: the object which received the signal. + +<!-- ##### STRUCT CajaMenuProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_file_items: +@get_background_items: +@get_toolbar_items: + +<!-- ##### FUNCTION caja_menu_provider_get_file_items ##### --> +<para> + +</para> + +@provider: +@window: +@files: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_get_background_items ##### --> +<para> + +</para> + +@provider: +@window: +@current_folder: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_get_toolbar_items ##### --> +<para> + +</para> + +@provider: +@window: +@current_folder: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_emit_items_updated_signal ##### --> +<para> + +</para> + +@provider: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu.sgml new file mode 100644 index 00000000..37187bc6 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu.sgml @@ -0,0 +1,208 @@ +<!-- ##### SECTION Title ##### --> +CajaMenuItem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_TYPE_MENU_ITEM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO CAJA_MENU_ITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO CAJA_MENU_ITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO CAJA_MENU_IS_ITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO CAJA_MENU_IS_ITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO CAJA_MENU_ITEM_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### STRUCT CajaMenuPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenuItemDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenu ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenuItem ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL CajaMenuItem::activate ##### --> +<para> + +</para> + +@cajamenuitem: the object which received the signal. + +<!-- ##### ARG CajaMenuItem:icon ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:menu ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:priority ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:sensitive ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:tip ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_menu_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_menu_append_item ##### --> +<para> + +</para> + +@menu: +@item: + + +<!-- ##### FUNCTION caja_menu_get_items ##### --> +<para> + +</para> + +@menu: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_list_free ##### --> +<para> + +</para> + +@item_list: + + +<!-- ##### FUNCTION caja_menu_item_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_new ##### --> +<para> + +</para> + +@name: +@label: +@tip: +@icon: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_activate ##### --> +<para> + +</para> + +@item: + + +<!-- ##### FUNCTION caja_menu_item_set_submenu ##### --> +<para> + +</para> + +@item: +@menu: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml new file mode 100644 index 00000000..a7df289b --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +caja-property-page-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaPropertyPageProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaPropertyPageProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_pages: + +<!-- ##### FUNCTION caja_property_page_provider_get_pages ##### --> +<para> + +</para> + +@provider: +@files: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml b/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml new file mode 100644 index 00000000..cc5753b2 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml @@ -0,0 +1,60 @@ +<!-- ##### SECTION Title ##### --> +CajaPropertyPage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaPropertyPageDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaPropertyPage ##### --> +<para> + +</para> + + +<!-- ##### ARG CajaPropertyPage:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaPropertyPage:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaPropertyPage:page ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_property_page_new ##### --> +<para> + +</para> + +@name: +@label: +@page: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml b/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml |