← 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.Foundation/NSMutableIndexSet.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.Foundation/NSMutableIndexSet.xml
15
15
    </Attribute>
16
16
  </Attributes>
17
17
  <Docs>
18
 
    <summary>To be added.</summary>
19
 
    <remarks>
20
 
      <format type="text/html">
21
 
        <h2 class="jump">Overview</h2>
22
 
      </format>
23
 
      <para>The <c>NSMutableIndexSet</c> class represents a mutable collection of unique unsigned integers, known as <i>indexes</i> because of the way they are used. This collection is referred to as a <i>mutable index set</i>.</para>
24
 
      <para>The values in a mutable index set are always sorted, so the order in which values are added is irrelevant.</para>
25
 
      <para>You must not subclass the <c>NSMutableIndexSet</c> class.</para>
26
 
      <format type="text/html">
27
 
        <h2 class="jump">Tasks</h2>
28
 
      </format>
29
 
      <format type="text/html">
30
 
        <h3 class="tasks">Adding Indexes</h3>
31
 
      </format>
32
 
      <list type="bullet">
33
 
        <item>
34
 
          <term>
35
 
            <c>
36
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.Add(System.UInt32)" />
37
 
            </c>
38
 
            <format type="text/html">
39
 
              <img data-abstract="Adds an index  to the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
40
 
            </format>
41
 
          </term>
42
 
        </item>
43
 
        <item>
44
 
          <term>
45
 
            <c>
46
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.Add(MonoMac.Foundation.NSIndexSet)" />
47
 
            </c>
48
 
            <format type="text/html">
49
 
              <img data-abstract="Adds the indexes in an index set to the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
50
 
            </format>
51
 
          </term>
52
 
        </item>
53
 
        <item>
54
 
          <term>
55
 
            <c>
56
 
              <format type="text/html">
57
 
                <a href="Reference.html#//apple_ref/occ/instm/NSMutableIndexSet/addIndexesInRange:">- addIndexesInRange:</a>
58
 
              </format>
59
 
            </c>
60
 
            <format type="text/html">
61
 
              <img data-abstract="Adds the indexes in an index range to the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
62
 
            </format>
63
 
          </term>
64
 
        </item>
65
 
      </list>
66
 
      <format type="text/html">
67
 
        <h3 class="tasks">Removing Indexes</h3>
68
 
      </format>
69
 
      <list type="bullet">
70
 
        <item>
71
 
          <term>
72
 
            <c>
73
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.Remove(System.UInt32)" />
74
 
            </c>
75
 
            <format type="text/html">
76
 
              <img data-abstract="Removes an index from the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
77
 
            </format>
78
 
          </term>
79
 
        </item>
80
 
        <item>
81
 
          <term>
82
 
            <c>
83
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.Remove(MonoMac.Foundation.NSIndexSet)" />
84
 
            </c>
85
 
            <format type="text/html">
86
 
              <img data-abstract="Removes the indexes in an index set from the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
87
 
            </format>
88
 
          </term>
89
 
        </item>
90
 
        <item>
91
 
          <term>
92
 
            <c>
93
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.Clear" />
94
 
            </c>
95
 
            <format type="text/html">
96
 
              <img data-abstract="Removes the receiver’s indexes." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
97
 
            </format>
98
 
          </term>
99
 
        </item>
100
 
        <item>
101
 
          <term>
102
 
            <c>
103
 
              <format type="text/html">
104
 
                <a href="Reference.html#//apple_ref/occ/instm/NSMutableIndexSet/removeIndexesInRange:">- removeIndexesInRange:</a>
105
 
              </format>
106
 
            </c>
107
 
            <format type="text/html">
108
 
              <img data-abstract="Removes the indexes in an index range from the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
109
 
            </format>
110
 
          </term>
111
 
        </item>
112
 
      </list>
113
 
      <format type="text/html">
114
 
        <h3 class="tasks">Shifting Index Groups</h3>
115
 
      </format>
116
 
      <list type="bullet">
117
 
        <item>
118
 
          <term>
119
 
            <c>
120
 
              <see cref="M:MonoMac.Foundation.NSMutableIndexSet.ShiftIndexes(System.UInt32,System.UInt32)" />
121
 
            </c>
122
 
            <format type="text/html">
123
 
              <img data-abstract="Shifts a group of indexes to the left or the right within the receiver." src="../../../../../../Resources/Images/info_icon.jpg" class="tooltipicon" width="10" border="0" height="10" />
124
 
            </format>
125
 
          </term>
126
 
        </item>
127
 
      </list>
128
 
    </remarks>
 
