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