gecko/dom/public/idl/geolocation/nsIGeolocationProvider.idl

142 lines
4.3 KiB
Plaintext
Raw Normal View History

/* ***** 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 Geolocation.
*
* The Initial Developer of the Original Code is Mozilla Corporation
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Doug Turner <dougt@meer.net> (Original Author)
*
* 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 "nsISupports.idl"
interface nsIURI;
interface nsIDOMWindow;
interface nsIDOMGeoPosition;
interface nsIGeolocationPrompt;
/**
* nsIGeolocationService
*/
[scriptable, uuid(68300FFD-802C-431B-BF92-0A657696B853)]
interface nsIGeolocationService : nsISupports {
attribute nsIGeolocationPrompt prompt;
};
/**
* Interface allows access to a geolocation and is passed to
* the nsIGeolocationPrompt so that the application can approve
* or deny the request.
*/
[scriptable, function, uuid(D681C322-C075-4C6E-9765-C22711A4A60E)]
interface nsIGeolocationRequest : nsISupports {
readonly attribute nsIURI requestingURI;
readonly attribute nsIDOMWindow requestingWindow;
void cancel();
void allow();
void allowButFuzz();
};
/**
* Interface provides a way for the application to handle
* the UI prompts associated with geo position.
*/
[scriptable, function, uuid(2300C895-1BEE-4297-912C-A57082F3E936)]
interface nsIGeolocationPrompt : nsISupports {
/**
* Called when a request has been made to access geolocation data
*/
void prompt(in nsIGeolocationRequest request);
};
/**
* Interface provides a way for a geolocation provider to
* notify the system that a new location is available.
*/
[scriptable, uuid(B89D7227-9F04-4236-A582-25A3F2779D72)]
interface nsIGeolocationUpdate : nsISupports {
/**
* Notify the geolocation service that a new geolocation
* has been discovered.
* This must be called on the main thread
*/
void update(in nsIDOMGeoPosition position);
};
/**
* Interface provides location information to the nsGeolocator
* via the nsIDOMGeolocationCallback interface. After
* startup is called, any geo location change should call
* callback.onRequest().
*/
[scriptable, uuid(E319BE2D-B1D1-4CA6-AEF4-66178589B63D)]
interface nsIGeolocationProvider : nsISupports {
/**
* Start up the provider. This is called before any other
* method. may be called multiple times.
*/
void startup();
/**
* Returns true when the devices is ready and has a
* postion, otherwise false.
*/
boolean isReady();
/**
* watch
* When a location change is observed, notify the callback
*/
void watch(in nsIGeolocationUpdate callback);
/**
* currentLocation return the current location as seen by
* the provider. may be null.
*/
readonly attribute nsIDOMGeoPosition currentPosition;
/**
* shutdown
* Shuts down the location devices.
*/
void shutdown();
};
%{C++
#define NS_GEOLOCATION_SERVICE_CONTRACTID "@mozilla.org/geolocation/service;1"
#define NS_GEOLOCATION_PROVIDER_CONTRACTID "@mozilla.org/geolocation/provider;1"
%}