nsINavHistoryResult Interface Reference
import "nsINavHistoryService.idl";
Public Attributes | |
| attribute unsigned short | sortingMode |
| attribute AUTF8String | sortingAnnotation |
| attribute nsINavHistoryResultViewer | viewer |
| readonly attribute nsINavHistoryContainerResultNode | root |
Detailed Description
The result of a history/bookmark query.Use the "root" element to access the children of this query.
The basic design of the system is a model-view-controller. This result object represents the model where the data is stored. External components provide the view and controller which define how the data looks and how interaction happens. [RESULT]----->[viewer]----->[controller] | +-- nsINavHistoryResultViewer
The result indicates to the view when something changes through the nsINavHistoryResultViewer interface. The viewer is set through the nsINavHistoryResult.viewer property.
Definition at line 588 of file nsINavHistoryService.idl.
Member Data Documentation
| readonly attribute nsINavHistoryContainerResultNode nsINavHistoryResult::root |
This is the root of the results. Remember that you need to open all containers for their contents to be valid.
Definition at line 617 of file nsINavHistoryService.idl.
| attribute AUTF8String nsINavHistoryResult::sortingAnnotation |
The annotation to use in SORT_BY_ANNOTATION_* sorting modes, set this before setting the sortingMode attribute.
Definition at line 602 of file nsINavHistoryService.idl.
| attribute unsigned short nsINavHistoryResult::sortingMode |
Sorts all nodes recursively by the given parameter, one of nsINavHistoryQueryOptions.SORT_BY_* This will update the corresponding options for this result, so that re-using the current options/queries will always give you the current view.
Definition at line 596 of file nsINavHistoryService.idl.
The viewer for this result (see comment for the class for how these objects are related). This may be null, in which case you can still manually walk the tree using the root node. When this is non-null, you can access the flattened list of items (flatItemCount, nodeForFlatIndex, flatIndexForNode).
Definition at line 611 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
