[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677

cblu cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 06:44:22 UTC 2009


The following commit has been merged in the debian/unstable branch:
commit efd3c69536f41e1b7c3acea9e9261e6e5bfa20c6
Author: cblu <cblu at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date:   Wed Sep 25 00:30:49 2002 +0000

    	More documentation changes.
    
            * WebView.subproj/WebControllerPolicyDelegate.h:
            * WebView.subproj/WebDefaultContextMenuDelegate.h:
            * WebView.subproj/WebDocument.h:
    
    
    git-svn-id: http://svn.webkit.org/repository/webkit/trunk@2154 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index 6b0dd2e..5feca41 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,11 @@
+2002-09-24  Chris Blumenberg  <cblu at apple.com>
+
+	More documentation changes.
+
+        * WebView.subproj/WebControllerPolicyDelegate.h:
+        * WebView.subproj/WebDefaultContextMenuDelegate.h:
+        * WebView.subproj/WebDocument.h:
+
 2002-09-24  Richard Williamson   <rjw at apple.com>
 
         Added FIXME not about unresolved issue with CFStringEncoding/NSStringEncoding.
diff --git a/WebKit/ChangeLog-2002-12-03 b/WebKit/ChangeLog-2002-12-03
index 6b0dd2e..5feca41 100644
--- a/WebKit/ChangeLog-2002-12-03
+++ b/WebKit/ChangeLog-2002-12-03
@@ -1,3 +1,11 @@
+2002-09-24  Chris Blumenberg  <cblu at apple.com>
+
+	More documentation changes.
+
+        * WebView.subproj/WebControllerPolicyDelegate.h:
+        * WebView.subproj/WebDefaultContextMenuDelegate.h:
+        * WebView.subproj/WebDocument.h:
+
 2002-09-24  Richard Williamson   <rjw at apple.com>
 
         Added FIXME not about unresolved issue with CFStringEncoding/NSStringEncoding.
diff --git a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
index 92acead..d5db289 100644
--- a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
@@ -34,6 +34,22 @@ typedef enum {
 } WebPolicyAction;
 
 /*!
+ at enum WebClickAction
+ @constant WebClickPolicyShow Have WebKit show the clicked URL.
+ @constant WebClickPolicyOpenNewWindow Open the clicked URL in another window.
+ @constant WebClickPolicySave Save the clicked URL to disk.
+ @constant WebClickPolicySaveAndOpenExternally Save the clicked URL to disk and open the file in another application.
+ @constant WebClickPolicyIgnore Do nothing with the clicked URL.
+ */
+typedef enum {
+    WebClickPolicyShow = WebPolicyUse,
+    WebClickPolicyOpenNewWindow = WebPolicyOpenNewWindow,
+    WebClickPolicySave = WebPolicySave,
+    WebClickPolicySaveAndOpenExternally = WebPolicySaveAndOpen,
+    WebClickPolicyIgnore = WebPolicyIgnore
+} WebClickAction;
+
+/*!
     @enum WebURLAction
     @constant WebURLPolicyUseContentPolicy Continue processing URL, ask for content policy.
     @constant WebURLPolicyOpenExternally Open the URL in another application. 
@@ -62,10 +78,10 @@ typedef enum {
 /*!
     @enum WebContentAction
     @constant WebContentPolicyNone Unitialized state.
-    @constant WebContentPolicyShow Show the resource in WebKit.
-    @constant WebContentPolicySave Save the resource to disk.
-    @constant WebContentPolicySaveAndOpenExternally, Save the resource to disk and open it in another application.
-    @constant WebContentPolicyIgnore Do nothing with the resource.
+    @constant WebContentPolicyShow Show the content in WebKit.
+    @constant WebContentPolicySave Save the content to disk.
+    @constant WebContentPolicySaveAndOpenExternally Save the content to disk and open it in another application.
+    @constant WebContentPolicyIgnore Do nothing with the content.
 */
 typedef enum {
     WebContentPolicyNone = WebPolicyNone,
@@ -75,22 +91,6 @@ typedef enum {
     WebContentPolicyIgnore = WebPolicyIgnore
 } WebContentAction;
 
-/*!
-    @enum WebClickAction
-    @constant WebClickPolicyShow Have WebKit show the clicked URL.
-    @constant WebClickPolicyOpenNewWindow Open the clicked URL in another window.
-    @constant WebClickPolicySave Save the clicked URL to disk.
-    @constant WebClickPolicySaveAndOpenExternally Save the clicked URL to disk and open the file in another application.
-    @constant WebClickPolicyIgnore Do nothing with the clicked URL.
-*/
-typedef enum {
-    WebClickPolicyShow = WebPolicyUse,
-    WebClickPolicyOpenNewWindow = WebPolicyOpenNewWindow,
-    WebClickPolicySave = WebPolicySave,
-    WebClickPolicySaveAndOpenExternally = WebPolicySaveAndOpen,
-    WebClickPolicyIgnore = WebPolicyIgnore
-} WebClickAction;
-
 
 /*!
     @class WebPolicy
@@ -105,16 +105,19 @@ typedef enum {
 
 /*!
     @method policyAction
+    @abstract The policy action of the WebPolicy.
 */
 - (WebPolicyAction)policyAction;
 
 /*!
     @method path
+    @abstract The path for the saved file.
 */
 - (NSString *)path;
 
 /*!
     @method URL
+    @abstract The URL of the WebPolicy.
 */
 - (NSURL *)URL;
 @end
@@ -127,8 +130,8 @@ typedef enum {
 @interface WebURLPolicy : WebPolicy
 /*!
     @method webPolicyWithURLAction:
-    @abstract WebURLPolicy constructor
-    @param action
+    @abstract WebURLPolicy constructor.
+    @param action The policy action of the WebURLPolicy.
 */
 + webPolicyWithURLAction: (WebURLAction)action;
 @end
@@ -142,7 +145,7 @@ typedef enum {
 /*!
     @method webPolicyWithFileAction:
     @abstract WebFileURLPolicy constructor
-    @param action
+    @param action The policy action of the WebFileURLPolicy.
 */
 + webPolicyWithFileAction: (WebFileAction)action;
 @end
@@ -156,7 +159,7 @@ typedef enum {
 /*!
     @method webPolicyWithContentAction:andPath:
     @abstract WebContentPolicy constructor
-    @param action
+    @param action The policy action of the WebContentPolicy.
     @param thePath Path to where the file should be saved. Only applicable for
     WebContentPolicySave and WebContentPolicySaveAndOpenExternally WebContentActions.
 */
@@ -172,7 +175,7 @@ typedef enum {
 /*!
     @method webPolicyWithClickAction:andPath:
     @abstract WebClickPolicy constructor
-    @param action
+    @param action The policy action of the WebClickPolicy.
     @param thePath Path to where the file should be saved. Only applicable for
     WebClickPolicySave and WebClickPolicySaveAndOpenExternally WebClickActions.
 */
@@ -182,12 +185,28 @@ typedef enum {
 
 /*!
     @protocol WebControllerPolicyHandler
-    @discussion A controller's WebControllerPolicyHandler is asked for policies for files,
-    URL's, clicked URL's and partially loaded content that WebKit has been asked to load.
+    @discussion While loading a URL, WebKit asks the WebControllerPolicyHandler for
+    policies that determine the action of what to do with the URL or the data that
+    the URL represents. Typically, the policy handler methods are called in this order:
+
+    clickPolicyForElement:button:modifierMask:<BR>
+    URLPolicyForURL:inFrame:<BR>
+    fileURLPolicyForMIMEType:inFrame:isDirectory:<BR>
+    contentPolicyForMIMEType:URL:inFrame:<BR>
 */
 @protocol WebControllerPolicyDelegate <NSObject>
 
 /*!
+     @method clickPolicyForElement:button:modifierMask:
+     @discussion Called right after the user clicks on a link.
+     @param elementInformation Dictionary that describes the clicked element.
+     @param eventType The type of event.
+     @param eventMask The event mask as described in NSEvents.h.
+     @result The WebClickPolicy for WebKit to implement
+*/
+- (WebClickPolicy *)clickPolicyForElement: (NSDictionary *)elementInformation button: (NSEventType)eventType modifierMask: (unsigned int)eventMask;
+
+/*!
     @method URLPolicyForURL:inFrame:
     @discussion URLPolicyForURL: is used to determine what to do BEFORE a URL is loaded, i.e.
     before it is clicked or loaded via a URL bar.  Clients can choose to handle the
@@ -199,6 +218,16 @@ typedef enum {
 - (WebURLPolicy *)URLPolicyForURL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
+     @method fileURLPolicyForMIMEType:inFrame:isDirectory:
+     @discussion Called when the response to URLPolicyForURL is WebURLPolicyUseContentPolicy and the URL is
+     a file URL. This allows clients to special-case WebKit's behavior for file URLs.
+     @param type MIME type for the file.
+     @param frame The frame which will load the file.
+     @param isDirectory YES if the file is a directory.
+*/
+- (WebFileURLPolicy *)fileURLPolicyForMIMEType: (NSString *)type inFrame:(WebFrame *)frame isDirectory: (BOOL)isDirectory;
+
+/*!
     @method contentPolicyForMIMEType:URL:inFrame:
     @discussion Returns the policy for content which has been partially loaded. Sent after locationChangeStarted. 
     Implementations typically call haveContentPolicy:forLocationChangeHandler: on WebController
@@ -210,38 +239,19 @@ typedef enum {
 - (WebContentPolicy *)contentPolicyForMIMEType: (NSString *)type URL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
-    @method fileURLPolicyForMIMEType:inFrame:isDirectory:
-    @discussion Called when the response to URLPolicyForURL is WebURLPolicyUseContentPolicy and the URL is
-    a file URL. This allows clients to special-case WebKit's behavior for file URLs.
-    @param type MIME type for the file.
-    @param frame The frame which will load the file.
-    @param isDirectory YES if the file is a directory.
-*/
-- (WebFileURLPolicy *)fileURLPolicyForMIMEType: (NSString *)type inFrame:(WebFrame *)frame isDirectory: (BOOL)isDirectory;
-
-/*!
-    @method clickPolicyForElement:button:modifierMask:
-    @discussion Returns the policy for a clicked URL.
-    @param elementInformation Dictionary that describes the clicked element.
-    @param eventType
-    @param eventMask
-*/
-- (WebClickPolicy *)clickPolicyForElement: (NSDictionary *)elementInformation button: (NSEventType)eventType modifierMask: (unsigned int)eventMask;
-
-/*!
     @method unableToImplementPolicy:error:forURL:inFrame:
     @discussion Called when a WebPolicy could not be implemented. It is up to the client to display appropriate feedback.
-    @param policy
-    @param error
-    @param frame
+    @param policy The policy that could not be implemented.
+    @param error The error that caused the policy to not be implemented.
+    @param frame The frame in the which the policy could not be implemented.
 */
 - (void)unableToImplementPolicy:(WebPolicy *)policy error:(WebError *)error forURL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
     @method pluginNotFoundForMIMEType:pluginPageURL:
-    @discussion Called when a plug-in for a certain mime type is not installed
-    @param mime
-    @param URL
+    @discussion Called when a plug-in for a certain mime type is not installed.
+    @param mime The MIME type that no installed plug-in supports.
+    @param URL The web page for the plug-in that supports the MIME type. Can be nil.
 */
 - (void)pluginNotFoundForMIMEType:(NSString *)mime pluginPageURL:(NSURL *)URL;
 
diff --git a/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h b/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
index 2325fc5..a0272d7 100644
--- a/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
+++ b/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
@@ -2,7 +2,7 @@
      WebDefaultContextMenuDelegate.h
      Copyright 2002, Apple, Inc. All rights reserved.
 
-     Public header file.
+     Private header file.
 */
 
 
diff --git a/WebKit/WebView.subproj/WebDocument.h b/WebKit/WebView.subproj/WebDocument.h
index 5c5886e..2a670f3 100644
--- a/WebKit/WebView.subproj/WebDocument.h
+++ b/WebKit/WebView.subproj/WebDocument.h
@@ -10,28 +10,36 @@
 
 /*!
     @protocol WebDocumentView
+    @discussion Protocol implemented by the document view of WebView
 */
 @protocol WebDocumentView <NSObject>
+
 /*!
     @method setDataSource:
-    @param dataSource
+    @abstract Called when the corresponding data source has been created.
+    @param dataSource The corresponding data source.
 */
 - (void)setDataSource: (WebDataSource *)dataSource;
 
 /*!
     @method dataSourceUpdated:
-    @param dataSource
+    @abstract Called when the corresponding data source has received data.
+    @param dataSource The corresponding data source.
 */
 - (void)dataSourceUpdated: (WebDataSource *)dataSource;
 
 /*!
     @method setNeedsLayout:
-    @param flag
+    @discussion Called when WebKit has determined that the document view needs to layout.
+    This method should simply set a flag and call layout from drawRect if the flag is YES.
+    @param flag YES to cause a layout, no to not cause a layout.
 */
 - (void)setNeedsLayout: (BOOL)flag;
 
 /*!
     @method layout
+    @discussion Called when the document view must immediately layout. For simple views,
+    setting the frame is a sufficient implementation of this method.
 */
 - (void)layout;
 @end
@@ -39,27 +47,32 @@
 
 /*!
     @protocol WebDocumentDragSettings
+    @discussion Optional protocol for setting dragging behavior for the document view of WebView. 
 */
 @protocol WebDocumentDragSettings <NSObject>
 /*!
     @method setCanDragFrom:
-    @param flag
+    @abstract Sets whether one can drag from the document view or not.
+    @param flag YES allows drags from the document view, NO disallows drags from the document view.
 */
 - (void)setCanDragFrom: (BOOL)flag;
 
 /*!
     @method canDragFrom
+    @result Whether one can drag from the document view or not.
 */
 - (BOOL)canDragFrom;
 
 /*!
     @method setCanDragTo:
-    @param flag
+    @abstract Sets whether one can drag to the document view or not.
+    @param flag YES allows drags to the document view, NO disallows drags to the document view.
 */
 - (void)setCanDragTo: (BOOL)flag;
 
 /*!
     @method canDragTo
+    @result Whether one can drag to the document view or not.
 */
 - (BOOL)canDragTo;
 @end
@@ -67,10 +80,16 @@
 
 /*!
     @protocol WebDocumentSearching
+    @discussion Optional protocol for searching document view of WebView. 
 */
 @protocol WebDocumentSearching <NSObject>
 /*!
     @method searchFor:direction:caseSensitive:
+    @abstract Searches a document view for a string and highlights the string if it is found.
+    @param string The string to search for.
+    @param forward YES to search forward, NO to seach backwards.
+    @param caseFlag YES to for case-sensitive search, NO for case-insensitive search.
+    @result YES if found, NO if not found.
 */
 - (BOOL)searchFor: (NSString *)string direction: (BOOL)forward caseSensitive: (BOOL)caseFlag;
 @end
@@ -78,10 +97,12 @@
 
 /*!
     @protocol WebDocumentTextEncoding
+    @discussion Optional protocol for supporting text encoding.
 */
 @protocol WebDocumentTextEncoding <NSObject>
 /*!
     @method supportsTextEncoding
+    @result YES if the document view support text encoding, NO if it doesn't.
 */
 - (BOOL)supportsTextEncoding;
 @end
@@ -89,31 +110,36 @@
 
 /*!
     @protocol WebDocumentRepresentation
+    @discussion Protocol implemented by the document representation of a data source.
 */
 @protocol WebDocumentRepresentation <NSObject>
 /*!
     @method setDataSource:
-    @param dataSource
+    @abstract Called soon after the document representation is created.
+    @param dataSource The data source that is set.
 */
 - (void)setDataSource: (WebDataSource *)dataSource;
 
 /*!
     @method receivedData:withDataSource:
-    @param data
-    @param dataSource
+    @abstract Called when the data source has received data.
+    @param data The data that the data source has received.
+    @param dataSource The data source that has received data.
 */
 - (void)receivedData: (NSData *)data withDataSource: (WebDataSource *)dataSource;
 
 /*!
     @method receivedError:withDataSource:
-    @param error
-    @param dataSource
+    @abstract Called when the data source has received an error.
+    @param error The error that the data source has received.
+    @param dataSource The data source that has received the error.
 */
 - (void)receivedError: (WebError *)error withDataSource: (WebDataSource *)dataSource;
 
 /*!
     @method finishLoadingWithDataSource:
-    @param dataSource
+    @abstract Called when the data source has finished loading.
+    @param dataSource The datasource that has finished loading.
 */
 - (void)finishedLoadingWithDataSource: (WebDataSource *)dataSource;
 @end
diff --git a/WebKit/WebView.subproj/WebPolicyDelegate.h b/WebKit/WebView.subproj/WebPolicyDelegate.h
index 92acead..d5db289 100644
--- a/WebKit/WebView.subproj/WebPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebPolicyDelegate.h
@@ -34,6 +34,22 @@ typedef enum {
 } WebPolicyAction;
 
 /*!
+ at enum WebClickAction
+ @constant WebClickPolicyShow Have WebKit show the clicked URL.
+ @constant WebClickPolicyOpenNewWindow Open the clicked URL in another window.
+ @constant WebClickPolicySave Save the clicked URL to disk.
+ @constant WebClickPolicySaveAndOpenExternally Save the clicked URL to disk and open the file in another application.
+ @constant WebClickPolicyIgnore Do nothing with the clicked URL.
+ */
+typedef enum {
+    WebClickPolicyShow = WebPolicyUse,
+    WebClickPolicyOpenNewWindow = WebPolicyOpenNewWindow,
+    WebClickPolicySave = WebPolicySave,
+    WebClickPolicySaveAndOpenExternally = WebPolicySaveAndOpen,
+    WebClickPolicyIgnore = WebPolicyIgnore
+} WebClickAction;
+
+/*!
     @enum WebURLAction
     @constant WebURLPolicyUseContentPolicy Continue processing URL, ask for content policy.
     @constant WebURLPolicyOpenExternally Open the URL in another application. 
@@ -62,10 +78,10 @@ typedef enum {
 /*!
     @enum WebContentAction
     @constant WebContentPolicyNone Unitialized state.
-    @constant WebContentPolicyShow Show the resource in WebKit.
-    @constant WebContentPolicySave Save the resource to disk.
-    @constant WebContentPolicySaveAndOpenExternally, Save the resource to disk and open it in another application.
-    @constant WebContentPolicyIgnore Do nothing with the resource.
+    @constant WebContentPolicyShow Show the content in WebKit.
+    @constant WebContentPolicySave Save the content to disk.
+    @constant WebContentPolicySaveAndOpenExternally Save the content to disk and open it in another application.
+    @constant WebContentPolicyIgnore Do nothing with the content.
 */
 typedef enum {
     WebContentPolicyNone = WebPolicyNone,
@@ -75,22 +91,6 @@ typedef enum {
     WebContentPolicyIgnore = WebPolicyIgnore
 } WebContentAction;
 
-/*!
-    @enum WebClickAction
-    @constant WebClickPolicyShow Have WebKit show the clicked URL.
-    @constant WebClickPolicyOpenNewWindow Open the clicked URL in another window.
-    @constant WebClickPolicySave Save the clicked URL to disk.
-    @constant WebClickPolicySaveAndOpenExternally Save the clicked URL to disk and open the file in another application.
-    @constant WebClickPolicyIgnore Do nothing with the clicked URL.
-*/
-typedef enum {
-    WebClickPolicyShow = WebPolicyUse,
-    WebClickPolicyOpenNewWindow = WebPolicyOpenNewWindow,
-    WebClickPolicySave = WebPolicySave,
-    WebClickPolicySaveAndOpenExternally = WebPolicySaveAndOpen,
-    WebClickPolicyIgnore = WebPolicyIgnore
-} WebClickAction;
-
 
 /*!
     @class WebPolicy
@@ -105,16 +105,19 @@ typedef enum {
 
 /*!
     @method policyAction
+    @abstract The policy action of the WebPolicy.
 */
 - (WebPolicyAction)policyAction;
 
 /*!
     @method path
+    @abstract The path for the saved file.
 */
 - (NSString *)path;
 
 /*!
     @method URL
+    @abstract The URL of the WebPolicy.
 */
 - (NSURL *)URL;
 @end
@@ -127,8 +130,8 @@ typedef enum {
 @interface WebURLPolicy : WebPolicy
 /*!
     @method webPolicyWithURLAction:
-    @abstract WebURLPolicy constructor
-    @param action
+    @abstract WebURLPolicy constructor.
+    @param action The policy action of the WebURLPolicy.
 */
 + webPolicyWithURLAction: (WebURLAction)action;
 @end
@@ -142,7 +145,7 @@ typedef enum {
 /*!
     @method webPolicyWithFileAction:
     @abstract WebFileURLPolicy constructor
-    @param action
+    @param action The policy action of the WebFileURLPolicy.
 */
 + webPolicyWithFileAction: (WebFileAction)action;
 @end
@@ -156,7 +159,7 @@ typedef enum {
 /*!
     @method webPolicyWithContentAction:andPath:
     @abstract WebContentPolicy constructor
-    @param action
+    @param action The policy action of the WebContentPolicy.
     @param thePath Path to where the file should be saved. Only applicable for
     WebContentPolicySave and WebContentPolicySaveAndOpenExternally WebContentActions.
 */
@@ -172,7 +175,7 @@ typedef enum {
 /*!
     @method webPolicyWithClickAction:andPath:
     @abstract WebClickPolicy constructor
-    @param action
+    @param action The policy action of the WebClickPolicy.
     @param thePath Path to where the file should be saved. Only applicable for
     WebClickPolicySave and WebClickPolicySaveAndOpenExternally WebClickActions.
 */
@@ -182,12 +185,28 @@ typedef enum {
 
 /*!
     @protocol WebControllerPolicyHandler
-    @discussion A controller's WebControllerPolicyHandler is asked for policies for files,
-    URL's, clicked URL's and partially loaded content that WebKit has been asked to load.
+    @discussion While loading a URL, WebKit asks the WebControllerPolicyHandler for
+    policies that determine the action of what to do with the URL or the data that
+    the URL represents. Typically, the policy handler methods are called in this order:
+
+    clickPolicyForElement:button:modifierMask:<BR>
+    URLPolicyForURL:inFrame:<BR>
+    fileURLPolicyForMIMEType:inFrame:isDirectory:<BR>
+    contentPolicyForMIMEType:URL:inFrame:<BR>
 */
 @protocol WebControllerPolicyDelegate <NSObject>
 
 /*!
+     @method clickPolicyForElement:button:modifierMask:
+     @discussion Called right after the user clicks on a link.
+     @param elementInformation Dictionary that describes the clicked element.
+     @param eventType The type of event.
+     @param eventMask The event mask as described in NSEvents.h.
+     @result The WebClickPolicy for WebKit to implement
+*/
+- (WebClickPolicy *)clickPolicyForElement: (NSDictionary *)elementInformation button: (NSEventType)eventType modifierMask: (unsigned int)eventMask;
+
+/*!
     @method URLPolicyForURL:inFrame:
     @discussion URLPolicyForURL: is used to determine what to do BEFORE a URL is loaded, i.e.
     before it is clicked or loaded via a URL bar.  Clients can choose to handle the
@@ -199,6 +218,16 @@ typedef enum {
 - (WebURLPolicy *)URLPolicyForURL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
+     @method fileURLPolicyForMIMEType:inFrame:isDirectory:
+     @discussion Called when the response to URLPolicyForURL is WebURLPolicyUseContentPolicy and the URL is
+     a file URL. This allows clients to special-case WebKit's behavior for file URLs.
+     @param type MIME type for the file.
+     @param frame The frame which will load the file.
+     @param isDirectory YES if the file is a directory.
+*/
+- (WebFileURLPolicy *)fileURLPolicyForMIMEType: (NSString *)type inFrame:(WebFrame *)frame isDirectory: (BOOL)isDirectory;
+
+/*!
     @method contentPolicyForMIMEType:URL:inFrame:
     @discussion Returns the policy for content which has been partially loaded. Sent after locationChangeStarted. 
     Implementations typically call haveContentPolicy:forLocationChangeHandler: on WebController
@@ -210,38 +239,19 @@ typedef enum {
 - (WebContentPolicy *)contentPolicyForMIMEType: (NSString *)type URL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
-    @method fileURLPolicyForMIMEType:inFrame:isDirectory:
-    @discussion Called when the response to URLPolicyForURL is WebURLPolicyUseContentPolicy and the URL is
-    a file URL. This allows clients to special-case WebKit's behavior for file URLs.
-    @param type MIME type for the file.
-    @param frame The frame which will load the file.
-    @param isDirectory YES if the file is a directory.
-*/
-- (WebFileURLPolicy *)fileURLPolicyForMIMEType: (NSString *)type inFrame:(WebFrame *)frame isDirectory: (BOOL)isDirectory;
-
-/*!
-    @method clickPolicyForElement:button:modifierMask:
-    @discussion Returns the policy for a clicked URL.
-    @param elementInformation Dictionary that describes the clicked element.
-    @param eventType
-    @param eventMask
-*/
-- (WebClickPolicy *)clickPolicyForElement: (NSDictionary *)elementInformation button: (NSEventType)eventType modifierMask: (unsigned int)eventMask;
-
-/*!
     @method unableToImplementPolicy:error:forURL:inFrame:
     @discussion Called when a WebPolicy could not be implemented. It is up to the client to display appropriate feedback.
-    @param policy
-    @param error
-    @param frame
+    @param policy The policy that could not be implemented.
+    @param error The error that caused the policy to not be implemented.
+    @param frame The frame in the which the policy could not be implemented.
 */
 - (void)unableToImplementPolicy:(WebPolicy *)policy error:(WebError *)error forURL:(NSURL *)URL inFrame:(WebFrame *)frame;
 
 /*!
     @method pluginNotFoundForMIMEType:pluginPageURL:
-    @discussion Called when a plug-in for a certain mime type is not installed
-    @param mime
-    @param URL
+    @discussion Called when a plug-in for a certain mime type is not installed.
+    @param mime The MIME type that no installed plug-in supports.
+    @param URL The web page for the plug-in that supports the MIME type. Can be nil.
 */
 - (void)pluginNotFoundForMIMEType:(NSString *)mime pluginPageURL:(NSURL *)URL;
 

-- 
WebKit Debian packaging



More information about the Pkg-webkit-commits mailing list