include/windows.devices.geolocation.idl

   1 /*
   2  * Copyright 2023 Fabian Maurer
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifdef __WIDL__
  20 #pragma winrt ns_prefix
  21 #endif
  22
  23 #ifndef DO_NO_IMPORTS
  24 import "inspectable.idl";
  25 import "asyncinfo.idl";
  26 import "eventtoken.idl";
  27 import "windowscontracts.idl";
  28 import "windows.foundation.idl";
  29 #endif
  30
  31 namespace Windows.Devices.Geolocation {
  32
  33     typedef enum PositionAccuracy PositionAccuracy;
  34     typedef enum PositionStatus PositionStatus;
  35
  36     interface IGeolocator;
  37     interface IGeoposition;
  38     interface IGeocoordinate;
  39     interface IPositionChangedEventArgs;
  40     interface IStatusChangedEventArgs;
  41     interface ICivicAddress;
  42
  43     runtimeclass Geolocator;
  44     runtimeclass Geoposition;
  45     runtimeclass Geocoordinate;
  46     runtimeclass PositionChangedEventArgs;
  47     runtimeclass StatusChangedEventArgs;
  48     runtimeclass CivicAddress;
  49
  50     declare {
  51         interface Windows.Foundation.AsyncOperationCompletedHandler<Windows.Devices.Geolocation.Geoposition*>;
  52         interface Windows.Foundation.IAsyncOperation<Windows.Devices.Geolocation.Geoposition*>;
  53         interface Windows.Foundation.TypedEventHandler<Windows.Devices.Geolocation.Geolocator*, Windows.Devices.Geolocation.PositionChangedEventArgs*>;
  54         interface Windows.Foundation.TypedEventHandler<Windows.Devices.Geolocation.Geolocator*, Windows.Devices.Geolocation.StatusChangedEventArgs*>;
  55     }
  56
  57     [contract(Windows.Foundation.UniversalApiContract, 1.0)]
  58     enum PositionAccuracy
  59     {
  60         Default = 0,
  61         High    = 1,
  62     };
  63
  64     [contract(Windows.Foundation.UniversalApiContract, 1.0)]
  65     enum PositionStatus
  66     {
  67         Ready          = 0,
  68         Initializing   = 1,
  69         NoData         = 2,
  70         Disabled       = 3,
  71         NotInitialized = 4,
  72         NotAvailable   = 5,
  73     };
  74
  75     /* Interfaces */
  76
  77     [
  78         contract(Windows.Foundation.UniversalApiContract, 1.0),
  79         exclusiveto(Windows.Devices.Geolocation.Geolocator),
  80         uuid(a9c3bf62-4524-4989-8aa9-de019d2e551f)
  81     ]
  82     interface IGeolocator : IInspectable
  83     {
  84         [propget] HRESULT DesiredAccuracy([out, retval] Windows.Devices.Geolocation.PositionAccuracy *value);
  85         [propput] HRESULT DesiredAccuracy([in] Windows.Devices.Geolocation.PositionAccuracy value);
  86         [propget] HRESULT MovementThreshold([out, retval] DOUBLE *value);
  87         [propput] HRESULT MovementThreshold([in] DOUBLE value);
  88         [propget] HRESULT ReportInterval([out, retval] UINT32 *value);
  89         [propput] HRESULT ReportInterval([in] UINT32 value);
  90         [propget] HRESULT LocationStatus([out, retval] Windows.Devices.Geolocation.PositionStatus *value);
  91         [overload("GetGeopositionAsync")]
  92         HRESULT GetGeopositionAsync([out, retval] Windows.Foundation.IAsyncOperation<Windows.Devices.Geolocation.Geoposition*> **value);
  93         [overload("GetGeopositionAsync")]
  94         HRESULT GetGeopositionAsyncWithAgeAndTimeout([in] Windows.Foundation.TimeSpan maximum_age,
  95                 [in] Windows.Foundation.TimeSpan timeout,
  96                 [out, retval] Windows.Foundation.IAsyncOperation<Windows.Devices.Geolocation.Geoposition*> **value);
  97         [eventadd] HRESULT PositionChanged([in] Windows.Foundation.TypedEventHandler<Windows.Devices.Geolocation.Geolocator*, Windows.Devices.Geolocation.PositionChangedEventArgs*> *handler,
  98                 [out, retval] EventRegistrationToken *token);
  99         [eventremove] HRESULT PositionChanged([in] EventRegistrationToken token);
 100         [eventadd] HRESULT StatusChanged([in] Windows.Foundation.TypedEventHandler<Windows.Devices.Geolocation.Geolocator*, Windows.Devices.Geolocation.StatusChangedEventArgs*> *handler,
 101                 [out, retval] EventRegistrationToken *token);
 102         [eventremove] HRESULT StatusChanged([in] EventRegistrationToken token);
 103     }
 104
 105     [
 106         contract(Windows.Foundation.UniversalApiContract, 1.0),
 107         exclusiveto(Windows.Devices.Geolocation.Geoposition),
 108         uuid(c18d0454-7d41-4ff7-a957-9dffb4ef7f5b)
 109     ]
 110     interface IGeoposition : IInspectable
 111     {
 112         [propget] HRESULT Coordinate([out, retval] Windows.Devices.Geolocation.Geocoordinate **value);
 113         [propget] HRESULT CivicAddress([out, retval] Windows.Devices.Geolocation.CivicAddress **value);
 114     }
 115
 116     [
 117         contract(Windows.Foundation.UniversalApiContract, 1.0),
 118         exclusiveto(Windows.Devices.Geolocation.Geocoordinate),
 119         uuid(ee21a3aa-976a-ac70-803d-083ea55bcbc4)
 120     ]
 121     interface IGeocoordinate : IInspectable
 122     {
 123         [deprecated("Use Point.Position.Latitude", deprecate, Windows.Foundation.UniversalApiContract, 1.0)]
 124         [propget] HRESULT Latitude([out, retval] DOUBLE *value);
 125         [deprecated("Use Point.Position.Longitude", deprecate, Windows.Foundation.UniversalApiContract, 1.0)]
 126         [propget] HRESULT Longitude([out, retval] DOUBLE *value);
 127         [deprecated("Use Point.Position.Altitude", deprecate, Windows.Foundation.UniversalApiContract, 1.0)]
 128         [propget] HRESULT Altitude([out, retval] Windows.Foundation.IReference<DOUBLE> **value);
 129         [propget] HRESULT Accuracy([out, retval] DOUBLE *value);
 130         [propget] HRESULT AltitudeAccuracy([out, retval] Windows.Foundation.IReference<DOUBLE> **value);
 131         [propget] HRESULT Heading([out, retval] Windows.Foundation.IReference<DOUBLE> **value);
 132         [propget] HRESULT Speed([out, retval] Windows.Foundation.IReference<DOUBLE> **value);
 133         [propget] HRESULT Timestamp([out, retval] Windows.Foundation.DateTime *value);
 134     }
 135
 136     [
 137         contract(Windows.Foundation.UniversalApiContract, 1.0),
 138         exclusiveto(Windows.Devices.Geolocation.PositionChangedEventArgs),
 139         uuid(37859ce5-9d1e-46c5-bf3b-6ad8cac1a093)
 140     ]
 141     interface IPositionChangedEventArgs : IInspectable
 142     {
 143         [propget] HRESULT Position([out, retval] Windows.Devices.Geolocation.Geoposition **value);
 144     }
 145
 146     [
 147         contract(Windows.Foundation.UniversalApiContract, 1.0),
 148         exclusiveto(Windows.Devices.Geolocation.StatusChangedEventArgs),
 149         uuid(3453d2da-8c93-4111-a205-9aecfc9be5c0)
 150     ]
 151     interface IStatusChangedEventArgs : IInspectable
 152     {
 153         [propget] HRESULT Status([out, retval] Windows.Devices.Geolocation.PositionStatus *value);
 154     }
 155
 156     [
 157         contract(Windows.Foundation.UniversalApiContract, 1.0),
 158         exclusiveto(Windows.Devices.Geolocation.CivicAddress),
 159         uuid(a8567a1a-64f4-4d48-bcea-f6b008eca34c)
 160     ]
 161     interface ICivicAddress : IInspectable
 162     {
 163         [propget] HRESULT Country([out, retval] HSTRING *value);
 164         [propget] HRESULT State([out, retval] HSTRING *value);
 165         [propget] HRESULT City([out, retval] HSTRING *value);
 166         [propget] HRESULT PostalCode([out, retval] HSTRING *value);
 167         [propget] HRESULT Timestamp([out, retval] Windows.Foundation.DateTime *value);
 168     }
 169
 170     /* Runtime Classes */
 171
 172     [
 173         activatable(Windows.Foundation.UniversalApiContract, 1.0),
 174         contract(Windows.Foundation.UniversalApiContract, 1.0),
 175         marshaling_behavior(agile),
 176         threading(both)
 177     ]
 178     runtimeclass Geolocator
 179     {
 180         [default] interface Windows.Devices.Geolocation.IGeolocator;
 181     }
 182
 183     [
 184         contract(Windows.Foundation.UniversalApiContract, 1.0),
 185         marshaling_behavior(agile)
 186     ]
 187     runtimeclass Geoposition
 188     {
 189         [default] interface Windows.Devices.Geolocation.IGeoposition;
 190     }
 191
 192     [
 193         contract(Windows.Foundation.UniversalApiContract, 1.0),
 194         marshaling_behavior(agile)
 195     ]
 196     runtimeclass Geocoordinate
 197     {
 198         [default] interface Windows.Devices.Geolocation.IGeocoordinate;
 199     }
 200
 201     [
 202         contract(Windows.Foundation.UniversalApiContract, 1.0),
 203         marshaling_behavior(agile)
 204     ]
 205     runtimeclass PositionChangedEventArgs
 206     {
 207         [default] interface Windows.Devices.Geolocation.IPositionChangedEventArgs;
 208     }
 209
 210     [
 211         marshaling_behavior(agile)
 212     ]
 213     runtimeclass StatusChangedEventArgs
 214     {
 215         [default] interface Windows.Devices.Geolocation.IStatusChangedEventArgs;
 216     }
 217
 218     [
 219         contract(Windows.Foundation.UniversalApiContract, 1.0),
 220         marshaling_behavior(agile)
 221     ]
 222     runtimeclass CivicAddress
 223     {
 224         [default] interface Windows.Devices.Geolocation.ICivicAddress;
 225     }
 226 }