Mimimum syndical pour en faire un produit zope / cmf.

[ckeditor.git] / skins / ckeditor / _source / core / eventInfo.js

diff --git a/skins/ckeditor/_source/core/eventInfo.js b/skins/ckeditor/_source/core/eventInfo.js
new file mode 100644 (file)
index 0000000..0f313e8
--- /dev/null
+++ b/skins/ckeditor/_source/core/eventInfo.js
@@ -0,0 +1,120 @@
+/*\r
+Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+*/\r
+\r
+/**\r
+ * @fileOverview Defines the "virtual" {@link CKEDITOR.eventInfo} class, which\r
+ *             contains the defintions of the event object passed to event listeners.\r
+ *             This file is for documentation purposes only.\r
+ */\r
+\r
+/**\r
+ * (Virtual Class) Do not call this constructor. This class is not really part\r
+ * of the API.\r
+ * @class Virtual class that illustrates the features of the event object to be\r
+ * passed to event listeners by a {@link CKEDITOR.event} based object.\r
+ * @name CKEDITOR.eventInfo\r
+ * @example\r
+ * // Do not do this.\r
+ * var myEvent = new CKEDITOR.eventInfo();  // Error: CKEDITOR.eventInfo is undefined\r
+ */\r
+\r
+/**\r
+ * The event name.\r
+ * @name CKEDITOR.eventInfo.prototype.name\r
+ * @field\r
+ * @type String\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         alert( <b>event.name</b> );  // "someEvent"\r
+ *     });\r
+ * someObject.fire( 'someEvent' );\r
+ */\r
+\r
+/**\r
+ * The object that publishes (sends) the event.\r
+ * @name CKEDITOR.eventInfo.prototype.sender\r
+ * @field\r
+ * @type Object\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         alert( <b>event.sender</b> == someObject );  // "true"\r
+ *     });\r
+ * someObject.fire( 'someEvent' );\r
+ */\r
+\r
+/**\r
+ * The editor instance that holds the sender. May be the same as sender. May be\r
+ * null if the sender is not part of an editor instance, like a component\r
+ * running in standalone mode.\r
+ * @name CKEDITOR.eventInfo.prototype.editor\r
+ * @field\r
+ * @type CKEDITOR.editor\r
+ * @example\r
+ * myButton.on( 'someEvent', function( event )\r
+ *     {\r
+ *         alert( <b>event.editor</b> == myEditor );  // "true"\r
+ *     });\r
+ * myButton.fire( 'someEvent', null, <b>myEditor</b> );\r
+ */\r
+\r
+/**\r
+ * Any kind of additional data. Its format and usage is event dependent.\r
+ * @name CKEDITOR.eventInfo.prototype.data\r
+ * @field\r
+ * @type Object\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         alert( <b>event.data</b> );  // "Example"\r
+ *     });\r
+ * someObject.fire( 'someEvent', <b>'Example'</b> );\r
+ */\r
+\r
+/**\r
+ * Any extra data appended during the listener registration.\r
+ * @name CKEDITOR.eventInfo.prototype.listenerData\r
+ * @field\r
+ * @type Object\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         alert( <b>event.listenerData</b> );  // "Example"\r
+ *     }\r
+ *     , null, <b>'Example'</b> );\r
+ */\r
+\r
+/**\r
+ * Indicates that no further listeners are to be called.\r
+ * @name CKEDITOR.eventInfo.prototype.stop\r
+ * @function\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         <b>event.stop()</b>;\r
+ *     });\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         // This one will not be called.\r
+ *     });\r
+ * alert( someObject.fire( 'someEvent' ) );  // "false"\r
+ */\r
+\r
+/**\r
+ * Indicates that the event is to be cancelled (if cancelable).\r
+ * @name CKEDITOR.eventInfo.prototype.cancel\r
+ * @function\r
+ * @example\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         <b>event.cancel()</b>;\r
+ *     });\r
+ * someObject.on( 'someEvent', function( event )\r
+ *     {\r
+ *         // This one will not be called.\r
+ *     });\r
+ * alert( someObject.fire( 'someEvent' ) );  // "true"\r
+ */\r