TreeFolderBrowserModel#

class omni.kit.browser.sample.model.TreeFolderBrowserModel(*args, **kwargs)#

Bases: FolderBrowserModel

Methods

`__init__`(self)	Constructs AbstractItemModel.
`folder_changed`(item)	Notify folder or file changed.
`get_category_items`(item)	Create category item for every root folder.
`get_collection_items`()	Override to get list of collection items
`get_detail_items`(item)	Override to get list of detail items
`process_root_folder`(root_folder[, sync])	Process a root folder name and url and add it to the list of root folders.
`remove_collection`(item)	Remove a collection item.

Attributes

__init__( self: omni.ui._ui.AbstractItemModel, ) → None#

Constructs AbstractItemModel.

`kwargsdict`
See below

### Keyword Arguments:

folder_changed( item: AbstractBrowserFolder | BrowserFile | None, ) → None#: Notify folder or file changed. :param item: Changed folder or file object. :type item: Union[AbstractBrowserFolder, BrowserFile]

get_category_items( item: FolderCollectionItem, ) → List[FolderCategoryItem]#: Create category item for every root folder. Also create category items for sub folders as children of parent category item. Summary category item will be created if required.

get_collection_items() → List[FolderCollectionItem]#: Override to get list of collection items

get_detail_items( item: CategoryItem, ) → List[FileDetailItem]#: Override to get list of detail items

process_root_folder( root_folder: str, sync: bool = True, ) → FileSystemFolder | None#

Process a root folder name and url and add it to the list of root folders.

Parameters:: root_folder – Name of root folder with optional prepended collection name.

remove_collection( item: FolderCollectionItem, ) → bool#

Remove a collection item.