[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677
mjs
mjs at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 06:43:00 UTC 2009
The following commit has been merged in the debian/unstable branch:
commit 0ac24d5c85dbbf7df64fd2863b4387991fb6ee2e
Author: mjs <mjs at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Mon Sep 23 21:36:17 2002 +0000
* WebView.subproj/WebWindowContext.h: Added inline header docs.
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@2126 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index 9053291..2222a40 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,7 @@
+2002-09-23 Maciej Stachowiak <mjs at apple.com>
+
+ * WebView.subproj/WebWindowContext.h: Added inline header docs.
+
2002-09-23 Ken Kocienda <kocienda at apple.com>
Fixes for some build problems I missed earlier due to the fact that PB can't handle header dependencies,
diff --git a/WebKit/ChangeLog-2002-12-03 b/WebKit/ChangeLog-2002-12-03
index 9053291..2222a40 100644
--- a/WebKit/ChangeLog-2002-12-03
+++ b/WebKit/ChangeLog-2002-12-03
@@ -1,3 +1,7 @@
+2002-09-23 Maciej Stachowiak <mjs at apple.com>
+
+ * WebView.subproj/WebWindowContext.h: Added inline header docs.
+
2002-09-23 Ken Kocienda <kocienda at apple.com>
Fixes for some build problems I missed earlier due to the fact that PB can't handle header dependencies,
diff --git a/WebKit/WebView.subproj/WebUIDelegate.h b/WebKit/WebView.subproj/WebUIDelegate.h
index a9e8c27..e3ec909 100644
--- a/WebKit/WebView.subproj/WebUIDelegate.h
+++ b/WebKit/WebView.subproj/WebUIDelegate.h
@@ -11,61 +11,87 @@
/*!
@protocol WebWindowContext
- @discussion A class that implements WebWindowContext provides window-related methods
- that may be used by Javascript, plugins and other aspects of web pages.
+ @discussion A class that implements WebWindowContext provides
+ window-related methods that may be used by Javascript, plugins and
+ other aspects of web pages. These methods are used to open new
+ windows and control aspects of existing windows.
*/
@protocol WebWindowContext <NSObject>
/*!
@method openNewWindowWithURL:referrer:
- @param URL
- @param referrer
+ @abstract Open a new window and load the specified URL.
+ @param URL The URL to load.
+ @param referrer The referrer to use when loading the URL.
+ @result The WebController for the WebView in the new window.
*/
- (WebController *)openNewWindowWithURL:(NSURL *)URL referrer:(NSString *)referrer;
/*!
@method setStatusText:
- @param text
+ @abstract Set the window's status display, if any, to the specified string.
+ @param text The status text to set
*/
- (void)setStatusText:(NSString *)text;
/*!
@method statusText
+ @abstract Get the currently displayed status text.
+ @result The status text
*/
- (NSString *)statusText;
/*!
@method areToolbarsVisible
+ @abstract Determine whether the window's toolbars are currently visible
+ @discussion This method should return true if the window has any
+ toolbars that are currently on, besides the status bar. If the app
+ has more than one toolbar per window, for example a regular
+ command toolbar and a favorites bar, it should return YES from
+ this method if at least one is on.
+ @result YES if at least one toolbar is visible, otherwise NO.
*/
- (BOOL)areToolbarsVisible;
/*!
@method setToolbarsVisible:
- @param visible
+ @abstract Set whether the window's toolbars are currently visible.
+ @param visible New value for toolbar visibility
+ @discussion Setting this to YES should turn on all toolbars
+ (except for a possible status bar). Setting it to NO should turn
+ off all toolbars (with the same exception).
*/
- (void)setToolbarsVisible:(BOOL)visible;
/*!
@method isStatusBarVisible
+ @abstract Determine whether the status bar is visible.
+ @result YES if the status bar is visible, otherwise NO.
*/
- (BOOL)isStatusBarVisible;
/*!
@method setStatusBarVisible:
- @param visible
+ @abstract Set whether the status bar is currently visible.
+ @param visible The new visibility value
+ @discussion Setting this to YES should show the status bar,
+ setting it to NO should hide it.
*/
- (void)setStatusBarVisible:(BOOL)visible;
/*!
@method setFrame:
+ @abstract Set the window's frame rect
+ @param frame The new window frame size
@discussion Even though a caller could set the frame directly using the NSWindow,
this method is provided so implementors of this protocol can do special
things on programmatic move/resize, like avoiding autosaving of the size.
- @param frame
*/
- (void)setFrame:(NSRect)frame;
/*!
@method window
+ @abstract Get the NSWindow that contains the top-level view of the WebController
+ @result The NSWindow corresponding to this WebController
*/
- (NSWindow *)window;
diff --git a/WebKit/WebView.subproj/WebWindowContext.h b/WebKit/WebView.subproj/WebWindowContext.h
index a9e8c27..e3ec909 100644
--- a/WebKit/WebView.subproj/WebWindowContext.h
+++ b/WebKit/WebView.subproj/WebWindowContext.h
@@ -11,61 +11,87 @@
/*!
@protocol WebWindowContext
- @discussion A class that implements WebWindowContext provides window-related methods
- that may be used by Javascript, plugins and other aspects of web pages.
+ @discussion A class that implements WebWindowContext provides
+ window-related methods that may be used by Javascript, plugins and
+ other aspects of web pages. These methods are used to open new
+ windows and control aspects of existing windows.
*/
@protocol WebWindowContext <NSObject>
/*!
@method openNewWindowWithURL:referrer:
- @param URL
- @param referrer
+ @abstract Open a new window and load the specified URL.
+ @param URL The URL to load.
+ @param referrer The referrer to use when loading the URL.
+ @result The WebController for the WebView in the new window.
*/
- (WebController *)openNewWindowWithURL:(NSURL *)URL referrer:(NSString *)referrer;
/*!
@method setStatusText:
- @param text
+ @abstract Set the window's status display, if any, to the specified string.
+ @param text The status text to set
*/
- (void)setStatusText:(NSString *)text;
/*!
@method statusText
+ @abstract Get the currently displayed status text.
+ @result The status text
*/
- (NSString *)statusText;
/*!
@method areToolbarsVisible
+ @abstract Determine whether the window's toolbars are currently visible
+ @discussion This method should return true if the window has any
+ toolbars that are currently on, besides the status bar. If the app
+ has more than one toolbar per window, for example a regular
+ command toolbar and a favorites bar, it should return YES from
+ this method if at least one is on.
+ @result YES if at least one toolbar is visible, otherwise NO.
*/
- (BOOL)areToolbarsVisible;
/*!
@method setToolbarsVisible:
- @param visible
+ @abstract Set whether the window's toolbars are currently visible.
+ @param visible New value for toolbar visibility
+ @discussion Setting this to YES should turn on all toolbars
+ (except for a possible status bar). Setting it to NO should turn
+ off all toolbars (with the same exception).
*/
- (void)setToolbarsVisible:(BOOL)visible;
/*!
@method isStatusBarVisible
+ @abstract Determine whether the status bar is visible.
+ @result YES if the status bar is visible, otherwise NO.
*/
- (BOOL)isStatusBarVisible;
/*!
@method setStatusBarVisible:
- @param visible
+ @abstract Set whether the status bar is currently visible.
+ @param visible The new visibility value
+ @discussion Setting this to YES should show the status bar,
+ setting it to NO should hide it.
*/
- (void)setStatusBarVisible:(BOOL)visible;
/*!
@method setFrame:
+ @abstract Set the window's frame rect
+ @param frame The new window frame size
@discussion Even though a caller could set the frame directly using the NSWindow,
this method is provided so implementors of this protocol can do special
things on programmatic move/resize, like avoiding autosaving of the size.
- @param frame
*/
- (void)setFrame:(NSRect)frame;
/*!
@method window
+ @abstract Get the NSWindow that contains the top-level view of the WebController
+ @result The NSWindow corresponding to this WebController
*/
- (NSWindow *)window;
diff --git a/WebKit/WebView.subproj/WebWindowOperationsDelegate.h b/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
index a9e8c27..e3ec909 100644
--- a/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
+++ b/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
@@ -11,61 +11,87 @@
/*!
@protocol WebWindowContext
- @discussion A class that implements WebWindowContext provides window-related methods
- that may be used by Javascript, plugins and other aspects of web pages.
+ @discussion A class that implements WebWindowContext provides
+ window-related methods that may be used by Javascript, plugins and
+ other aspects of web pages. These methods are used to open new
+ windows and control aspects of existing windows.
*/
@protocol WebWindowContext <NSObject>
/*!
@method openNewWindowWithURL:referrer:
- @param URL
- @param referrer
+ @abstract Open a new window and load the specified URL.
+ @param URL The URL to load.
+ @param referrer The referrer to use when loading the URL.
+ @result The WebController for the WebView in the new window.
*/
- (WebController *)openNewWindowWithURL:(NSURL *)URL referrer:(NSString *)referrer;
/*!
@method setStatusText:
- @param text
+ @abstract Set the window's status display, if any, to the specified string.
+ @param text The status text to set
*/
- (void)setStatusText:(NSString *)text;
/*!
@method statusText
+ @abstract Get the currently displayed status text.
+ @result The status text
*/
- (NSString *)statusText;
/*!
@method areToolbarsVisible
+ @abstract Determine whether the window's toolbars are currently visible
+ @discussion This method should return true if the window has any
+ toolbars that are currently on, besides the status bar. If the app
+ has more than one toolbar per window, for example a regular
+ command toolbar and a favorites bar, it should return YES from
+ this method if at least one is on.
+ @result YES if at least one toolbar is visible, otherwise NO.
*/
- (BOOL)areToolbarsVisible;
/*!
@method setToolbarsVisible:
- @param visible
+ @abstract Set whether the window's toolbars are currently visible.
+ @param visible New value for toolbar visibility
+ @discussion Setting this to YES should turn on all toolbars
+ (except for a possible status bar). Setting it to NO should turn
+ off all toolbars (with the same exception).
*/
- (void)setToolbarsVisible:(BOOL)visible;
/*!
@method isStatusBarVisible
+ @abstract Determine whether the status bar is visible.
+ @result YES if the status bar is visible, otherwise NO.
*/
- (BOOL)isStatusBarVisible;
/*!
@method setStatusBarVisible:
- @param visible
+ @abstract Set whether the status bar is currently visible.
+ @param visible The new visibility value
+ @discussion Setting this to YES should show the status bar,
+ setting it to NO should hide it.
*/
- (void)setStatusBarVisible:(BOOL)visible;
/*!
@method setFrame:
+ @abstract Set the window's frame rect
+ @param frame The new window frame size
@discussion Even though a caller could set the frame directly using the NSWindow,
this method is provided so implementors of this protocol can do special
things on programmatic move/resize, like avoiding autosaving of the size.
- @param frame
*/
- (void)setFrame:(NSRect)frame;
/*!
@method window
+ @abstract Get the NSWindow that contains the top-level view of the WebController
+ @result The NSWindow corresponding to this WebController
*/
- (NSWindow *)window;
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list