Unreviewed, fix iOS build with recent SDKs.
[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 #import <WebKit/WKBackForwardListItem.h>
29
30 /*! @abstract A WKBackForwardList object is a list of webpages previously
31  visited in a web view that can be reached by going back or forward.
32  */
33 NS_ASSUME_NONNULL_BEGIN
34
35 WK_CLASS_AVAILABLE(macos(10.10), ios(8.0))
36 @interface WKBackForwardList : NSObject
37
38 /*! @abstract The current item.
39  */
40 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *currentItem;
41
42 /*! @abstract The item immediately preceding the current item, or nil
43 if there isn't one.
44  */
45 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *backItem;
46
47 /*! @abstract The item immediately following the current item, or nil
48 if there isn't one.
49  */
50 @property (nullable, nonatomic, readonly, strong) WKBackForwardListItem *forwardItem;
51
52 /*! @abstract Returns the item at a specified distance from the current
53  item.
54  @param index Index of the desired list item relative to the current item:
55  0 for the current item, -1 for the immediately preceding item, 1 for the
56  immediately following item, and so on.
57  @result The item at the specified distance from the current item, or nil
58  if the index parameter exceeds the limits of the list.
59  */
60 - (nullable WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
61
62 /*! @abstract The portion of the list preceding the current item.
63  @discussion The items are in the order in which they were originally
64  visited.
65  */
66 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *backList;
67
68 /*! @abstract The portion of the list following the current item.
69  @discussion The items are in the order in which they were originally
70  visited.
71  */
72 @property (nonatomic, readonly, copy) NSArray<WKBackForwardListItem *> *forwardList;
73
74 @end
75
76 NS_ASSUME_NONNULL_END