[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677
rjw
rjw at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 06:40:12 UTC 2009
The following commit has been merged in the debian/unstable branch:
commit b34800bda7ca671057a975314e1dcc03cdfa0e62
Author: rjw <rjw at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Thu Sep 19 01:43:32 2002 +0000
Header file reorg.
* BrowserWebController.m:
* ContextMenuHandler.m:
Get HTML source from rep.
* WebBrowser/HTMLSourceDocument.m
Fix compile errors from John's last checkin.
*WebBrowser/LocationFieldEditor.m
*WebBrowser/LocationTextField.m
Added document keywords to headers.
Made bookmark related APIs private.
* Misc.subproj/WebIconDatabase.h:
* Misc.subproj/WebIconLoader.h:
* Misc.subproj/WebKitErrors.h:
* Panels.subproj/WebStandardPanels.h:
* WebKit.pbproj/project.pbxproj:
* WebView.subproj/WebDefaultContextMenuHandler.h:
* WebView.subproj/WebLoadProgress.h:
* WebView.subproj/WebLocationChangeHandler.h:
* WebView.subproj/WebPreferences.h:
Made public
* WebHTMLRepresentation.h
* WebHTMLRepresentation.m
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@2094 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index fb9dee6..d3abb42 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,21 @@
+2002-09-18 Richard Williamson <rjw at apple.com>
+
+ Added document keywords to headers.
+ Made bookmark related APIs private.
+ * Misc.subproj/WebIconDatabase.h:
+ * Misc.subproj/WebIconLoader.h:
+ * Misc.subproj/WebKitErrors.h:
+ * Panels.subproj/WebStandardPanels.h:
+ * WebKit.pbproj/project.pbxproj:
+ * WebView.subproj/WebDefaultContextMenuHandler.h:
+ * WebView.subproj/WebLoadProgress.h:
+ * WebView.subproj/WebLocationChangeHandler.h:
+ * WebView.subproj/WebPreferences.h:
+
+ Made public
+ * WebHTMLRepresentation.h
+ * WebHTMLRepresentation.m
+
2002-09-18 John Sullivan <sullivan at apple.com>
WebKit part of fix for
@@ -23,7 +41,7 @@
2002-09-18 Richard Williamson <rjw at apple.com>
- Added documentation keywords to header.
+ Added documentation keywords to headers.
Create seperate files for the protocols
that were defined in WebController.h.
Made -[WebController createFrameNamed:for:inParent:allowsScrolling:]):
diff --git a/WebKit/ChangeLog-2002-12-03 b/WebKit/ChangeLog-2002-12-03
index fb9dee6..d3abb42 100644
--- a/WebKit/ChangeLog-2002-12-03
+++ b/WebKit/ChangeLog-2002-12-03
@@ -1,3 +1,21 @@
+2002-09-18 Richard Williamson <rjw at apple.com>
+
+ Added document keywords to headers.
+ Made bookmark related APIs private.
+ * Misc.subproj/WebIconDatabase.h:
+ * Misc.subproj/WebIconLoader.h:
+ * Misc.subproj/WebKitErrors.h:
+ * Panels.subproj/WebStandardPanels.h:
+ * WebKit.pbproj/project.pbxproj:
+ * WebView.subproj/WebDefaultContextMenuHandler.h:
+ * WebView.subproj/WebLoadProgress.h:
+ * WebView.subproj/WebLocationChangeHandler.h:
+ * WebView.subproj/WebPreferences.h:
+
+ Made public
+ * WebHTMLRepresentation.h
+ * WebHTMLRepresentation.m
+
2002-09-18 John Sullivan <sullivan at apple.com>
WebKit part of fix for
@@ -23,7 +41,7 @@
2002-09-18 Richard Williamson <rjw at apple.com>
- Added documentation keywords to header.
+ Added documentation keywords to headers.
Create seperate files for the protocols
that were defined in WebController.h.
Made -[WebController createFrameNamed:for:inParent:allowsScrolling:]):
diff --git a/WebKit/Misc.subproj/WebIconDatabase.h b/WebKit/Misc.subproj/WebIconDatabase.h
index 0f7050d..58a1c96 100644
--- a/WebKit/Misc.subproj/WebIconDatabase.h
+++ b/WebKit/Misc.subproj/WebIconDatabase.h
@@ -1,28 +1,12 @@
/*
- WebIconDatabase.h
- Copyright 2001, 2002, Apple, Inc. All rights reserved.
+ WebIconDatabase.h
+ Copyright 2001, 2002, Apple, Inc. All rights reserved.
+
+ Public header file.
*/
#import <Cocoa/Cocoa.h>
-
-/*
-
- WebIconDatabase
-
- Features:
- - memory cache icons at different sizes
- - disk storage
- - icon update notification
- - user/client icon customization
-
- Uses:
- - WebIconLoader to cache icon images
- - UI elements to retrieve icons that represent site URLs.
- - Save icons to disk for later use.
-
- */
-
// Sent whenever a site icon has changed. The object of the notification is the icon database.
// The userInfo contains the site URL who's icon has changed.
// It can be accessed with the key WebIconNotificationUserInfoSiteURLKey.
@@ -36,6 +20,25 @@ extern NSSize WebIconLargeSize; // 128 x 128
@class WebIconDatabasePrivate;
+/*!
+ @class WebIconDatabase
+ @discussion Features:
+ - memory cache icons at different sizes
+ - disk storage
+ - icon update notification
+ - user/client icon customization
+
+ Uses:
+ - WebIconLoader to cache icon images
+ - UI elements to retrieve icons that represent site URLs.
+ - Save icons to disk for later use.
+
+ Every icon in the database has a retain count. If an icon has a retain count greater than 0, it will be written to disk for later use. If an icon's retain count equals zero it will be removed from disk. The retain count is not persistent across launches. If the WebKit client wishes to retain an icon it should retain the icon once for every launch. This is best done at initialization time before the database begins removing icons. To make sure that the database does not remove unretained icons prematurely, call delayDatabaseCleanup until all desired icons are retained. Once all are retained, call allowDatabaseCleanup.
+
+ Note that an icon can be retained after the database clean-up has begun. This just has to be done before the icon is removed. Icons are removed from the database whenever new icons are added to it.
+
+ Retention methods can be called for icons that are not yet in the database.
+*/
@interface WebIconDatabase : NSObject {
@private
@@ -43,48 +46,72 @@ extern NSSize WebIconLargeSize; // 128 x 128
}
-// Returns a shared instance of the icon database
+/*!
+ @method sharedIconDatabase
+ @abstract Returns a shared instance of the icon database
+*/
+ (WebIconDatabase *)sharedIconDatabase;
-// Returns an icon for a web site URL from memory or disk. nil if none is found.
-// Usually called by a UI element to determine if a site URL has an associated icon.
-// Also usually called by the observer of WebIconChangedNotification after the notification is sent.
+/*!
+ @method iconForSiteURL:withSize:
+ @discussion Returns an icon for a web site URL from memory or disk. nil if none is found.
+ Usually called by a UI element to determine if a site URL has an associated icon.
+ Also usually called by the observer of WebIconChangedNotification after the notification is sent.
+ @param siteURL
+ @param size
+*/
- (NSImage *)iconForSiteURL:(NSURL *)siteURL withSize:(NSSize)size;
+/*!
+ @method defaultIconWithSize:
+ @param size
+*/
- (NSImage *)defaultIconWithSize:(NSSize)size;
-// Customize the site icon for all web sites with the given host name.
+/*!
+ @method setIcon:forHost:
+ @abstract Customize the site icon for all web sites with the given host name.
+ @param icon
+ @param host
+*/
- (void)setIcon:(NSImage *)icon forHost:(NSString *)host;
-// Customize the site icon for a specific web page.
+/*!
+ @method setIcon:forSiteURL:
+ @abstract Customize the site icon for a specific web page.
+ @param icon
+ @param siteURL
+*/
- (void)setIcon:(NSImage *)icon forSiteURL:(NSURL *)siteURL;
-/*
-
-Retention
-
-Every icon in the database has a retain count. If an icon has a retain count greater than 0, it will be written to disk for later use. If an icon's retain count equals zero it will be removed from disk. The retain count is not persistent across launches. If the WebKit client wishes to retain an icon it should retain the icon once for every launch. This is best done at initialization time before the database begins removing icons. To make sure that the database does not remove unretained icons prematurely, call delayDatabaseCleanup until all desired icons are retained. Once all are retained, call allowDatabaseCleanup.
-
-Note that an icon can be retained after the database clean-up has begun. This just has to be done before the icon is removed. Icons are removed from the database whenever new icons are added to it.
-
-Retention methods can be called for icons that are not yet in the database.
-
+/*!
+ @method retainIconForSiteURL:
+ @abstract Increments the retain count of the icon.
+ @param siteURL
*/
-
-// Increments the retain count of the icon.
- (void)retainIconForSiteURL:(NSURL *)siteURL;
-// Decrements the retain count of the icon.
+/*!
+ @method releaseIconForSiteURL:
+ @abstract Decrements the retain count of the icon.
+ @param siteURL
+*/
- (void)releaseIconForSiteURL:(NSURL *)siteURL;
-// Only effective if called before the database begins removing icons.
-// delayDatabaseCleanUp increments an internal counter that when 0 begins the database clean-up.
-// The counter equals 0 at initialization.
+/*!
+ @method delayDatabaseCleanup:
+ @discussion Only effective if called before the database begins removing icons.
+ delayDatabaseCleanUp increments an internal counter that when 0 begins the database clean-up.
+ The counter equals 0 at initialization.
+*/
- (void)delayDatabaseCleanup;
-// Informs the database that it now can begin removing icons.
-// allowDatabaseCleanup decrements an internal counter that when 0 begins the database clean-up.
-// The counter equals 0 at initialization.
+/*!
+ @method allowDatabaseCleanup:
+ @discussion Informs the database that it now can begin removing icons.
+ allowDatabaseCleanup decrements an internal counter that when 0 begins the database clean-up.
+ The counter equals 0 at initialization.
+*/
- (void)allowDatabaseCleanup;
@end
diff --git a/WebKit/Misc.subproj/WebIconLoader.h b/WebKit/Misc.subproj/WebIconLoader.h
index 9ca18bd..5b325ff 100644
--- a/WebKit/Misc.subproj/WebIconLoader.h
+++ b/WebKit/Misc.subproj/WebIconLoader.h
@@ -1,27 +1,59 @@
-//
-// WebIconLoader.h
-// WebKit
-//
-// Created by Chris Blumenberg on Thu Jul 18 2002.
-// Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
-//
+/*
+ WebIconLoader.h
+ Copyright 2002, Apple, Inc. All rights reserved.
+
+ Public header file.
+*/
#import <Cocoa/Cocoa.h>
@class WebIconLoaderPrivate;
@protocol WebResourceClient;
+/*!
+ @class WebIconLoader
+*/
@interface WebIconLoader : NSObject <WebResourceClient>
{
WebIconLoaderPrivate *_private;
}
+/*!
+ @method iconLoaderWithURL:
+ @param URL
+*/
+ iconLoaderWithURL:(NSURL *)URL;
+
+/*!
+ @method initWithURL:
+ @param URL
+*/
- initWithURL:(NSURL *)URL;
+
+/*!
+ @method URL
+*/
- (NSURL *)URL;
+
+/*!
+ @method delegate
+*/
- (id)delegate;
+
+/*!
+ @method setDelegate:
+ @param delegate
+*/
- (void)setDelegate:(id)delegate;
+
+/*!
+ @method startLoading
+*/
- (void)startLoading;
+
+/*!
+ @method stopLoading
+*/
- (void)stopLoading;
@end
diff --git a/WebKit/Misc.subproj/WebKitErrors.h b/WebKit/Misc.subproj/WebKitErrors.h
index 33ff709..bc37c4e 100644
--- a/WebKit/Misc.subproj/WebKitErrors.h
+++ b/WebKit/Misc.subproj/WebKitErrors.h
@@ -1,10 +1,29 @@
-/* WebKitErrors.h
+/*
+ WebKitErrors.h
Copyright 2002, Apple, Inc. All rights reserved.
+
+ Public header file.
*/
// WebFoundation error codes < 10000
// WebKit error codes >= 10000
+/*!
+ @enum WebErrorCode
+ @constant WebErrorNoError
+ @constant WebErrorCannotFindFile
+ @constant WebErrorCannotCreateFile
+ @constant WebErrorCannotOpenFile
+ @constant WebErrorCannotReadFile
+ @constant WebErrorCannotWriteToFile
+ @constant WebErrorCannotRemoveFile
+ @constant WebErrorCannotFindApplicationForFile
+ @constant WebErrorFinderCannotOpenDirectory
+ @constant WebErrorCannotShowDirectory
+ @constant WebErrorCannotShowMIMEType
+ @constant WebErrorCannotShowURL
+ @constant WebErrorCannotNotFindApplicationForURL
+*/
typedef enum {
WebErrorNoError = 0,
WebErrorCannotFindFile = 10000,
diff --git a/WebKit/Panels.subproj/WebStandardPanels.h b/WebKit/Panels.subproj/WebStandardPanels.h
index fa0a19a..e377f35 100644
--- a/WebKit/Panels.subproj/WebStandardPanels.h
+++ b/WebKit/Panels.subproj/WebStandardPanels.h
@@ -1,27 +1,57 @@
/*
- WebStandardPanels.h
-
- Copyright 2002 Apple, Inc. All rights reserved.
+ WebStandardPanels.h
+ Copyright 2002 Apple, Inc. All rights reserved.
+
+ Public header file.
*/
#import <Cocoa/Cocoa.h>
@class WebStandardPanelsPrivate;
+/*!
+ @class WebStandardPanels
+*/
@interface WebStandardPanels : NSObject
{
@private
WebStandardPanelsPrivate *_privatePanels;
}
+/*!
+ @method sharedStandardPanels
+*/
+(WebStandardPanels *)sharedStandardPanels;
+/*!
+ @method setUseStandardAuthenticationPanel:
+ @param use
+*/
-(void)setUseStandardAuthenticationPanel:(BOOL)use;
+
+/*!
+ @method useStandardAuthenticationPanel
+*/
-(BOOL)useStandardAuthenticationPanel;
+/*!
+ @method didStartLoadingURL:inWindow:
+ @param URL
+ @param window
+*/
-(void)didStartLoadingURL:(NSURL *)URL inWindow:(NSWindow *)window;
+
+/*!
+ @method didStopLoadingURL:inWindow:
+ @param URL
+ @param window
+*/
-(void)didStopLoadingURL:(NSURL *)URL inWindow:(NSWindow *)window;
+/*!
+ @method frontmostWindowLoadingURL:
+ @param URL
+*/
-(NSWindow *)frontmostWindowLoadingURL:(NSURL *)URL;
@end
diff --git a/WebKit/WebKit.pbproj/project.pbxproj b/WebKit/WebKit.pbproj/project.pbxproj
index 7fbd658..fcc7885 100644
--- a/WebKit/WebKit.pbproj/project.pbxproj
+++ b/WebKit/WebKit.pbproj/project.pbxproj
@@ -570,6 +570,9 @@
fileRef = 35081D9202B6D4D80ACA2ACA;
isa = PBXBuildFile;
settings = {
+ ATTRIBUTES = (
+ Public,
+ );
};
};
35081D9D02B6D4D80ACA2ACA = {
@@ -584,6 +587,7 @@
settings = {
ATTRIBUTES = (
Private,
+ Public,
);
};
};
@@ -1146,6 +1150,9 @@
fileRef = 5130FC39033946E600CA2ACD;
isa = PBXBuildFile;
settings = {
+ ATTRIBUTES = (
+ Public,
+ );
};
};
//510
@@ -1174,6 +1181,9 @@
fileRef = 6523FACF032DA06B005EFCFF;
isa = PBXBuildFile;
settings = {
+ ATTRIBUTES = (
+ Public,
+ );
};
};
6523FAD2032DA06B005EFCFF = {
@@ -1512,7 +1522,7 @@
isa = PBXBuildFile;
settings = {
ATTRIBUTES = (
- Public,
+ Private,
);
};
};
@@ -1527,7 +1537,7 @@
isa = PBXBuildFile;
settings = {
ATTRIBUTES = (
- Public,
+ Private,
);
};
};
@@ -2369,7 +2379,7 @@
isa = PBXBuildFile;
settings = {
ATTRIBUTES = (
- Public,
+ Private,
);
};
};
diff --git a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
index a2b6674..49aee67 100644
--- a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
@@ -13,13 +13,13 @@
/*!
@enum WebPolicyAction
- @constant WebPolicyNone,
- @constant WebPolicyUse,
- @constant WebPolicyRevealInFinder,
- @constant WebPolicySave,
- @constant WebPolicyOpenURL,
- @constant WebPolicySaveAndOpen,
- @constant WebPolicyOpenNewWindow,
+ @constant WebPolicyNone
+ @constant WebPolicyUse
+ @constant WebPolicyRevealInFinder
+ @constant WebPolicySave
+ @constant WebPolicyOpenURL
+ @constant WebPolicySaveAndOpen
+ @constant WebPolicyOpenNewWindow
@constant WebPolicyIgnore
*/
typedef enum {
diff --git a/WebKit/WebView.subproj/WebControllerPolicyHandler.h b/WebKit/WebView.subproj/WebControllerPolicyHandler.h
index a2b6674..49aee67 100644
--- a/WebKit/WebView.subproj/WebControllerPolicyHandler.h
+++ b/WebKit/WebView.subproj/WebControllerPolicyHandler.h
@@ -13,13 +13,13 @@
/*!
@enum WebPolicyAction
- @constant WebPolicyNone,
- @constant WebPolicyUse,
- @constant WebPolicyRevealInFinder,
- @constant WebPolicySave,
- @constant WebPolicyOpenURL,
- @constant WebPolicySaveAndOpen,
- @constant WebPolicyOpenNewWindow,
+ @constant WebPolicyNone
+ @constant WebPolicyUse
+ @constant WebPolicyRevealInFinder
+ @constant WebPolicySave
+ @constant WebPolicyOpenURL
+ @constant WebPolicySaveAndOpen
+ @constant WebPolicyOpenNewWindow
@constant WebPolicyIgnore
*/
typedef enum {
diff --git a/WebKit/WebView.subproj/WebDataSource.h b/WebKit/WebView.subproj/WebDataSource.h
index 0a74f41..8788c25 100644
--- a/WebKit/WebView.subproj/WebDataSource.h
+++ b/WebKit/WebView.subproj/WebDataSource.h
@@ -173,12 +173,6 @@
- (BOOL)isDocumentHTML;
/*!
- @method documentSource
- @abstract Get the actual source of the document.
-*/
-- (NSString *)documentSource;
-
-/*!
@method base
@abstract URL reference point, these should probably not be public for 1.0.
*/
diff --git a/WebKit/WebView.subproj/WebDataSource.m b/WebKit/WebView.subproj/WebDataSource.m
index 7d2677c..05b962f 100644
--- a/WebKit/WebView.subproj/WebDataSource.m
+++ b/WebKit/WebView.subproj/WebDataSource.m
@@ -249,17 +249,6 @@
return [[self representation] isKindOfClass: [WebHTMLRepresentation class]];
}
-// Get the actual source of the docment.
-// FIXME: Move to WebHTMLRepresentation
-- (NSString *)documentSource
-{
- // FIMXE: Converting to string with ASCII encoding is not appropriate, although it works for some pages.
- if ([self isDocumentHTML]) {
- return [[[NSString alloc] initWithData:[self data] encoding:NSASCIIStringEncoding] autorelease];
- }
- return nil;
-}
-
// URL reference point, these should probably not be public for 1.0.
- (NSURL *)base
{
diff --git a/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h b/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
index 987bf0a..671f08f 100644
--- a/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
+++ b/WebKit/WebView.subproj/WebDefaultContextMenuDelegate.h
@@ -1,9 +1,8 @@
/*
WebDefaultContextMenuHandler.h
-
Copyright 2002, Apple, Inc. All rights reserved.
- Private header file.
+ Public header file.
*/
@@ -11,10 +10,21 @@
@protocol WebContextMenuHandler;
- at interface WebDefaultContextMenuHandler : NSObject <WebContextMenuHandler> {
+/*!
+ @class WebDefaultContextMenuHandler
+*/
+ at interface WebDefaultContextMenuHandler : NSObject <WebContextMenuHandler>
+{
NSDictionary *element;
}
+/*!
+ @method addMenuItemWithTitle:action:target:toArray:
+ @param title
+ @param selector
+ @param target
+ @param menuItems
+*/
+ (void)addMenuItemWithTitle:(NSString *)title action:(SEL)selector target:(id)target toArray:(NSMutableArray *)menuItems;
@end
diff --git a/WebKit/WebView.subproj/WebDefaultContextMenuHandler.h b/WebKit/WebView.subproj/WebDefaultContextMenuHandler.h
index 987bf0a..671f08f 100644
--- a/WebKit/WebView.subproj/WebDefaultContextMenuHandler.h
+++ b/WebKit/WebView.subproj/WebDefaultContextMenuHandler.h
@@ -1,9 +1,8 @@
/*
WebDefaultContextMenuHandler.h
-
Copyright 2002, Apple, Inc. All rights reserved.
- Private header file.
+ Public header file.
*/
@@ -11,10 +10,21 @@
@protocol WebContextMenuHandler;
- at interface WebDefaultContextMenuHandler : NSObject <WebContextMenuHandler> {
+/*!
+ @class WebDefaultContextMenuHandler
+*/
+ at interface WebDefaultContextMenuHandler : NSObject <WebContextMenuHandler>
+{
NSDictionary *element;
}
+/*!
+ @method addMenuItemWithTitle:action:target:toArray:
+ @param title
+ @param selector
+ @param target
+ @param menuItems
+*/
+ (void)addMenuItemWithTitle:(NSString *)title action:(SEL)selector target:(id)target toArray:(NSMutableArray *)menuItems;
@end
diff --git a/WebKit/WebView.subproj/WebFrameLoadDelegate.h b/WebKit/WebView.subproj/WebFrameLoadDelegate.h
index 8589124..b260cc0 100644
--- a/WebKit/WebView.subproj/WebFrameLoadDelegate.h
+++ b/WebKit/WebView.subproj/WebFrameLoadDelegate.h
@@ -11,50 +11,75 @@
@class WebDataSource;
@class WebFrame;
-/*
- =============================================================================
-
- WebLocationChangeHandlers track changes to a frame's location. This includes
- changes that may result in a download, or a resource being opened externally.
- rather than a change to the frame document.
-
- Handlers are created by WebController's provideLocationChangeHandlerForFrame:andURL:
- method.
-
- A location change that results in changing a frame's document will trigger the
- following messages, sent in order:
-
- - (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
- - (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
- // Only sent for the WebContentPolicyShow policy.
- - (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
-
- None of the WebLocationChangeHandler methods should block for any extended period
- of time.
-
- =============================================================================
+/*!
+ @protcol WebLocationChangeHandler
+ @abstract A controller's WebLocationChangeHandler track changes it's frame's location.
*/
-
@protocol WebLocationChangeHandler <NSObject>
+/*!
+ @method locationChangeStartedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeCommittedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeDone:forDataSource
+ @param error
+ @param dataSource
+*/
- (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method receivedPageTitle:forDataSource:
+ @param title
+ @param dataSource
+*/
- (void)receivedPageTitle:(NSString *)title forDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method receivedPageIcon:forDataSource:
+ @param image
+ @param dataSource
+*/
- (void)receivedPageIcon:(NSImage *)image forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method serverRedirectTo:forDataSource:
+ @param URL
+ @param dataSource
+*/
- (void)serverRedirectTo:(NSURL *)URL forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method clientRedirectTo:delay:fireDate:forFrame:
+ @param URL
+ @param seconds
+ @param date
+ @param frame
+*/
- (void)clientRedirectTo:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date forFrame:(WebFrame *)frame;
+
+/*!
+ @method clientRedirectCancelledForFrame:
+ @param frame
+*/
- (void)clientRedirectCancelledForFrame:(WebFrame *)frame;
@end
-// The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
-// methods by doing nothing. It's provided for the convenience of clients who only want
-// to implement some of the above methods and ignore others.
-
+/*!
+ @class WebLocationChangeHandler
+ @discussion The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
+ methods by doing nothing. It's provided for the convenience of clients who only want
+ to implement some of the above methods and ignore others.
+*/
@interface WebLocationChangeHandler : NSObject <WebLocationChangeHandler>
{
}
diff --git a/WebKit/WebView.subproj/WebHTMLRepresentation.h b/WebKit/WebView.subproj/WebHTMLRepresentation.h
index 69ef0e5..df9b31f 100644
--- a/WebKit/WebView.subproj/WebHTMLRepresentation.h
+++ b/WebKit/WebView.subproj/WebHTMLRepresentation.h
@@ -1,6 +1,8 @@
/*
- WebHTMLRepresentation.h
+ WebHTMLRepresentation.h
Copyright 2002, Apple, Inc. All rights reserved.
+
+ Public header file.
*/
#import <Foundation/Foundation.h>
@@ -8,8 +10,25 @@
@protocol WebDocumentRepresentation;
@class WebHTMLRepresentationPrivate;
+/*!
+ @class WebHTMLRepresentation
+*/
@interface WebHTMLRepresentation : NSObject <WebDocumentRepresentation>
{
WebHTMLRepresentationPrivate *_private;
}
+
+/*!
+ @method documentSource
+ @abstract Get the actual source of the document.
+*/
+- (NSString *)documentSource;
+
+/*!
+ @method documentSource
+ @abstract Get the current HTML reconstructed from the current state of the DOM.
+*/
+- (NSString *)reconstructedDocumentSource;
+
+
@end
diff --git a/WebKit/WebView.subproj/WebHTMLRepresentation.m b/WebKit/WebView.subproj/WebHTMLRepresentation.m
index 213106b..0502c1c 100644
--- a/WebKit/WebView.subproj/WebHTMLRepresentation.m
+++ b/WebKit/WebView.subproj/WebHTMLRepresentation.m
@@ -65,4 +65,19 @@
{
}
+- (NSString *)documentSource
+{
+
+ // FIMXE: Converting to string with ASCII encoding is not appropriate, although it works for some pages.
+ return [[[NSString alloc] initWithData:[[_private->bridge dataSource] data] encoding:NSASCIIStringEncoding] autorelease];
+}
+
+
+- (NSString *)reconstructedDocumentSource
+{
+ // FIXME implement
+ return @"";
+}
+
+
@end
diff --git a/WebKit/WebView.subproj/WebLoadProgress.h b/WebKit/WebView.subproj/WebLoadProgress.h
index aca1728..8fe5157 100644
--- a/WebKit/WebView.subproj/WebLoadProgress.h
+++ b/WebKit/WebView.subproj/WebLoadProgress.h
@@ -9,6 +9,9 @@
@class WebResourceHandle;
+/*!
+ @class WebLoadProgress
+*/
@interface WebLoadProgress : NSObject
{
int bytesSoFar; // 0 if this is the start of load
@@ -16,15 +19,50 @@
// bytesSoFar == totalLoaded when complete
}
-- (id)init; // both -1
+/*!
+ @method init
+*/
+- (id)init;
+
+/*!
+ @method initWithBytesSoFar:totalToLoad:
+ @param bytes
+ @param total
+*/
- (id)initWithBytesSoFar:(int)bytes totalToLoad:(int)total;
+
+/*!
+ @method initWithResourceHandle:
+ @param handle
+*/
- (id)initWithResourceHandle:(WebResourceHandle *)handle;
+/*!
+ @method progress
+*/
+ (WebLoadProgress *)progress; // both -1
+
+/*!
+ @method progressWithBytesSoFar:totalToLoad:
+ @param bytes
+ @param total
+*/
+ (WebLoadProgress *)progressWithBytesSoFar:(int)bytes totalToLoad:(int)total;
+
+/*!
+ @method progressWithResourceHandle:
+ @param handle
+*/
+ (WebLoadProgress *)progressWithResourceHandle:(WebResourceHandle *)handle;
+/*!
+ @method bytesSoFar:
+*/
- (int)bytesSoFar;
+
+/*!
+ @method totalToLoad:
+*/
- (int)totalToLoad;
@end
diff --git a/WebKit/WebView.subproj/WebLocationChangeDelegate.h b/WebKit/WebView.subproj/WebLocationChangeDelegate.h
index 8589124..b260cc0 100644
--- a/WebKit/WebView.subproj/WebLocationChangeDelegate.h
+++ b/WebKit/WebView.subproj/WebLocationChangeDelegate.h
@@ -11,50 +11,75 @@
@class WebDataSource;
@class WebFrame;
-/*
- =============================================================================
-
- WebLocationChangeHandlers track changes to a frame's location. This includes
- changes that may result in a download, or a resource being opened externally.
- rather than a change to the frame document.
-
- Handlers are created by WebController's provideLocationChangeHandlerForFrame:andURL:
- method.
-
- A location change that results in changing a frame's document will trigger the
- following messages, sent in order:
-
- - (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
- - (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
- // Only sent for the WebContentPolicyShow policy.
- - (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
-
- None of the WebLocationChangeHandler methods should block for any extended period
- of time.
-
- =============================================================================
+/*!
+ @protcol WebLocationChangeHandler
+ @abstract A controller's WebLocationChangeHandler track changes it's frame's location.
*/
-
@protocol WebLocationChangeHandler <NSObject>
+/*!
+ @method locationChangeStartedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeCommittedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeDone:forDataSource
+ @param error
+ @param dataSource
+*/
- (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method receivedPageTitle:forDataSource:
+ @param title
+ @param dataSource
+*/
- (void)receivedPageTitle:(NSString *)title forDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method receivedPageIcon:forDataSource:
+ @param image
+ @param dataSource
+*/
- (void)receivedPageIcon:(NSImage *)image forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method serverRedirectTo:forDataSource:
+ @param URL
+ @param dataSource
+*/
- (void)serverRedirectTo:(NSURL *)URL forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method clientRedirectTo:delay:fireDate:forFrame:
+ @param URL
+ @param seconds
+ @param date
+ @param frame
+*/
- (void)clientRedirectTo:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date forFrame:(WebFrame *)frame;
+
+/*!
+ @method clientRedirectCancelledForFrame:
+ @param frame
+*/
- (void)clientRedirectCancelledForFrame:(WebFrame *)frame;
@end
-// The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
-// methods by doing nothing. It's provided for the convenience of clients who only want
-// to implement some of the above methods and ignore others.
-
+/*!
+ @class WebLocationChangeHandler
+ @discussion The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
+ methods by doing nothing. It's provided for the convenience of clients who only want
+ to implement some of the above methods and ignore others.
+*/
@interface WebLocationChangeHandler : NSObject <WebLocationChangeHandler>
{
}
diff --git a/WebKit/WebView.subproj/WebLocationChangeHandler.h b/WebKit/WebView.subproj/WebLocationChangeHandler.h
index 8589124..b260cc0 100644
--- a/WebKit/WebView.subproj/WebLocationChangeHandler.h
+++ b/WebKit/WebView.subproj/WebLocationChangeHandler.h
@@ -11,50 +11,75 @@
@class WebDataSource;
@class WebFrame;
-/*
- =============================================================================
-
- WebLocationChangeHandlers track changes to a frame's location. This includes
- changes that may result in a download, or a resource being opened externally.
- rather than a change to the frame document.
-
- Handlers are created by WebController's provideLocationChangeHandlerForFrame:andURL:
- method.
-
- A location change that results in changing a frame's document will trigger the
- following messages, sent in order:
-
- - (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
- - (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
- // Only sent for the WebContentPolicyShow policy.
- - (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
-
- None of the WebLocationChangeHandler methods should block for any extended period
- of time.
-
- =============================================================================
+/*!
+ @protcol WebLocationChangeHandler
+ @abstract A controller's WebLocationChangeHandler track changes it's frame's location.
*/
-
@protocol WebLocationChangeHandler <NSObject>
+/*!
+ @method locationChangeStartedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeStartedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeCommittedForDataSource:
+ @param dataSource
+*/
- (void)locationChangeCommittedForDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method locationChangeDone:forDataSource
+ @param error
+ @param dataSource
+*/
- (void)locationChangeDone:(WebError *)error forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method receivedPageTitle:forDataSource:
+ @param title
+ @param dataSource
+*/
- (void)receivedPageTitle:(NSString *)title forDataSource:(WebDataSource *)dataSource;
+
+/*!
+ @method receivedPageIcon:forDataSource:
+ @param image
+ @param dataSource
+*/
- (void)receivedPageIcon:(NSImage *)image forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method serverRedirectTo:forDataSource:
+ @param URL
+ @param dataSource
+*/
- (void)serverRedirectTo:(NSURL *)URL forDataSource:(WebDataSource *)dataSource;
+/*!
+ @method clientRedirectTo:delay:fireDate:forFrame:
+ @param URL
+ @param seconds
+ @param date
+ @param frame
+*/
- (void)clientRedirectTo:(NSURL *)URL delay:(NSTimeInterval)seconds fireDate:(NSDate *)date forFrame:(WebFrame *)frame;
+
+/*!
+ @method clientRedirectCancelledForFrame:
+ @param frame
+*/
- (void)clientRedirectCancelledForFrame:(WebFrame *)frame;
@end
-// The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
-// methods by doing nothing. It's provided for the convenience of clients who only want
-// to implement some of the above methods and ignore others.
-
+/*!
+ @class WebLocationChangeHandler
+ @discussion The WebLocationChangeHandler class responds to all WebLocationChangeHandler protocol
+ methods by doing nothing. It's provided for the convenience of clients who only want
+ to implement some of the above methods and ignore others.
+*/
@interface WebLocationChangeHandler : NSObject <WebLocationChangeHandler>
{
}
diff --git a/WebKit/WebView.subproj/WebPolicyDelegate.h b/WebKit/WebView.subproj/WebPolicyDelegate.h
index a2b6674..49aee67 100644
--- a/WebKit/WebView.subproj/WebPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebPolicyDelegate.h
@@ -13,13 +13,13 @@
/*!
@enum WebPolicyAction
- @constant WebPolicyNone,
- @constant WebPolicyUse,
- @constant WebPolicyRevealInFinder,
- @constant WebPolicySave,
- @constant WebPolicyOpenURL,
- @constant WebPolicySaveAndOpen,
- @constant WebPolicyOpenNewWindow,
+ @constant WebPolicyNone
+ @constant WebPolicyUse
+ @constant WebPolicyRevealInFinder
+ @constant WebPolicySave
+ @constant WebPolicyOpenURL
+ @constant WebPolicySaveAndOpen
+ @constant WebPolicyOpenNewWindow
@constant WebPolicyIgnore
*/
typedef enum {
diff --git a/WebKit/WebView.subproj/WebPreferences.h b/WebKit/WebView.subproj/WebPreferences.h
index efbf3f4..ab6b40c 100644
--- a/WebKit/WebView.subproj/WebPreferences.h
+++ b/WebKit/WebView.subproj/WebPreferences.h
@@ -7,81 +7,225 @@
#import <Foundation/Foundation.h>
+/*!
+ @class WebPreferences
+*/
@interface WebPreferences: NSObject
+/*!
+ @method standardPreferences
+*/
+ (WebPreferences *)standardPreferences;
+/*!
+ @method standardFontFamily
+*/
- (NSString *)standardFontFamily;
+
+/*!
+ @method setStandardFontFamily:
+ @param family
+*/
- (void)setStandardFontFamily:(NSString *)family;
+/*!
+ @method fixedFontFamily
+*/
- (NSString *)fixedFontFamily;
+
+/*!
+ @method setFixedFontFamily:
+ @param family
+*/
- (void)setFixedFontFamily:(NSString *)family;
+/*!
+ @method serifFontFamily
+*/
- (NSString *)serifFontFamily;
+
+/*!
+ @method setSerifFontFamily:
+ @param family
+*/
- (void)setSerifFontFamily:(NSString *)family;
+/*!
+ @method sansSerifFontFamily
+*/
- (NSString *)sansSerifFontFamily;
+
+/*!
+ @method setSansSerifFontFamily:
+ @param family
+*/
- (void)setSansSerifFontFamily:(NSString *)family;
+/*!
+ @method cursiveFontFamily
+*/
- (NSString *)cursiveFontFamily;
+
+/*!
+ @method setCursiveFontFamily:
+ @param family
+*/
- (void)setCursiveFontFamily:(NSString *)family;
+/*!
+ @method fantasyFontFamily
+*/
- (NSString *)fantasyFontFamily;
+
+/*!
+ @method setFantasyFontFamily:
+ @param family
+*/
- (void)setFantasyFontFamily:(NSString *)family;
+/*!
+ @method defaultFontSize
+*/
- (int)defaultFontSize;
+
+/*!
+ @method setDefaultFontSize:
+ @param size
+*/
- (void)setDefaultFontSize:(int)size;
+/*!
+ @method defaultFixedFontSize
+*/
- (int)defaultFixedFontSize;
+
+/*!
+ @method setDefaultFixedFontSize:
+ @param size
+*/
- (void)setDefaultFixedFontSize:(int)size;
+/*!
+ @method minimumFontSize
+*/
- (int)minimumFontSize;
+
+/*!
+ @method setMinimumFontSize:
+ @param size
+*/
- (void)setMinimumFontSize:(int)size;
+/*!
+ @method defaultTextEncoding
+*/
- (CFStringEncoding)defaultTextEncoding;
+
+/*!
+ @method setDefaultTextEncoding:
+ @param encoding
+*/
- (void)setDefaultTextEncoding:(CFStringEncoding)encoding;
+/*!
+ @method userStyleSheetEnabled
+*/
- (BOOL)userStyleSheetEnabled;
+
+/*!
+ @method setUserStyleSheetEnabled:
+ @param flag
+*/
- (void)setUserStyleSheetEnabled:(BOOL)flag;
-// The user style sheet is stored as a URL string, e.g. "file://<etc>"
+/*!
+ @method userStyleSheetLocation
+ @discussion The user style sheet is stored as a URL string, e.g. "file://<etc>"
+*/
- (NSString *)userStyleSheetLocation;
+
+/*!
+ @method setUserStyleSheetLocation:
+ @param string
+*/
- (void)setUserStyleSheetLocation:(NSString *)string;
+/*!
+ @method JavaEnabled
+*/
- (BOOL)JavaEnabled;
+
+/*!
+ @method setJavaEnabled:
+ @param flag
+*/
- (void)setJavaEnabled:(BOOL)flag;
+/*!
+ @method JavaScriptEnabled
+*/
- (BOOL)JavaScriptEnabled;
+
+/*!
+ @method setJavaScriptEnabled:
+ @param flag
+*/
- (void)setJavaScriptEnabled:(BOOL)flag;
+/*!
+ @method JavaScriptCanOpenWindowsAutomatically
+*/
- (BOOL)JavaScriptCanOpenWindowsAutomatically;
+
+/*!
+ @method setJavaScriptCanOpenWindowsAutomatically:
+ @param flag
+*/
- (void)setJavaScriptCanOpenWindowsAutomatically:(BOOL)flag;
+/*!
+ @method pluginsEnabled
+*/
- (BOOL)pluginsEnabled;
+
+/*!
+ @method setJavaScriptCanOpenWindowsAutomatically:
+ @param flag
+*/
- (void)setPluginsEnabled:(BOOL)flag;
+/*!
+ @method allowAnimatedImages
+*/
- (BOOL)allowAnimatedImages;
+
+/*!
+ @method setAllowAnimatedImages:
+ @param flag
+*/
- (void)setAllowAnimatedImages:(BOOL)flag;
+/*!
+ @method allowAnimatedImageLooping
+*/
- (BOOL)allowAnimatedImageLooping;
+
+/*!
+ @method setAllowAnimatedImageLooping:
+ @param flag
+*/
- (void)setAllowAnimatedImageLooping: (BOOL)flag;
+/*!
+ @method setWillLoadImagesAutomatically:
+ @param flag
+*/
- (void)setWillLoadImagesAutomatically: (BOOL)flag;
-- (BOOL)willLoadImagesAutomatically;
-
- at end
-#ifdef READY_FOR_PRIMETIME
-- setRefreshEnabled: (BOOL)flag;
-- (BOOL)refreshEnabled;
-
-/*
- Specify whether only local references ( stylesheets, images, scripts, subdocuments )
- should be loaded. ( default false - everything is loaded, if the more specific
- options allow )
- This is carried over from KDE.
+/*!
+ @method willLoadImagesAutomatically:
+ @param flag
*/
-- (void)setOnlyLocalReferences: (BOOL)flag;
-- (BOOL)onlyLocalReferences;
+- (BOOL)willLoadImagesAutomatically;
-#endif
+ at end
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list