Changeset 4905


Ignore:
Timestamp:
01/08/2010 03:15:33 PM (5 years ago)
Author:
fredck
Message:

Documentation writing for events.

Location:
CKEditor/trunk/_source
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/core/_bootstrap.js

    r4858 r4905  
    7777}
    7878*/
     79
     80/**
     81 * Fired when a CKEDITOR core object is fully loaded and ready for interaction.
     82 * @name CKEDITOR#loaded
     83 * @event
     84 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     85 */
  • CKEditor/trunk/_source/core/ckeditor.js

    r4858 r4905  
    9595 */
    9696CKEDITOR.TRISTATE_DISABLED = 0;
     97
     98/**
     99 * Fired when the CKEDITOR.currentInstance object reference changes. This may
     100 * happen when setting the focus on different editor instances in the page.
     101 * @name CKEDITOR#currentInstance
     102 * @event
     103 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     104 */
  • CKEditor/trunk/_source/core/editor.js

    r4895 r4905  
    692692 * config.htmlEncodeOutput = true;
    693693 */
     694
     695/**
     696 * Fired when a CKEDITOR instance is created, but still before initializing it.
     697 * To interact with a fully initialized instance, use the
     698 * {@link CKEDITOR#instanceReady} event instead.
     699 * @name CKEDITOR#instanceCreated
     700 * @event
     701 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     702 * @param {CKEDITOR.editor} e.editor The editor instance that has been created.
     703 */
     704 
     705/**
     706 * Fired when a CKEDITOR instance is destroyed.
     707 * @name CKEDITOR#instanceDestroyed
     708 * @event
     709 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     710 * @param {CKEDITOR.editor} e.editor The editor instance that has been destroyed.
     711 */
     712
     713/**
     714 * Fired when all plugins are loaded and initialized into the editor instance.
     715 * @name CKEDITOR#pluginsLoaded
     716 * @event
     717 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     718 */
  • CKEditor/trunk/_source/core/focusmanager.js

    r4858 r4905  
    122122        }
    123123};
     124
     125/**
     126 * Fired when the editor instance receives the input focus.
     127 * @name CKEDITOR.editor#focus
     128 * @event
     129 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     130 * @param {CKEDITOR.editor} e.editor The editor instance.
     131 */
     132
     133/**
     134 * Fired when the editor instance loses the input focus.
     135 * @name CKEDITOR.editor#blur
     136 * @event
     137 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     138 * @param {CKEDITOR.editor} e.editor The editor instance.
     139 */
  • CKEditor/trunk/_source/plugins/clipboard/plugin.js

    r4858 r4905  
    357357                });
    358358})();
     359
     360/**
     361 * Fired when a clipboard operation is about to be taken into the editor.
     362 * Listeners can manipulate the data to be pasted before having it effectively
     363 * inserted into the document.
     364 * @name CKEDITOR.editor#paste
     365 * @since 3.1
     366 * @event
     367 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     368 * @param {String} [e.data.html] The HTML data to be pasted. If not available, e.data.text will be defined.
     369 * @param {String} [e.data.text] The plain text data to be pasted, available when plain text operations are to used. If not available, e.data.html will be defined.
     370 */
  • CKEditor/trunk/_source/plugins/dialog/plugin.js

    r4858 r4905  
    27782778 * config.dialog_magnetDistance = 30;
    27792779 */
     2780
     2781/**
     2782 * Fired when a dialog definition is about to be used to create a dialog into
     2783 * an editor instance. This event makes it possible to customize the definition
     2784 * before creating it.
     2785 * <p>Note that this event is called only the first time a specific dialog is
     2786 * opened. Successive openings will use the cached dialog, and this event will
     2787 * not get fired.</p>
     2788 * @name CKEDITOR#dialogDefinition
     2789 * @event
     2790 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     2791 * @param {CKEDITOR.dialog.dialogDefinition} e.data The dialog defination that
     2792 *              is being loaded.
     2793 * @param {CKEDITOR.editor} e.editor The editor instance that will use the
     2794 *              dialog.
     2795 */
  • CKEditor/trunk/_source/plugins/editingblock/plugin.js

    r4858 r4905  
    235235 */
    236236CKEDITOR.config.editingBlock = true;
     237
     238/**
     239 * Fired when a CKEDITOR instance is created, fully initialized and ready for interaction.
     240 * @name CKEDITOR#instanceReady
     241 * @event
     242 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     243 * @param {CKEDITOR.editor} e.editor The editor instance that has been created.
     244 */
  • CKEditor/trunk/_source/plugins/keystrokes/plugin.js

    r4858 r4905  
    217217        [ CKEDITOR.ALT + 109 /*-*/, 'toolbarCollapse' ]
    218218];
     219
     220/**
     221 * Fired when any keyboard key (or combination) is pressed into the editing area.
     222 * @name CKEDITOR#key
     223 * @event
     224 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     225 * @param {Number} e.data.keyCode A number representing the key code (or
     226 *              combination). It is the sum of the current key code and the
     227 *              {@link CKEDITOR.CTRL}, {@link CKEDITOR.SHIFT} and {@link CKEDITOR.ALT}
     228 *              constants, if those are pressed.
     229 */
  • CKEditor/trunk/_source/plugins/undo/plugin.js

    r4858 r4905  
    504504 */
    505505CKEDITOR.config.undoStackSize = 20;
     506
     507/**
     508 * Fired when the editor is about to save an undo snapshot. This event can be
     509 * fired by plugins and customizations to make the editor saving undo snapshots.
     510 * @name CKEDITOR.editor#saveSnapshot
     511 * @event
     512 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     513 */
     514 
  • CKEditor/trunk/_source/plugins/wysiwygarea/plugin.js

    r4858 r4905  
    846846 */
    847847CKEDITOR.config.ignoreEmptyParagraph = true;
     848
     849/**
     850 * Fired when data is loaded and ready for retrieval in an editor instance.
     851 * @name CKEDITOR.editor#dataReady
     852 * @event
     853 * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
     854 */
     855 
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2012 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy