src/third_party/WebKit/Source/core/frame/WindowTimers.idl

   1 /*
   2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  * Copyright (C) 2013 Samsung Electronics. All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 // http://www.whatwg.org/specs/web-apps/current-work/multipage/timers.html#windowtimers
  29
  30 [
  31     ImplementedAs=DOMWindowTimers,
  32     LegacyTreatAsPartialInterface,
  33     NoInterfaceObject, // Always used on target of 'implements'
  34 ] interface WindowTimers {
  35     // FIXME: currently using [Custom] and |any| because overload algorithm
  36     // can't handle Function/DOMString overload properly
  37     // http://crbug.com/293561
  38     // FIXME: would be clearer as a union type, like:
  39     // typedef (Function or DOMString) Handler
  40     // Needs spec update and better union support: http://crbug.com/240176
  41     [Custom] long setTimeout(any handler, [Default=Undefined] optional long timeout);
  42     void clearTimeout([Default=Undefined] optional long handle);
  43     [Custom] long setInterval(any handler, [Default=Undefined] optional long timeout);
  44     void clearInterval([Default=Undefined] optional long handle);
  45 };