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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.CoreAnimation/CAShapeLayer.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:
49
49
        <Attribute>
50
50
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
51
51
        </Attribute>
 
52
        <Attribute>
 
53
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
54
        </Attribute>
52
55
      </Attributes>
53
56
      <Parameters />
54
57
      <Docs>
68
71
        <Attribute>
69
72
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
70
73
        </Attribute>
 
74
        <Attribute>
 
75
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
76
        </Attribute>
71
77
      </Attributes>
72
78
      <Parameters>
73
79
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
85
91
      <AssemblyInfo>
86
92
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
87
93
      </AssemblyInfo>
 
94
      <Attributes>
 
95
        <Attribute>
 
96
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
97
        </Attribute>
 
98
      </Attributes>
88
99
      <Parameters>
89
100
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
90
101
      </Parameters>
91
102
      <Docs>
92
103
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
93
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
104
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
94
105
        <remarks>
95
 
          <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>
96
 
          <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>
97
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
98
 
          <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>
99
 
          <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>
 
106
          <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>
100
107
          <example>
101
108
            <code lang="C#">
102
 
//
103
 
// The NSObjectFlag merely allocates the object and registers the
104
 
// C# class with the Objective-C runtime if necessary, but no actual
105
 
// initXxx method is invoked, that is done later in the constructor
106
 
//
107
 
// This is taken from MonoMac's source code:
108
 
//
109
 
[Export ("initWithFrame:")]
110
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
111
 
{
112
 
// Invoke the init method now.
113
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
114
 
        if (IsDirectBinding)
115
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
116
 
        else
117
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
118
 
}
 
109
public class MyClass : BaseClass {
 
110
    [Export ("initWithFoo:")]
 
111
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
112
    {
 
113
        ...
 
114
    }
119
115
</code>
120
116
          </example>
121
117
        </remarks>
128
124
      <AssemblyInfo>
129
125
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
130
126
      </AssemblyInfo>
 
127
      <Attributes>
 
128
        <Attribute>
 
129
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
130
        </Attribute>
 
131
      </Attributes>
131
132
      <Parameters>
132
133
        <Parameter Name="handle" Type="System.IntPtr" />
133
134
      </Parameters>
150
151
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
151
152
      </ReturnValue>
152
153
      <Docs>
153
 
        <summary>To be added.</summary>
154
 
        <value>To be added.</value>
 
154
        <summary>Represents the value associated with the constant kCALineCapButt</summary>
 
155
        <value>
 
156
        </value>
155
157
        <remarks>To be added.</remarks>
156
158
      </Docs>
157
159
    </Member>
166
168
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
167
169
      </ReturnValue>
168
170
      <Docs>
169
 
        <summary>To be added.</summary>
170
 
        <value>To be added.</value>
 
171
        <summary>Represents the value associated with the constant kCALineCapRound</summary>
 
172
        <value>
 
173
        </value>
171
174
        <remarks>To be added.</remarks>
172
175
      </Docs>
173
176
    </Member>
182
185
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
183
186
      </ReturnValue>
184
187
      <Docs>
185
 
        <summary>To be added.</summary>
186
 
        <value>To be added.</value>
 
188
        <summary>Represents the value associated with the constant kCALineCapSquare</summary>
 
189
        <value>
 
190
        </value>
187
191
        <remarks>To be added.</remarks>
188
192
      </Docs>
189
193
    </Member>
242
246
        <param name="disposing">
243
247
          <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>
244
248
        </param>
245
 
        <summary>Releases the resourced used by the CAShapeLayer object.</summary>
 
249
        <summary>Releases the resources used by the CAShapeLayer object.</summary>
246
250
        <remarks>
247
251
          <para>This Dispose method releases the resources used by the CAShapeLayer class.</para>
248
252
          <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>
271
275
      </ReturnValue>
272
276
      <Docs>
273
277
        <summary>To be added.</summary>
274
 
        <value>To be added.</value>
 
278
        <value>
 
279
          <para>(More documentation for this node is coming)</para>
 
280
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
281
        </value>
275
282
        <remarks>To be added.</remarks>
276
283
      </Docs>
277
284
    </Member>
310
317
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
311
318
      </ReturnValue>
312
319
      <Docs>
313
 
        <summary>To be added.</summary>
314
 
        <value>To be added.</value>
 
320
        <summary>Represents the value associated with the constant kCAFillRuleEvenOdd</summary>
 
321
        <value>
 
322
        </value>
315
323
        <remarks>To be added.</remarks>
316
324
      </Docs>
317
325
    </Member>
326
334
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
327
335
      </ReturnValue>
328
336
      <Docs>
329
 
        <summary>To be added.</summary>
330
 
        <value>To be added.</value>
 
337
        <summary>Represents the value associated with the constant kCAFillRuleNonZero</summary>
 
338
        <value>
 
339
        </value>
331
340
        <remarks>To be added.</remarks>
332
341
      </Docs>
333
342
    </Member>
342
351
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
343
352
      </ReturnValue>
344
353
      <Docs>
345
 
        <summary>To be added.</summary>
346
 
        <value>To be added.</value>
 
354
        <summary>Represents the value associated with the constant kCALineJoinBevel</summary>
 
355
        <value>
 
356
        </value>
347
357
        <remarks>To be added.</remarks>
348
358
      </Docs>
349
359
    </Member>
358
368
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
359
369
      </ReturnValue>
360
370
      <Docs>
361
 
        <summary>To be added.</summary>
362
 
        <value>To be added.</value>
 
371
        <summary>Represents the value associated with the constant kCALineJoinMiter</summary>
 
372
        <value>
 
373
        </value>
363
374
        <remarks>To be added.</remarks>
364
375
      </Docs>
365
376
    </Member>
374
385
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
375
386
      </ReturnValue>
376
387
      <Docs>
377
 
        <summary>To be added.</summary>
378
 
        <value>To be added.</value>
 
388
        <summary>Represents the value associated with the constant kCALineJoinRound</summary>
 
389
        <value>
 
390
        </value>
379
391
        <remarks>To be added.</remarks>
380
392
      </Docs>
381
393
    </Member>
423
435
      </ReturnValue>
424
436
      <Docs>
425
437
        <summary>To be added.</summary>
426
 
        <value>To be added.</value>
 
438
        <value>
 
439
          <para>(More documentation for this node is coming)</para>
 
440
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
441
        </value>
427
442
        <remarks>To be added.</remarks>
428
443
      </Docs>
429
444
    </Member>
543
558
      </ReturnValue>
544
559
      <Docs>
545
560
        <summary>To be added.</summary>
546
 
        <value>To be added.</value>
 
561
        <value>
 
562
          <para>(More documentation for this node is coming)</para>
 
563
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
564
        </value>
547
565
        <remarks>To be added.</remarks>
548
566
      </Docs>
549
567
    </Member>
567
585
      </ReturnValue>
568
586
      <Docs>
569
587
        <summary>To be added.</summary>
570
 
        <value>To be added.</value>
 
588
        <value>
 
589
          <para>(More documentation for this node is coming)</para>
 
590
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
591
        </value>
571
592
        <remarks>To be added.</remarks>
572
593
      </Docs>
573
594
    </Member>
580
601
      </AssemblyInfo>
581
602
      <Attributes>
582
603
        <Attribute>
 
604
          <AttributeName>MonoMac.ObjCRuntime.Since(4, 2)</AttributeName>
 
605
        </Attribute>
 
606
        <Attribute>
583
607
          <AttributeName>get: MonoMac.Foundation.Export("strokeEnd")</AttributeName>
584
608
        </Attribute>
585
609
        <Attribute>
604
628
      </AssemblyInfo>
605
629
      <Attributes>
606
630
        <Attribute>
 
631
          <AttributeName>MonoMac.ObjCRuntime.Since(4, 2)</AttributeName>
 
632
        </Attribute>
 
633
        <Attribute>
607
634
          <AttributeName>get: MonoMac.Foundation.Export("strokeStart")</AttributeName>
608
635
        </Attribute>
609
636
        <Attribute>