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.

nsINavHistoryResultNode

IID:47cf89e3-4777-46bf-9677-21793870ce62
Inherits From:nsISupports

Constants

Identifies the type of this node. This node can then be QI-ed to the corresponding specialized result node interface.
PRUint32 RESULT_TYPE_URI = 0
PRUint32 RESULT_TYPE_VISIT = 1
PRUint32 RESULT_TYPE_FULL_VISIT = 2
PRUint32 RESULT_TYPE_HOST = 3
PRUint32 RESULT_TYPE_DYNAMIC_CONTAINER = 4
PRUint32 RESULT_TYPE_QUERY = 5
PRUint32 RESULT_TYPE_FOLDER = 6
PRUint32 RESULT_TYPE_SEPARATOR = 7
PRUint32 RESULT_TYPE_DAY = 8
PRUint32 RESULT_TYPE_FOLDER_SHORTCUT = 9

Properties

readonly PRUint32 accessCount

Total number of times the URI has ever been accessed. For hosts, this is the total of the children under it, NOT the total times the host has been accessed (this would require an additional query, so is not given by default when most of the time it is never needed).

readonly PRInt32 bookmarkIndex

When this item is in a bookmark folder (parent is of type folder), this is the index into that folder of this node. These indices start at 0 and increase in the order that they appear in the bookmark folder. For items that are not in a bookmark folder, this value is -1.

readonly PRTime dateAdded

If the node is an item (bookmark, folder or a separator) this value is the time that the item was created. For other nodes, this value is 0.

readonly nsIURI icon

This URI can be used as an image source URI and will give you the favicon for the page. It is *not* the URI of the favicon, but rather something that will resolve to the actual image.

In most cases, this is an annotation URI that will query the favicon service. If the entry has no favicon, this is the chrome URI of the default favicon. If the favicon originally lived in chrome, this will be the original chrome URI of the icon.

readonly PRInt32 indentLevel

This is the number of levels between this node and the top of the hierarchy. The members of result.children have indentLevel = 0, their children have indentLevel = 1, etc. The indent level of the root node is set to -1.

readonly PRInt64 itemId

If the node is an item (bookmark, folder or a separator) this value is the row ID of that bookmark in the database. For other nodes, this value is set to -1.

readonly PRTime lastModified

If the node is an item (bookmark, folder or a separator) this value is the time that the item was last modified. For other nodes, this value is 0.

readonly nsINavHistoryContainerResultNode parent

Indentifies the parent result node in the result set. This is null for top level nodes.

readonly nsINavHistoryResult parentResult

The history-result to which this node belongs.

readonly nsIWritablePropertyBag propertyBag

You can use this to associate temporary information with the result node. This property bag is associated with the result node and is not persisted in any way.

readonly AString tags

For uri nodes, this is a sorted list of the tags, delimited with commans, for the uri represented by this node. Otherwise this is an empty string.

readonly PRTime time

This is the time the user accessed the page.

If this is a visit, it is the exact time that the page visit occurred.

If this is a URI, it is the most recent time that the URI was visited. Even if you ask for all URIs for a given date range long ago, this might contain today's date if the URI was visited today.

For hosts, or other node types with children, this is the most recent access time for any of the children.

For days, this is midnight on the morning of the day in question in UTC time.

readonly AUTF8String title

Title of the web page, or of the node's grouping (day, host, folder, etc)

readonly PRUint32 type

readonly AUTF8String uri

URI of the resource in question. For visits and URLs, this is the URL of the page. For folders and queries, this is the place: URI of the corresponding folder or query. This may be empty for other types of objects like host containers.

PRInt32 viewIndex

Value with undefined meaning for use by the view. Its initial value will be -1. The result implementation treats nodes with this property set to -1 as invisible!

View-implementations may use this value to track the node index in the view, e.g. the tree view uses this value to indicate the row in the tree that this node is at. Other views may choose not to use this, but should inititalize this value to anything but -1 for visible nodes.


References

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

nsINavHistoryResultTreeViewer.treeIndexForNode, nsINavHistoryResultViewer.itemChanged, nsINavHistoryResultViewer.itemInserted, nsINavHistoryResultViewer.itemMoved, nsINavHistoryResultViewer.itemRemoved, nsINavHistoryResultViewer.itemReplaced

This interface is returned from the following methods:

nsINavHistoryContainerResultNode.appendURINode, nsINavHistoryContainerResultNode.getChild, nsINavHistoryResultTreeViewer.nodeForTreeIndex

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com