Modified: trunk/Source/WebKit2/ChangeLog (166754 => 166755)
--- 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)
@@ -1,3 +1,14 @@
+2014-04-03 Anders Carlsson <[email protected]>
+
+ 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:
+
2014-04-03 Michael Saboff <[email protected]>
REGRESSION: PCE.js is 20x slower in WebKit2 because timers are throttled
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h (166754 => 166755)
--- 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)
@@ -29,7 +29,7 @@
#import <Foundation/Foundation.h>
-/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back forward list.
+/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back-forward list.
*/
WK_API_CLASS
@interface WKBackForwardListItem : NSObject
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h (166754 => 166755)
--- 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)
@@ -34,7 +34,7 @@
@abstract the type of action that triggered a possible navigation.
@constant WKNavigationTypeLinkActivated A link with an href activated by the user.
@constant WKNavigationTypeFormSubmitted A form was submitted.
- @constant WKNavigationTypeBackForward The user requested an item from the back forward list.
+ @constant WKNavigationTypeBackForward The user requested an item from the back-forward list.
@constant WKNavigationTypeReload The user reloaded a page.
@constant WKNavigationTypeFormResubmitted A form as resubmitted (for example by going back, forward or reloading).
@constant WKNavigationTypeOther Navigation is taking place for some other reason.
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h (166754 => 166755)
--- 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)
@@ -58,8 +58,10 @@
/*! @abstract A copy of the configuration with which the @link WKWebView @/link was initialized. */
@property (nonatomic, readonly) WKWebViewConfiguration *configuration;
+/*! @abstract The view's navigation delegate. */
@property (nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
+/*! @abstract The view's user interface delegate. */
@property (nonatomic, weak) id <WKUIDelegate> UIDelegate;
/*! @abstract The view's back-forward list. */
@@ -71,7 +73,6 @@
@result An initialized view, or nil if the object could not be initialized.
@discussion This is a designated initializer. You can use @link -initWithFrame: @/link to
initialize an instance with the default configuration.
-
The initializer copies
@link //apple_ref/doc/methodparam/WKWebView/initWithFrame:configuration:/configuration
configuration@/link, so mutating it after initialization has no effect on the
@@ -79,16 +80,21 @@
*/
- (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration WK_DESIGNATED_INITIALIZER;
+/*! @abstract Navigates to the given NSURLRequest.
+ @param request The NSURLRequest to navigate to.
+ @result A new navigation for the given request.
+ */
- (WKNavigation *)loadRequest:(NSURLRequest *)request;
/*! @abstract Navigates to an item from the back-forward list and sets it as the current item.
- @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.
+ @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.
@seealso backForwardList
*/
- (WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
+/*! @abstract The page title. @link WKWebView @/link is KVO-compliant for this property.
+ */
@property (nonatomic, readonly) NSString *title;
/*! @abstract The active URL. @link WKWebView @/link is KVO-compliant for this property.
@@ -100,8 +106,7 @@
property. */
@property (nonatomic, readonly, getter=isLoading) BOOL loading;
-/*!
- @abstract An estimate of the fraction complete for a document load. @link WKWebView @/link is
+/*! @abstract An estimate of the fraction complete for a document load. @link WKWebView @/link is
KVO-compliant for this property.
@discussion This value will range from 0 to 1 and, once a load completes, will remain at 1.0
until a new load starts, at which point it will be reset to 0. The value is an estimate based
@@ -110,28 +115,71 @@
*/
@property (nonatomic, readonly) double estimatedProgress;
+/*! @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.
+ */
@property (nonatomic, readonly) BOOL hasOnlySecureContent;
+/*! @abstract Whether there's a back item in the back-forward list that can be navigated to.
+ @seealso backForwardList.
+ */
@property (readonly) BOOL canGoBack;
+
+/*! @abstract Whether there's a forward item in the back-forward list that can be navigated to.
+ @seealso backForwardList.
+ */
@property (readonly) BOOL canGoForward;
+/*! @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.
+ */
- (WKNavigation *)goBack;
+
+/*! @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.
+ */
- (WKNavigation *)goForward;
+/*! @abstract Reloads the current page.
+ @result A new navigation representing the reload.
+ */
- (WKNavigation *)reload;
+
+/*! @abstract Reloads the current page, performing end-to-end revalidation using cache-validating conditionals if possible.
+ @result A new navigation representing the reload.
+ */
- (WKNavigation *)reloadFromOrigin;
+/*! @abstract Stops loading all resources on the current page.
+ */
- (void)stopLoading;
+/*! @abstract Whether horizontal swipe gestures will trigger back-forward list navigations.
+ */
@property (nonatomic) BOOL allowsBackForwardNavigationGestures;
#if TARGET_OS_IPHONE
+/*! @abstract The scroll view associated with the web view.
+ */
@property (nonatomic, readonly) UIScrollView *scrollView;
-#else
+#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.
+ */
@property (nonatomic) BOOL allowsMagnification;
+
+/* @abstract The amount by which the page content is currently scaled. The default value is 1.0.
+ */
@property (nonatomic) CGFloat magnification;
+/* @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.
+ */
- (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;
+
#endif
@end
@@ -140,12 +188,30 @@
@interface WKWebView (WKIBActions) <NSUserInterfaceValidations>
+/*! @abstract Action method that navigates to the back item in the back-forward list.
+ @param sender The object that sent this message.
+ */
- (IBAction)goBack:(id)sender;
+
+/*! @abstract Action method that navigates to the forward item in the back-forward list.
+ @param sender The object that sent this message.
+ */
- (IBAction)goForward:(id)sender;
+/*! @abstract Action method that reloads the current page.
+ @param sender The object that sent this message.
+ */
- (IBAction)reload:(id)sender;
+
+/*! @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.
+ */
- (IBAction)reloadFromOrigin:(id)sender;
+/*! @abstract Action method that stops loading all resources on the current page.
+ @param sender The object that sent this message.
+ */
- (IBAction)stopLoading:(id)sender;
@end
