← Back to branch summary

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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreAnimation/CAMediaTimingFunction.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:
external/monomac/docs/en/MonoMac.CoreAnimation/CAMediaTimingFunction.xml
17
17
  <Docs>
18
18
    <summary>Defines the pacing of an animation.</summary>
19
19
    <remarks>To be added.</remarks>
 
20
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=afab3ce5-a98f-43d8-a981-c803ca8b9738">Example_CoreAnimation</related>
 
21
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=109bd2a4-3437-4919-b556-3b44433ccc70">ViewTransitions</related>
20
22
  </Docs>
21
23
  <Members>
22
24
    <Member MemberName=".ctor">
28
30
      </AssemblyInfo>
29
31
      <Attributes>
30
32
        <Attribute>
31
 
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
 
33
          <AttributeName>System.Obsolete("This type is not meant to be created by application code")</AttributeName>
32
34
        </Attribute>
33
35
      </Attributes>
34
36
      <Parameters />
49
51
        <Attribute>
50
52
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
53
        </Attribute>
 
54
        <Attribute>
 
55
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
56
        </Attribute>
52
57
      </Attributes>
53
58
      <Parameters>
54
59
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
71
      <AssemblyInfo>
67
72
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
73
      </AssemblyInfo>
 
74
      <Attributes>
 
75
        <Attribute>
 
76
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
77
        </Attribute>
 
78
      </Attributes>
69
79
      <Parameters>
70
80
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
81
      </Parameters>
72
82
      <Docs>
73
83
        <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>
 
84
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
85
        <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>
 
86
          <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
87
          <example>
82
88
            <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
 
}
 
89
public class MyClass : BaseClass {
 
90
    [Export ("initWithFoo:")]
 
91
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
92
    {
 
93
        ...
 
94
    }
100
95
</code>
101
96
          </example>
102
97
        </remarks>
109
104
      <AssemblyInfo>
110
105
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
106
      </AssemblyInfo>
 
107
      <Attributes>
 
108
        <Attribute>
 
109
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
110
        </Attribute>
 
111
      </Attributes>
112
112
      <Parameters>
113
113
        <Parameter Name="handle" Type="System.IntPtr" />
114
114
      </Parameters>
163
163
        <remarks>Each MonoMac class mirrors an unmanaged Objective-C class.   This value contains the pointer to the Objective-C class, it is similar to calling objc_getClass with the object name.</remarks>
164
164
      </Docs>
165
165
    </Member>
 
166
    <Member MemberName="Default">
 
167
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString Default { get; }" />
 
168
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString Default" />
 
169
      <MemberType>Property</MemberType>
 
170
      <AssemblyInfo>
 
171
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
172
      </AssemblyInfo>
 
173
      <ReturnValue>
 
174
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
175
      </ReturnValue>
 
176
      <Docs>
 
177
        <summary>To be added.</summary>
 
178
        <value>To be added.</value>
 
179
        <remarks>To be added.</remarks>
 
180
      </Docs>
 
181
    </Member>
166
182
    <Member MemberName="EaseIn">
167
183
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString EaseIn { get; }" />
168
184
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString EaseIn" />
174
190
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
175
191
      </ReturnValue>
176
192
      <Docs>
177
 
        <summary>To be added.</summary>
178
 
        <value>To be added.</value>
 
193
        <summary>Represents the value associated with the constant kCAMediaTimingFunctionEaseIn</summary>
 
194
        <value>
 
195
        </value>
179
196
        <remarks>To be added.</remarks>
180
197
      </Docs>
181
198
    </Member>
190
207
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
191
208
      </ReturnValue>
192
209
      <Docs>
193
 
        <summary>To be added.</summary>
194
 
        <value>To be added.</value>
 
210
        <summary>Represents the value associated with the constant kCAMediaTimingFunctionEaseInEaseOut</summary>
 
211
        <value>
 
212
        </value>
195
213
        <remarks>To be added.</remarks>
196
214
      </Docs>
197
215
    </Member>
206
224
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
207
225
      </ReturnValue>
208
226
      <Docs>
209
 
