User Tools

Site Tools


DzAbstractAssetContainer

Properties

Methods

Signals

voidassetIconChanged ( DzAsset asset )
voidassetRenamed ( DzAsset asset, Number index )
voidbeginAssetAdd ( Number start, Number end )
voidbeginAssetRemove ( Number start, Number end )
voidbeginChildContainerAdd ( DzAbstractAssetContainer container, Number start, Number end )
voidbeginChildContainerRemove ( DzAbstractAssetContainer container, Number start, Number end )
voidchildContainerAboutToBeRemoved ( DzAbstractAssetContainer childContainer )
voidchildContainerRemoved ( DzAbstractAssetContainer childContainer )
voidendAssetAdd ()
voidendAssetRemove ()
voidendChildContainerAdd ()
voidendChildContainerRemove ()
voidiconChanged ( DzAbstractAssetContainer container )

Detailed Description

TODO: Add detailed description.

Properties


Boolean : canCopyContainers

Holds whether or not sub-containers can be copied. (Read Only)


Boolean : canDeleteContainer

Holds whether or not this container can be deleted. (Read Only)


Boolean : canInsertSubContainer

Holds whether or not sub-containers can be added to this container. (Read Only)


Boolean : canModifyAssets

Holds whether or not the assets in this container can be modified. (Read Only)


Boolean : canRenameContainer

Holds whether or not this container can be renamed. (Read Only)


Object : id

Holds the id for this container. (Read Only)


Boolean : removeAssetCausesDelete

Holds whether or not removing an asset from this container will result in that asset's file being deleted. (Read Only)

Since:

  • 4.11.0.193

String : tooltip

Holds the tooltip for this container. (Read Only)


Number : useCount

Holds the use count for this container.

Methods


Boolean : clearRebuildableAssets()

Attempts to clear out the assets that can be rebuilt.

Return Value:

  • The current implementation does nothing and always returns false

Boolean : createNewChildContainer( String containerName )

Attempts to create a new child container.

Parameter(s):

  • containerName - The name of the new child container.

Return Value:

  • true if the container was successfully created, otherwise false.

DzAsset : getAsset( Number index )

Parameter(s):

  • index - The index of the asset to be returned.

Return Value:

  • The asset at the specified index (if valid), otherwise null.

Array : getAssets()

Return Value:

  • A list of assets for this container.

DzAbstractAssetContainer : getChildContainer( Number index )

Parameter(s):

  • index - The index of the child container to get.

Return Value:

  • The child container at the given index (if valid), otherwise null.

Array : getChildContainers()

Return Value:

  • A list of child containers for this container.

Size : getChildIconSize()

Return Value:

  • The size of the icon associated with child containers.

String : getContainerName()

Return Value:

  • The name of this container.

Array : getIDPath()

Return Value:

  • The ID path for this container.

Number : getNumAssets()

Return Value:

  • The number of assets associated with this container.

Number : getNumChildContainers()

Return Value:

  • The number of child containers this container has.

DzAbstractAssetContainer : getOwner()

Return Value:

  • The owner of this container.

Size : getSmallChildIconSize()

Return Value:

  • The small icon size of the icon associated with child containers.

String : getSupportFile()

Return Value:

  • The support file for this asset container. Base implementation returns an empty string.

Boolean : hasAsset( DzAsset asset )

Parameter(s):

  • asset - The asset to check for.

Return Value:

  • true if this container has the given asset, otherwise false.

Boolean : hasChildContainers()

Return Value:

  • true if thic container has child containers, otherwise false.

Boolean : ignoreAssetConflicts()

Boolean DzAbstractAssetContainer::ingoreAssetConflicts()

Return Value:

  • true if asset conflicts in this container will be ignored, otherwise false.

Boolean : initChildren()

Initializes this containers child containers.

Return Value:

  • true if the containers were successfully initialized, otherwise false.

Boolean : insertAsset( DzAsset asset )

Attempts to insert the given asset into this container.

Parameter(s):

  • asset - The asset to add to this container.

Return Value:

  • true if the asset was successfully inserted, otherwise false.

Boolean : insertChildContainer( DzAbstractAssetContainer container )

Attempts to insert container as a child of this container.

Parameter(s):

  • container - The container to insert.

Return Value:

  • true if the container was successfully inserted, otherwise false.

Boolean : isFileSystemBased()

Return Value:

  • true if this container is based on a filesystem, otherwise false.

