← 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/NSDictionary.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/NSDictionary.xml
43
43
        <Attribute>
44
44
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
45
45
        </Attribute>
 
46
        <Attribute>
 
47
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
48
        </Attribute>
46
49
      </Attributes>
47
50
      <Parameters />
48
51
      <Docs>
62
65
        <Attribute>
63
66
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
64
67
        </Attribute>
 
68
        <Attribute>
 
69
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
70
        </Attribute>
65
71
      </Attributes>
66
72
      <Parameters>
67
73
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
100
106
      <AssemblyInfo>
101
107
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
102
108
      </AssemblyInfo>
 
109
      <Attributes>
 
110
        <Attribute>
 
111
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
112
        </Attribute>
 
113
      </Attributes>
103
114
      <Parameters>
104
115
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
105
116
      </Parameters>
106
117
      <Docs>
107
118
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
108
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
119
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
109
120
        <remarks>
110
 
          <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>
111
 
          <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>
112
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
113
 
          <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>
114
 
          <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>
 
121
          <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>
115
122
          <example>
116
123
            <code lang="C#">
117
 
//
118
 
// The NSObjectFlag merely allocates the object and registers the
119
 
// C# class with the Objective-C runtime if necessary, but no actual
120
 
// initXxx method is invoked, that is done later in the constructor
121
 
//
122
 
// This is taken from MonoMac's source code:
123
 
//
124
 
[Export ("initWithFrame:")]
125
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
126
 
{
127
 
// Invoke the init method now.
128
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
129
 
        if (IsDirectBinding)
130
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
131
 
        else
132
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
133
 
}
 
124
public class MyClass : BaseClass {
 
125
    [Export ("initWithFoo:")]
 
126
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
127
    {
 
128
        ...
 
129
    }
134
130
</code>
135
131
          </example>
136
132
        </remarks>
164
160
      <AssemblyInfo>
165
161
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
166
162
      </AssemblyInfo>
 
163
      <Attributes>
 
164
        <Attribute>
 
165
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
166
        </Attribute>
 
167
      </Attributes>
167
168
      <Parameters>
168
169
        <Parameter Name="handle" Type="System.IntPtr" />
169
170
      </Parameters>
196
197
        <remarks>To be added.</remarks>
197
198
      </Docs>
198
199
    </Member>
 
200
    <Member MemberName=".ctor">
 
201
      <MemberSignature Language="C#" Value="public NSDictionary (MonoMac.Foundation.NSObject first, MonoMac.Foundation.NSObject second, MonoMac.Foundation.NSObject[] args);" />
 
202
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSObject first, class MonoMac.Foundation.NSObject second, class MonoMac.Foundation.NSObject[] args) cil managed" />
 
203
      <MemberType>Constructor</MemberType>
 
204
      <AssemblyInfo>
 
205
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
206
      </AssemblyInfo>
 
207
      <Parameters>
 
208
        <Parameter Name="first" Type="MonoMac.Foundation.NSObject" />
 
209
        <Parameter Name="second" Type="MonoMac.Foundation.NSObject" />
 
210
        <Parameter Name="args" Type="MonoMac.Foundation.NSObject[]">
 
211
          <Attributes>
 
212
            <Attribute>
 
213
              <AttributeName>System.ParamArray</AttributeName>
 
214
            </Attribute>
 
215
          </Attributes>
 
216
        </Parameter>
 
217
      </Parameters>
 
218
      <Docs>
 
219
        <param name="first">To be added.</param>
 
220
        <param name="second">To be added.</param>
 
221
        <param name="args">To be added.</param>
 
222
        <summary>To be added.</summary>
 
223
        <remarks>To be added.</remarks>
 
224
      </Docs>
 
225
    </Member>
 
226
    <Member MemberName=".ctor">
 
227
      <MemberSignature Language="C#" Value="public NSDictionary (object first, object second, object[] args);" />
 
228
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(object first, object second, object[] args) cil managed" />
 
229
      <MemberType>Constructor</MemberType>
 
230
      <AssemblyInfo>
 
231
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
232
      </AssemblyInfo>
 
233
      <Parameters>
 
234
        <Parameter Name="first" Type="System.Object" />
 
235
        <Parameter Name="second" Type="System.Object" />
 
236
        <Parameter Name="args" Type="System.Object[]">
 
237
          <Attributes>
 
238
            <Attribute>
 
239
              <AttributeName>System.ParamArray</AttributeName>
 
240
            </Attribute>
 
241
          </Attributes>
 
242
        </Parameter>
 
243
      </Parameters>
 
244
      <Docs>
 
245
        <param name="first">To be added.</param>
 
246
        <param name="second">To be added.</param>
 
247
        <param name="args">To be added.</param>
 
248
        <summary>To be added.</summary>
 
249
        <remarks>To be added.</remarks>
 
250
      </Docs>
 
251
    </Member>
199
252
    <Member MemberName="ClassHandle">
200
253
      <MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
201
254
      <MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
253
306
        <remarks>To be added.</remarks>
254
307
      </Docs>
