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     runtimeclass Deferral;
  72     runtimeclass MemoryBuffer;
  73
  74     declare {
  75         interface Windows.Foundation.Collections.IIterable<HSTRING>;
  76         interface Windows.Foundation.Collections.IIterable<IInspectable *>;
  77         interface Windows.Foundation.Collections.IIterator<HSTRING>;
  78         interface Windows.Foundation.Collections.IIterator<IInspectable *>;
  79         interface Windows.Foundation.Collections.IVectorView<HSTRING>;
  80         interface Windows.Foundation.Collections.IVectorView<IInspectable *>;
  81         interface Windows.Foundation.Collections.IVector<HSTRING>;
  82         interface Windows.Foundation.Collections.IVector<IInspectable *>;
  83         interface Windows.Foundation.Collections.IMapView<HSTRING, Windows.Foundation.Collections.IVectorView<HSTRING> *>;
  84         interface Windows.Foundation.EventHandler<IInspectable *>;
  85         interface Windows.Foundation.AsyncOperationCompletedHandler<IInspectable *>;
  86         interface Windows.Foundation.AsyncOperationCompletedHandler<boolean>;
  87         interface Windows.Foundation.IAsyncOperation<IInspectable *>;
  88         interface Windows.Foundation.IAsyncOperation<boolean>;
  89         interface Windows.Foundation.IReference<BYTE>;
  90         interface Windows.Foundation.IReference<INT32>;
  91         interface Windows.Foundation.IReference<DOUBLE>;
  92         interface Windows.Foundation.TypedEventHandler<IInspectable *, IInspectable *>;
  93         interface Windows.Foundation.TypedEventHandler<Windows.Foundation.IMemoryBufferReference *, IInspectable *>;
  94     }
  95
  96     [
  97         contract(Windows.Foundation.FoundationContract, 1.0),
  98         uuid(a4ed5c81-76c9-40bd-8be6-b1d90fb20ae7)
  99     ]
 100     delegate HRESULT AsyncActionCompletedHandler([in] Windows.Foundation.IAsyncAction *action, [in] AsyncStatus status);
 101
 102     [
 103         contract(Windows.Foundation.FoundationContract, 1.0),
 104         uuid(ed32a372-f3c8-4faa-9cfb-470148da3888)
 105     ]
 106     delegate HRESULT DeferralCompletedHandler();
 107
 108     [contract(Windows.Foundation.FoundationContract, 1.0)]
 109     enum PropertyType
 110     {
 111         Empty       = 0,
 112         UInt8       = 1,
 113         Int16       = 2,
 114         UInt16      = 3,
 115         Int32       = 4,
 116         UInt32      = 5,
 117         Int64       = 6,
 118         UInt64      = 7,
 119         Single      = 8,
 120         Double      = 9,
 121         Char16      = 10,
 122         Boolean     = 11,
 123         String      = 12,
 124         Inspectable = 13,
 125         DateTime    = 14,
 126         TimeSpan    = 15,
 127         Guid        = 16,
 128         Point       = 17,
 129         Size        = 18,
 130         Rect        = 19,
 131         OtherType   = 20,
 132         UInt8Array       = 1025,
 133         Int16Array       = 1026,
 134         UInt16Array      = 1027,
 135         Int32Array       = 1028,
 136         UInt32Array      = 1029,
 137         Int64Array       = 1030,
 138         UInt64Array      = 1031,
 139         SingleArray      = 1032,
 140         DoubleArray      = 1033,
 141         Char16Array      = 1034,
 142         BooleanArray     = 1035,
 143         StringArray      = 1036,
 144         InspectableArray = 1037,
 145         DateTimeArray    = 1038,
 146         TimeSpanArray    = 1039,
 147         GuidArray        = 1040,
 148         PointArray       = 1041,
 149         SizeArray        = 1042,
 150         RectArray        = 1043,
 151         OtherTypeArray   = 1044,
 152     };
 153
 154     [contract(Windows.Foundation.FoundationContract, 1.0)]
 155     struct Point
 156     {
 157         FLOAT X;
 158         FLOAT Y;
 159     };
 160
 161     [contract(Windows.Foundation.FoundationContract, 1.0)]
 162     struct Size
 163     {
 164         FLOAT Width;
 165         FLOAT Height;
 166     };
 167
 168     [contract(Windows.Foundation.FoundationContract, 1.0)]
 169     struct Rect
 170     {
 171         FLOAT X;
 172         FLOAT Y;
 173         FLOAT Width;
 174         FLOAT Height;
 175     };
 176
 177     [contract(Windows.Foundation.FoundationContract, 1.0)]
 178     struct DateTime
 179     {
 180         INT64 UniversalTime;
 181     };
 182
 183     [contract(Windows.Foundation.FoundationContract, 1.0)]
 184     struct TimeSpan
 185     {
 186         INT64 Duration;
 187     };
 188
 189     [
 190         contract(Windows.Foundation.FoundationContract, 1.0),
 191         uuid(96369f54-8eb6-48f0-abce-c1b211e627c3)
 192     ]
 193     interface IStringable : IInspectable
 194     {
 195         HRESULT ToString([out, retval] HSTRING *value);
 196     }
 197
 198     [
 199         contract(Windows.Foundation.FoundationContract, 1.0),
 200         uuid(30d5a829-7fa4-4026-83bb-d75bae4ea99e)
 201     ]
 202     interface IClosable : IInspectable
 203     {
 204         HRESULT Close();
 205     }
 206
 207     [
 208         contract(Windows.Foundation.FoundationContract, 1.0),
 209         exclusiveto(Windows.Foundation.Deferral),
 210         uuid(d6269732-3b7f-46a7-b40b-4fdca2a2c693)
 211     ]
 212     interface IDeferral : IInspectable
 213         requires Windows.Foundation.IClosable
 214     {
 215         HRESULT Complete();
 216     }
 217
 218     [
 219         contract(Windows.Foundation.FoundationContract, 1.0),
 220         exclusiveto(Windows.Foundation.Deferral),
 221         uuid(65a1ecc5-3fb5-4832-8ca9-f061b281d13a)
 222     ]
 223     interface IDeferralFactory : IInspectable
 224     {
 225         HRESULT Create([in] Windows.Foundation.DeferralCompletedHandler *handler, [out, retval] Windows.Foundation.Deferral **result);
 226     }
 227
 228     [
 229         contract(Windows.Foundation.FoundationContract, 1.0),
 230         uuid(5a648006-843a-4da9-865b-9d26e5dfad7b)
 231     ]
 232     interface IAsyncAction : IInspectable
 233         requires IAsyncInfo
 234     {
 235         [propput] HRESULT Completed([in] Windows.Foundation.AsyncActionCompletedHandler *handler);
 236         [propget] HRESULT Completed([out, retval] Windows.Foundation.AsyncActionCompletedHandler **handler);
 237         HRESULT GetResults();
 238     }
 239
 240     [
 241         contract(Windows.Foundation.UniversalApiContract, 1.0),
 242         uuid(fbc4dd2a-245b-11e4-af98-689423260cf8)
 243     ]
 244     interface IMemoryBuffer : IInspectable
 245         requires Windows.Foundation.IClosable
 246     {
 247         HRESULT CreateReference([out, retval] Windows.Foundation.IMemoryBufferReference **reference);
 248     }
 249
 250     [
 251         contract(Windows.Foundation.UniversalApiContract, 1.0),
 252         exclusiveto(Windows.Foundation.MemoryBuffer),
 253         uuid(fbc4dd2b-245b-11e4-af98-689423260cf8)
 254     ]
 255     interface IMemoryBufferFactory : IInspectable
 256     {
 257         HRESULT Create([in, range(0x00000000, 0x7fffffff)] UINT32 capacity,
 258                        [out, retval] Windows.Foundation.MemoryBuffer **value);
 259     }
 260
 261     [
 262         contract(Windows.Foundation.UniversalApiContract, 1.0),
 263         uuid(fbc4dd29-245b-11e4-af98-689423260cf8)
 264     ]
 265     interface IMemoryBufferReference : IInspectable
 266         requires Windows.Foundation.IClosable
 267     {
 268         [propget] HRESULT Capacity([out, retval] UINT32 *value);
 269         [eventadd] HRESULT Closed([in] Windows.Foundation.TypedEventHandler<Windows.Foundation.IMemoryBufferReference *, IInspectable *> *handler,
 270                                   [out, retval] EventRegistrationToken *cookie);
 271         [eventremove] HRESULT Closed([in] EventRegistrationToken cookie);
 272     }
 273
 274     [
 275         activatable(Windows.Foundation.IDeferralFactory, Windows.Foundation.FoundationContract, 1.0),
 276         contract(Windows.Foundation.FoundationContract, 1.0),
 277         marshaling_behavior(agile)
 278     ]
 279     runtimeclass Deferral
 280     {
 281         [default] interface Windows.Foundation.IDeferral;
 282         interface Windows.Foundation.IClosable;
 283     }
 284
 285     [
 286         activatable(Windows.Foundation.IMemoryBufferFactory, Windows.Foundation.UniversalApiContract, 1.0),
 287         contract(Windows.Foundation.UniversalApiContract, 1.0),
 288         marshaling_behavior(agile),
 289         threading(both)
 290     ]
 291     runtimeclass MemoryBuffer
 292     {
 293         [default] interface Windows.Foundation.IMemoryBuffer;
 294         interface Windows.Foundation.IClosable;
 295     }
 296 }