~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.QTKit/QTMedia.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
ImportĀ upstreamĀ versionĀ 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
30
30
        <Attribute>
31
31
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
33
36
      </Attributes>
34
37
      <Parameters />
35
38
      <Docs>
49
52
        <Attribute>
50
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
52
58
      </Attributes>
53
59
      <Parameters>
54
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
72
      <AssemblyInfo>
67
73
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
74
      </AssemblyInfo>
 
75
      <Attributes>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
 
79
      </Attributes>
69
80
      <Parameters>
70
81
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
82
      </Parameters>
72
83
      <Docs>
73
84
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
74
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
85
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
86
        <remarks>
76
 
          <para>This constructor should be called by derived classes when they completely construct the object in managed code and merely want the runtime to allocate and initialize the NSObject.   This is required to implement the two-step initialization process that Objective-C uses, the first step is to perform the object allocation, the second step is to initialize the object.   When you invoke the constructor that takes the NSObjectFlag.Empty you taking advatnage of a direct path that goes all the way up to NSObject to merely allocate the object's memory and bind the Objective-C and C# objects together.    The actual initialization of the object is up to you.</para>
77
 
          <para>This constructor is typically used by the binding generator to allocate the object, but prevent the actual initialization to take place.   Once the allocation has taken place, the constructor has to initialize the object.   With constructors generated by the binding generator this means that it manually invokes one of the "init" methods to initialize the object.</para>
78
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
79
 
          <para>In general, if your constructors invokes the NSObjectFlag.Empty base implementation, then it should be calling an Objective-C init method.   If this is not the case, you should instead chain to the proper constructor in your class. </para>
80
 
          <para>The argument value is ignored and merely ensures that the only code that is executed is the construction phase is the basic NSObject allocation and runtime type registration.  Typically the chaining would look like this:</para>
 
87
          <para>This constructor should be called by derived classes when they are initialized using an [Export] attribute. The argument value is ignore, typically the chaining would look like this:</para>
81
88
          <example>
82
89
            <code lang="C#">
83
 
//
84
 
// The NSObjectFlag merely allocates the object and registers the
85
 
// C# class with the Objective-C runtime if necessary, but no actual
86
 
// initXxx method is invoked, that is done later in the constructor
87
 
//
88
 
// This is taken from MonoMac's source code:
89
 
//
90
 
[Export ("initWithFrame:")]
91
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
92
 
{
93
 
// Invoke the init method now.
94
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
95
 
        if (IsDirectBinding)
96
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
97
 
        else
98
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
99
 
}
 
90
public class MyClass : BaseClass {
 
91
    [Export ("initWithFoo:")]
 
92
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
93
    {
 
94
        ...
 
95
    }
100
96
</code>
101
97
          </example>
102
98
        </remarks>
109
105
      <AssemblyInfo>
110
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
107
      </AssemblyInfo>
 
108
      <Attributes>
 
109
        <Attribute>
 
110
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
111
        </Attribute>
 
112
      </Attributes>
112
113
      <Parameters>
113
114
        <Parameter Name="handle" Type="System.IntPtr" />
114
115
      </Parameters>
131
132
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
132
133
      </ReturnValue>
133
134
      <Docs>
134
 
        <summary>To be added.</summary>
135
 
        <value>To be added.</value>
 
135
        <summary>Represents the value associated with the constant QTMediaCharacteristicAudio</summary>
 
136
        <value>
 
137
        </value>
136
138
        <remarks>To be added.</remarks>
137
139
      </Docs>
138
140
    </Member>
147
149
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
148
150
      </ReturnValue>
149
151
      <Docs>
150
 
        <summary>To be added.</summary>
151
 
        <value>To be added.</value>
 
152
        <summary>Represents the value associated with the constant QTMediaCharacteristicCanSendVideo</summary>
 
153
        <value>
 
154
        </value>
152
155
        <remarks>To be added.</remarks>
153
156
      </Docs>
154
157
    </Member>
163
166
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
164
167
      </ReturnValue>
165
168
      <Docs>
166
 
        <summary>To be added.</summary>
167
 
        <value>To be added.</value>
 
169
        <summary>Represents the value associated with the constant QTMediaCharacteristicCanStep</summary>
 
170
        <value>
 
171
        </value>
168
172
        <remarks>To be added.</remarks>
169
173
      </Docs>
170
174
    </Member>
179
183
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
180
184
      </ReturnValue>
181
185
      <Docs>
182
 
        <summary>To be added.</summary>
183
 
        <value>To be added.</value>
 
186
        <summary>Represents the value associated with the constant QTMediaCharacteristicHasNoDuration</summary>
 
187
        <value>
 
188
        </value>
184
189
        <remarks>To be added.</remarks>
185
190
      </Docs>
186
191
    </Member>
195
200
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
196
201
      </ReturnValue>
197
202
      <Docs>
198
 
        <summary>To be added.</summary>
199
 
        <value>To be added.</value>
 
203
        <summary>Represents the value associated with the constant QTMediaCharacteristicHasSkinData</summary>
 
204
        <value>
 
205
        </value>
200
206
        <remarks>To be added.</remarks>
201
207
      </Docs>
202
208
    </Member>
211
217
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
212
218
      </ReturnValue>
213
219
      <Docs>
214
 
        <summary>To be added.</summary>
215
 
        <value>To be added.</value>
 
220
        <summary>Represents the value associated with the constant QTMediaCharacteristicHasVideoFrameRate</summary>
 
221
        <value>
 
222
        </value>
216
223
        <remarks>To be added.</remarks>
217
224
      </Docs>
218
225
    </Member>
227
234
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
228
235
      </ReturnValue>
229
236
      <Docs>
230
 
