Title: [166664] trunk/Source/WebKit2
- Revision
- 166664
- Author
- [email protected]
- Date
- 2014-04-02 14:02:22 -0700 (Wed, 02 Apr 2014)
Log Message
Document WKUIDelegate and WKWindowFeatures
https://bugs.webkit.org/show_bug.cgi?id=131124
Reviewed by Dan Bernstein.
* UIProcess/API/Cocoa/WKProcessPool.h:
* UIProcess/API/Cocoa/WKUIDelegate.h:
* UIProcess/API/Cocoa/WKWindowFeatures.h:
Modified Paths
Diff
Modified: trunk/Source/WebKit2/ChangeLog (166663 => 166664)
--- trunk/Source/WebKit2/ChangeLog 2014-04-02 20:59:19 UTC (rev 166663)
+++ trunk/Source/WebKit2/ChangeLog 2014-04-02 21:02:22 UTC (rev 166664)
@@ -1,3 +1,14 @@
+2014-04-02 Anders Carlsson <[email protected]>
+
+ Document WKUIDelegate and WKWindowFeatures
+ https://bugs.webkit.org/show_bug.cgi?id=131124
+
+ Reviewed by Dan Bernstein.
+
+ * UIProcess/API/Cocoa/WKProcessPool.h:
+ * UIProcess/API/Cocoa/WKUIDelegate.h:
+ * UIProcess/API/Cocoa/WKWindowFeatures.h:
+
2014-04-02 Dean Jackson <[email protected]>
[iOS] Expose geolocation provider on the process pool
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h (166663 => 166664)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h 2014-04-02 20:59:19 UTC (rev 166663)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h 2014-04-02 21:02:22 UTC (rev 166664)
@@ -28,11 +28,10 @@
#if WK_API_ENABLED
-/*! A WKProcessPool defines a distinct type-or category-of Web Content process.
- A @link WKWebView @/link specifies the WKProcessPool of the Web
- Content process backing it through its @link WKWebViewConfiguration @/link.
- @helperclass @link WKProcessPoolConfiguration @/link
- Used to configure @link WKProcessPool @/link instances.
+/*! A pool of Web Content processes.
+ A @link WKWebView @/link specifies from which pool the Web Content process backing it comes through its @link WKWebViewConfiguration @/link.
+ Each WKWebView will get its own Web Content process until an implementation-defined process limit is reached; after that,
+ web views with the same process pool end up sharing Web Content processes.
*/
WK_API_CLASS
@interface WKProcessPool : NSObject
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h (166663 => 166664)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h 2014-04-02 20:59:19 UTC (rev 166663)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h 2014-04-02 21:02:22 UTC (rev 166664)
@@ -32,16 +32,52 @@
@class WKWebViewConfiguration;
@class WKWindowFeatures;
+/*! A class that conforms to WKUIDelegate provides methods for presenting native UI on behalf of the webpage.
+ */
@protocol WKUIDelegate <NSObject>
@optional
+/*! @abstract Create a new WKWebView.
+ @param webView The WKWebView invoking the delegate method.
+ @param configuration The configuration that must be used when creating the new WKWebView.
+ @param navigationAction The navigation action that is causing the new WKWebView to be created.
+ @param windowFeatures Window features requested by the webpage.
+ @result A new WKWebView or nil.
+ @discussion The WKWebView returned must be created with the specified configuration. WebKit will load the request in the returned WKWebView.
+ */
- (WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures;
+/*! @abstract Display a _javascript_ alert panel.
+ @param webView The WKWebView invoking the delegate method.
+ @param message The message to display.
+ @param frame Information about the frame whose _javascript_ initiated this call.
+ @param completionHandler The completion handler that should get called after the alert panel has been dismissed.
+ @discussion Clients should visually indicate that this panel comes from _javascript_ initiated by the specified frame.
+ The panel should have a single "OK" button.
+ */
- (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)())completionHandler;
+/*! @abstract Display a _javascript_ confirm panel.
+ @param webView The WKWebView invoking the delegate method.
+ @param message The message to display.
+ @param frame Information about the frame whose _javascript_ initiated this call.
+ @param completionHandler The completion handler that should get called after the confirm panel has been dismissed.
+ Pass YES if the user chose OK, NO if the user chose Cancel.
+ @discussion Clients should visually indicate that this panel comes from _javascript_ initiated by the specified frame.
+ The panel should have two buttons, e.g. "OK" and "Cancel".
+ */
- (void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL result))completionHandler;
+/*! @abstract Display a _javascript_ text input panel.
+ @param webView The WKWebView invoking the delegate method.
+ @param message The message to display.
+ @param defaultText The initial text for the text entry area.
+ @param frame Information about the frame whose _javascript_ initiated this call.
+ @param completionHandler The completion handler that should get called after the text input panel has been dismissed. Pass the typed text if the user chose OK, otherwise nil.
+ @discussion Clients should visually indicate that this panel comes from _javascript_ initiated by the specified frame.
+ The panel should have two buttons, e.g. "OK" and "Cancel", and an area to type text.
+ */
- (void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString *result))completionHandler;
@end
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWindowFeatures.h (166663 => 166664)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWindowFeatures.h 2014-04-02 20:59:19 UTC (rev 166663)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWindowFeatures.h 2014-04-02 21:02:22 UTC (rev 166664)
@@ -28,18 +28,41 @@
#if WK_API_ENABLED
+/*! WKWindowFeatures specifies optional attributes for the containing window when a new WKWebView is requested.
+ */
WK_API_CLASS
@interface WKWindowFeatures : NSObject
+/*! @abstract BOOL. Whether the menu bar should be visible. nil if menu bar visibility was not specified.
+ */
@property (nonatomic, readonly) NSNumber *menuBarVisibility;
+
+/*! @abstract BOOL. Whether the status bar should be visible. nil if status bar visibility was not specified.
+ */
@property (nonatomic, readonly) NSNumber *statusBarVisibility;
+
+/*! @abstract BOOL. Whether toolbars should be visible. nil if toolbar visibility was not specified.
+ */
@property (nonatomic, readonly) NSNumber *toolbarsVisibility;
+/*! @abstract BOOL. Whether the containing window should be resizable. nil if resizability was not specified.
+ */
@property (nonatomic, readonly) NSNumber *allowsResizing;
+/*! @abstract The x coordinate of the containing window. nil if the x coordinate was not specified.
+ */
@property (nonatomic, readonly) NSNumber *x;
+
+/*! @abstract The y coordinate of the containing window. nil if the y coordinate was not specified.
+ */
@property (nonatomic, readonly) NSNumber *y;
+
+/*! @abstract The width coordinate of the containing window. nil if the width was not specified.
+ */
@property (nonatomic, readonly) NSNumber *width;
+
+/*! @abstract The height coordinate of the containing window. nil if the height was not specified.
+ */
@property (nonatomic, readonly) NSNumber *height;
@end
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes
