1 /* 2 * CKEditor - The text editor for Internet - http://ckeditor.com 3 * Copyright (C) 2003-2008 Frederico Caldeira Knabben 4 * 5 * == BEGIN LICENSE == 6 * 7 * Licensed under the terms of any of the following licenses at your 8 * choice: 9 * 10 * - GNU General Public License Version 2 or later (the "GPL") 11 * http://www.gnu.org/licenses/gpl.html 12 * 13 * - GNU Lesser General Public License Version 2.1 or later (the "LGPL") 14 * http://www.gnu.org/licenses/lgpl.html 15 * 16 * - Mozilla Public License Version 1.1 or later (the "MPL") 17 * http://www.mozilla.org/MPL/MPL-1.1.html 18 * 19 * == END LICENSE == 20 */ 21 22 /** 23 * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which 24 * contains the defintion of a plugin. This file is for documentation 25 * purposes only. 26 */ 27 28 /** 29 * This class is not really part of the API. It just illustrates the features 30 * of plugin objects to passed to the {@link CKEDITOR.plugins.add} function. 31 * @name CKEDITOR.pluginDefinition 32 * @constructor 33 * @example 34 * // Do not do this. 35 * var myEvent = new CKEDITOR.pluginDefinition(); // Error: CKEDITOR.pluginDefinition is undefined 36 */ 37 38 /** 39 * Function called on initialization of every editor instance created in the 40 * page. 41 * @name CKEDITOR.pluginDefinition.prototype.init 42 * @function 43 * @param {CKEDITOR.editor} editor The editor instance being initialized. 44 * @param {String} pluginPath The URL path for the plugin installation folder. 45 * @type undefined 46 * @example 47 * CKEDITOR.plugins.add( 'sample', 48 * { 49 * init : function( editor, pluginPath ) 50 * { 51 * alert( 'Editor "' + editor.name + '" is being initialized!' ); 52 * } 53 * }); 54 */ 55