Public Member Functions

nsIDynamicContainer Interface Reference

The dynamic container interface provides a base class for services that want to provide containers for temporary contents. More...

import "nsIDynamicContainer.idl";

List of all members.

Public Member Functions

void onContainerNodeOpening (in nsINavHistoryContainerResultNode aContainer, in nsINavHistoryQueryOptions aOptions)
 Called when the given container node is about to be populated so that the service can populate the container if necessary.
void onContainerNodeClosed (in nsINavHistoryContainerResultNode aContainer)
 Called when the given container has just been collapsed so that the service can do any necessary cleanup.
void onContainerRemoving (in long long aItemId)
 Called when the given container is about to be deleted from the bookmarks table, so that the service can do any necessary cleanup.
void onContainerMoved (in long long aItemId, in long long aNewParent, in long aNewIndex)
 Called when the given container has just been moved, in case the service needs to do any bookkeeping.

Detailed Description

The dynamic container interface provides a base class for services that want to provide containers for temporary contents.

The service can fill result nodes directly into the container when it is being opened. It can use the property bag on every result node to store data associated with each item, such as full path on disk. It would create additional containers for each container, registered to its service.

See also createDynamicContainer in nsINavBookmarksService.


Member Function Documentation

void nsIDynamicContainer::onContainerMoved ( in long long  aItemId,
in long long  aNewParent,
in long  aNewIndex 
)

Called when the given container has just been moved, in case the service needs to do any bookkeeping.

Called AFTER the container has been moved.

Parameters:
aItemId The item-id of the container item.
aNewParent The item of the new parent folder for the container.
aNewIndex The index the container will be inserted at, or -1 for append.
void nsIDynamicContainer::onContainerNodeClosed ( in nsINavHistoryContainerResultNode  aContainer  ) 

Called when the given container has just been collapsed so that the service can do any necessary cleanup.

This is NOT guaranteed to get called. In particular, if the query just goes away, you will not get this call. This only happens when the container itself goes from the open state to the closed state. A service with large numbers of dynamically populated items might use this to do some cleanup so those items don't hang around

Parameters:
aContainer The container node of the container being closed. The service need not worry about removing any created nodes, they will be automatically removed when this call completes.
void nsIDynamicContainer::onContainerNodeOpening ( in nsINavHistoryContainerResultNode  aContainer,
in nsINavHistoryQueryOptions  aOptions 
)

Called when the given container node is about to be populated so that the service can populate the container if necessary.

Parameters:
aContainer The container node for the container being opened. Note that all result nodes implement a property bag if you need to store state.
aOptions The options used to generate this query. Containers should follow these when possible, for example, whether to expand queries, etc. Implementations should use this when possible if adding query and folder nodes to the container. DO NOT MODIFY THIS VALUE.
void nsIDynamicContainer::onContainerRemoving ( in long long  aItemId  ) 

Called when the given container is about to be deleted from the bookmarks table, so that the service can do any necessary cleanup.

Called BEFORE the container is deleted, so that the service can still reference it.

Parameters:
aItemId The item-id of the container item.

The documentation for this interface was generated from the following file: