import "nsINavHistoryService.idl";
Public Member Functions | |
| nsINavHistoryQueryOptions | clone () |
Public Attributes | |
| const unsigned short | SORT_BY_NONE = 0 |
| const unsigned short | SORT_BY_TITLE_ASCENDING = 1 |
| const unsigned short | SORT_BY_TITLE_DESCENDING = 2 |
| const unsigned short | SORT_BY_DATE_ASCENDING = 3 |
| const unsigned short | SORT_BY_DATE_DESCENDING = 4 |
| const unsigned short | SORT_BY_URI_ASCENDING = 5 |
| const unsigned short | SORT_BY_URI_DESCENDING = 6 |
| const unsigned short | SORT_BY_VISITCOUNT_ASCENDING = 7 |
| const unsigned short | SORT_BY_VISITCOUNT_DESCENDING = 8 |
| const unsigned short | SORT_BY_KEYWORD_ASCENDING = 9 |
| const unsigned short | SORT_BY_KEYWORD_DESCENDING = 10 |
| const unsigned short | SORT_BY_DATEADDED_ASCENDING = 11 |
| const unsigned short | SORT_BY_DATEADDED_DESCENDING = 12 |
| const unsigned short | SORT_BY_LASTMODIFIED_ASCENDING = 13 |
| const unsigned short | SORT_BY_LASTMODIFIED_DESCENDING = 14 |
| const unsigned short | SORT_BY_TAGS_ASCENDING = 17 |
| const unsigned short | SORT_BY_TAGS_DESCENDING = 18 |
| const unsigned short | SORT_BY_ANNOTATION_ASCENDING = 19 |
| const unsigned short | SORT_BY_ANNOTATION_DESCENDING = 20 |
| const unsigned short | RESULTS_AS_URI = 0 |
| const unsigned short | RESULTS_AS_VISIT = 1 |
| const unsigned short | RESULTS_AS_FULL_VISIT = 2 |
| const unsigned short | RESULTS_AS_DATE_QUERY = 3 |
| const unsigned short | RESULTS_AS_SITE_QUERY = 4 |
| const unsigned short | RESULTS_AS_DATE_SITE_QUERY = 5 |
| const unsigned short | RESULTS_AS_TAG_QUERY = 6 |
| const unsigned short | RESULTS_AS_TAG_CONTENTS = 7 |
| attribute unsigned short | sortingMode |
| attribute AUTF8String | sortingAnnotation |
| attribute unsigned short | resultType |
| attribute boolean | excludeItems |
| attribute boolean | excludeQueries |
| attribute boolean | excludeReadOnlyFolders |
| attribute AUTF8String | excludeItemIfParentHasAnnotation |
| attribute boolean | expandQueries |
| attribute boolean | includeHidden |
| attribute boolean | showSessions |
| attribute unsigned long | maxResults |
| const unsigned short | QUERY_TYPE_HISTORY = 0 |
| const unsigned short | QUERY_TYPE_BOOKMARKS = 1 |
| const unsigned short | QUERY_TYPE_UNIFIED = 2 |
| attribute unsigned short | queryType |
Definition at line 869 of file nsINavHistoryService.idl.
| nsINavHistoryQueryOptions nsINavHistoryQueryOptions::clone | ( | ) |
Creates a new options item with the same parameters of this one.
| attribute AUTF8String nsINavHistoryQueryOptions::excludeItemIfParentHasAnnotation |
This option excludes items from a bookmarks query if the parent of the item has this annotation. An example is to exclude livemark items (parent folders have the "livemark/feedURI" annotation) Ignored for queries over history.
Definition at line 1009 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::excludeItems |
This option excludes all URIs and separators from a bookmarks query. This would be used if you just wanted a list of bookmark folders and queries (such as the left pane of the places page). Ignored for queries over history. Defaults to false.
Definition at line 983 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::excludeQueries |
Set to true to exclude queries ("place:" URIs) from the query results. Simple folder queries (bookmark folder symlinks) will still be included. Defaults to false.
Definition at line 990 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::excludeReadOnlyFolders |
Set to true to exclude read-only folders from the query results. This is designed for cases where you want to give the user the option of filing something into a list of folders. It only affects cases where the actual folder result node would appear in its parent folder and filters it out. It doesn't affect the query at all, and doesn't affect more complex queries (such as "folders with annotation X").
Definition at line 1000 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::expandQueries |
When set, allows items with "place:" URIs to appear as containers, with the container's contents filled in from the stored query. If not set, these will appear as normal items. Doesn't do anything if excludeQueries is set. Defaults to false.
Note that this has no effect on folder links, which are place: URIs returned by nsINavBookmarkService.GetFolderURI. These are always expanded and will appear as bookmark folders.
Definition at line 1021 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::includeHidden |
Most items in history are marked "hidden." Only toplevel pages that the user sees in the URL bar are not hidden. Hidden things include the content of iframes and all images on web pages. Normally, you don't want these things. If you do, set this flag and you'll get all items, even hidden ones. Does nothing for bookmark queries. Defaults to false.
Definition at line 1030 of file nsINavHistoryService.idl.
| attribute unsigned long nsINavHistoryQueryOptions::maxResults |
This is the maximum number of results that you want. The query is exeucted, the results are sorted, and then the top 'maxResults' results are taken and returned. Set to 0 (the default) to get all results.
THIS DOES NOT WORK IN CONJUNCTION WITH SORTING BY TITLE. This is because sorting by title requires us to sort after using locale-sensetive sorting (as opposed to letting the database do it for us).
Instead, we get the result ordered by date, pick the maxResult most recent ones, and THEN sort by title.
Definition at line 1050 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS = 1 |
Definition at line 1053 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::QUERY_TYPE_HISTORY = 0 |
Definition at line 1052 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::QUERY_TYPE_UNIFIED = 2 |
Definition at line 1054 of file nsINavHistoryService.idl.
| attribute unsigned short nsINavHistoryQueryOptions::queryType |
The type of search to use when querying the DB; This attribute is only honored by query nodes. It is silently ignored for simple folder queries.
Definition at line 1060 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_DATE_QUERY = 3 |
This returns query nodes for each predefined date range where we had visits. The node contains information how to load its content:
Definition at line 928 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_DATE_SITE_QUERY = 5 |
This returns nsINavHistoryQueryResultNode nodes for each day where we have visits. The node contains information how to load its content:
Definition at line 942 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_FULL_VISIT = 2 |
This is identical to RESULT_TYPE_VISIT except that individual result nodes will have type "FullVisit". This is used for the attributes that are not commonly accessed to save space in the common case (the lists can be very long).
Definition at line 921 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_SITE_QUERY = 4 |
This returns nsINavHistoryQueryResultNode nodes for each site where we have visits. The node contains information how to load its content:
Definition at line 935 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS = 7 |
This is a container with an URI result type that contains the last modified bookmarks for the given tag. Tag folder id must be defined in the query. Setting this resultType will force queryType to QUERY_TYPE_BOOKMARKS.
Definition at line 958 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_TAG_QUERY = 6 |
This returns nsINavHistoryQueryResultNode nodes for each tag. The node contains information how to load its content:
Definition at line 950 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_URI = 0 |
"URI" results, one for each URI visited in the range. Individual result nodes will be of type "URI".
Definition at line 906 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::RESULTS_AS_VISIT = 1 |
"Visit" results, with one for each time a page was visited (this will often give you multiple results for one URI). Individual result nodes will have type "Visit"
Definition at line 913 of file nsINavHistoryService.idl.
| attribute unsigned short nsINavHistoryQueryOptions::resultType |
Sets the result type. One of RESULT_TYPE_* which includes how URIs are represented.
Definition at line 975 of file nsINavHistoryService.idl.
| attribute boolean nsINavHistoryQueryOptions::showSessions |
Separate/group history items based on session information. Only matters when sorting by date.
Definition at line 1036 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_ANNOTATION_ASCENDING = 19 |
Definition at line 898 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_ANNOTATION_DESCENDING = 20 |
Definition at line 899 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_DATE_ASCENDING = 3 |
Definition at line 884 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_DATE_DESCENDING = 4 |
Definition at line 885 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_DATEADDED_ASCENDING = 11 |
Definition at line 892 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_DATEADDED_DESCENDING = 12 |
Definition at line 893 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_KEYWORD_ASCENDING = 9 |
Definition at line 890 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_KEYWORD_DESCENDING = 10 |
Definition at line 891 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_LASTMODIFIED_ASCENDING = 13 |
Definition at line 894 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_LASTMODIFIED_DESCENDING = 14 |
Definition at line 895 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_NONE = 0 |
You can ask for the results to be pre-sorted. Since the DB has indices of many items, it can produce sorted results almost for free. These should be self-explanatory.
Note: re-sorting is slower, as is sorting by title or when you have a host name.
For bookmark items, SORT_BY_NONE means sort by the natural bookmark order.
Definition at line 881 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_TAGS_ASCENDING = 17 |
Definition at line 896 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_TAGS_DESCENDING = 18 |
Definition at line 897 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_TITLE_ASCENDING = 1 |
Definition at line 882 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_TITLE_DESCENDING = 2 |
Definition at line 883 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_URI_ASCENDING = 5 |
Definition at line 886 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_URI_DESCENDING = 6 |
Definition at line 887 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_VISITCOUNT_ASCENDING = 7 |
Definition at line 888 of file nsINavHistoryService.idl.
| const unsigned short nsINavHistoryQueryOptions::SORT_BY_VISITCOUNT_DESCENDING = 8 |
Definition at line 889 of file nsINavHistoryService.idl.
| attribute AUTF8String nsINavHistoryQueryOptions::sortingAnnotation |
The annotation to use in SORT_BY_ANNOTATION_* sorting modes.
Definition at line 969 of file nsINavHistoryService.idl.
| attribute unsigned short nsINavHistoryQueryOptions::sortingMode |
The sorting mode to be used for this query. mode is one of SORT_BY_*
Definition at line 964 of file nsINavHistoryService.idl.
1.5.8