Changes between Version 60 and Version 61 of WebKitIDL

Timestamp:

Feb 21, 2012, 6:20:22 PM (14 years ago)

Author:

haraken@chromium.org

Comment:

--

WebKitIDL

@@ -547 +547 @@
 You should avoid using [ImplementedAs] as much as possible though.
 
-== [Reflect](a) FIXME == #Reflect
-
-Summary: ADD SUMMARY
-
-Usage: [Reflect] can be specified on attributes:
-{{{
-    attribute [Reflect] DOMString str;
-}}}
-
-ADD EXPLANATIONS
+== [Reflect](a) == #Reflect
+
+ * [http://www.whatwg.org/specs/web-apps/current-work/multipage/common-dom-interfaces.html#reflect The spec of Reflect]
+
+Summary: [Reflect] indicates that a given attribute should reflect the values of a corresponding content attribute.
+
+Usage: The possible usage is [Reflect] or [Reflect=X], where X is the name of a corresponding content attribute.
+[Reflect] can be specified on attributes:
+{{{
+    interface Element {
+        attribute [Reflect] DOMString id;
+        attribute [Reflect=class] DOMString className;
+    };
+}}}
+
+(Informally speaking,) a content attribute means an attribute on an HTML tag:
+{{{
+    <div id="foo" class="fooClass"></div>
+}}}
+Here 'id' and 'class' are content attributes.
+
+If a given attribute in an IDL file is marked as [Reflect],
+it indicates that the attribute getter returns the value of the corresponding content attribute
+and that the attribute setter sets the value of the corresponding content attribute.
+In the above example, 'div.id' returns 'foo', and 'div.id = "bar"' sets "bar" to the 'id' content attribute.
+
+If the name of the corresponding content attribute is different from the attribute name in an IDL file,
+you can specify the content attribute name by [Reflect=X].
+For example, in case of [Reflect=class], if 'div.className="barClass"' is evaluated, then "barClass" is set to the 'class' content attribute.
+
+Whether [Reflect] should be specified or not depends on the spec of each attribute.
 
 == [Replaceable](a) == #Replaceable
@@ -1308 +1329 @@
 If a given DOM object needs to be kept alive as long as the DOM object has pending activities, you need to specify [ActiveDOMObject].
 For example, [ActiveDOMObject] can be used when the DOM object is expecting events to be raised in the future.
+
+If you use [ActiveDOMObject], the corresponding WebCore class needs to inherit ActiveDOMObject.
+For example, in case of XMLHttpRequest, WebCore/xml/XMLHttpRequest.h would look like this:
+{{{
+    class XMLHttpRequest : public ActiveDOMObject {
+        ...;
+    };
+}}}
+Then you need to implement the virtual methods of the ActiveDOMObject class, e.g. contextDestroyed(), canSuspend(), suspend(), resume() and stop().
 
 If an interface X has [ActiveDOMObject] and an interface Y inherits the interface X,