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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreAnimation/CAAnimation.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:
17
17
  <Docs>
18
18
    <summary>Base class for animations.</summary>
19
19
    <remarks />
 
20
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=109bd2a4-3437-4919-b556-3b44433ccc70">ViewTransitions</related>
 
21
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=afab3ce5-a98f-43d8-a981-c803ca8b9738">Example_CoreAnimation</related>
20
22
  </Docs>
21
23
  <Members>
22
24
    <Member MemberName=".ctor">
30
32
        <Attribute>
31
33
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
34
        </Attribute>
 
35
        <Attribute>
 
36
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
37
        </Attribute>
33
38
      </Attributes>
34
39
      <Parameters />
35
40
      <Docs>
49
54
        <Attribute>
50
55
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
56
        </Attribute>
 
57
        <Attribute>
 
58
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
59
        </Attribute>
52
60
      </Attributes>
53
61
      <Parameters>
54
62
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
74
      <AssemblyInfo>
67
75
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
76
      </AssemblyInfo>
 
77
      <Attributes>
 
78
        <Attribute>
 
79
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
80
        </Attribute>
 
81
      </Attributes>
69
82
      <Parameters>
70
83
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
84
      </Parameters>
72
85
      <Docs>
73
86
        <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>
 
87
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
88
        <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>
 
89
          <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
90
          <example>
82
91
            <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
 
}
 
92
public class MyClass : BaseClass {
 
93
    [Export ("initWithFoo:")]
 
94
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
95
    {
 
96
        ...
 
97
    }
100
98
</code>
101
99
          </example>
102
100
        </remarks>
109
107
      <AssemblyInfo>
110
108
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
109
      </AssemblyInfo>
 
110
      <Attributes>
 
111
        <Attribute>
 
112
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
113
        </Attribute>
 
114
      </Attributes>
112
115
      <Parameters>
113
116
        <Parameter Name="handle" Type="System.IntPtr" />
114
117
      </Parameters>
131
134
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
132
135
      </ReturnValue>
133
136
      <Docs>
134
 
        <summary>To be added.</summary>
135
 
        <value>To be added.</value>
 
137
        <summary>Represents the value associated with the constant kCAAnimationDiscrete</summary>
 
138
        <value>
 
139
        </value>
136
140
        <remarks>To be added.</remarks>
137
141
      </Docs>
138
142
    </Member>
147
151
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
148
152
      </ReturnValue>
149
153
      <Docs>
150
 
        <summary>To be added.</summary>
151
 
        <value>To be added.</value>
 
154
        <summary>Represents the value associated with the constant kCAAnimationLinear</summary>
 
155
        <value>
 
156
        </value>
152
157
        <remarks>To be added.</remarks>
153
158
      </Docs>
154
159
    </Member>
163
168
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
164
169
      </ReturnValue>
165
170
      <Docs>
166
 
        <summary>To be added.</summary>
167
 
        <value>To be added.</value>
 
171
        <summary>Represents the value associated with the constant kCAAnimationPaced</summary>
 
172
        <value>
 
173
        </value>
168
174
        <remarks>To be added.</remarks>
169
175
      </Docs>
170
176
    </Member>
359
365
      </ReturnValue>
360
366
      <Docs>
361
367
        <summary>An instance of the MonoMac.CoreAnimation.CAAnimationDelegate model class which acts as the class delegate.</summary>
362
 
        <value>The instance of the MonoMac.CoreAnimation.CAAnimationDelegate model class</value>
 
368
        <value>
 
369
          <para>The instance of the MonoMac.CoreAnimation.CAAnimationDelegate model class</para>
 
370
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
371
        </value>
363
372
        <remarks>
364
373
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
365
374
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>
408
417
        <param name="disposing">
409
418
          <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>
410
419
        </param>
411
 
        <summary>Releases the resourced used by the CAAnimation object.</summary>
 
420
        <summary>Releases the resources used by the CAAnimation object.</summary>
412
421
        <remarks>
413
422
          <para>This Dispose method releases the resources used by the CAAnimation class.</para>
414
423
          <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>
548
557
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
549
558
      </ReturnValue>
550
559
      <Docs>
551
 
        <summary>To be added.</summary>
552
 
