<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[166755] trunk/Source/WebKit2</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/166755">166755</a></dd>
<dt>Author</dt> <dd>andersca@apple.com</dd>
<dt>Date</dt> <dd>2014-04-03 16:55:31 -0700 (Thu, 03 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add WKWebView documentation
https://bugs.webkit.org/show_bug.cgi?id=131190
Reviewed by Sam Weinig.
* UIProcess/API/Cocoa/WKBackForwardListItem.h:
* UIProcess/API/Cocoa/WKNavigationAction.h:
* UIProcess/API/Cocoa/WKWebView.h:</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListItemh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKNavigationActionh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (166754 => 166755)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2014-04-03 23:51:47 UTC (rev 166754)
+++ trunk/Source/WebKit2/ChangeLog 2014-04-03 23:55:31 UTC (rev 166755)
</span><span class="lines">@@ -1,3 +1,14 @@
</span><ins>+2014-04-03 Anders Carlsson <andersca@apple.com>
+
+ Add WKWebView documentation
+ https://bugs.webkit.org/show_bug.cgi?id=131190
+
+ Reviewed by Sam Weinig.
+
+ * UIProcess/API/Cocoa/WKBackForwardListItem.h:
+ * UIProcess/API/Cocoa/WKNavigationAction.h:
+ * UIProcess/API/Cocoa/WKWebView.h:
+
</ins><span class="cx"> 2014-04-03 Michael Saboff <msaboff@apple.com>
</span><span class="cx">
</span><span class="cx"> REGRESSION: PCE.js is 20x slower in WebKit2 because timers are throttled
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListItemh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h (166754 => 166755)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-04-03 23:51:47 UTC (rev 166754)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-04-03 23:55:31 UTC (rev 166755)
</span><span class="lines">@@ -29,7 +29,7 @@
</span><span class="cx">
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back forward list.
</del><ins>+/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back-forward list.
</ins><span class="cx"> */
</span><span class="cx"> WK_API_CLASS
</span><span class="cx"> @interface WKBackForwardListItem : NSObject
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKNavigationActionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h (166754 => 166755)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h 2014-04-03 23:51:47 UTC (rev 166754)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h 2014-04-03 23:55:31 UTC (rev 166755)
</span><span class="lines">@@ -34,7 +34,7 @@
</span><span class="cx"> @abstract the type of action that triggered a possible navigation.
</span><span class="cx"> @constant WKNavigationTypeLinkActivated A link with an href activated by the user.
</span><span class="cx"> @constant WKNavigationTypeFormSubmitted A form was submitted.
</span><del>- @constant WKNavigationTypeBackForward The user requested an item from the back forward list.
</del><ins>+ @constant WKNavigationTypeBackForward The user requested an item from the back-forward list.
</ins><span class="cx"> @constant WKNavigationTypeReload The user reloaded a page.
</span><span class="cx"> @constant WKNavigationTypeFormResubmitted A form as resubmitted (for example by going back, forward or reloading).
</span><span class="cx"> @constant WKNavigationTypeOther Navigation is taking place for some other reason.
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h (166754 => 166755)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2014-04-03 23:51:47 UTC (rev 166754)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2014-04-03 23:55:31 UTC (rev 166755)
</span><span class="lines">@@ -58,8 +58,10 @@
</span><span class="cx"> /*! @abstract A copy of the configuration with which the @link WKWebView @/link was initialized. */
</span><span class="cx"> @property (nonatomic, readonly) WKWebViewConfiguration *configuration;
</span><span class="cx">
</span><ins>+/*! @abstract The view's navigation delegate. */
</ins><span class="cx"> @property (nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
</span><span class="cx">
</span><ins>+/*! @abstract The view's user interface delegate. */
</ins><span class="cx"> @property (nonatomic, weak) id <WKUIDelegate> UIDelegate;
</span><span class="cx">
</span><span class="cx"> /*! @abstract The view's back-forward list. */
</span><span class="lines">@@ -71,7 +73,6 @@
</span><span class="cx"> @result An initialized view, or nil if the object could not be initialized.
</span><span class="cx"> @discussion This is a designated initializer. You can use @link -initWithFrame: @/link to
</span><span class="cx"> initialize an instance with the default configuration.
</span><del>-
</del><span class="cx"> The initializer copies
</span><span class="cx"> @link //apple_ref/doc/methodparam/WKWebView/initWithFrame:configuration:/configuration
</span><span class="cx"> configuration@/link, so mutating it after initialization has no effect on the
</span><span class="lines">@@ -79,16 +80,21 @@
</span><span class="cx"> */
</span><span class="cx"> - (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration WK_DESIGNATED_INITIALIZER;
</span><span class="cx">
</span><ins>+/*! @abstract Navigates to the given NSURLRequest.
+ @param request The NSURLRequest to navigate to.
+ @result A new navigation for the given request.
+ */
</ins><span class="cx"> - (WKNavigation *)loadRequest:(NSURLRequest *)request;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Navigates to an item from the back-forward list and sets it as the current item.
</span><del>- @param item The item to navigate to. Must be one of the items in the receiver's back-forward
- list.
- @result A new navigation to requested item, or nil if it is the current item.
</del><ins>+ @param item The item to navigate to. Must be one of the items in the receiver's back-forward list.
+ @result A new navigation to the requested item, or nil if it is the current item or the item is not part of the view's back-forward list.
</ins><span class="cx"> @seealso backForwardList
</span><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
</span><span class="cx">
</span><ins>+/*! @abstract The page title. @link WKWebView @/link is KVO-compliant for this property.
+ */
</ins><span class="cx"> @property (nonatomic, readonly) NSString *title;
</span><span class="cx">
</span><span class="cx"> /*! @abstract The active URL. @link WKWebView @/link is KVO-compliant for this property.
</span><span class="lines">@@ -100,8 +106,7 @@
</span><span class="cx"> property. */
</span><span class="cx"> @property (nonatomic, readonly, getter=isLoading) BOOL loading;
</span><span class="cx">
</span><del>-/*!
- @abstract An estimate of the fraction complete for a document load. @link WKWebView @/link is
</del><ins>+/*! @abstract An estimate of the fraction complete for a document load. @link WKWebView @/link is
</ins><span class="cx"> KVO-compliant for this property.
</span><span class="cx"> @discussion This value will range from 0 to 1 and, once a load completes, will remain at 1.0
</span><span class="cx"> until a new load starts, at which point it will be reset to 0. The value is an estimate based
</span><span class="lines">@@ -110,28 +115,71 @@
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) double estimatedProgress;
</span><span class="cx">
</span><ins>+/*! @abstract Whether all of the resources on the page have been loaded over securely encrypted connections.
+ @link WKWebView @/link is KVO-compliant for this property.
+ */
</ins><span class="cx"> @property (nonatomic, readonly) BOOL hasOnlySecureContent;
</span><span class="cx">
</span><ins>+/*! @abstract Whether there's a back item in the back-forward list that can be navigated to.
+ @seealso backForwardList.
+ */
</ins><span class="cx"> @property (readonly) BOOL canGoBack;
</span><ins>+
+/*! @abstract Whether there's a forward item in the back-forward list that can be navigated to.
+ @seealso backForwardList.
+ */
</ins><span class="cx"> @property (readonly) BOOL canGoForward;
</span><span class="cx">
</span><ins>+/*! @abstract Navigates to the back item in the back-forward list.
+ @result A new navigation to the requested item, or nil if there is no back item in the back-forward list.
+ */
</ins><span class="cx"> - (WKNavigation *)goBack;
</span><ins>+
+/*! @abstract Navigates to the forward item in the back-forward list.
+ @result A new navigation to the requested item, or nil if there is no forward item in the back-forward list.
+ */
</ins><span class="cx"> - (WKNavigation *)goForward;
</span><span class="cx">
</span><ins>+/*! @abstract Reloads the current page.
+ @result A new navigation representing the reload.
+ */
</ins><span class="cx"> - (WKNavigation *)reload;
</span><ins>+
+/*! @abstract Reloads the current page, performing end-to-end revalidation using cache-validating conditionals if possible.
+ @result A new navigation representing the reload.
+ */
</ins><span class="cx"> - (WKNavigation *)reloadFromOrigin;
</span><span class="cx">
</span><ins>+/*! @abstract Stops loading all resources on the current page.
+ */
</ins><span class="cx"> - (void)stopLoading;
</span><span class="cx">
</span><ins>+/*! @abstract Whether horizontal swipe gestures will trigger back-forward list navigations.
+ */
</ins><span class="cx"> @property (nonatomic) BOOL allowsBackForwardNavigationGestures;
</span><span class="cx">
</span><span class="cx"> #if TARGET_OS_IPHONE
</span><ins>+/*! @abstract The scroll view associated with the web view.
+ */
</ins><span class="cx"> @property (nonatomic, readonly) UIScrollView *scrollView;
</span><del>-#else
</del><ins>+#endif
+
+#if !TARGET_OS_IPHONE
+/* @abstract Whether magnify gestures will change the WKWebView magnification.
+ @discussion It is possible to set the magnification property even if allowsMagnify is set to NO.
+ */
</ins><span class="cx"> @property (nonatomic) BOOL allowsMagnification;
</span><ins>+
+/* @abstract The amount by which the page content is currently scaled. The default value is 1.0.
+ */
</ins><span class="cx"> @property (nonatomic) CGFloat magnification;
</span><span class="cx">
</span><ins>+/* @abstract Magnify the page content by the given amount and center the result on the given point.
+ * @param magnification The amount by which to magnify the content.
+ * @param point The point (in view space) on which to center magnification.
+ */
</ins><span class="cx"> - (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;
</span><ins>+
</ins><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> @end
</span><span class="lines">@@ -140,12 +188,30 @@
</span><span class="cx">
</span><span class="cx"> @interface WKWebView (WKIBActions) <NSUserInterfaceValidations>
</span><span class="cx">
</span><ins>+/*! @abstract Action method that navigates to the back item in the back-forward list.
+ @param sender The object that sent this message.
+ */
</ins><span class="cx"> - (IBAction)goBack:(id)sender;
</span><ins>+
+/*! @abstract Action method that navigates to the forward item in the back-forward list.
+ @param sender The object that sent this message.
+ */
</ins><span class="cx"> - (IBAction)goForward:(id)sender;
</span><span class="cx">
</span><ins>+/*! @abstract Action method that reloads the current page.
+ @param sender The object that sent this message.
+ */
</ins><span class="cx"> - (IBAction)reload:(id)sender;
</span><ins>+
+/*! @abstract Action method that reloads the current page, performing end-to-end revalidation using
+ cache-validating conditionals if possible.
+ @param sender The object that sent this message.
+ */
</ins><span class="cx"> - (IBAction)reloadFromOrigin:(id)sender;
</span><span class="cx">
</span><ins>+/*! @abstract Action method that stops loading all resources on the current page.
+ @param sender The object that sent this message.
+ */
</ins><span class="cx"> - (IBAction)stopLoading:(id)sender;
</span><span class="cx">
</span><span class="cx"> @end
</span></span></pre>
</div>
</div>
</body>
</html>