Source/WebCore/page/Screen.idl

   1 /*
   2  * Copyright (C) 2007 Apple Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29
  30 module window {
  31
  32     interface [
  33         JSGenerateIsReachable=ImplFrame,
  34 #if defined(ENABLE_SCREEN_ORIENTATION_SUPPORT) && ENABLE_SCREEN_ORIENTATION_SUPPORT
  35         EventTarget,
  36 #endif
  37         OmitConstructor
  38     ] Screen {
  39         readonly attribute unsigned long height;
  40         readonly attribute unsigned long width;
  41         readonly attribute unsigned long colorDepth;
  42         readonly attribute unsigned long pixelDepth;
  43         readonly attribute long availLeft;
  44         readonly attribute long availTop;
  45         readonly attribute unsigned long availHeight;
  46         readonly attribute unsigned long availWidth;
  47
  48 #if defined(ENABLE_SCREEN_ORIENTATION_SUPPORT) && ENABLE_SCREEN_ORIENTATION_SUPPORT
  49         // http://www.w3.org/TR/screen-orientation
  50         readonly attribute DOMString orientation;
  51
  52         boolean lockOrientation (in DOMString orientation);
  53         void unlockOrientation ();
  54
  55         attribute EventListener onorientationchange;
  56
  57         // EventTarget interface
  58         void addEventListener(in DOMString type,
  59                               in EventListener listener,
  60                               in [Optional] boolean useCapture);
  61         void removeEventListener(in DOMString type,
  62                                  in EventListener listener,
  63                                  in [Optional] boolean useCapture);
  64         boolean dispatchEvent(in Event evt)
  65             raises(EventException);
  66 #endif
  67     };
  68
  69 }