diff options
Diffstat (limited to 'libnautilus-extension/nautilus-file-info.h')
| -rw-r--r-- | libnautilus-extension/nautilus-file-info.h | 128 |
1 files changed, 105 insertions, 23 deletions
diff --git a/libnautilus-extension/nautilus-file-info.h b/libnautilus-extension/nautilus-file-info.h index a7da8ec6b..dbd91e529 100644 --- a/libnautilus-extension/nautilus-file-info.h +++ b/libnautilus-extension/nautilus-file-info.h @@ -46,46 +46,55 @@ G_DECLARE_INTERFACE (NautilusFileInfo, nautilus_file_info, NAUTILUS, FILE_INFO, typedef struct NautilusFile NautilusFile; /** + * SECTION:nautilus-file-info + * @title: NautilusFileInfo + * @short_description: File interface for nautilus extensions + * + * #NautilusFileInfo provides methods to get and modify information + * about file objects in the file manager. + */ + +/** * NautilusFileInfoInterface: * @g_iface: The parent interface. * @is_gone: Returns whether the file info is gone. - * See nautilus_file_info_is_gone() for details. + * See nautilus_file_info_is_gone() for details. * @get_name: Returns the file name as a string. - * See nautilus_file_info_get_name() for details. + * See nautilus_file_info_get_name() for details. * @get_uri: Returns the file URI as a string. - * See nautilus_file_info_get_uri() for details. + * See nautilus_file_info_get_uri() for details. * @get_parent_uri: Returns the file parent URI as a string. - * See nautilus_file_info_get_parent_uri() for details. + * See nautilus_file_info_get_parent_uri() for details. * @get_uri_scheme: Returns the file URI scheme as a string. - * See nautilus_file_info_get_uri_scheme() for details. + * See nautilus_file_info_get_uri_scheme() for details. * @get_mime_type: Returns the file mime type as a string. - * See nautilus_file_info_get_mime_type() for details. + * See nautilus_file_info_get_mime_type() for details. * @is_mime_type: Returns whether the file is the given mime type. - * See nautilus_file_info_is_mime_type() for details. + * See nautilus_file_info_is_mime_type() for details. * @is_directory: Returns whether the file is a directory. - * See nautilus_file_info_is_directory() for details. + * See nautilus_file_info_is_directory() for details. * @add_emblem: Adds an emblem to this file. - * See nautilus_file_info_add_emblem() for details. + * See nautilus_file_info_add_emblem() for details. * @get_string_attribute: Returns the specified file attribute as a string. - * See nautilus_file_info_get_string_attribute() for details. + * See nautilus_file_info_get_string_attribute() for details. * @add_string_attribute: Sets the specified string file attribute value. - * See nautilus_file_info_add_string_attribute() for details. + * See nautilus_file_info_add_string_attribute() for details. * @invalidate_extension_info: Invalidates information of the file provided by extensions. - * See nautilus_file_info_invalidate_extension_info() for details. + * See nautilus_file_info_invalidate_extension_info() for details. * @get_activation_uri: Returns the file activation URI as a string. - * See nautilus_file_info_get_activation_uri() for details. + * See nautilus_file_info_get_activation_uri() for details. * @get_file_type: Returns the file type. - * See nautilus_file_info_get_file_type() for details. + * See nautilus_file_info_get_file_type() for details. * @get_location: Returns the file location as a #GFile. - * See nautilus_file_info_get_location() for details. + * See nautilus_file_info_get_location() for details. * @get_parent_location: Returns the file parent location as a #GFile. - * See nautilus_file_info_get_parent_location() for details. + * See nautilus_file_info_get_parent_location() for details. * @get_parent_info: Returns the file parent #NautilusFileInfo. - * See nautilus_file_info_get_parent_info() for details. + * See nautilus_file_info_get_parent_info() for details. * @get_mount: Returns the file mount as a #GMount. - * See nautilus_file_info_get_mount() for details. + * See nautilus_file_info_get_mount() for details. * @can_write: Returns whether the file is writable. - * See nautilus_file_info_can_write() for details. + * See nautilus_file_info_can_write() for details. * * Interface for extensions to provide additional menu items. */ @@ -124,28 +133,77 @@ struct _NautilusFileInfoInterface gboolean (*can_write) (NautilusFileInfo *file_info); }; +/** + * nautilus_file_info_list_copy: + * @files: (element-type NautilusFileInfo): the files to copy + * + * Returns: (element-type NautilusFileInfo) (transfer full): a copy of @files. + * Use #nautilus_file_info_list_free to free the list and unref its contents. + */ GList *nautilus_file_info_list_copy (GList *files); +/** + * nautilus_file_info_list_free: + * @files: (element-type NautilusFileInfo): a list created with #nautilus_file_info_list_copy + * + */ void nautilus_file_info_list_free (GList *files); -/* Return true if the file has been deleted */ +/** + * nautilus_file_info_is_gone: + * @file_info: a #NautilusFileInfo + * + * Returns: whether the file has been deleted + */ gboolean nautilus_file_info_is_gone (NautilusFileInfo *file_info); /* Name and Location */ GFileType nautilus_file_info_get_file_type (NautilusFileInfo *file_info); +/** + * nautilus_file_info_get_location: + * @file_info: a #NautilusFileInfo + * + * Returns: (transfer full): a #GFile for the location of @file_info + */ GFile *nautilus_file_info_get_location (NautilusFileInfo *file_info); char *nautilus_file_info_get_name (NautilusFileInfo *file_info); char *nautilus_file_info_get_uri (NautilusFileInfo *file_info); char *nautilus_file_info_get_activation_uri (NautilusFileInfo *file_info); +/** + * nautilus_file_info_get_parent_location: + * @file_info: a #NautilusFileInfo + * + * Returns: (allow-none) (transfer full): a #GFile for the parent location of @file_info, + * or %NULL if @file_info has no parent + */ GFile *nautilus_file_info_get_parent_location (NautilusFileInfo *file_info); char *nautilus_file_info_get_parent_uri (NautilusFileInfo *file_info); +/** + * nautilus_file_info_get_mount: + * @file_info: a #NautilusFileInfo + * + * Returns: (nullable) (transfer full): a #GMount for the mount of @file_info, + * or %NULL if @file_info has no mount + */ GMount *nautilus_file_info_get_mount (NautilusFileInfo *file_info); char *nautilus_file_info_get_uri_scheme (NautilusFileInfo *file_info); -/* It's not safe to call this recursively multiple times, as it works +/** + * nautilus_file_info_get_parent_info: + * @file_info: a #NautilusFileInfo + * + * It's not safe to call this recursively multiple times, as it works * only for files already cached by Nautilus. + * + * Returns: (nullable) (transfer full): a #NautilusFileInfo for the parent of @file_info, + * or %NULL if @file_info has no parent. */ NautilusFileInfo *nautilus_file_info_get_parent_info (NautilusFileInfo *file_info); -/* File Type */ +/** + * nautilus_file_info_get_parent_info: + * @file_info: a #NautilusFileInfo + * + * Returns: (transfer full): the MIME type of @file_info + */ char * nautilus_file_info_get_mime_type (NautilusFileInfo *file_info); gboolean nautilus_file_info_is_mime_type (NautilusFileInfo *file_info, const char *mime_type); @@ -165,9 +223,33 @@ void nautilus_file_info_add_string_attribute (NautilusFileInfo *fil /* Invalidating file info */ void nautilus_file_info_invalidate_extension_info (NautilusFileInfo *file_info); +/** + * nautilus_file_info_lookup: + * @location: the location for which to look up a corresponding #NautilusFileInfo object + * + * Returns: (transfer full): a #NautilusFileInfo + */ NautilusFileInfo *nautilus_file_info_lookup (GFile *location); +/** + * nautilus_file_info_create: + * @location: the location to create the file info for + * + * Returns: (transfer full): a #NautilusFileInfo + */ NautilusFileInfo *nautilus_file_info_create (GFile *location); +/** + * nautilus_file_info_lookup_for_uri: + * @uri: the URI to lookup the file info for + * + * Returns: (transfer full): a #NautilusFileInfo + */ NautilusFileInfo *nautilus_file_info_lookup_for_uri (const char *uri); +/** + * nautilus_file_info_create_for_uri: + * @uri: the URI to lookup the file info for + * + * Returns: (transfer full): a #NautilusFileInfo + */ NautilusFileInfo *nautilus_file_info_create_for_uri (const char *uri); -G_END_DECLS
\ No newline at end of file +G_END_DECLS |