        <summary>To be added.</summary>
210
 
        <value>To be added.</value>
 
227
        <summary>Represents the value associated with the constant kCAMediaTimingFunctionEaseOut</summary>
 
228
        <value>
 
229
        </value>
211
230
        <remarks>To be added.</remarks>
212
231
      </Docs>
213
232
    </Member>
243
262
      </Docs>
244
263
    </Member>
245
264
    <Member MemberName="FromName">
 
265
      <MemberSignature Language="C#" Value="public static MonoMac.CoreAnimation.CAMediaTimingFunction FromName (MonoMac.Foundation.NSString name);" />
 
266
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreAnimation.CAMediaTimingFunction FromName(class MonoMac.Foundation.NSString name) cil managed" />
 
267
      <MemberType>Method</MemberType>
 
268
      <AssemblyInfo>
 
269
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
270
      </AssemblyInfo>
 
271
      <Attributes>
 
272
        <Attribute>
 
273
          <AttributeName>MonoMac.Foundation.Export("functionWithName:")</AttributeName>
 
274
        </Attribute>
 
275
      </Attributes>
 
276
      <ReturnValue>
 
277
        <ReturnType>MonoMac.CoreAnimation.CAMediaTimingFunction</ReturnType>
 
278
      </ReturnValue>
 
279
      <Parameters>
 
280
        <Parameter Name="name" Type="MonoMac.Foundation.NSString" />
 
281
      </Parameters>
 
282
      <Docs>
 
283
        <param name="name">To be added.</param>
 
284
        <summary>To be added.</summary>
 
285
        <returns>To be added.</returns>
 
286
        <remarks>To be added.</remarks>
 
287
      </Docs>
 
288
    </Member>
 
289
    <Member MemberName="FromName">
246
290
      <MemberSignature Language="C#" Value="public static MonoMac.CoreAnimation.CAMediaTimingFunction FromName (string name);" />
247
291
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreAnimation.CAMediaTimingFunction FromName(string name) cil managed" />
248
292
      <MemberType>Method</MemberType>
251
295
      </AssemblyInfo>
252
296
      <Attributes>
253
297
        <Attribute>
254
 
          <AttributeName>MonoMac.Foundation.Export("functionWithName:")</AttributeName>
 
298
          <AttributeName>System.Obsolete("Use FromName(NSString) with one of the CAMediaTimingFunction fields")</AttributeName>
255
299
        </Attribute>
256
300
      </Attributes>
257
301
      <ReturnValue>
267
311
        <remarks>To be added.</remarks>
268
312
      </Docs>
269
313
    </Member>
 
314
    <Member MemberName="GetControlPoint">
 
315
      <MemberSignature Language="C#" Value="public System.Drawing.PointF GetControlPoint (int index);" />
 
316
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Drawing.PointF GetControlPoint(int32 index) cil managed" />
 
317
      <MemberType>Method</MemberType>
 
318
      <AssemblyInfo>
 
319
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
320
      </AssemblyInfo>
 
321
      <ReturnValue>
 
322
        <ReturnType>System.Drawing.PointF</ReturnType>
 
323
      </ReturnValue>
 
324
      <Parameters>
 
325
        <Parameter Name="index" Type="System.Int32" />
 
326
      </Parameters>
 
327
      <Docs>
 
328
        <param name="index">To be added.</param>
 
329
        <summary>To be added.</summary>
 
330
        <returns>To be added.</returns>
 
331
        <remarks>To be added.</remarks>
 
332
      </Docs>
 
333
    </Member>
270
334
    <Member MemberName="Linear">
271
335
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSString Linear { get; }" />
272
336
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSString Linear" />
278
342
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
279
343
      </ReturnValue>
280
344
      <Docs>
281
 
        <summary>To be added.</summary>
282
 
        <value>To be added.</value>
 
345
        <summary>Represents the value associated with the constant kCAMediaTimingFunctionLinear</summary>
 
346
        <value>
 
347
        </value>
283
348
        <remarks>To be added.</remarks>
284
349
      </Docs>
285
350
    </Member>