Baul.FileInfo
Prev | Available Classes | Next

## Baul.FileInfo

Baul.FileInfo — Baul.FileInfo Reference

## Synopsis

    class Baul.FileInfo(gobject.GInterface):
        def is_gone()
        def get_file_type()
        def get_location()
        def get_name()
        def get_uri()
        def get_activation_uri()
        def get_parent_info()
        def get_parent_location()
        def get_parent_uri()
        def get_mount()
        def get_uri_scheme()
        def get_mime_type()
        def is_mime_type(mime_type)
        def is_directory()
        def can_write()
        def add_emblem(emblem_name)
        def get_string_attribute(attribute_name)
        def add_string_attribute(attribute_name, value)
        def invalidate_extension_info()

## Ancestry

    +-- gobject.GInterface
        +-- Baul.FileInfo

## Description

`Baul.FileInfo` objects are passed to extensions by the `Baul.InfoProvider`.

## Public Methods

### Baul.FileInfo.is_gone

        def is_gone()

Returns : | whether the file still exists

### Baul.FileInfo.get_file_type

        def get_file_type()

Returns : | the `gio.FileType` associated with the file

### Baul.FileInfo.get_location

        def get_location()

Returns : | the `gio.File` associated with the file

### Baul.FileInfo.get_name

        def get_name()

Returns : | the basename of the file

### Baul.FileInfo.get_uri

        def get_uri()

Returns : | the uri of the file

### Baul.FileInfo.get_activation_uri

        def get_activation_uri()

Returns : | the activation uri of the file

### Baul.FileInfo.get_parent_info

        def get_parent_info()

Returns : | the `Baul.FileInfo` object associated with the file's parent

### Baul.FileInfo.get_parent_location

        def get_parent_location()

Returns : | the `gio.File` associated with the file's parent location

### Baul.FileInfo.get_parent_uri

        def get_parent_uri()

Returns : | the uri of the file's parent

### Baul.FileInfo.get_mount

        def get_mount()

Returns : | the `gio.GMount` associated with the file, if it exists

### Baul.FileInfo.get_uri_scheme

        def get_uri_scheme()

Returns : | the uri scheme of the file

### Baul.FileInfo.get_mime_type

        def get_mime_type()

Returns : | the mimetype of the file

### Baul.FileInfo.is_mime_type

        def is_mime_type(mimetype)

`mimetype` : | a mimetype string (i.e. "text/plain")
Returns : | whether the file's mimetype string matches the provided mimetype string

### Baul.FileInfo.is_directory

        def is_directory()

Returns : | whether the item is a directory

### Baul.FileInfo.can_write

        def can_write()

Returns : | whether the file is writeable

### Baul.FileInfo.add_emblem

        def add_emblem(emblem_name)

`emblem_name` : | the name of an emblem to add

### Baul.FileInfo.get_string_attribute

        def get_string_attribute(attribute_name)

`attribute_name` : | a string attribute name
Returns : | the value associated with the file attribute

### Baul.FileInfo.add_string_attribute

        def add_string_attribute(attribute_name, value)

`attribute_name` : | a string attribute name
`value` : | an attribute value

### Baul.FileInfo.invalidate_extension_info

        def invalidate_extension_info()

Invalidates the information Baul has about this file, which causes it to request new information from its `Baul.InfoProvider` providers.

Prev | Up | Next
Baul.Column | Home | Baul.Menu