include/windows.foundation.idl

   1 /*
   2  * Copyright 2015 Jacek Caban for CodeWeavers
   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 import "inspectable.idl";
  24 import "asyncinfo.idl";
  25 import "windowscontracts.idl";
  26 import "eventtoken.idl";
  27 /* import "ivectorchangedeventargs.idl"; */
  28 import "windows.foundation.collections.idl";
  29
  30 namespace Windows.Foundation.Collections {
  31     interface IPropertySet;
  32
  33     declare {
  34         interface Windows.Foundation.Collections.IKeyValuePair<HSTRING, IInspectable *>;
  35         interface Windows.Foundation.Collections.IIterable<Windows.Foundation.Collections.IKeyValuePair<HSTRING, IInspectable *> *>;
  36         interface Windows.Foundation.Collections.IIterator<Windows.Foundation.Collections.IKeyValuePair<HSTRING, IInspectable *> *>;
  37         interface Windows.Foundation.Collections.IMapChangedEventArgs<HSTRING>;
  38         interface Windows.Foundation.Collections.MapChangedEventHandler<HSTRING, IInspectable *>;
  39         interface Windows.Foundation.Collections.IMap<HSTRING, IInspectable *>;
  40         interface Windows.Foundation.Collections.IMapView<HSTRING, IInspectable *>;
  41         interface Windows.Foundation.Collections.IObservableMap<HSTRING, IInspectable *>;
  42     }
  43
  44     [
  45         contract(Windows.Foundation.FoundationContract, 1.0),
  46         uuid(8a43ed9f-f4e6-4421-acf9-1dab2986820c)
  47     ]
  48     interface IPropertySet : IInspectable
  49         requires Windows.Foundation.Collections.IObservableMap<HSTRING, IInspectable *>,
  50                  Windows.Foundation.Collections.IMap<HSTRING, IInspectable *>,
  51                  Windows.Foundation.Collections.IIterable<Windows.Foundation.Collections.IKeyValuePair<HSTRING, IInspectable *> *>
  52     {
  53     }
  54 }
  55
  56 namespace Windows.Foundation {
  57     typedef enum PropertyType PropertyType;
  58     typedef struct Point Point;
  59     typedef struct Size Size;
  60     typedef struct Rect Rect;
  61     typedef struct DateTime DateTime;
  62     typedef struct TimeSpan TimeSpan;
  63     interface IAsyncAction;
  64     interface IClosable;
  65     interface IDeferral;
  66     interface IDeferralFactory;
  67     interface IMemoryBuffer;
  68     interface IMemoryBufferFactory;
  69     interface IMemoryBufferReference;
  70     interface IStringable;
  71     interface IUriEscapeStatics;
  72     interface IUriRuntimeClass;
  73     interface IUriRuntimeClassFactory;
  74     interface IUriRuntimeClassWithAbsoluteCanonicalUri;
  75     interface IWwwFormUrlDecoderEntry;
  76     interface IWwwFormUrlDecoderRuntimeClass;
  77     interface IWwwFormUrlDecoderRuntimeClassFactory;
  78
  79     runtimeclass Deferral;
  80     runtimeclass MemoryBuffer;
  81     runtimeclass Uri;
  82     runtimeclass WwwFormUrlDecoder;
  83     runtimeclass WwwFormUrlDecoderEntry;
  84
  85     declare {
  86         interface Windows.Foundation.Collections.IIterable<HSTRING>;
  87         interface Windows.Foundation.Collections.IIterable<IInspectable *>;
  88         interface Windows.Foundation.Collections.IIterable<IWwwFormUrlDecoderEntry *>;
  89         interface Windows.Foundation.Collections.IIterable<Uri *>;
  90         interface Windows.Foundation.Collections.IIterator<HSTRING>;
  91         interface Windows.Foundation.Collections.IIterator<IInspectable *>;
  92         interface Windows.Foundation.Collections.IIterator<IWwwFormUrlDecoderEntry *>;
  93         interface Windows.Foundation.Collections.IIterator<Uri *>;
  94         interface Windows.Foundation.Collections.IVectorView<HSTRING>;
  95         interface Windows.Foundation.Collections.IVectorView<IInspectable *>;
  96         interface Windows.Foundation.Collections.IVectorView<IWwwFormUrlDecoderEntry *>;
  97         interface Windows.Foundation.Collections.IVector<HSTRING>;
  98         interface Windows.Foundation.Collections.IVector<IInspectable *>;
  99         interface Windows.Foundation.Collections.IMapView<HSTRING, Windows.Foundation.Collections.IVectorView<HSTRING> *>;
 100         interface Windows.Foundation.EventHandler<IInspectable *>;
 101         interface Windows.Foundation.AsyncOperationCompletedHandler<IInspectable *>;
 102         interface Windows.Foundation.AsyncOperationCompletedHandler<boolean>;
 103         interface Windows.Foundation.AsyncOperationCompletedHandler<UINT32>;
 104         interface Windows.Foundation.IAsyncOperation<IInspectable *>;
 105         interface Windows.Foundation.IAsyncOperation<boolean>;
 106         interface Windows.Foundation.IAsyncOperation<UINT32>;
 107         interface Windows.Foundation.IReference<BYTE>;
 108         interface Windows.Foundation.IReference<INT32>;
 109         interface Windows.Foundation.IReference<DOUBLE>;
 110         interface Windows.Foundation.TypedEventHandler<IInspectable *, IInspectable *>;
 111         interface Windows.Foundation.TypedEventHandler<Windows.Foundation.IMemoryBufferReference *, IInspectable *>;
 112     }
 113
 114     [
 115         contract(Windows.Foundation.FoundationContract, 1.0),
 116         uuid(a4ed5c81-76c9-40bd-8be6-b1d90fb20ae7)
 117     ]
 118     delegate HRESULT AsyncActionCompletedHandler([in] Windows.Foundation.IAsyncAction *action, [in] AsyncStatus status);
 119
 120     [
 121         contract(Windows.Foundation.FoundationContract, 1.0),
 122         uuid(ed32a372-f3c8-4faa-9cfb-470148da3888)
 123     ]
 124     delegate HRESULT DeferralCompletedHandler();
 125
 126     [contract(Windows.Foundation.FoundationContract, 1.0)]
 127     enum PropertyType
 128     {
 129         Empty       = 0,
 130         UInt8       = 1,
 131         Int16       = 2,
 132         UInt16      = 3,
 133         Int32       = 4,
 134         UInt32      = 5,
 135         Int64       = 6,
 136         UInt64      = 7,
 137         Single      = 8,
 138         Double      = 9,
 139         Char16      = 10,
 140         Boolean     = 11,
 141         String      = 12,
 142         Inspectable = 13,
 143         DateTime    = 14,
 144         TimeSpan    = 15,
 145         Guid        = 16,
 146         Point       = 17,
 147         Size        = 18,
 148         Rect        = 19,
 149         OtherType   = 20,
 150         UInt8Array       = 1025,
 151         Int16Array       = 1026,
 152         UInt16Array      = 1027,
 153         Int32Array       = 1028,
 154         UInt32Array      = 1029,
 155         Int64Array       = 1030,
 156         UInt64Array      = 1031,
 157         SingleArray      = 1032,
 158         DoubleArray      = 1033,
 159         Char16Array      = 1034,
 160         BooleanArray     = 1035,
 161         StringArray      = 1036,
 162         InspectableArray = 1037,
 163         DateTimeArray    = 1038,
 164         TimeSpanArray    = 1039,
 165         GuidArray        = 1040,
 166         PointArray       = 1041,
 167         SizeArray        = 1042,
 168         RectArray        = 1043,
 169         OtherTypeArray   = 1044,
 170     };
 171
 172     [contract(Windows.Foundation.FoundationContract, 1.0)]
 173     struct Point
 174     {
 175         FLOAT X;
 176         FLOAT Y;
 177     };
 178
 179     [contract(Windows.Foundation.FoundationContract, 1.0)]
 180     struct Size
 181     {
 182         FLOAT Width;
 183         FLOAT Height;
 184     };
 185
 186     [contract(Windows.Foundation.FoundationContract, 1.0)]
 187     struct Rect
 188     {
 189         FLOAT X;
 190         FLOAT Y;
 191         FLOAT Width;
 192         FLOAT Height;
 193     };
 194
 195     [contract(Windows.Foundation.FoundationContract, 1.0)]
 196     struct DateTime
 197     {
 198         INT64 UniversalTime;
 199     };
 200
 201     [contract(Windows.Foundation.FoundationContract, 1.0)]
 202     struct TimeSpan
 203     {
 204         INT64 Duration;
 205     };
 206
 207     [
 208         contract(Windows.Foundation.FoundationContract, 1.0),
 209         uuid(96369f54-8eb6-48f0-abce-c1b211e627c3)
 210     ]
 211     interface IStringable : IInspectable
 212     {
 213         HRESULT ToString([out, retval] HSTRING *value);
 214     }
 215
 216     [
 217         contract(Windows.Foundation.FoundationContract, 1.0),
 218         uuid(30d5a829-7fa4-4026-83bb-d75bae4ea99e)
 219     ]
 220     interface IClosable : IInspectable
 221     {
 222         HRESULT Close();
 223     }
 224
 225     [
 226         contract(Windows.Foundation.FoundationContract, 1.0),
 227         exclusiveto(Windows.Foundation.Deferral),
 228         uuid(d6269732-3b7f-46a7-b40b-4fdca2a2c693)
 229     ]
 230     interface IDeferral : IInspectable
 231         requires Windows.Foundation.IClosable
 232     {
 233         HRESULT Complete();
 234     }
 235
 236     [
 237         contract(Windows.Foundation.FoundationContract, 1.0),
 238         exclusiveto(Windows.Foundation.Deferral),
 239         uuid(65a1ecc5-3fb5-4832-8ca9-f061b281d13a)
 240     ]
 241     interface IDeferralFactory : IInspectable
 242     {
 243         HRESULT Create([in] Windows.Foundation.DeferralCompletedHandler *handler, [out, retval] Windows.Foundation.Deferral **result);
 244     }
 245
 246     [
 247         contract(Windows.Foundation.FoundationContract, 1.0),
 248         uuid(5a648006-843a-4da9-865b-9d26e5dfad7b)
 249     ]
 250     interface IAsyncAction : IInspectable
 251         requires IAsyncInfo
 252     {
 253         [propput] HRESULT Completed([in] Windows.Foundation.AsyncActionCompletedHandler *handler);
 254         [propget] HRESULT Completed([out, retval] Windows.Foundation.AsyncActionCompletedHandler **handler);
 255         HRESULT GetResults();
 256     }
 257
 258     [
 259         contract(Windows.Foundation.UniversalApiContract, 1.0),
 260         uuid(fbc4dd2a-245b-11e4-af98-689423260cf8)
 261     ]
 262     interface IMemoryBuffer : IInspectable
 263         requires Windows.Foundation.IClosable
 264     {
 265         HRESULT CreateReference([out, retval] Windows.Foundation.IMemoryBufferReference **reference);
 266     }
 267
 268     [
 269         contract(Windows.Foundation.UniversalApiContract, 1.0),
 270         exclusiveto(Windows.Foundation.MemoryBuffer),
 271         uuid(fbc4dd2b-245b-11e4-af98-689423260cf8)
 272     ]
 273     interface IMemoryBufferFactory : IInspectable
 274     {
 275         HRESULT Create([in, range(0x00000000, 0x7fffffff)] UINT32 capacity,
 276                        [out, retval] Windows.Foundation.MemoryBuffer **value);
 277     }
 278
 279     [
 280         contract(Windows.Foundation.UniversalApiContract, 1.0),
 281         uuid(fbc4dd29-245b-11e4-af98-689423260cf8)
 282     ]
 283     interface IMemoryBufferReference : IInspectable
 284         requires Windows.Foundation.IClosable
 285     {
 286         [propget] HRESULT Capacity([out, retval] UINT32 *value);
 287         [eventadd] HRESULT Closed([in] Windows.Foundation.TypedEventHandler<Windows.Foundation.IMemoryBufferReference *, IInspectable *> *handler,
 288                                   [out, retval] EventRegistrationToken *cookie);
 289         [eventremove] HRESULT Closed([in] EventRegistrationToken cookie);
 290     }
 291
 292     [
 293         contract(Windows.Foundation.UniversalApiContract, 1.0),
 294         exclusiveto(Windows.Foundation.Uri),
 295         uuid(c1d432ba-c824-4452-a7fd-512bc3bbe9a1)
 296     ]
 297     interface IUriEscapeStatics : IInspectable
 298     {
 299         HRESULT UnescapeComponent([in] HSTRING to_unescape, [out, retval] HSTRING *value);
 300         HRESULT EscapeComponent([in] HSTRING to_escape, [out, retval] HSTRING *value);
 301     }
 302
 303     [
 304         contract(Windows.Foundation.UniversalApiContract, 1.0),
 305         exclusiveto(Windows.Foundation.Uri),
 306         uuid(9e365e57-48b2-4160-956f-c7385120bbfc)
 307     ]
 308     interface IUriRuntimeClass : IInspectable
 309     {
 310         [propget] HRESULT AbsoluteUri([out, retval] HSTRING *value);
 311         [propget] HRESULT DisplayUri([out, retval] HSTRING *value);
 312         [propget] HRESULT Domain([out, retval] HSTRING *value);
 313         [propget] HRESULT Extension([out, retval] HSTRING *value);
 314         [propget] HRESULT Fragment([out, retval] HSTRING *value);
 315         [propget] HRESULT Host([out, retval] HSTRING *value);
 316         [propget] HRESULT Password([out, retval] HSTRING *value);
 317         [propget] HRESULT Path([out, retval] HSTRING *value);
 318         [propget] HRESULT Query([out, retval] HSTRING *value);
 319         [propget] HRESULT QueryParsed([out, retval] Windows.Foundation.WwwFormUrlDecoder **decoder);
 320         [propget] HRESULT RawUri([out, retval] HSTRING *value);
 321         [propget] HRESULT SchemeName([out, retval] HSTRING *value);
 322         [propget] HRESULT UserName([out, retval] HSTRING *value);
 323         [propget] HRESULT Port([out, retval] INT32 *value);
 324         [propget] HRESULT Suspicious([out, retval] boolean *value);
 325         HRESULT Equals([in] Windows.Foundation.Uri *uri, [out, retval] boolean *value);
 326         HRESULT CombineUri([in] HSTRING relative_uri, [out, retval] Windows.Foundation.Uri **instance);
 327     }
 328
 329     [
 330         contract(Windows.Foundation.UniversalApiContract, 1.0),
 331         exclusiveto(Windows.Foundation.Uri),
 332         uuid(44a9796f-723e-4fdf-a218-033e75b0c084)
 333     ]
 334     interface IUriRuntimeClassFactory : IInspectable
 335     {
 336         HRESULT CreateUri([in] HSTRING uri, [out, retval] Windows.Foundation.Uri **instance);
 337         HRESULT CreateWithRelativeUri([in] HSTRING base_uri, [in] HSTRING relative_uri, [out, retval] Windows.Foundation.Uri **instance);
 338     }
 339
 340     [
 341         contract(Windows.Foundation.UniversalApiContract, 1.0),
 342         exclusiveto(Windows.Foundation.Uri),
 343         uuid(758d9661-221c-480f-a339-50656673f46f)
 344     ]
 345     interface IUriRuntimeClassWithAbsoluteCanonicalUri : IInspectable
 346     {
 347         [propget] HRESULT AbsoluteCanonicalUri([out, retval] HSTRING *value);
 348         [propget] HRESULT DisplayIri([out, retval] HSTRING *value);
 349     }
 350
 351     [
 352         contract(Windows.Foundation.UniversalApiContract, 1.0),
 353         uuid(125e7431-f678-4e8e-b670-20a9b06c512d)
 354     ]
 355     interface IWwwFormUrlDecoderEntry : IInspectable
 356     {
 357         [propget] HRESULT Name([out, retval] HSTRING *value);
 358         [propget] HRESULT Value([out, retval] HSTRING *value);
 359     }
 360
 361     [
 362         contract(Windows.Foundation.UniversalApiContract, 1.0),
 363         exclusiveto(Windows.Foundation.WwwFormUrlDecoder),
 364         uuid(d45a0451-f225-4542-9296-0e1df5d254df)
 365     ]
 366     interface IWwwFormUrlDecoderRuntimeClass : IInspectable
 367         requires Windows.Foundation.Collections.IIterable<Windows.Foundation.IWwwFormUrlDecoderEntry *>,
 368                  Windows.Foundation.Collections.IVectorView<Windows.Foundation.IWwwFormUrlDecoderEntry *>
 369     {
 370         HRESULT GetFirstValueByName([in] HSTRING name, [out, retval] HSTRING *value);
 371     }
 372
 373     [
 374         contract(Windows.Foundation.UniversalApiContract, 1.0),
 375         exclusiveto(Windows.Foundation.WwwFormUrlDecoder),
 376         uuid(5b8c6b3d-24ae-41b5-a1bf-f0c3d544845b)
 377     ]
 378     interface IWwwFormUrlDecoderRuntimeClassFactory : IInspectable
 379     {
 380         HRESULT CreateWwwFormUrlDecoder([in] HSTRING query, [out, retval] Windows.Foundation.WwwFormUrlDecoder **instance);
 381     }
 382
 383     [
 384         activatable(Windows.Foundation.IDeferralFactory, Windows.Foundation.FoundationContract, 1.0),
 385         contract(Windows.Foundation.FoundationContract, 1.0),
 386         marshaling_behavior(agile)
 387     ]
 388     runtimeclass Deferral
 389     {
 390         [default] interface Windows.Foundation.IDeferral;
 391         interface Windows.Foundation.IClosable;
 392     }
 393
 394     [
 395         activatable(Windows.Foundation.IMemoryBufferFactory, Windows.Foundation.UniversalApiContract, 1.0),
 396         contract(Windows.Foundation.UniversalApiContract, 1.0),
 397         marshaling_behavior(agile),
 398         threading(both)
 399     ]
 400     runtimeclass MemoryBuffer
 401     {
 402         [default] interface Windows.Foundation.IMemoryBuffer;
 403         interface Windows.Foundation.IClosable;
 404     }
 405
 406     [
 407         activatable(Windows.Foundation.IUriRuntimeClassFactory, Windows.Foundation.UniversalApiContract, 1.0),
 408         contract(Windows.Foundation.UniversalApiContract, 1.0),
 409         marshaling_behavior(agile),
 410         static(Windows.Foundation.IUriEscapeStatics, Windows.Foundation.UniversalApiContract, 1.0),
 411         threading(both)
 412     ]
 413     runtimeclass Uri
 414     {
 415         [default] interface Windows.Foundation.IUriRuntimeClass;
 416         interface Windows.Foundation.IUriRuntimeClassWithAbsoluteCanonicalUri;
 417         [contract(Windows.Foundation.UniversalApiContract, 1.0)] interface Windows.Foundation.IStringable;
 418     }
 419
 420     [
 421         activatable(Windows.Foundation.IWwwFormUrlDecoderRuntimeClassFactory, Windows.Foundation.UniversalApiContract, 1.0),
 422         contract(Windows.Foundation.UniversalApiContract, 1.0),
 423         marshaling_behavior(agile),
 424         threading(both)
 425     ]
 426     runtimeclass WwwFormUrlDecoder
 427     {
 428         [default] interface Windows.Foundation.IWwwFormUrlDecoderRuntimeClass;
 429         interface Windows.Foundation.Collections.IVectorView<Windows.Foundation.IWwwFormUrlDecoderEntry *>;
 430         interface Windows.Foundation.Collections.IIterable<Windows.Foundation.IWwwFormUrlDecoderEntry *>;
 431     }
 432
 433     [
 434         contract(Windows.Foundation.UniversalApiContract, 1.0),
 435         marshaling_behavior(agile),
 436         threading(both)
 437     ]
 438     runtimeclass WwwFormUrlDecoderEntry
 439     {
 440         [default] interface Windows.Foundation.IWwwFormUrlDecoderEntry;
 441     }
 442 }