/* ***** 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
 * Doug Turner <dougt@dougt.org>
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either 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 "nsIDOMEvent.idl"

[scriptable, uuid(1618546a-c176-40a2-9086-2d973acceeb1)]
interface nsIDOMOrientationEvent : nsIDOMEvent
{
  void                      initOrientationEvent(in DOMString eventTypeArg,
                                                 in boolean canBubbleArg,
                                                 in boolean cancelableArg,
                                                 in double x,
                                                 in double y,
                                                 in double z);
  /*
   * Axis values are between -1 to 1 where 0 is the balance point.
   *
   * For example, x = 0 would mean that the device, along the x axis, is parallel to the earth
   *              x decreasing would mean that the device is undergoing a counterclock-wise rotation on the x axis
   *              x increasing would mean that the device is undergoing a clock-wise rotation on the x axis.
   */

  readonly attribute double x;
  readonly attribute double y;
  readonly attribute double z;
};