255
308
    </Member>
256
 
    <Member MemberName="Description">
257
 
      <MemberSignature Language="C#" Value="public virtual string Description { get; }" />
258
 
      <MemberSignature Language="ILAsm" Value=".property instance string Description" />
259
 
      <MemberType>Property</MemberType>
260
 
      <AssemblyInfo>
261
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
262
 
      </AssemblyInfo>
263
 
      <Attributes>
264
 
        <Attribute>
265
 
          <AttributeName>get: MonoMac.Foundation.Export("description")</AttributeName>
266
 
        </Attribute>
267
 
      </Attributes>
268
 
      <ReturnValue>
269
 
        <ReturnType>System.String</ReturnType>
270
 
      </ReturnValue>
271
 
      <Docs>
272
 
        <summary>To be added.</summary>
273
 
        <value>To be added.</value>
274
 
        <remarks>To be added.</remarks>
275
 
      </Docs>
276
 
    </Member>
277
309
    <Member MemberName="DescriptionInStringsFileFormat">
278
310
      <MemberSignature Language="C#" Value="public virtual string DescriptionInStringsFileFormat { get; }" />
279
311
      <MemberSignature Language="ILAsm" Value=".property instance string DescriptionInStringsFileFormat" />
312
344
        <param name="disposing">
313
345
          <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>
314
346
        </param>
315
 
        <summary>Releases the resourced used by the NSDictionary object.</summary>
 
347
        <summary>Releases the resources used by the NSDictionary object.</summary>
316
348
        <remarks>
317
349
          <para>This Dispose method releases the resources used by the NSDictionary class.</para>
318
350
          <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>
532
564
        <remarks>To be added.</remarks>
533
565
      </Docs>
534
566
    </Member>
 
567
    <Member MemberName="GetSharedKeySetForKeys">
 
568
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject GetSharedKeySetForKeys (MonoMac.Foundation.NSObject[] keys);" />
 
569
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject GetSharedKeySetForKeys(class MonoMac.Foundation.NSObject[] keys) cil managed" />
 
570
      <MemberType>Method</MemberType>
 
571
      <AssemblyInfo>
 
572
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
573
      </AssemblyInfo>
 
574
      <Attributes>
 
575
        <Attribute>
 
576
          <AttributeName>MonoMac.Foundation.Export("sharedKeySetForKeys:")</AttributeName>
 
577
        </Attribute>
 
578
      </Attributes>
 
579
      <ReturnValue>
 
580
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
581
      </ReturnValue>
 
582
      <Parameters>
 
583
        <Parameter Name="keys" Type="MonoMac.Foundation.NSObject[]" />
 
584
      </Parameters>
 
585
      <Docs>
 
586
        <param name="keys">To be added.</param>
 
587
        <summary>To be added.</summary>
 
588
        <returns>To be added.</returns>
 
589
        <remarks>To be added.</remarks>
 
590
      </Docs>
 
591
    </Member>
535
592
    <Member MemberName="IsEqualToDictionary">
536
593
      <MemberSignature Language="C#" Value="public virtual bool IsEqualToDictionary (MonoMac.Foundation.NSDictionary other);" />
537
594
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsEqualToDictionary(class MonoMac.Foundation.NSDictionary other) cil managed" />
577
634
        <remarks>To be added.</remarks>
578
635
      </Docs>
579
636
    </Member>
 
637
    <Member MemberName="Item">
 
638
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSObject this[MonoMac.Foundation.NSString key] { get; set; }" />
 
639
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSObject Item(class MonoMac.Foundation.NSString)" />
 
640
      <MemberType>Property</MemberType>
 
641
      <AssemblyInfo>
 
642
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
643
      </AssemblyInfo>
 
644
      <ReturnValue>
 
645
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
646
      </ReturnValue>
 
647
      <Parameters>
 
648
        <Parameter Name="key" Type="MonoMac.Foundation.NSString" />
 
649
      </Parameters>
 
650
      <Docs>
 
651
        <param name="key">To be added.</param>
 
652
        <summary>To be added.</summary>
 
653
        <value>To be added.</value>
 
654
        <remarks>To be added.</remarks>
 
655
      </Docs>
 
656
    </Member>
 
657
    <Member MemberName="Item">
 
658
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSObject this[string key] { get; set; }" />
 
659
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSObject Item(string)" />
 
660
      <MemberType>Property</MemberType>
 
661
      <AssemblyInfo>
 
662
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
663
      </AssemblyInfo>
 
664
      <ReturnValue>
 
665
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
666
      </ReturnValue>
 
667
      <Parameters>
 
668
        <Parameter Name="key" Type="System.String" />
 
669
      </Parameters>
 
670
      <Docs>
 
671
        <param name="key">To be added.</param>
 
672
        <summary>To be added.</summary>
 
673
        <value>To be added.</value>
 
674
        <remarks>To be added.</remarks>
 
675
      </Docs>
 
676
    </Member>
580
677
    <Member MemberName="Keys">
581
678
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSObject[] Keys { get; }" />
582
679
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSObject[] Keys" />