/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2000
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vidur Apparao <vidur@netscape.com> (original author)
 *   Johnny Stenback <jst@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsIDOMEventTarget.idl"

[scriptable, uuid(8a66b30c-9a32-4b17-ab4e-ca8b7b588243)]
interface nsIDOMScreen : nsIDOMEventTarget
{
  readonly attribute long             top;
  readonly attribute long             left;
  readonly attribute long             width;
  readonly attribute long             height;
  readonly attribute long             pixelDepth;
  readonly attribute long             colorDepth;
  readonly attribute long             availWidth;
  readonly attribute long             availHeight;
  readonly attribute long             availLeft;
  readonly attribute long             availTop;

  /**
   * Is the device's screen currently enabled?  This attribute controls the
   * device's screen, so setting it to false will turn off the screen.
   */
  attribute boolean mozEnabled;

  /**
   * How bright is the screen's backlight, on a scale from 0 (very dim) to 1
   * (full brightness)?  Setting this attribute modifies the screen's
   * brightness.
   *
   * You can read and write this attribute even when the screen is disabled,
   * but the backlight is off while the screen is disabled.
   *
   * If you write a value of X into this attribute, the attribute may not have
   * the same value X when you later read it.  Most screens don't support as
   * many different brightness levels as there are doubles between 0 and 1, so
   * we may reduce the value's precision before storing it.
   *
   * @throw NS_ERROR_INVALID_ARG if brightness is not in the range [0, 1].
   */
  attribute double mozBrightness;

  /**
   * Returns the current screen orientation.
   * Can be: landscape-primary, landscape-secondary,
   *         portrait-primary or portrait-secondary.
   */
  readonly attribute DOMString       mozOrientation;

  attribute nsIDOMEventListener      onmozorientationchange;

  /**
   * Lock screen orientation to the specified type.
   */
  boolean mozLockOrientation(in DOMString orientation);

  /**
   * Unlock the screen orientation.
   */
  void mozUnlockOrientation();
};
