Represents a view's navigation history More...
Import Statement: | import com.canonical.Oxide 1.15 |
Instantiates: | OxideQQuickNavigationHistory |
NavigationHistory represents a view's navigation history. It provides lists of NavigationItems via backItems, forwardItems and items, which provide details about individual history entries. It's also possible to navigate to entries in the navigation history by calling goBack, goForward or goToOffset, or by manipulating the currentItem or currentItemIndex properties directly.
NavigationHistory is also a list model, although this functionality is deprecated and should not be used in newly written code.
backItems : list<NavigationItem> |
This is the list of navigation items preceding the currentItem. The order is such that the next item to be navigated to by calling goBack is the first item in the list.
Any items in the list referenced by the QML engine will be kept alive until they go out of scope.
The notify signal for this property will be emitted whenever the list changes. When this happens, items that are removed but still referenced by the QML engine will become stale (they are still valid objects, but can't be used to initiate a history navigation by setting currentItem). Properties of items that persist between changes may also be updated.
Note: The notify signal for this is changed
This QML property was introduced in OxideQt 1.19.
This property will be true if the application can navigate to the previous NavigationItem by calling goBack, otherwise it will be false.
Note: The notify signal for this is changed.
This QML property was introduced in OxideQt 1.19.
This property will be true if the application can navigate to the next NavigationItem by calling goForward, otherwise it will be false.
Note: The notify signal for this is changed.
This QML property was introduced in OxideQt 1.19.
currentItem : NavigationItem |
This is the current navigation item. If there is a browser-initiated history navigation in progress, this item will be the pending navigation item. Otherwise it will be the current committed navigation item, or null if no navigation has committed yet in this view.
The item will be kept alive as long as it is referenced by the QML engine.
Setting this property to another valid NavigationItem will initiate a history navigation to that item.
Note: The notify signal for this is changed.
This QML property was introduced in OxideQt 1.19.
This is the index of the current NavigationItem (currentItem) within the complete list of items (items).
Setting this property to a new index will initiate a history navigation to the NavigationItem at that index.
Note: The notify signal for this is changed.
This QML property was introduced in OxideQt 1.19.
forwardItems : list<NavigationItem> |
This is the list of navigation items following the currentItem.
Any items in the list referenced by the QML engine will be kept alive until they go out of scope.
The notify signal for this property will be emitted whenever the list changes. When this happens, items that are removed but still referenced by the QML engine will become stale (they are still valid objects, but can't be used to initiate a history navigation by setting currentItem). Properties of items that persist between changes may also be updated.
Note: The notify signal for this is changed
This QML property was introduced in OxideQt 1.19.
items : list<NavigationItem> |
This is the complete list of navigation items, including the currentItem.
Any items in the list referenced by the QML engine will be kept alive until they go out of scope.
The notify signal for this property will be emitted whenever the list changes. When this happens, items that are removed but still referenced by the QML engine will become stale (they are still valid objects, but can't be used to initiate a history navigation by setting currentItem). Properties of items that persist between changes may also be updated.
Note: The notify signal for this is changed
This QML property was introduced in OxideQt 1.19.
This signal is emitted whenever the navigation history changes. This can happen multiple times during a single navigation.
This QML signal was introduced in OxideQt 1.19.
Navigate to the previous NavigationItem. If there isn't one (canGoBack is false), then calling this function will do nothing.
This QML method was introduced in OxideQt 1.19.
Navigate to the next NavigationItem. If there isn't one (canGoForward is false), then calling this function will do nothing.
This QML method was introduced in OxideQt 1.19.
Navigate to the NavigationItem at the specified offset from currentItemIndex. Setting this to a negative number will navigate backwards through history.
This will do nothing if there is no NavigationItem at the specified offset.
This QML method was introduced in OxideQt 1.19.