Changeset 247657 in webkit

Timestamp:

Jul 19, 2019, 3:50:17 PM (7 years ago)

Author:

dino@apple.com

Message:

Provide correct names for UIContextMenuInteraction API replacements
​https://bugs.webkit.org/show_bug.cgi?id=199966

Reviewed by Tim Horton.

We had some old incorrect names for replacements to SPI. While
here, I reordered and expanded the documentation for the new API.

• UIProcess/API/Cocoa/WKUIDelegate.h:
• UIProcess/API/Cocoa/WKUIDelegatePrivate.h:

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/Cocoa/WKUIDelegate.h (modified) (2 diffs)
• UIProcess/API/Cocoa/WKUIDelegatePrivate.h (modified) (1 diff)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2019-07-19  Dean Jackson  <dino@apple.com>
+
+        Provide correct names for UIContextMenuInteraction API replacements
+        https://bugs.webkit.org/show_bug.cgi?id=199966
+
+        Reviewed by Tim Horton.
+
+        We had some old incorrect names for replacements to SPI. While
+        here, I reordered and expanded the documentation for the new API.
+
+        * UIProcess/API/Cocoa/WKUIDelegate.h:
+        * UIProcess/API/Cocoa/WKUIDelegatePrivate.h:
+
 2019-07-19  Daniel Bates  <dabates@apple.com>
 

trunk/Source/WebKit/UIProcess/API/Cocoa/WKUIDelegate.h

@@ -175 +175 @@
 
 /**
+ * @abstract Called when the context menu will be presented.
+ *
+ * @param webView The web view invoking the delegate method.
+ * @param elementInfo The elementInfo for the element the user is touching.
+ */
+
+- (void)webView:(WKWebView *)webView contextMenuWillPresentForElement:(WKContextMenuElementInfo *)elementInfo WK_API_AVAILABLE(ios(WK_IOS_TBA));
+
+/**
  * @abstract Called when the context menu configured by the UIContextMenuConfiguration from
- * webView:contextMenuConfigurationForElement:completionHandler: is committed.
+ * webView:contextMenuConfigurationForElement:completionHandler: is committed. That is, when
+ * the user has selected the view provided in the UIContextMenuContentPreviewProvider.
  *
  * @param webView The web view invoking the delegate method.
@@ -183 +193 @@
  */
 
-- (void)webView:(WKWebView *)webView contextMenuForElement:(WKContextMenuElementInfo *)elementInfo willCommitWithAnimator:(id<UIContextMenuInteractionCommitAnimating>)animator WK_API_AVAILABLE(ios(WK_IOS_TBA));
-
-/**
- * @abstract Called when the context menu will be presented.
- *
- * @param webView The web view invoking the delegate method.
- * @param elementInfo The elementInfo for the element the user is touching.
- */
-
-- (void)webView:(WKWebView *)webView contextMenuWillPresentForElement:(WKContextMenuElementInfo *)elementInfo WK_API_AVAILABLE(ios(WK_IOS_TBA));
-
-/**
- * @abstract Called when the context menu ends.
+- (void)webView:(WKWebView *)webView contextMenuForElement:(WKContextMenuElementInfo *)elementInfo willCommitWithAnimator:(id <UIContextMenuInteractionCommitAnimating>)animator WK_API_AVAILABLE(ios(WK_IOS_TBA));
+
+/**
+ * @abstract Called when the context menu ends, either by being dismissed or when a menu action is taken.
  *
  * @param webView The web view invoking the delegate method.

trunk/Source/WebKit/UIProcess/API/Cocoa/WKUIDelegatePrivate.h

@@ -145 +145 @@
 
 - (UIViewController *)_webView:(WKWebView *)webView previewViewControllerForURL:(NSURL *)url WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuConfigurationForElement:completionHandler:", ios(9.0, WK_IOS_TBA));
-- (void)_webView:(WKWebView *)webView commitPreviewedViewController:(UIViewController *)previewedViewController WK_API_DEPRECATED_WITH_REPLACEMENT("webView:commitContextMenu:", ios(9.0, WK_IOS_TBA));
+- (void)_webView:(WKWebView *)webView commitPreviewedViewController:(UIViewController *)previewedViewController WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuForElement:willCommitWithAnimator:", ios(9.0, WK_IOS_TBA));
 - (void)_webView:(WKWebView *)webView willPreviewImageWithURL:(NSURL *)imageURL WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuConfigurationForElement:completionHandler:", ios(9.0, WK_IOS_TBA));
-- (void)_webView:(WKWebView *)webView commitPreviewedImageWithURL:(NSURL *)imageURL WK_API_DEPRECATED_WITH_REPLACEMENT("webView:commitContextMenu:", ios(9.0, WK_IOS_TBA));
-- (void)_webView:(WKWebView *)webView didDismissPreviewViewController:(UIViewController *)previewedViewController committing:(BOOL)committing WK_API_DEPRECATED_WITH_REPLACEMENT("webView:dismissContextMenu:", ios(9.0, WK_IOS_TBA));
-- (void)_webView:(WKWebView *)webView didDismissPreviewViewController:(UIViewController *)previewedViewController WK_API_DEPRECATED_WITH_REPLACEMENT("webView:dismissContextMenu:", ios(9.0, WK_IOS_TBA));
+- (void)_webView:(WKWebView *)webView commitPreviewedImageWithURL:(NSURL *)imageURL WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuForElement:willCommitWithAnimator:", ios(9.0, WK_IOS_TBA));
+- (void)_webView:(WKWebView *)webView didDismissPreviewViewController:(UIViewController *)previewedViewController committing:(BOOL)committing WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuDidEndForElement:", ios(9.0, WK_IOS_TBA));
+- (void)_webView:(WKWebView *)webView didDismissPreviewViewController:(UIViewController *)previewedViewController WK_API_DEPRECATED_WITH_REPLACEMENT("webView:contextMenuDidEndForElement:", ios(9.0, WK_IOS_TBA));
 
 #if TARGET_OS_IOS