ACTION-3307: Will stub out suspendRedraw, unsuspendRedraw, unsuspendRedrawAll - return value must be specified.
--- a/master/changes.html Sat Jun 16 21:34:12 2012 -0700
+++ b/master/changes.html Thu Jun 28 18:06:37 2012 +0200
@@ -41,6 +41,12 @@
<li>References to the SVG DTD have been removed.</li>
</ul>
+<h3 id="structure">Document Structure chapter</h3>
+
+<ul>
+ <li>Deprecated the <code>suspendRedraw</code>, <code>unsuspendRedraw</code> and <code>unsuspendRedrawAll</code> methods in the SVGSVGElement interface.</li>
+</ul>
+
<h3 id="styling">Styling chapter</h3>
<ul>
--- a/master/svg.idl Sat Jun 16 21:34:12 2012 -0700
+++ b/master/svg.idl Thu Jun 28 18:06:37 2012 +0200
@@ -2118,50 +2118,28 @@
readonly attribute SVGPoint currentTranslate;
/**
- * Takes a time-out value which indicates that redraw shall not occur until:
- * <ol>
- * <li>the corresponding unsuspendRedraw() call has been made,</li>
- * <li>an unsuspendRedrawAll() call has been made, or</li>
- * <li>its timer has timed out.</li>
- * </ol>
- * <p>In environments that do not support interactivity (e.g., print media),
- * then redraw shall not be suspended.
- * Calls to suspendRedraw() and unsuspendRedraw() should, but need not be,
- * made in balanced pairs.</p>
- * <p>To suspend redraw actions as a collection of SVG DOM changes occur,
- * precede the changes to the SVG DOM with a method call similar to:</p>
- * <pre>suspendHandleID = suspendRedraw(maxWaitMilliseconds);</pre>
- * <p>and follow the changes with a method call similar to:</p>
- * <pre>unsuspendRedraw(suspendHandleID);</pre>
- * <p>Note that multiple suspendRedraw calls can be used at once and that
- * each such method call is treated independently of the other suspendRedraw
- * method calls.</p>
- *
- * @param maxWaitMilliseconds The amount of time in milliseconds
- * to hold off before redrawing the device. Values greater than 60 seconds
- * will be truncated down to 60 seconds.
- * @return A number which acts as a unique identifier for the given
- * suspendRedraw() call. This value must be passed as the parameter to the
- * corresponding unsuspendRedraw() method call.
+ * This method is deprecated, and is only kept due to
+ * compatibility with legacy content. Calling this method has no
+ * effect on redrawing.
+ *
+ * @param maxWaitMilliseconds This parameter is ignored.
+ * @return The returned value is always <span class="attr-value">1</span>.
*/
unsigned long suspendRedraw(in unsigned long maxWaitMilliseconds);
/**
- * Cancels a specified suspendRedraw() by providing a unique
- * suspend handle ID that was returned by a previous suspendRedraw() call.
- *
- * @param suspendHandleID A number which acts as a unique identifier for
- * the desired suspendRedraw() call. The number supplied must be a value
- * returned from a previous call to suspendRedraw(). If an invalid
- * handle ID value is provided then the request to unsuspendRedraw() is
- * silently ignored.
+ * This method is deprecated, and is only kept due to
+ * compatibility with legacy content. Calling this method has no
+ * effect on redrawing.
+ *
+ * @param suspendHandleID This parameter is ignored.
*/
void unsuspendRedraw(in unsigned long suspendHandleID);
/**
- * Cancels all currently active suspendRedraw() method calls. This method
- * is most useful at the very end of a set of SVG DOM calls to ensure that
- * all pending suspendRedraw() method calls have been cancelled.
+ * This method is deprecated, and is only kept due to
+ * compatibility with legacy content. Calling this method has no
+ * effect on redrawing.
*/
void unsuspendRedrawAll();