JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
ae2523f0ea6d4dada1b74fd58dd3157230a4a195
[ckeditor.git] / _source / plugins / smiley / plugin.js
1 /*\r
2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
4 */\r
5 \r
6 CKEDITOR.plugins.add( 'smiley',\r
7 {\r
8         requires : [ 'dialog' ],\r
9 \r
10         init : function( editor )\r
11         {\r
12                 editor.addCommand( 'smiley', new CKEDITOR.dialogCommand( 'smiley' ) );\r
13                 editor.ui.addButton( 'Smiley',\r
14                         {\r
15                                 label : editor.lang.smiley.toolbar,\r
16                                 command : 'smiley'\r
17                         });\r
18                 CKEDITOR.dialog.add( 'smiley', this.path + 'dialogs/smiley.js' );\r
19         }\r
20 } );\r
21 \r
22 /**\r
23  * The base path used to build the URL for the smiley images. It must end with\r
24  * a slash.\r
25  * @type String\r
26  * @default {@link CKEDITOR.basePath} + 'plugins/smiley/images/'\r
27  * @example\r
28  * config.smiley_path = 'http://www.example.com/images/smileys/';\r
29  * @example\r
30  * config.smiley_path = '/images/smileys/';\r
31  */\r
32 CKEDITOR.config.smiley_path = CKEDITOR.basePath +\r
33         'plugins/smiley/images/';\r
34 \r
35 /**\r
36  * The file names for the smileys to be displayed. These files must be\r
37  * contained inside the URL path defined with the\r
38  * {@link CKEDITOR.config.smiley_path} setting.\r
39  * @type Array\r
40  * @default (see example)\r
41  * @example\r
42  * // This is actually the default value.\r
43  * config.smiley_images = [\r
44  *     'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',\r
45  *     'embaressed_smile.gif','omg_smile.gif','whatchutalkingabout_smile.gif','angry_smile.gif','angel_smile.gif','shades_smile.gif',\r
46  *     'devil_smile.gif','cry_smile.gif','lightbulb.gif','thumbs_down.gif','thumbs_up.gif','heart.gif',\r
47  *     'broken_heart.gif','kiss.gif','envelope.gif'];\r
48  */\r
49 CKEDITOR.config.smiley_images = [\r
50         'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',\r
51         'embaressed_smile.gif','omg_smile.gif','whatchutalkingabout_smile.gif','angry_smile.gif','angel_smile.gif','shades_smile.gif',\r
52         'devil_smile.gif','cry_smile.gif','lightbulb.gif','thumbs_down.gif','thumbs_up.gif','heart.gif',\r
53         'broken_heart.gif','kiss.gif','envelope.gif'];\r
54 \r
55 /**\r
56  * The description to be used for each of the smileys defined in the\r
57  * {@link CKEDITOR.config.smiley_images} setting. Each entry in this array list\r
58  * must match its relative pair in the {@link CKEDITOR.config.smiley_images}\r
59  * setting.\r
60  * @type Array\r
61  * @default (see example)\r
62  * @example\r
63  * // This is actually the default value.\r
64  * config.smiley_descriptions = [\r
65  *     ':)', ':(', ';)', ':D', ':/', ':P',\r
66  *     '', '', '', '', '', '',\r
67  *     '', ';(', '', '', '', '',\r
68  *     '', ':kiss', '' ];\r
69  */\r
70 CKEDITOR.config.smiley_descriptions = [\r
71         ':)', ':(', ';)', ':D', ':/', ':P',\r
72         '', '', '', '', '', '',\r
73         '', ';(', '', '', '', '',\r
74         '', ':kiss', '' ];\r