nsINavHistoryResultNode Interface Reference
import "nsINavHistoryService.idl";
Inherited by nsINavHistoryContainerResultNode, and nsINavHistoryVisitResultNode.
Public Attributes | |
| readonly attribute nsINavHistoryContainerResultNode | parent |
| readonly attribute nsINavHistoryResult | parentResult |
| readonly attribute AUTF8String | uri |
| const unsigned long | RESULT_TYPE_URI = 0 |
| const unsigned long | RESULT_TYPE_VISIT = 1 |
| const unsigned long | RESULT_TYPE_FULL_VISIT = 2 |
| const unsigned long | RESULT_TYPE_DYNAMIC_CONTAINER = 4 |
| const unsigned long | RESULT_TYPE_QUERY = 5 |
| const unsigned long | RESULT_TYPE_FOLDER = 6 |
| const unsigned long | RESULT_TYPE_SEPARATOR = 7 |
| const unsigned long | RESULT_TYPE_FOLDER_SHORTCUT = 9 |
| readonly attribute unsigned long | type |
| readonly attribute AUTF8String | title |
| readonly attribute unsigned long | accessCount |
| readonly attribute PRTime | time |
| readonly attribute nsIURI | icon |
| readonly attribute long | indentLevel |
| attribute long | viewIndex |
| readonly attribute nsIWritablePropertyBag | propertyBag |
| readonly attribute long | bookmarkIndex |
| readonly attribute long long | itemId |
| readonly attribute PRTime | dateAdded |
| readonly attribute PRTime | lastModified |
| readonly attribute AString | tags |
Detailed Description
Definition at line 60 of file nsINavHistoryService.idl.
Member Data Documentation
| readonly attribute unsigned long nsINavHistoryResultNode::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).
Definition at line 106 of file nsINavHistoryService.idl.
| readonly attribute long nsINavHistoryResultNode::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.
Definition at line 170 of file nsINavHistoryService.idl.
| readonly attribute PRTime nsINavHistoryResultNode::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.
Definition at line 183 of file nsINavHistoryService.idl.
| readonly attribute nsIURI nsINavHistoryResultNode::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.
Definition at line 135 of file nsINavHistoryService.idl.
| readonly attribute long nsINavHistoryResultNode::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.
Definition at line 143 of file nsINavHistoryService.idl.
| readonly attribute long long nsINavHistoryResultNode::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.
Definition at line 177 of file nsINavHistoryService.idl.
| readonly attribute PRTime nsINavHistoryResultNode::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.
Definition at line 189 of file nsINavHistoryService.idl.
| readonly attribute nsINavHistoryContainerResultNode nsINavHistoryResultNode::parent |
Indentifies the parent result node in the result set. This is null for top level nodes.
Definition at line 66 of file nsINavHistoryService.idl.
| readonly attribute nsINavHistoryResult nsINavHistoryResultNode::parentResult |
The history-result to which this node belongs.
Definition at line 71 of file nsINavHistoryService.idl.
| readonly attribute nsIWritablePropertyBag nsINavHistoryResultNode::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.
Definition at line 162 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_DYNAMIC_CONTAINER = 4 |
Definition at line 88 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_FOLDER = 6 |
Definition at line 90 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_FOLDER_SHORTCUT = 9 |
Definition at line 92 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_FULL_VISIT = 2 |
Definition at line 87 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_QUERY = 5 |
Definition at line 89 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_SEPARATOR = 7 |
Definition at line 91 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_URI = 0 |
Identifies the type of this node. This node can then be QI-ed to the corresponding specialized result node interface.
Definition at line 85 of file nsINavHistoryService.idl.
| const unsigned long nsINavHistoryResultNode::RESULT_TYPE_VISIT = 1 |
Definition at line 86 of file nsINavHistoryService.idl.
| readonly attribute AString nsINavHistoryResultNode::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.
Definition at line 195 of file nsINavHistoryService.idl.
| readonly attribute PRTime nsINavHistoryResultNode::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 queries this is the respective endTime - a maximum possible visit time to fit in the day range.
Definition at line 123 of file nsINavHistoryService.idl.
| readonly attribute AUTF8String nsINavHistoryResultNode::title |
Title of the web page, or of the node's query (day, host, folder, etc)
Definition at line 98 of file nsINavHistoryService.idl.
| readonly attribute unsigned long nsINavHistoryResultNode::type |
Definition at line 93 of file nsINavHistoryService.idl.
| readonly attribute AUTF8String nsINavHistoryResultNode::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.
Definition at line 79 of file nsINavHistoryService.idl.
| attribute long nsINavHistoryResultNode::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.
Definition at line 155 of file nsINavHistoryService.idl.
The documentation for this interface was generated from the following file:
- /Users/dietrich/moz/trunk/mozilla/toolkit/components/places/public/nsINavHistoryService.idl
