WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsINavHistoryContainerResultNode

IID:f9c8e1c1-e701-44ad-893c-8504c3956929
Inherits From:nsINavHistoryResultNode

Properties

readonly PRUint32 childCount

This gives you the children of the nodes. It is preferrable to use this interface over the array one, since it avoids creating an nsIArray object and the interface is already the correct type.

readonly PRBool childrenReadOnly

Returns false if this node's list of children can be modified (adding or removing children, or reordering children), or true if the UI should not allow the list of children to be modified. This is false for bookmark folder nodes unless setFolderReadOnly() has been called to override it, and true for non-folder nodes.

PRBool containerOpen

Set this to allow descent into the container. When closed, attempting to call getChildren or childCount will result in an error. You should set this to false when you are done reading.

For HOST and DAY groupings, doing this is free since the children have been precomputed. For queries and bookmark folders, being open means they will keep themselves up-to-date by listening for updates and re-querying as needed.

readonly AUTF8String dynamicContainerType

This is a string representing the dynamic container API service that is responsible for this container. This throws if if the node is not a dynamic container.

readonly PRBool hasChildren

This indicates whether this node "may" have children, and can be used when the container is open or closed. When the container is closed, it will give you an exact answer if the node can easily be populated (for example, a bookmark folder). If not (for example, a complex history query), it will return true. When the container is open, it will always be accurate. It is intended to be used to see if we should draw the "+" next to a tree item.


Methods

nsINavHistoryContainerResultNode appendFolderNode ( PRInt64 folderId ) nsINavHistoryResultNode appendURINode ( AUTF8String URI , AUTF8String title , PRUint32 accessCount , PRTime time , AUTF8String iconURI ) nsINavHistoryResultNode getChild ( PRUint32 index )

nsINavHistoryContainerResultNode appendFolderNode ( PRInt64 folderId )

Appends a bookmark folder node to this container and returns it. For the dynamic container API. TO BE CALLED FROM nsIDynamicContainer::OnContainerOpening() ONLY, and only for non-bookmark-folder containers.

All container attributes will come from the boomkarks service for this folder.

Arguments:
folderId

nsINavHistoryResultNode appendURINode ( AUTF8String URI , AUTF8String title , PRUint32 accessCount , PRTime time , AUTF8String iconURI )

Appends a full visit node to this container and returns it. For the dynamic container API. TO BE CALLED FROM nsIDynamicContainer::OnContainerOpening() ONLY, and only for non-bookmark-folder containers.

Arguments:
URI
title
accessCount
time
iconURI

nsINavHistoryResultNode getChild ( PRUint32 index )

Arguments:
index

References

This interface is the type of the following properties:

nsINavHistoryResult.root, nsINavHistoryResultNode.parent

This interface is passed as an argument to the following methods:

nsIDynamicContainer.onContainerNodeClosed, nsIDynamicContainer.onContainerNodeOpening, nsINavHistoryResultViewer.containerClosed, nsINavHistoryResultViewer.containerOpened, nsINavHistoryResultViewer.invalidateContainer, nsINavHistoryResultViewer.itemInserted, nsINavHistoryResultViewer.itemMoved, nsINavHistoryResultViewer.itemRemoved, nsINavHistoryResultViewer.itemReplaced

This interface is returned from the following methods:

nsINavHistoryContainerResultNode.appendFolderNode

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com