Unreviewed, rolling out r240630.
[WebKit-https.git] / Source / WebKit / UIProcess / API / Cocoa / WKBackForwardList.h
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <WebKit/WKFoundation.h>
27
28 #if WK_API_ENABLED
29
30 #import <WebKit/WKBackForwardListItem.h>
31
32 /*! @abstract A WKBackForwardList object is a list of webpages previously
33  visited in a web view that can be reached by going back or forward.
34  */
35 NS_ASSUME_NONNULL_BEGIN
36
37 WK_CLASS_AVAILABLE(macosx(10.10), ios(8.0))
38 @interface WKBackForwardList : NSObject
39
40 /*! @abstract The current item.
41  */
42 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *currentItem;
43
44 /*! @abstract The item immediately preceding the current item, or nil
45 if there isn't one.
46  */
47 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *backItem;
48
49 /*! @abstract The item immediately following the current item, or nil
50 if there isn't one.
51  */
52 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *forwardItem;
53
54 /*! @abstract Returns the item at a specified distance from the current
55  item.
56  @param index Index of the desired list item relative to the current item:
57  0 for the current item, -1 for the immediately preceding item, 1 for the
58  immediately following item, and so on.
59  @result The item at the specified distance from the current item, or nil
60  if the index parameter exceeds the limits of the list.
61  */
62 - (nullable WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
63
64 /*! @abstract The portion of the list preceding the current item.
65  @discussion The items are in the order in which they were originally
66  visited.
67  */
68 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *backList;
69
70 /*! @abstract The portion of the list following the current item.
71  @discussion The items are in the order in which they were originally
72  visited.
73  */
74 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *forwardList;
75
76 @end
77
78 NS_ASSUME_NONNULL_END
79
80 #endif