Package mrv :: Package maya :: Package ui :: Package browse :: Module control :: Class FileProvider
[hide private]
[frames] | no frames]

Class FileProvider

source code

           object --+        
                    |        
  interface.Interface --+    
                        |    
interface.iFinderProvider --+
                            |
                           FileProvider

Implements a provider for a file system
Instance Methods [hide private]
 
__init__(self, root)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code

Inherited from interface.Interface: supports

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

    Interface
 
formatItem(self, url_base, url_index, url_item)
Given the url_item, as well as additional information such as its base and its index inside of the url, this method encodes the item for presentation in the user interface.
source code
 
urlItems(self, url)
Return directory items alphabetically, directories first
source code

Inherited from interface.iFinderProvider: root, storeUrlItem, storedUrlItemByIndex

Class Variables [hide private]
    Configuration

Inherited from interface.iFinderProvider: memorize_urlItems

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, root)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

formatItem(self, url_base, url_index, url_item)

source code 
Given the url_item, as well as additional information such as its base
and its index inside of the url, this method encodes the item for presentation
in the user interface.
:param url_base: relative url at which the url_item resides. Is "" if url_index 
        is 0
:param url_index: index representing the position of the url_item within the
        url
:param url_item: item which is to be formatted.
:return: string representing the formatted url.

Overrides: interface.iFinderProvider.formatItem
(inherited documentation)

urlItems(self, url)

source code 
Return directory items alphabetically, directories first
Overrides: interface.iFinderProvider.urlItems