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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.Foundation/NSArray.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>An untyped Objective-C array.</summary>
19
19
    <remarks>To be added.</remarks>
 
20
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=67b46eb2-81d9-477f-a448-18e68db1227b">AppPrefs</related>
 
21
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=c66750f5-a4dd-4ea8-b5f8-10c01098bae0">WorldCities</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>
243
246
        <remarks>To be added.</remarks>
244
247
      </Docs>
245
248
    </Member>
 
249
    <Member MemberName="Filter">
 
250
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSArray Filter (MonoMac.Foundation.NSPredicate predicate);" />
 
251
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class MonoMac.Foundation.NSArray Filter(class MonoMac.Foundation.NSPredicate predicate) cil managed" />
 
252
      <MemberType>Method</MemberType>
 
253
      <AssemblyInfo>
 
254
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
255
      </AssemblyInfo>
 
256
      <Attributes>
 
257
        <Attribute>
 
258
          <AttributeName>MonoMac.Foundation.Export("filteredArrayUsingPredicate:")</AttributeName>
 
259
        </Attribute>
 
260
      </Attributes>
 
261
      <ReturnValue>
 
262
        <ReturnType>MonoMac.Foundation.NSArray</ReturnType>
 
263
      </ReturnValue>
 
264
      <Parameters>
 
265
        <Parameter Name="predicate" Type="MonoMac.Foundation.NSPredicate" />
 
266
      </Parameters>
 
267
      <Docs>
 
268
        <param name="predicate">To be added.</param>
 
269
        <summary>To be added.</summary>
 
270
        <returns>To be added.</returns>
 
271
        <remarks>To be added.</remarks>
 
272
      </Docs>
 
273
    </Member>
246
274
    <Member MemberName="FromArray&lt;T&gt;">
247
275
      <MemberSignature Language="C#" Value="public static T[] FromArray&lt;T&gt; (MonoMac.Foundation.NSArray weakArray) where T : MonoMac.Foundation.NSObject;" />
248
276
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig !!T[] FromArray&lt;(class MonoMac.Foundation.NSObject) T&gt;(class MonoMac.Foundation.NSArray weakArray) cil managed" />
342
370
        <remarks>To be added.</remarks>
343
371
      </Docs>
344
372
    </Member>
 
373
    <Member MemberName="FromNSObjects">
 
374
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSArray FromNSObjects (int count, MonoMac.Foundation.NSObject[] items);" />
 
375
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSArray FromNSObjects(int32 count, class MonoMac.Foundation.NSObject[] items) cil managed" />
 
376
      <MemberType>Method</MemberType>
 
377
      <AssemblyInfo>
 
378
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
379
      </AssemblyInfo>
 
380
      <ReturnValue>
 
381
        <ReturnType>MonoMac.Foundation.NSArray</ReturnType>
 
382
      </ReturnValue>
 
383
      <Parameters>
 
384
        <Parameter Name="count" Type="System.Int32" />
 
385
        <Parameter Name="items" Type="MonoMac.Foundation.NSObject[]">
 
386
          <Attributes>
 
387
            <Attribute>
 
388
              <AttributeName>System.ParamArray</AttributeName>
 
389
            </Attribute>
 
390
          </Attributes>
 
391
        </Parameter>
 
392
      </Parameters>
 
393
      <Docs>
 
394
        <param name="count">To be added.</param>
 
395
        <param name="items">To be added.</param>
 
396
        <summary>To be added.</summary>
 
397
        <returns>To be added.</returns>
 
398
        <remarks>To be added.</remarks>
 
399
      </Docs>
 
400
    </Member>
345
401
    <Member MemberName="FromObjects">
346
402
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSArray FromObjects (object[] items);" />
347
403
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSArray FromObjects(object[] items) cil managed" />
420
476
        <remarks>To be added.</remarks>
421
477
      </Docs>
422
478
    </Member>
 
479
    <Member MemberName="Sort">
 
480
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSArray Sort (MonoMac.Foundation.NSComparator cmptr);" />
 
481
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class MonoMac.Foundation.NSArray Sort(class MonoMac.Foundation.NSComparator cmptr) cil managed" />
 
482
      <MemberType>Method</MemberType>
 
483
      <AssemblyInfo>
 
484
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
485
      </AssemblyInfo>
 
486
      <Attributes>
 
487
        <Attribute>
 
488
          <AttributeName>MonoMac.Foundation.Export("sortedArrayUsingComparator:")</AttributeName>
 
489
        </Attribute>
 
490
      </Attributes>
 
491
      <ReturnValue>
 
492
        <ReturnType>MonoMac.Foundation.NSArray</ReturnType>
 
493
      </ReturnValue>
 
494
      <Parameters>
 
495
        <Parameter Name="cmptr" Type="MonoMac.Foundation.NSComparator" />
 
496
      </Parameters>
 
497
      <Docs>
 
498
        <param name="cmptr">To be added.</param>
 
499
        <summary>To be added.</summary>
 
500
        <returns>To be added.</returns>
 
501
        <remarks>To be added.</remarks>
 
502
      </Docs>
 
503
    </Member>
423
504
    <Member MemberName="StringArrayFromHandle">
424
505
      <MemberSignature Language="C#" Value="public static string[] StringArrayFromHandle (IntPtr handle);" />
425
506
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig string[] StringArrayFromHandle(native int handle) cil managed" />