Boolean : moveFromParent( DzAbstractAssetContainer child )

Attempts to move the given container from its parent.

Parameter(s):

  • child - The container to move from its parent.

Return Value:

  • true if the container was successfully moved, otherwise false.

Boolean : removeAsset( DzAsset asset )

Attempts to remove the given asset from this container.

Parameter(s):

  • asset - The asset to remove.

Return Value:

  • true if the asset was successfully removed, otherwise false.

Boolean : removeAssetOnCut( DzAbstractAssetContainer toContainer )

Parameter(s):

  • toContainer - The container to check.

Return Value:

  • true if assets moved to toContainer should be removed from this container, otherwise false.

Boolean : removeChildContainer( DzAbstractAssetContainer container )

Attempts to remove the given container.

Parameter(s):

  • container - The container to remove.

Return Value:

  • true if the container was successfully removed, otherwise false.

Boolean : rename( String name )

Attempts to rename this container.

Parameter(s):

  • name - The new name for this container.

Return Value:

  • true if the rename was successful, otherwise false.

Boolean : renameAsset( DzAsset asset, String newAssetName )

Attempts to rename the given asset.

Parameter(s):

  • asset - The asset to rename.
  • newAssetName - The new name for the asset.

Return Value:

  • true if the asset was successfully renamed, otherwise false.

Boolean : renameChildContainer( DzAbstractAssetContainer container, String name )

Attempts to rename the given child container.

Parameter(s):

  • container - The container to rename.
  • name - The new name for the container.

Return Value:

  • true if the container was successfully renamed, otherwise false.

void : setContainerName( String name )

Sets the name for this container.

Parameter(s):

  • name - The new name for this container.

Boolean : update()

Attemps to update this container.

Return Value:

  • true if the update was successful, otherwise false.

Boolean : updateAssets()

Attempts to update the assets associated with this container.

Return Value:

  • true if the update was successful, otherwise false.

Signals


void : assetIconChanged( DzAsset asset )

Signature:“assetIconChanged(DzAsset*)”

Emitted the icon for an asset has changed.

Parameter(s):

  • asset - The asset that the icon changed for.

void : assetRenamed( DzAsset asset, Number index )

Signature:“assetRenamed(DzAsset*,int)”

Emitted when an asset has been renamed.

Parameter(s):

  • asset - The asset that was renamed.
  • index - The index of the asset that was renamed.

void : beginAssetAdd( Number start, Number end )

Signature:“beginAssetAdd(int,int)”

Emitted before assets are added.

Parameter(s):

  • start - …
  • end - …

void : beginAssetRemove( Number start, Number end )

Signature:“beginAssetRemove(int,int)”

Emitted before assets are removed.

Parameter(s):

  • start - …
  • end - …

void : beginChildContainerAdd( DzAbstractAssetContainer container, Number start, Number end )

Signature:“beginChildContainerAdd(DzAbstractAssetContainer*,int,int)”

Emitted before a child container is added.

Parameter(s):

  • container - The container being added.
  • start - …
  • end - …

void : beginChildContainerRemove( DzAbstractAssetContainer container, Number start, Number end )

Signature:“beginChildContainerRemove(DzAbstractAssetContainer*,int,int)”

Emitted before a child container is removed.

Parameter(s):

  • container - The container being removed.
  • start - …
  • end - …

void : childContainerAboutToBeRemoved( DzAbstractAssetContainer childContainer )

Signature:“childContainerAboutToBeRemoved(DzAbstractAssetContainerPtr)”

Emitted just before a child container is removed.

Parameter(s):

  • container - The child container that will be removed.

void : childContainerRemoved( DzAbstractAssetContainer childContainer )

Signature:“childContainerRemoved(DzAbstractAssetContainerPtr)”

Emitted after a child container has been removed.

Parameter(s):

  • childContainer - The child container that was removed.

void : endAssetAdd()

Signature:“endAssetAdd()”

Emitted after assets have been added.


void : endAssetRemove()

Signature:“endAssetRemove()”

Emitted after assets have been removed.


void : endChildContainerAdd()

Signature:“endChildContainerAdd()”

Emitted after a child container has been added.


void : endChildContainerRemove()

Signature:“endChildContainerRemove()”

Emitted after a child container has been removed.


void : iconChanged( DzAbstractAssetContainer container )

Signature:“iconChanged(DzAbstractAssetContainer*)”

Emitted after the icon for the container has changed.

Parameter(s):

  • container - The container with the icon that changed.