18
    <summary>Represents a mutable collection of unique, unsigned integers (<see cref="T:System.UInt32" />). These integers are also known as indexes. </summary>
 
19
    <remarks>NSMutableIndexSet sorts the integers as they are added, therefore the order in which integers are added is irrelevant.</remarks>
129
20
  </Docs>
130
21
  <Members>
131
22
    <Member MemberName=".ctor">
139
30
        <Attribute>
140
31
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
141
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
142
36
      </Attributes>
143
37
      <Parameters />
144
38
      <Docs>
145
 
        <summary>Default constructor that initializes a new instance of this class with no parameters.</summary>
 
39
        <summary>Default constructor, initializes a new instance of this class.</summary>
146
40
        <remarks>
147
41
        </remarks>
148
42
      </Docs>
158
52
        <Attribute>
159
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
160
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
161
58
      </Attributes>
162
59
      <Parameters>
163
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
185
82
      </Parameters>
186
83
      <Docs>
187
84
        <param name="other">To be added.</param>
188
 
        <summary>
189
 
          <para>Initializes an allocated <c><format type="text/html"><a href="Reference.html#//apple_ref/doc/uid/20002197-SW1">NSIndexSet</a></format></c> object with an index set.</para>
190
 
        </summary>
191
 
        <remarks>
192
 
          <para>This method is a designated initializer for <c><format type="text/html"><a href="Reference.html#//apple_ref/doc/uid/20002197-SW1">NSIndexSet</a></format></c>.</para>
193
 
          <format type="text/html">
194
 
            <h5 class="tight">Availability</h5>
195
 
          </format>
196
 
          <list type="bullet">
197
 
            <item>
198
 
              <term>Available in iPhone OS 2.0 and later.</term>
199
 
            </item>
200
 
          </list>
201
 
        </remarks>
 
85
        <summary>Creates a new MSMutableIndexSet from an existing set.</summary>
 
86
        <remarks>To be added.</remarks>
202
87
      </Docs>
203
88
    </Member>
204
89
    <Member MemberName=".ctor">
208
93
      <AssemblyInfo>
209
94
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
210
95
      </AssemblyInfo>
 
96
      <Attributes>
 
97
        <Attribute>
 
98
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
99
        </Attribute>
 
100
      </Attributes>
211
101
      <Parameters>
212
102
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
213
103
      </Parameters>
214
104
      <Docs>
215
105
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
216
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
106
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
217
107
        <remarks>
218
 
          <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>
219
 
          <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>
220
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
221
 
          <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>
222
 
          <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>
 
108
          <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>
223
109
          <example>
224
110
            <code lang="C#">
225
 
//
226
 
// The NSObjectFlag merely allocates the object and registers the
227
 
// C# class with the Objective-C runtime if necessary, but no actual
228
 
// initXxx method is invoked, that is done later in the constructor
229
 
//
230
 
// This is taken from MonoMac's source code:
231
 
//
232
 
[Export ("initWithFrame:")]
233
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
234
 
{
235
 
// Invoke the init method now.
236
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
237
 
        if (IsDirectBinding)
238
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
239
 
        else
240
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
241
 
}
 
111
public class MyClass : BaseClass {
 
112
    [Export ("initWithFoo:")]
 
113
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
114
    {
 
115
        ...
 
116
    }
242
117
</code>
243
118
          </example>
244
119
        </remarks>
251
126
      <AssemblyInfo>
252
127
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
253
128
      </AssemblyInfo>
 
129
      <Attributes>
 
130
        <Attribute>
 
131
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
132
        </Attribute>
 
133
      </Attributes>
254
134
      <Parameters>
255
135
        <Parameter Name="handle" Type="System.IntPtr" />
256
136
      </Parameters>
279
159
      </Parameters>
280
160
      <Docs>
281
161
        <param name="index">To be added.</param>
282
 
        <summary>
283
 
          <para>Initializes an allocated <c><format type="text/html"><a href="Reference.html#//apple_ref/doc/uid/20002197-SW1">NSIndexSet</a></format></c> object with an index.</para>
284
 
        </summary>
285
 
        <remarks>
286
 
        </remarks>
 
162
        <summary>Initializes a new index set from an existing unsigned integer.</summary>
 
163
        <remarks>To be added.</remarks>
287
164
      </Docs>
288
165
    </Member>
289
166
    <Member MemberName="Add">
305
182
        <Parameter Name="other" Type="MonoMac.Foundation.NSIndexSet" />
306
183
      </Parameters>
307
184
      <Docs>
308
 
        <param name="other">To be added.</param>
309
 