        <summary>To be added.</summary>
231
 
        <value>To be added.</value>
 
237
        <summary>Represents the value associated with the constant QTMediaCharacteristicNonLinear</summary>
 
238
        <value>
 
239
        </value>
232
240
        <remarks>To be added.</remarks>
233
241
      </Docs>
234
242
    </Member>
243
251
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
244
252
      </ReturnValue>
245
253
      <Docs>
246
 
        <summary>To be added.</summary>
247
 
        <value>To be added.</value>
 
254
        <summary>Represents the value associated with the constant QTMediaCharacteristicProvidesActions</summary>
 
255
        <value>
 
256
        </value>
248
257
        <remarks>To be added.</remarks>
249
258
      </Docs>
250
259
    </Member>
259
268
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
260
269
      </ReturnValue>
261
270
      <Docs>
262
 
        <summary>To be added.</summary>
263
 
        <value>To be added.</value>
 
271
        <summary>Represents the value associated with the constant QTMediaCharacteristicProvidesKeyFocus</summary>
 
272
        <value>
 
273
        </value>
264
274
        <remarks>To be added.</remarks>
265
275
      </Docs>
266
276
    </Member>
275
285
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
276
286
      </ReturnValue>
277
287
      <Docs>
278
 
        <summary>To be added.</summary>
279
 
        <value>To be added.</value>
 
288
        <summary>Represents the value associated with the constant QTMediaCharacteristicVisual</summary>
 
289
        <value>
 
290
        </value>
280
291
        <remarks>To be added.</remarks>
281
292
      </Docs>
282
293
    </Member>
334
345
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
335
346
      </ReturnValue>
336
347
      <Docs>
337
 
        <summary>To be added.</summary>
338
 
        <value>To be added.</value>
 
348
        <summary>Represents the value associated with the constant QTMediaCreationTimeAttribute</summary>
 
349
        <value>
 
350
        </value>
339
351
        <remarks>To be added.</remarks>
340
352
      </Docs>
341
353
    </Member>
356
368
        <param name="disposing">
357
369
          <para>If set to <see langword="true" />, the method is invoked directly and will dispose manage and unmanaged resources;   If set to <see langword="false" /> the method is being called by the garbage collector finalizer and should only release unmanaged resources.</para>
358
370
        </param>
359
 
        <summary>Releases the resourced used by the QTMedia object.</summary>
 
371
        <summary>Releases the resources used by the QTMedia object.</summary>
360
372
        <remarks>
361
373
          <para>This Dispose method releases the resources used by the QTMedia class.</para>
362
374
          <para>This method is called by both the Dispose() method and the object finalizer (Finalize).    When invoked by the Dispose method, the parameter disposting <paramref name="disposing" /> is set to <see langword="true" /> and any managed object references that this object holds are also disposed or released;  when invoked by the object finalizer, on the finalizer thread the value is set to <see langword="false" />. </para>
376
388
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
377
389
      </ReturnValue>
378
390
      <Docs>
379
 
        <summary>To be added.</summary>
380
 
        <value>To be added.</value>
 
391
        <summary>Represents the value associated with the constant QTMediaDurationAttribute</summary>
 
392
        <value>
 
393
        </value>
381
394
        <remarks>To be added.</remarks>
382
395
      </Docs>
383
396
    </Member>
493
506
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
494
507
      </ReturnValue>
495
508
      <Docs>
496
 
        <summary>To be added.</summary>
497
 
        <value>To be added.</value>
 
509
        <summary>Represents the value associated with the constant QTMediaModificationTimeAttribute</summary>
 
510
        <value>
 
511
        </value>
498
512
        <remarks>To be added.</remarks>
499
513
      </Docs>
500
514
    </Member>
509
523
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
510
524
      </ReturnValue>
511
525
      <Docs>
512
 
        <summary>To be added.</summary>
513
 
        <value>To be added.</value>
 
526
        <summary>Represents the value associated with the constant QTMediaQualityAttribute</summary>
 
527
        <value>
 
528
        </value>
514
529
        <remarks>To be added.</remarks>
515
530
      </Docs>
516
531
    </Member>
546
561
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
547
562
      </ReturnValue>
548
563
      <Docs>
549
 
        <summary>To be added.</summary>
550
 
        <value>To be added.</value>
 
564
        <summary>Represents the value associated with the constant QTMediaSampleCountAttribute</summary>
 
565
        <value>
 
566
        </value>
551
567
        <remarks>To be added.</remarks>
552
568
      </Docs>
553
569
    </Member>
588
604
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
589
605
      </ReturnValue>
590
606
      <Docs>
591
 
        <summary>To be added.</summary>
592
 
        <value>To be added.</value>
 
607
        <summary>Represents the value associated with the constant QTMediaTimeScaleAttribute</summary>
 
608
        <value>
 
609
        </value>
593
610
        <remarks>To be added.</remarks>
594
611
      </Docs>
595
612
    </Member>
625
642
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
626
643
      </ReturnValue>
627
644
      <Docs>
628
 
        <summary>To be added.</summary>
629
 
        <value>To be added.</value>
 
645
        <summary>Represents the value associated with the constant QTMediaTypeAttribute</summary>
 
646
        <value>
 
647
        </value>
630
648
        <remarks>To be added.</remarks>
631
649
      </Docs>
632
650
    </Member>