nsINavHistoryResultTreeViewer Interface Reference
import "nsINavHistoryService.idl";
Inherits nsINavHistoryResultViewer.
Public Member Functions | |
| nsINavHistoryResultNode | nodeForTreeIndex (in unsigned long aIndex) |
| unsigned long | treeIndexForNode (in nsINavHistoryResultNode aNode) |
Public Attributes | |
| const unsigned long | INDEX_INVISIBLE = 0xffffffff |
Detailed Description
A predefined view adaptor for interfacing results with an nsITree. This object will remove itself from its associated result when the tree has been detached. This prevents circular references. Users should be aware of this, if you want to re-use the same viewer, you will need to keep your own reference to it and re-initialize it when the tree changes. If you use this object, attach it to a result, never attach it to a tree, and forget about it, it will leak!Definition at line 544 of file nsINavHistoryService.idl.
Member Function Documentation
| nsINavHistoryResultNode nsINavHistoryResultTreeViewer::nodeForTreeIndex | ( | in unsigned long | aIndex | ) |
This allows you to get at the real node for a given row index. This is only valid when a tree is attached.
| unsigned long nsINavHistoryResultTreeViewer::treeIndexForNode | ( | in nsINavHistoryResultNode | aNode | ) |
Member Data Documentation
| const unsigned long nsINavHistoryResultTreeViewer::INDEX_INVISIBLE = 0xffffffff |
Reverse of nodeForFlatIndex, returns the row index for a given result node. Returns INDEX_INVISIBLE if the item is not visible (for example, its parent is collapsed). This is only valid when a tree is attached. The the result will always be INDEX_INVISIBLE if not.
Note: This sounds sort of obvious, but it got me: aNode must be a node retrieved from the same result that this viewer is for. If you execute another query and get a node from a _different_ result, this function will always return the index of that node in the tree that is attached to that result.
Definition at line 564 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