        <summary>
310
 
          <para>Adds the indexes in an index set to the receiver.</para>
311
 
        </summary>
312
 
        <remarks>
313
 
        </remarks>
 
185
        <param name="other">The existing set of indexes to add.</param>
 
186
        <summary>Adds an existing set of indexes to this set.</summary>
 
187
        <remarks>To be added.</remarks>
314
188
      </Docs>
315
189
    </Member>
316
190
    <Member MemberName="Add">
332
206
        <Parameter Name="index" Type="System.UInt32" />
333
207
      </Parameters>
334
208
      <Docs>
335
 
        <param name="index">To be added.</param>
336
 
        <summary>
337
 
          <para>Adds an index  to the receiver.</para>
338
 
        </summary>
339
 
        <remarks>
340
 
        </remarks>
 
209
        <param name="index">The index to add.</param>
 
210
        <summary>Adds a single index to the existing set.</summary>
 
211
        <remarks>To be added.</remarks>
341
212
      </Docs>
342
213
    </Member>
343
214
    <Member MemberName="ClassHandle">
373
244
      </ReturnValue>
374
245
      <Parameters />
375
246
      <Docs>
376
 
        <summary>
377
 
          <para>Removes the receiver’s indexes.</para>
378
 
        </summary>
379
 
        <remarks>
380
 
        </remarks>
 
247
        <summary>Removes all indexes from this set.</summary>
 
248
        <remarks>To be added.</remarks>
381
249
      </Docs>
382
250
    </Member>
383
251
    <Member MemberName="Remove">
399
267
        <Parameter Name="other" Type="MonoMac.Foundation.NSIndexSet" />
400
268
      </Parameters>
401
269
      <Docs>
402
 
        <param name="other">To be added.</param>
403
 
        <summary>
404
 
          <para>Removes the indexes in an index set from the receiver.</para>
405
 
        </summary>
406
 
        <remarks>
407
 
        </remarks>
 
270
        <param name="other">The set of indexes to remove.</param>
 
271
        <summary>Removes the indexes specified in <paramref name="other" /> that exist in this set.</summary>
 
272
        <remarks>To be added.</remarks>
408
273
      </Docs>
409
274
    </Member>
410
275
    <Member MemberName="Remove">
426
291
        <Parameter Name="index" Type="System.UInt32" />
427
292
      </Parameters>
428
293
      <Docs>
429
 
        <param name="index">To be added.</param>
430
 
        <summary>
431
 
          <para>Removes an index from the receiver.</para>
432
 
        </summary>
433
 
        <remarks>
434
 
        </remarks>
 
294
        <param name="index">The index to remove.</param>
 
295
        <summary>Removes a single index from the collection.</summary>
 
296
        <remarks>To be added.</remarks>
435
297
      </Docs>
436
298
    </Member>
437
299
    <Member MemberName="ShiftIndexes">
454
316
        <Parameter Name="delta" Type="System.UInt32" />
455
317
      </Parameters>
456
318
      <Docs>
457
 
        <param name="startIndex">To be added.</param>
458
 
        <param name="delta">To be added.</param>
459
 
        <summary>
460
 
          <para>Shifts a group of indexes to the left or the right within the receiver.</para>
461
 
        </summary>
462
 
        <remarks>
463
 
          <para>The group of indexes shifted is made up by <i>startIndex</i> and the indexes that follow it in the receiver.</para>
464
 
          <para>A left shift deletes the indexes in the range <c>(</c><i>startIndex</i><c>-</c><i>delta</i><c>,</c><i>delta</i><c>)</c> from the receiver.</para>
465
 
          <para>A right shift inserts empty space in the range <c>(</c><i>indexStart</i><c>,</c><i>delta</i><c>)</c> in the receiver.</para>
466
 
          <format type="text/html">
467
 
            <h5 class="tight">Availability</h5>
468
 
          </format>
469
 
          <list type="bullet">
470
 
            <item>
471
 
              <term>Available in iPhone OS 2.0 and later.</term>
472
 
            </item>
473
 
          </list>
474
 
        </remarks>
 
319
        <param name="startIndex">The staring index in which to begin the shift.</param>
 
320
        <param name="delta">The amount and direction to move the indexes. A positive number will shift the indexes to the right, and a negative number will shift them to the left.</param>
 
321
        <summary>Shifts a subset of indexes either left or right starting at the <paramref name="startIndex" /> by the amount specified in <paramref name="delta" />.</summary>
 
322
        <remarks>To be added.</remarks>
475
323
      </Docs>
476
324
    </Member>
477
325
  </Members>