        <value>To be added.</value>
 
560
        <summary>Represents the value associated with the constant kCAAnimationRotateAuto</summary>
 
561
        <value>
 
562
        </value>
553
563
        <remarks>To be added.</remarks>
554
564
      </Docs>
555
565
    </Member>
564
574
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
565
575
      </ReturnValue>
566
576
      <Docs>
567
 
        <summary>To be added.</summary>
568
 
        <value>To be added.</value>
 
577
        <summary>Represents the value associated with the constant kCAAnimationRotateAutoReverse</summary>
 
578
        <value>
 
579
        </value>
569
580
        <remarks>To be added.</remarks>
570
581
      </Docs>
571
582
    </Member>
677
688
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
678
689
      </ReturnValue>
679
690
      <Docs>
680
 
        <summary>Constant: Transition fade.</summary>
681
 
        <value>To be added.</value>
 
691
        <summary>Represents the value associated with the constant kCATransitionFade</summary>
 
692
        <value>
 
693
        </value>
682
694
        <remarks>To be added.</remarks>
683
695
      </Docs>
684
696
    </Member>
693
705
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
694
706
      </ReturnValue>
695
707
      <Docs>
696
 
        <summary>Constant, transition from bottom</summary>
697
 
        <value>To be added.</value>
 
708
        <summary>Represents the value associated with the constant kCATransitionFromBottom</summary>
 
709
        <value>
 
710
        </value>
698
711
        <remarks>To be added.</remarks>
699
712
      </Docs>
700
713
    </Member>
709
722
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
710
723
      </ReturnValue>
711
724
      <Docs>
712
 
        <summary>Contant: transition from the left.</summary>
713
 
        <value>To be added.</value>
 
725
        <summary>Represents the value associated with the constant kCATransitionFromLeft</summary>
 
726
        <value>
 
727
        </value>
714
728
        <remarks>To be added.</remarks>
715
729
      </Docs>
716
730
    </Member>
725
739
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
726
740
      </ReturnValue>
727
741
      <Docs>
728
 
        <summary>Constant: transition from the right.</summary>
729
 
        <value>To be added.</value>
 
742
        <summary>Represents the value associated with the constant kCATransitionFromRight</summary>
 
743
        <value>
 
744
        </value>
730
745
        <remarks>To be added.</remarks>
731
746
      </Docs>
732
747
    </Member>
741
756
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
742
757
      </ReturnValue>
743
758
      <Docs>
744
 
        <summary>Constant: transition from the top.</summary>
745
 
        <value>To be added.</value>
 
759
        <summary>Represents the value associated with the constant kCATransitionFromTop</summary>
 
760
        <value>
 
761
        </value>
746
762
        <remarks>To be added.</remarks>
747
763
      </Docs>
748
764
    </Member>
757
773
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
758
774
      </ReturnValue>
759
775
      <Docs>
760
 
        <summary>Constant: transition by moving in.</summary>
761
 
        <value>To be added.</value>
 
776
        <summary>Represents the value associated with the constant kCATransitionMoveIn</summary>
 
777
        <value>
 
778
        </value>
762
779
        <remarks>To be added.</remarks>
763
780
      </Docs>
764
781
    </Member>
773
790
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
774
791
      </ReturnValue>
775
792
      <Docs>
776
 
        <summary>Constant: transition by pushing.</summary>
777
 
        <value>To be added.</value>
 
793
        <summary>Represents the value associated with the constant kCATransitionPush</summary>
 
794
        <value>
 
795
        </value>
778
796
        <remarks>To be added.</remarks>
779
797
      </Docs>
780
798
    </Member>
789
807
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
790
808
      </ReturnValue>
791
809
      <Docs>
792
 
        <summary>Constant: transition by revealing.</summary>
793
 
        <value>To be added.</value>
 
810
        <summary>Represents the value associated with the constant kCATransitionReveal</summary>
 
811
        <value>
 
812
        </value>
794
813
        <remarks>To be added.</remarks>
795
814
      </Docs>
796
815
    </Member>
814
833
      </ReturnValue>
815
834
      <Docs>
816
835
        <summary>An object that can respond to the delegate protocol for this type</summary>
817
 
        <value>The instance that will respond to events and data requests.</value>
 
836
        <value>
 
837
          <para>The instance that will respond to events and data requests.</para>
 
838
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
839
        </value>
818
840
        <remarks>
819
841
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
820
842
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>