1 /*

     2  * Copyright 2009 Google Inc.

     3  *

     4  * Licensed under the Apache License, Version 2.0 (the "License");

     5  * you may not use this file except in compliance with the License.

     6  * You may obtain a copy of the License at

     7  *

     8  *     http://www.apache.org/licenses/LICENSE-2.0

     9  *

    10  * Unless required by applicable law or agreed to in writing, software

    11  * distributed under the License is distributed on an "AS IS" BASIS,

    12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    13  * See the License for the specific language governing permissions and

    14  * limitations under the License.

    15  */

    16 

    17 /**

    18  * @fileoverview Externs for jQuery 1.3.2.

    19  * The externs defined here are in the order of the jQuery documentation pages.

    20  * Note that some functions use different return types depending on the number

    21  * of parameters passed in. In this cases, you may need to annotate the type

    22  * of the result in your code, so the JSCompiler understands which type you're

    23  * expecting. For example:

    24  *    <code>var elt = /** @type {Element} * / (foo.get(0));</code>

    25  * @see http://docs.jquery.com/

    26 *

    27  */

    28 

    29 /**

    30  * @param {string|Node|Element|Array.<Element>|Function} arg

    31  * @param {(jQueryObject|Document)=} opt_arg

    32  * @return {jQueryObject}

    33  */

    34 var $ = function(arg, opt_arg) {};

    35 

    36 var jQuery = {};

    37 

    38 /** @constructor */

    39 function jQueryObject() {};

    40 

    41 

    42 // http://docs.jquery.com/Core - Object accessors

    43 

    44 /**

    45  * @param {Function} callback

    46  * @return {jQueryObject}

    47  */

    48 jQueryObject.prototype.each = function(callback) {};

    49 

    50 /** @return {number} */

    51 jQueryObject.prototype.size = function() {};

    52 

    53 /** @type {number} */

    54 jQueryObject.prototype.length;

    55 

    56 /** @return {string} */

    57 jQueryObject.prototype.selector = function() {};

    58 

    59 /** @return {Element} */

    60 jQueryObject.prototype.context = function() {};

    61 

    62 /**

    63  * @param {number=} opt_index

    64  * @return {Element|Array.<Element>}

    65  */

    66 jQueryObject.prototype.get = function(opt_index) {};

    67 

    68 /**

    69  * @param {Element|jQueryObject} subject

    70  * @return {number}

    71  */

    72 jQueryObject.prototype.index = function(subject) {};

    73 

    74 

    75 // http://docs.jquery.com/Core - Data

    76 

    77 /**

    78  * @param {string} name

    79  * @param {string=} opt_value

    80  * @return {*}

    81  */

    82 jQueryObject.prototype.data = function(name, opt_value) {};

    83 

    84 /**

    85  * @param {string} name

    86  * @return {jQueryObject}

    87  */

    88 jQueryObject.prototype.removeData = function(name) {};

    89 

    90 /**

    91  * @param {(string|Function|Array.<Function>)=} opt_arg1

    92  * @param {(Function|Array.<Function>)=} opt_arg2

    93  * @return {Array.<Function>|jQueryObject}

    94  */

    95 jQueryObject.prototype.queue = function(opt_arg1, opt_arg2) {};

    96 

    97 /**

    98  * @param {string=} opt_name

    99  * @return {jQueryObject}

   100  */

   101 jQueryObject.prototype.dequeue = function(opt_name) {};

   102 

   103 

   104 // http://docs.jquery.com/Attributes - Attr

   105 

   106 /**

   107  * @param {string|Object} nameOrProperties

   108  * @param {*=} opt_value

   109  * @return {Object|jQueryObject}

   110  */

   111 jQueryObject.prototype.attr = function(nameOrProperties, opt_value) {};

   112 

   113 /**

   114  * @param {string} name

   115  * @return {jQueryObject}

   116  */

   117 jQueryObject.prototype.removeAttr = function(name) {};

   118 

   119 

   120 // http://docs.jquery.com/Attributes - Class

   121 

   122 /**

   123  * @param {string} klass

   124  * @return {jQueryObject}

   125  */

   126 jQueryObject.prototype.addClass = function(klass) {};

   127 

   128 /**

   129  * @param {string} klass

   130  * @return {boolean}

   131  */

   132 jQueryObject.prototype.hasClass = function(klass) {};

   133 

   134 /**

   135  * @param {string=} opt_klass

   136  * @return {jQueryObject}

   137  */

   138 jQueryObject.prototype.removeClass = function(opt_klass) {};

   139 

   140 /**

   141  * @param {string} klass

   142  * @param {boolean=} opt_switch

   143  * @return {jQueryObject}

   144  */

   145 jQueryObject.prototype.toggleClass = function(klass, opt_switch) {};

   146 

   147 

   148 // http://docs.jquery.com/Attributes - HTML, Text, Value

   149 

   150 /**

   151  * @param {string} opt_val

   152  * @return {string|jQueryObject}

   153  */

   154 jQueryObject.prototype.html = function(opt_val) {};

   155 

   156 /**

   157  * @param {string=} opt_val

   158  * @return {string|jQueryObject}

   159  */

   160 jQueryObject.prototype.text = function(opt_val) {};

   161 

   162 /**

   163  * @param {string|Array.<string>} opt_val

   164  * @return {string|Array|jQueryObject}

   165  */

   166 jQueryObject.prototype.val = function(opt_val) {};

   167 

   168 

   169 // http://docs.jquery.com/Traversing - Filtering

   170 

   171 /**

   172  * @param {number} index

   173  * @return {jQueryObject}

   174  */

   175 jQueryObject.prototype.eq = function(index) {};

   176 

   177 /**

   178  * @param {string|Function} arg

   179  * @return {jQueryObject}

   180  */

   181 jQueryObject.prototype.filter = function(arg) {};

   182 

   183 /**

   184  * @param {string} expr

   185  * @return {boolean}

   186  */

   187 jQueryObject.prototype.is = function(expr) {};

   188 

   189 /**

   190  * @param {Function} callback

   191  * @return {jQueryObject}

   192  */

   193 jQueryObject.prototype.map = function(callback) {};

   194 

   195 /**

   196  * @param {string} expr

   197  * @return {jQueryObject}

   198  */

   199 jQueryObject.prototype.not = function(expr) {};

   200 

   201 /**

   202  * @param {number} start

   203  * @param {number=} opt_end

   204  * @return {jQueryObject}

   205  */

   206 jQueryObject.prototype.slice = function(start, opt_end) {};

   207 

   208 

   209 // http://docs.jquery.com/Traversing - Finding, Chaining

   210 

   211 /**

   212  * @param {string|Element|Array.<Element>} expr

   213  * @return {jQueryObject}

   214  */

   215 jQueryObject.prototype.add = function(expr) {};

   216 

   217 /**

   218  * @param {string=} opt_expr

   219  * @return {jQueryObject}

   220  */

   221 jQueryObject.prototype.children = function(opt_expr) {};

   222 

   223 /**

   224  * @param {string} expr

   225  * @return {jQueryObject}

   226  */

   227 jQueryObject.prototype.closest = function(expr) {};

   228 

   229 /**

   230  * @return {jQueryObject}

   231  */

   232 jQueryObject.prototype.contents = function() {};

   233 

   234 /**

   235  * @param {string} expr

   236  * @return {jQueryObject}

   237  */

   238 jQueryObject.prototype.find = function(expr) {};

   239 

   240 /**

   241  * @param {string=} opt_expr

   242  * @return {jQueryObject}

   243  */

   244 jQueryObject.prototype.next = function(opt_expr) {};

   245 

   246 /**

   247  * @param {string=} opt_expr

   248  * @return {jQueryObject}

   249  */

   250 jQueryObject.prototype.nextAll = function(opt_expr) {};

   251 

   252 /**

   253  * @return {jQueryObject}

   254  */

   255 jQueryObject.prototype.offsetParent = function() {};

   256 

   257 /**

   258  * @param {string=} opt_expr

   259  * @return {jQueryObject}

   260  */

   261 jQueryObject.prototype.parent = function(opt_expr) {};

   262 

   263 /**

   264  * @param {string=} opt_expr

   265  * @return {jQueryObject}

   266  */

   267 jQueryObject.prototype.parents = function(opt_expr) {};

   268 

   269 /**

   270  * @param {string=} opt_expr

   271  * @return {jQueryObject}

   272  */

   273 jQueryObject.prototype.prev = function(opt_expr) {};

   274 

   275 /**

   276  * @param {string=} opt_expr

   277  * @return {jQueryObject}

   278  */

   279 jQueryObject.prototype.prevAll = function(opt_expr) {};

   280 

   281 /**

   282  * @param {string=} opt_expr

   283  * @return {jQueryObject}

   284  */

   285 jQueryObject.prototype.siblings = function(opt_expr) {};

   286 

   287 /**

   288  * @return {jQueryObject}

   289  */

   290 jQueryObject.prototype.andSelf = function() {};

   291 

   292 /**

   293  * @return {jQueryObject}

   294  */

   295 jQueryObject.prototype.end = function() {};

   296 

   297 

   298 // http://docs.jquery.com/Manipulation

   299 

   300 /**

   301  * @param {string|Node|Element|jQueryObject} content

   302  * @return {jQueryObject}

   303  */

   304 jQueryObject.prototype.append = function(content) {};

   305 

   306 /**

   307  * @param {string} selector

   308  * @return {jQueryObject}

   309  */

   310 jQueryObject.prototype.appendTo = function(selector) {};

   311 

   312 /**

   313  * @param {string|Node|Element|jQueryObject} content

   314  * @return {jQueryObject}

   315  */

   316 jQueryObject.prototype.prepend = function(content) {};

   317 

   318 /**

   319  * @param {string} selector

   320  * @return {jQueryObject}

   321  */

   322 jQueryObject.prototype.prependTo = function(selector) {};

   323 

   324 /**

   325  * @param {string|Node|Element|jQueryObject} content

   326  * @return {jQueryObject}

   327  */

   328 jQueryObject.prototype.after = function(content) {};

   329 

   330 /**

   331  * @param {string|Node|Element|jQueryObject} content

   332  * @return {jQueryObject}

   333  */

   334 jQueryObject.prototype.before = function(content) {};

   335 

   336 /**

   337  * @param {string} selector

   338  * @return {jQueryObject}

   339  */

   340 jQueryObject.prototype.insertAfter = function(selector) {};

   341 

   342 /**

   343  * @param {string} selector

   344  * @return {jQueryObject}

   345  */

   346 jQueryObject.prototype.insertBefore = function(selector) {};

   347 

   348 /**

   349  * @param {string|Element} arg

   350  * @return {jQueryObject}

   351  */

   352 jQueryObject.prototype.wrap = function(arg) {};

   353 

   354 /**

   355  * @param {string|Element} arg

   356  * @return {jQueryObject}

   357  */

   358 jQueryObject.prototype.wrapAll = function(arg) {};

   359 

   360 /**

   361  * @param {string|Element} arg

   362  * @return {jQueryObject}

   363  */

   364 jQueryObject.prototype.wrapInner = function(arg) {};

   365 

   366 /**

   367  * @param {string|Node|Element|jQueryObject} content

   368  * @return {jQueryObject}

   369  */

   370 jQueryObject.prototype.replaceWith = function(content) {};

   371 

   372 /**

   373  * @param {string} selector

   374  * @return {jQueryObject}

   375  */

   376 jQueryObject.prototype.replaceAll = function(selector) {};

   377 

   378 /**

   379  * @return {jQueryObject}

   380  */

   381 jQueryObject.prototype.empty = function() {};

   382 

   383 /**

   384  * @param {string=} opt_expr

   385  * @return {jQueryObject}

   386  */

   387 jQueryObject.prototype.remove = function(opt_expr) {};

   388 

   389 /**

   390  * @param {boolean=} opt_cloneEvents

   391  * @return {jQueryObject}

   392  */

   393 jQueryObject.prototype.clone = function(opt_cloneEvents) {};

   394 

   395 

   396 // http://docs.jquery.com/CSS

   397 

   398 /**

   399  * @param {string|Object} nameOrProperties

   400  * @param {(string|number|Function)=} opt_value

   401  * @return {Object|jQueryObject|string}

   402  */

   403 jQueryObject.prototype.css = function(nameOrProperties, opt_value) {};

   404 

   405 /**

   406  * @return {Object}

   407  */

   408 jQueryObject.prototype.offset = function() {};

   409 

   410 /**

   411  * @return {Object}

   412  */

   413 jQueryObject.prototype.position = function() {};

   414 

   415 /**

   416  * @param {number=} opt_val

   417  * @return {number|jQueryObject}

   418  */

   419 jQueryObject.prototype.scrollTop = function(opt_val) {};

   420 

   421 /**

   422  * @param {number=} opt_val

   423  * @return {number|jQueryObject}

   424  */

   425 jQueryObject.prototype.scrollLeft = function(opt_val) {};

   426 

   427 /**

   428  * @param {number=} opt_val

   429  * @return {number|jQueryObject}

   430  */

   431 jQueryObject.prototype.height = function(opt_val) {};

   432 

   433 /**

   434  * @param {number=} opt_val

   435  * @return {number|jQueryObject}

   436  */

   437 jQueryObject.prototype.width = function(opt_val) {};

   438 

   439 /**

   440  * @return {number}

   441  */

   442 jQueryObject.prototype.innerHeight = function() {};

   443 

   444 /**

   445  * @return {number}

   446  */

   447 jQueryObject.prototype.innerWidth = function() {};

   448 

   449 /**

   450  * @param {boolean=} opt_margin

   451  * @return {number}

   452  */

   453 jQueryObject.prototype.outerHeight = function(opt_margin) {};

   454 

   455 /**

   456  * @param {boolean=} opt_margin

   457  * @return {number}

   458  */

   459 jQueryObject.prototype.outerWidth = function(opt_margin) {};

   460 

   461 

   462 // http://docs.jquery.com/Events

   463 

   464 /**

   465  * @param {string} type

   466  * @param {Function} fn

   467  * @return {jQueryObject}

   468  */

   469 jQueryObject.prototype.live = function(type, fn) {};

   470 

   471 /**

   472  * @param {string=} opt_type

   473  * @param {Function=} opt_fn

   474  * @return {jQueryObject}

   475  */

   476 jQueryObject.prototype.die = function(opt_type, opt_fn) {};

   477 

   478 /**

   479  * @param {Function} over

   480  * @param {Function} out

   481  * @return {jQueryObject}

   482  */

   483 jQueryObject.prototype.hover = function(over, out) {};

   484 

   485 /**

   486  * @param {Function=} opt_fn

   487  * @return {jQueryObject}

   488  */

   489 jQueryObject.prototype.blur = function(opt_fn) {};

   490 

   491 /**

   492  * @param {Function=} opt_fn

   493  * @return {jQueryObject}

   494  */

   495 jQueryObject.prototype.change = function(opt_fn) {};

   496 

   497 /**

   498  * @param {Function=} opt_fn

   499  * @return {jQueryObject}

   500  */

   501 jQueryObject.prototype.click = function(opt_fn) {};

   502 

   503 /**

   504  * @param {Function=} opt_fn

   505  * @return {jQueryObject}

   506  */

   507 jQueryObject.prototype.dblclick = function(opt_fn) {};

   508 

   509 /**

   510  * @param {Function=} opt_fn

   511  * @return {jQueryObject}

   512  */

   513 jQueryObject.prototype.error = function(opt_fn) {};

   514 

   515 /**

   516  * @param {Function=} opt_fn

   517  * @return {jQueryObject}

   518  */

   519 jQueryObject.prototype.focus = function(opt_fn) {};

   520 

   521 /**

   522  * @param {Function=} opt_fn

   523  * @return {jQueryObject}

   524  */

   525 jQueryObject.prototype.keydown = function(opt_fn) {};

   526 

   527 /**

   528  * @param {Function=} opt_fn

   529  * @return {jQueryObject}

   530  */

   531 jQueryObject.prototype.keypress = function(opt_fn) {};

   532 

   533 /**

   534  * @param {Function} fn

   535  * @return {jQueryObject}

   536  */

   537 jQueryObject.prototype.keyup = function(fn) {};

   538 

   539 /**

   540  * @param {Function} fn

   541  * @return {jQueryObject}

   542  */

   543 jQueryObject.prototype.load = function(fn) {};

   544 

   545 /**

   546  * @param {Function} fn

   547  * @return {jQueryObject}

   548  */

   549 jQueryObject.prototype.mousedown = function(fn) {};

   550 

   551 /**

   552  * @param {Function} fn

   553  * @return {jQueryObject}

   554  */

   555 jQueryObject.prototype.mouseenter = function(fn) {};

   556 

   557 /**

   558  * @param {Function} fn

   559  * @return {jQueryObject}

   560  */

   561 jQueryObject.prototype.mouseleave = function(fn) {};

   562 

   563 /**

   564  * @param {Function} fn

   565  * @return {jQueryObject}

   566  */

   567 jQueryObject.prototype.mousemove = function(fn) {};

   568 

   569 /**

   570  * @param {Function} fn

   571  * @return {jQueryObject}

   572  */

   573 jQueryObject.prototype.mouseout = function(fn) {};

   574 

   575 /**

   576  * @param {Function} fn

   577  * @return {jQueryObject}

   578  */

   579 jQueryObject.prototype.mouseover = function(fn) {};

   580 

   581 /**

   582  * @param {Function} fn

   583  * @return {jQueryObject}

   584  */

   585 jQueryObject.prototype.mouseup = function(fn) {};

   586 

   587 /**

   588  * @param {Function} fn

   589  * @return {jQueryObject}

   590  */

   591 jQueryObject.prototype.resize = function(fn) {};

   592 

   593 /**

   594  * @param {Function} fn

   595  * @return {jQueryObject}

   596  */

   597 jQueryObject.prototype.scroll = function(fn) {};

   598 

   599 /**

   600  * @param {Function=} opt_fn

   601  * @return {jQueryObject}

   602  */

   603 jQueryObject.prototype.select = function(opt_fn) {};

   604 

   605 /**

   606  * @param {Function=} opt_fn

   607  * @return {jQueryObject}

   608  */

   609 jQueryObject.prototype.submit = function(opt_fn) {};

   610 

   611 /**

   612  * @param {Function} fn

   613  * @return {jQueryObject}

   614  */

   615 jQueryObject.prototype.unload = function(fn) {};

   616 

   617 

   618 // http://docs.jquery.com/Effects

   619 

   620 /**

   621  * @param {(number|string)=} opt_speed

   622  * @param {Function=} opt_fn

   623  * @return {jQueryObject}

   624  */

   625 jQueryObject.prototype.show = function(opt_speed, opt_fn) {};

   626 

   627 /**

   628  * @param {(number|string)=} opt_speed

   629  * @param {Function=} opt_fn

   630  * @return {jQueryObject}

   631  */

   632 jQueryObject.prototype.hide = function(opt_speed, opt_fn) {};

   633 

   634 /**

   635  * toggle() is defined as both an event and an effect... sigh.

   636  * @param {(Function|boolean|number|string)=} opt_arg1

   637  * @param {Function=} opt_fn2

   638  * @param {...Function} var_args

   639  * @return {jQueryObject}

   640  */

   641 jQueryObject.prototype.toggle = function(opt_arg1, opt_fn2, var_args) {};

   642 

   643 /**

   644  * @param {(number|string)=} opt_speed

   645  * @param {Function=} opt_fn

   646  * @return {jQueryObject}

   647  */

   648 jQueryObject.prototype.slideDown = function(opt_speed, opt_fn) {};

   649 

   650 /**

   651  * @param {(number|string)=} opt_speed

   652  * @param {Function=} opt_fn

   653  * @return {jQueryObject}

   654  */

   655 jQueryObject.prototype.slideUp = function(opt_speed, opt_fn) {};

   656 

   657 /**

   658  * @param {(number|string)=} opt_speed

   659  * @param {Function=} opt_fn

   660  * @return {jQueryObject}

   661  */

   662 jQueryObject.prototype.slideToggle = function(opt_speed, opt_fn) {};

   663 

   664 /**

   665  * @param {(number|string)=} opt_speed

   666  * @param {Function=} opt_fn

   667  * @return {jQueryObject}

   668  */

   669 jQueryObject.prototype.fadeIn = function(opt_speed, opt_fn) {};

   670 

   671 /**

   672  * @param {(number|string)=} opt_speed

   673  * @param {Function=} opt_fn

   674  * @return {jQueryObject}

   675  */

   676 jQueryObject.prototype.fadeOut = function(opt_speed, opt_fn) {};

   677 

   678 /**

   679  * @param {(number|string)=} opt_speed

   680  * @param {number=} opt_opacity

   681  * @param {Function=} opt_fn

   682  * @return {jQueryObject}

   683  */

   684 jQueryObject.prototype.fadeTo = function(opt_speed, opt_opacity, opt_fn) {};

   685 

   686 /**

   687  * @param {Object} params

   688  * @param {(number|string|Object)=} opt_durationOrOptions

   689  * @param {string=} opt_easing

   690  * @param {Function=} opt_fn

   691  * @return {jQueryObject}

   692  */

   693 jQueryObject.prototype.animate = function(

   694     params, opt_durationOrOptions, opt_easing, opt_fn) {};

   695 

   696 /**

   697  * @param {boolean} opt_clearQueue

   698  * @param {boolean} opt_gotoEnd

   699  * @return {jQueryObject}

   700  */

   701 jQueryObject.prototype.stop = function(opt_clearQueue, opt_gotoEnd) {};

   702 

   703 jQuery.fx = {};

   704 

   705 /** @type {boolean} */

   706 jQuery.fx.off;

   707 

   708 // http://docs.jquery.com/Utilities

   709 

   710 /**

   711  * @param {number|string|Object} value

   712  * @param {Array} array

   713  * @return {number}

   714  */

   715 jQueryObject.prototype.inArray = function(value, array) {};