Attachment 46297 Details for Bug 33484 – Add and cleanup return values

[patch] Add and cleanup return values

webview-signals-return.diff (text/plain), 12.50 KB, created by Christian Dywan on 2010-01-11 12:16:28 PST

(hide)

Description:

Filename:

MIME Type:

Creator: Christian Dywan

Created: 2010-01-11 12:16:28 PST

Size: 12.50 KB

patch

obsolete

>diff --git a/WebKit/gtk/webkit/webkitwebframe.cpp b/WebKit/gtk/webkit/webkitwebframe.cpp
>index ed23f13..7a5fa75 100644
>--- a/WebKit/gtk/webkit/webkitwebframe.cpp
>+++ b/WebKit/gtk/webkit/webkitwebframe.cpp
>@@ -269,6 +269,9 @@ static void webkit_web_frame_class_init(WebKitWebFrameClass* frameClass)
>      * WebKitWebFrame:horizontal-scrollbar-policy and
>      * WebKitWebFrame:vertical-scrollbar-policy properties.
>      *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>+     *
>      * Since: 1.1.14
>      */
>     webkit_web_frame_signals[SCROLLBARS_POLICY_CHANGED] = g_signal_new("scrollbars-policy-changed",
>diff --git a/WebKit/gtk/webkit/webkitwebview.cpp b/WebKit/gtk/webkit/webkitwebview.cpp
>index 2d2e6e7..7daca4e 100644
>--- a/WebKit/gtk/webkit/webkitwebview.cpp
>+++ b/WebKit/gtk/webkit/webkitwebview.cpp
>@@ -1290,7 +1290,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * WebKitWebView::create-web-view:
>      * @web_view: the object on which the signal is emitted
>      * @frame: the #WebKitWebFrame
>-     * @return: a newly allocated #WebKitWebView or %NULL
>      *
>      * Emitted when the creation of a new window is requested.
>      * If this signal is handled the signal handler should return the
>@@ -1303,6 +1302,8 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * the new #WebKitWebView. The widget to which the widget is added will
>      * handle that.
>      *
>+     * Return value: a newly allocated #WebKitWebView, or %NULL
>+     *
>      * Since: 1.0.3
>      */
>     webkit_web_view_signals[CREATE_WEB_VIEW] = g_signal_new("create-web-view",
>@@ -1318,8 +1319,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>     /**
>      * WebKitWebView::web-view-ready:
>      * @web_view: the object on which the signal is emitted
>-     * @return: %TRUE to stop other handlers from being invoked for
>-     * the event, %FALSE to propagate the event further
>      *
>      * Emitted after #WebKitWebView::create-web-view when the new #WebKitWebView
>      * should be displayed to the user. When this signal is emitted
>@@ -1332,6 +1331,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * time of the window, so you may want to connect to the ::notify
>      * signal of the #WebKitWebWindowFeatures object to handle those.
>      *
>+     * Return value: %TRUE to stop handlers from being invoked for the event or
>+     * %FALSE to propagate the event furter
>+     *
>      * Since: 1.0.3
>      */
>     webkit_web_view_signals[WEB_VIEW_READY] = g_signal_new("web-view-ready",
>@@ -1346,14 +1348,16 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>     /**
>      * WebKitWebView::close-web-view:
>      * @web_view: the object on which the signal is emitted
>-     * @return: %TRUE to stop handlers from being invoked for the event or
>-     * %FALSE to propagate the event furter
>      *
>      * Emitted when closing a #WebKitWebView is requested. This occurs when a
>      * call is made from JavaScript's window.close function. The default
>      * signal handler does not do anything. It is the owner's responsibility
>      * to hide or delete the web view, if necessary.
>      *
>+     *
>+     * Return value: %TRUE to stop handlers from being invoked for the event or
>+     * %FALSE to propagate the event furter
>+     *
>      * Since: 1.1.11
>      */
>     webkit_web_view_signals[CLOSE_WEB_VIEW] = g_signal_new("close-web-view",
>@@ -1370,10 +1374,11 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @web_view: the object on which the signal is emitted
>      * @frame: the #WebKitWebFrame that required the navigation
>      * @request: a #WebKitNetworkRequest
>-     * @return: a WebKitNavigationResponse
>      *
>      * Emitted when @frame requests a navigation to another page.
>      *
>+     * * Return value: a #WebKitNavigationResponse
>+     *
>      * Deprecated: Use WebKitWebView::navigation-policy-decision-requested
>      * instead
>      */
>@@ -1395,8 +1400,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @request: a #WebKitNetworkRequest
>      * @navigation_action: a #WebKitWebNavigation
>      * @policy_decision: a #WebKitWebPolicyDecision
>-     * @return: TRUE if a decision was made, FALSE to have the
>-     *          default behavior apply
>      *
>      * Emitted when @frame requests opening a new window. With this
>      * signal the browser can use the context of the request to decide
>@@ -1418,6 +1421,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * webkit_web_policy_decision_download() on the @policy_decision
>      * object.
>      *
>+     * Return value: %TRUE if a decision was made, %FALSE to have the
>+     * default behavior apply
>+     *
>      * Since: 1.1.4
>      */
>     webkit_web_view_signals[NEW_WINDOW_POLICY_DECISION_REQUESTED] =
>@@ -1441,8 +1447,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @request: a #WebKitNetworkRequest
>      * @navigation_action: a #WebKitWebNavigation
>      * @policy_decision: a #WebKitWebPolicyDecision
>-     * @return: TRUE if a decision was made, FALSE to have the
>-     *          default behavior apply
>      *
>      * Emitted when @frame requests a navigation to another page.
>      * If this signal is not handled, the default behavior is to allow the
>@@ -1455,6 +1459,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * webkit_web_policy_decision_download() on the @policy_decision
>      * object.
>      *
>+     * Return value: %TRUE if a decision was made, %FALSE to have the
>+     * default behavior apply
>+     *
>      * Since: 1.0.3
>      */
>     webkit_web_view_signals[NAVIGATION_POLICY_DECISION_REQUESTED] = g_signal_new("navigation-policy-decision-requested",
>@@ -1477,8 +1484,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @request: a WebKitNetworkRequest
>      * @mimetype: the MIME type attempted to load
>      * @policy_decision: a #WebKitWebPolicyDecision
>-     * @return: TRUE if a decision was made, FALSE to have the
>-     *          default behavior apply
>      *
>      * Decide whether or not to display the given MIME type.  If this
>      * signal is not handled, the default behavior is to show the
>@@ -1496,6 +1501,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * webkit_web_policy_decision_download() on the @policy_decision
>      * object.
>      *
>+     * Return value: %TRUE if a decision was made, %FALSE to have the
>+     * default behavior apply
>+     *
>      * Since: 1.0.3
>      */
>     webkit_web_view_signals[MIME_TYPE_POLICY_DECISION_REQUESTED] = g_signal_new("mime-type-policy-decision-requested",
>@@ -1543,7 +1551,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @web_view: the object on which the signal is emitted
>      * @download: a #WebKitDownload object that lets you control the
>      * download process
>-     * @return: %TRUE if the download should be performed, %FALSE to cancel it.
>      *
>      * A new Download is being requested. By default, if the signal is
>      * not handled, the download is cancelled. If you handle the download
>@@ -1566,6 +1573,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * is to download anything that WebKit can't handle, which you can
>      * figure out by using webkit_web_view_can_show_mime_type()).
>      *
>+     * Return value: TRUE if the download should be performed, %FALSE to
>+     * cancel it
>+     *
>      * Since: 1.1.2
>      */
>     webkit_web_view_signals[DOWNLOAD_REQUESTED] = g_signal_new("download-requested",
>@@ -1646,6 +1656,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * handle the signal if you want to provide your own error page.
>      *
>      * Since: 1.1.6
>+     *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>      */
>     webkit_web_view_signals[LOAD_ERROR] = g_signal_new("load-error",
>             G_TYPE_FROM_CLASS(webViewClass),
>@@ -1739,8 +1752,6 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * WebKitWebView::print-requested
>      * @web_view: the object in which the signal is emitted
>      * @web_frame: the frame that is requesting to be printed
>-     * @return: %TRUE if the print request has been handled, %FALSE if
>-     * the default handler should run
>      *
>      * Emitted when printing is requested by the frame, usually
>      * because of a javascript call. When handling this signal you
>@@ -1752,6 +1763,9 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * ignore a print request you must connect to this signal, and
>      * return %TRUE.
>      *
>+     * Return value: %TRUE if the print request has been handled, %FALSE if
>+     * the default handler should run
>+     *
>      * Since: 1.1.5
>      */
>     webkit_web_view_signals[PRINT_REQUESTED] = g_signal_new("print-requested",
>@@ -1808,9 +1822,11 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @message: the message text
>      * @line: the line where the error occured
>      * @source_id: the source id
>-     * @return: TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
>      *
>      * A JavaScript console message was created.
>+     *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>      */
>     webkit_web_view_signals[CONSOLE_MESSAGE] = g_signal_new("console-message",
>             G_TYPE_FROM_CLASS(webViewClass),
>@@ -1827,9 +1843,11 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @web_view: the object on which the signal is emitted
>      * @frame: the relevant frame
>      * @message: the message text
>-     * @return: TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
>      *
>      * A JavaScript alert dialog was created.
>+     *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>      */
>     webkit_web_view_signals[SCRIPT_ALERT] = g_signal_new("script-alert",
>             G_TYPE_FROM_CLASS(webViewClass),
>@@ -1847,9 +1865,11 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @frame: the relevant frame
>      * @message: the message text
>      * @confirmed: whether the dialog has been confirmed
>-     * @return: TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
>      *
>      * A JavaScript confirm dialog was created, providing Yes and No buttons.
>+     *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>      */
>     webkit_web_view_signals[SCRIPT_CONFIRM] = g_signal_new("script-confirm",
>             G_TYPE_FROM_CLASS(webViewClass),
>@@ -1868,9 +1888,11 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * @message: the message text
>      * @default: the default value
>      * @text: To be filled with the return value or NULL if the dialog was cancelled.
>-     * @return: TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further.
>      *
>      * A JavaScript prompt dialog was created, providing an entry to input text.
>+     *
>+     * Return value: %TRUE to stop other handlers from being invoked for the
>+     * event. %FALSE to propagate the event further.
>      */
>     webkit_web_view_signals[SCRIPT_PROMPT] = g_signal_new("script-prompt",
>             G_TYPE_FROM_CLASS(webViewClass),
>@@ -1997,6 +2019,10 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      *
>      * The #WebKitWebView::move-cursor will be emitted to apply the
>      * cursor movement described by its parameters to the @view.
>+     *
>+     * The return value has no practical meaning.
>+     *
>+     * Return value: %TRUE or %FALSE
>      * 
>      * Since: 1.1.4
>      */
>@@ -2024,6 +2050,8 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
>      * to set the property value of "webkit-widget-is-selected". This can
>      * be used to draw a visual indicator of the selection.
>      *
>+     * Return value: a new #GtkWidget, or %NULL
>+     *
>      * Since: 1.1.8
>      */
>     webkit_web_view_signals[PLUGIN_WIDGET] = g_signal_new("create-plugin-widget",

Flags:

gustavo: review+

Actions: View | Formatted Diff | Diff

Attachments on bug 33484: 46297