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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreAnimation/CAEmitterLayer.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>
247
248
        <param name="disposing">
248
249
          <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>
249
250
        </param>
250
 
        <summary>Releases the resourced used by the CAEmitterLayer object.</summary>
 
251
        <summary>Releases the resources used by the CAEmitterLayer object.</summary>
251
252
        <remarks>
252
253
          <para>This Dispose method releases the resources used by the CAEmitterLayer class.</para>
253
254
          <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>
315
316
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
316
317
      </ReturnValue>
317
318
      <Docs>
318
 
        <summary>To be added.</summary>
319
 
        <value>To be added.</value>
 
319
        <summary>Represents the value associated with the constant kCAEmitterLayerOutline</summary>
 
320
        <value>
 
321
        </value>
320
322
        <remarks>To be added.</remarks>
321
323
      </Docs>
322
324
    </Member>
331
333
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
332
334
      </ReturnValue>
333
335
      <Docs>
334
 
        <summary>To be added.</summary>
335
 
        <value>To be added.</value>
 
336
        <summary>Represents the value associated with the constant kCAEmitterLayerPoints</summary>
 
337
        <value>
 
338
        </value>
336
339
        <remarks>To be added.</remarks>
337
340
      </Docs>
338
341
    </Member>
347
350
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
348
351
      </ReturnValue>
349
352
      <Docs>
350
 
        <summary>To be added.</summary>
351
 
        <value>To be added.</value>
 
353
        <summary>Represents the value associated with the constant kCAEmitterLayerSurface</summary>
 
354
        <value>
 
355
        </value>
352
356
        <remarks>To be added.</remarks>
353
357
      </Docs>
354
358
    </Member>
363
367
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
364
368
      </ReturnValue>
365
369
      <Docs>
366
 
        <summary>To be added.</summary>
367
 
        <value>To be added.</value>
 
370
        <summary>Represents the value associated with the constant kCAEmitterLayerVolume</summary>
 
371
        <value>
 
372
        </value>
368
373
        <remarks>To be added.</remarks>
369
374
      </Docs>
370
375
    </Member>
427
432
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
428
433
      </ReturnValue>
429
434
      <Docs>
430
 
        <summary>To be added.</summary>
431
 
        <value>To be added.</value>
 
435
        <summary>Represents the value associated with the constant kCAEmitterLayerAdditive</summary>
 
436
        <value>
 
437
        </value>
432
438
        <remarks>To be added.</remarks>
433
439
      </Docs>
434
440
    </Member>
443
449
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
444
450
      </ReturnValue>
445
451
      <Docs>
446
 
        <summary>To be added.</summary>
447
 
        <value>To be added.</value>
 
452
        <summary>Represents the value associated with the constant kCAEmitterLayerBackToFront</summary>
 
453
        <value>
 
454
        </value>
448
455
        <remarks>To be added.</remarks>
449
456
      </Docs>
450
457
    </Member>
483
490
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
484
491
      </ReturnValue>
485
492
      <Docs>
486
 
        <summary>To be added.</summary>
487
 
        <value>To be added.</value>
 
493
        <summary>Represents the value associated with the constant kCAEmitterLayerOldestFirst</summary>
 
494
        <value>
 
495
        </value>
488
496
        <remarks>To be added.</remarks>
489
497
      </Docs>
490
498
    </Member>
499
507
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
500
508
      </ReturnValue>
501
509
      <Docs>
502
 
        <summary>To be added.</summary>
503
 
        <value>To be added.</value>
 
510
        <summary>Represents the value associated with the constant kCAEmitterLayerOldestLast</summary>
 
511
        <value>
 
512
        </value>
504
513
        <remarks>To be added.</remarks>
505
514
      </Docs>
506
515
    </Member>
515
524
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
516
525
      </ReturnValue>
517
526
      <Docs>
518
 
        <summary>To be added.</summary>
519
 
        <value>To be added.</value>
 
527
        <summary>Represents the value associated with the constant kCAEmitterLayerUnordered</summary>
 
528
        <value>
 
529
        </value>
520
530
        <remarks>To be added.</remarks>
521
531
      </Docs>
522
532
    </Member>
603
613
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
604
614
      </ReturnValue>
605
615
      <Docs>
606
 
        <summary>To be added.</summary>
607
 
        <value>To be added.</value>
 
616
        <summary>Represents the value associated with the constant kCAEmitterLayerCircle</summary>
 
617
        <value>
 
618
        </value>
608
619
        <remarks>To be added.</remarks>
609
620
      </Docs>
610
621
    </Member>
619
630
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
620
631
      </ReturnValue>
621
632
      <Docs>
622
 
        <summary>To be added.</summary>
623
 
        <value>To be added.</value>
 
633
        <summary>Represents the value associated with the constant kCAEmitterLayerCuboid</summary>
 
634
        <value>
 
635
        </value>
624
636
        <remarks>To be added.</remarks>
625
637
      </Docs>
626
638
    </Member>
635
647
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
636
648
      </ReturnValue>
637
649
      <Docs>
638
 
        <summary>To be added.</summary>
639
 
        <value>To be added.</value>
 
650
        <summary>Represents the value associated with the constant kCAEmitterLayerLine</summary>
 
651
        <value>
 
652
        </value>
640
653
        <remarks>To be added.</remarks>
641
654
      </Docs>
642
655
    </Member>
651
664
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
652
665
      </ReturnValue>
653
666
      <Docs>
654
 
        <summary>To be added.</summary>
655
 
        <value>To be added.</value>
 
667
        <summary>Represents the value associated with the constant kCAEmitterLayerPoint</summary>
 
668
        <value>
 
669
        </value>
656
670
        <remarks>To be added.</remarks>
657
671
      </Docs>
658
672
    </Member>
667
681
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
668
682
      </ReturnValue>
669
683
      <Docs>
670
 
        <summary>To be added.</summary>
671
 
        <value>To be added.</value>
 
684
        <summary>Represents the value associated with the constant kCAEmitterLayerRectangle</summary>
 
685
        <value>
 
686
        </value>
672
687
        <remarks>To be added.</remarks>
673
688
      </Docs>
674
689
    </Member>
683
698
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
684
699
      </ReturnValue>
685
700
      <Docs>
686
 
        <summary>To be added.</summary>
687
 
        <value>To be added.</value>
 
701
        <summary>Represents the value associated with the constant kCAEmitterLayerSphere</summary>
 
702
        <value>
 
703
        </value>
688
704
        <remarks>To be added.</remarks>
689
705
      </Docs>
690
706
    </Member>