Changeset 7181 for CKEditor/trunk


Ignore:
Timestamp:
08/04/11 16:31:39 (4 years ago)
Author:
Anna
Message:

API documentation revised for the colorbutton plugin.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_source/plugins/colorbutton/plugin.js

    r6985 r7181  
    44*/
    55
     6/**
     7 * @fileOverview The "colorbutton" plugin that makes it possible to assign
     8 *               text and background colors to editor contents.
     9 *
     10 */
    611CKEDITOR.plugins.add( 'colorbutton',
    712{
     
    226231
    227232/**
    228  * Whether to enable the "More Colors..." button in the color selectors.
     233 * Whether to enable the <strong>More Colors</strong> button in the color selectors.
    229234 * @name CKEDITOR.config.colorButton_enableMore
    230  * @default true
     235 * @default <code>true</code>
    231236 * @type Boolean
    232237 * @example
     
    235240
    236241/**
    237  * Defines the colors to be displayed in the color selectors. It's a string
    238  * containing the hexadecimal notation for HTML colors, without the "#" prefix.
    239  *
    240  * Since 3.3: A name may be optionally defined by prefixing the entries with the
    241  * name and the slash character. For example, "FontColor1/FF9900" will be
    242  * displayed as the color #FF9900 in the selector, but will be outputted as "FontColor1".
     242 * Defines the colors to be displayed in the color selectors. This is a string
     243 * containing hexadecimal notation for HTML colors, without the "#" prefix.
     244 * <br /><br />
     245 * Since 3.3: A color name may optionally be defined by prefixing the entries with
     246 * a name and the slash character. For example, "FontColor1/FF9900" will be
     247 * displayed as the color #FF9900 in the selector, but will be output as "FontColor1".
    243248 * @name CKEDITOR.config.colorButton_colors
    244249 * @type String
    245  * @default '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF'
     250 * @default <code>'000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF'</code>
    246251 * @example
    247252 * // Brazil colors only.
     
    258263
    259264/**
    260  * Holds the style definition to be used to apply the text foreground color.
     265 * Stores the style definition that applies the text foreground color.
    261266 * @name CKEDITOR.config.colorButton_foreStyle
    262267 * @type Object
    263  * @example
    264  * // This is basically the default setting value.
     268 * @default (see example)
     269 * @example
     270 * // This is actually the default value.
    265271 * config.colorButton_foreStyle =
    266272 *     {
     
    277283
    278284/**
    279  * Holds the style definition to be used to apply the text background color.
     285 * Stores the style definition that applies the text background color.
    280286 * @name CKEDITOR.config.colorButton_backStyle
    281287 * @type Object
    282  * @example
    283  * // This is basically the default setting value.
     288 * @default (see example)
     289 * @example
     290 * // This is actually the default value.
    284291 * config.colorButton_backStyle =
    285292 *     {
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2015 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy