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