Nemo.InfoProvider

Nemo.InfoProvider — Nemo.InfoProvider Reference

Synopsis

 Nemo.InfoProvider {
  update_file_info(file);
  update_file_info_full(provider,
                        handle,
                        closure,
                        file);

  cancel_update(provider,
                handle);

  Nemo.info_provider_update_complete_invoke(provider,
                                            handle,
                                            closure,
                                            result= Nemo.OperationResult.COMPLETE);

}

Description

If subclassed, Nemo will call update_file_info(_full) to notify extensions of which files are being viewed by the user. This gives extensions an opportunity to invoke actions on the files, or to add emblems or attributes.

Example 3. Nemo.InfoProvider Example

1
2
3
4
5
6
7
8
9
10
11
12
from gi.repository import Nemo, GObject

class ColumnExtension(GObject.GObject, Nemo.InfoProvider):
    def __init__(self):
        pass
    
    def update_file_info_full(self, provider, handle, closure, file):
        gobject.timeout_add_seconds(3, self.update_cb, provider, handle, closure)
        return Nemo.OperationResult.IN_PROGRESS
        
    def update_cb(self, provider, handle, closure):
        Nemo.info_provider_update_complete_invoke(closure, provider, handle, Nemo.OperationResult.FAILED)

Passive Methods

Nemo.InfoProvider.update_file_info

update_file_info(file);

file :

a Nemo.FileInfo object

This method is called by Nemo for each file or folder that exists under the current directory listing. There is no return value.


Nemo.InfoProvider.update_file_info_full

update_file_info_full(provider,
                      handle,
                      closure,
                      file);

provider :

the current Nemo.InfoProvider instance

handle :

a gobject.gpointer generated solely to track this call

closure :

a C Closure that must be passed to Nemo.info_provider_update_complete_invoke if that method is called

file :

a Nemo.FileInfo object

Returns :

None or a Nemo.OperationResult enum

This method is called by Nemo for each file or folder that exists under the current directory listing. Originally, Nemo.InfoProvider only provided the update_file_info method, which blocked Nemo when the method required a lot of computation time. This method was created to allow an extension to tell Nemo that it will be spending time on an operation and that Nemo should not block itself during that time.

In order to notify Nemo of your extension's intentions, you must return a Nemo.OperationResult enum. Then, when the operation has completed, call the Nemo.info_provider_update_complete_invoke method, passing the provider, handle and closure variables as parameters.

This method was created for backwards compatibility reasons. If your extension used the update_file_info method and you want non-blocking usage, you should switch to this method.

This method was introduced in nemo-python 0.7.0.

Nemo.InfoProvider.cancel_update

cancel_update(provider,
              handle);

provider :

the current Nemo.InfoProvider instance

handle :

a gobject.gpointer generated by a specific update_file_info_full call

This method is called by Nemo when an update_file_info_full call is in progress but is no longer required. This may happen because the user is moving directories or a file has been deleted, etc. You may use the handle parameter here to match the handle parameter passed in update_file_info_full.

This method was introduced in nemo-python 0.7.0.

Active Methods

Nemo.info_provider_update_complete_invoke

info_provider_update_complete_invoke(provider,
                                     handle,
                                     closure,
                                     result= Nemo.OperationResult.COMPLETE);

provider :

the current Nemo.InfoProvider instance

handle :

a gobject.gpointer generated by a specific update_file_info_full call

closure :

a C Closure that must be passed to Nemo.info_provider_update_complete_invoke if that method is called

result :

an optional parameter. If left out, Nemo.OperationResult.COMPLETE is assumed. Otherwise, you may pass any any of the Nemo.OperationResult enums.

An extension must call this method for each update_file_info_full method that returns the Nemo.OperationResult.IN_PROGRESS enum. The method must be called with the provider, handle, and closure parameters which were passed to the earlier update_file_info_full method.

This method was introduced in nemo-python 0.7.0.