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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.Foundation/NSThread.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:
30
30
        <Attribute>
31
31
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
33
36
      </Attributes>
34
37
      <Parameters />
35
38
      <Docs>
49
52
        <Attribute>
50
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
52
58
      </Attributes>
53
59
      <Parameters>
54
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
72
      <AssemblyInfo>
67
73
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
74
      </AssemblyInfo>
 
75
      <Attributes>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
 
79
      </Attributes>
69
80
      <Parameters>
70
81
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
82
      </Parameters>
72
83
      <Docs>
73
84
        <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>
 
85
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
86
        <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>
 
87
          <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
88
          <example>
82
89
            <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
 
}
 
90
public class MyClass : BaseClass {
 
91
    [Export ("initWithFoo:")]
 
92
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
93
    {
 
94
        ...
 
95
    }
100
96
</code>
101
97
          </example>
102
98
        </remarks>
109
105
      <AssemblyInfo>
110
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
107
      </AssemblyInfo>
 
108
      <Attributes>
 
109
        <Attribute>
 
110
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
111
        </Attribute>
 
112
      </Attributes>
112
113
      <Parameters>
113
114
        <Parameter Name="handle" Type="System.IntPtr" />
114
115
      </Parameters>
138
139
        <Parameter Name="argument" Type="MonoMac.Foundation.NSObject" />
139
140
      </Parameters>
140
141
      <Docs>
141
 
        <param name="target">To be added.</param>
142
 
        <param name="selector">To be added.</param>
143
 
        <param name="argument">To be added.</param>
144
 
        <summary>To be added.</summary>
145
 
        <remarks>To be added.</remarks>
 
142
        <param name="target">Target object</param>
 
143
        <param name="selector">The selector to invoke on the target object on the new thread.</param>
 
144
        <param name="argument">
 
145
          <para>Argument to pass to the method.</para>
 
146
          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
 
147
        </param>
 
148
        <summary>Creates an NSThread and invokes the specified selector on the specified target.</summary>
 
149
        <remarks>
 
150
        </remarks>
146
151
      </Docs>
147
152
    </Member>
148
153
    <Member MemberName="Cancel">
203
208
        <remarks>To be added.</remarks>
204
209
      </Docs>
205
210
    </Member>
206
 
    <Member MemberName="Dispose">
207
 
      <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
208
 
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
209
 
      <MemberType>Method</MemberType>
210
 
      <AssemblyInfo>
211
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
212
 
      </AssemblyInfo>
213
 
      <ReturnValue>
214
 
        <ReturnType>System.Void</ReturnType>
215
 
      </ReturnValue>
216
 
      <Parameters>
217
 
        <Parameter Name="disposing" Type="System.Boolean" />
218
 
      </Parameters>
219
 
      <Docs>
220
 
        <param name="disposing">
221
 
          <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>
222
 
        </param>
223
 
        <summary>Releases the resourced used by the NSThread object.</summary>
224
 
        <remarks>
225
 
          <para>This Dispose method releases the resources used by the NSThread class.</para>
226
 
          <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>
227
 
          <para>Calling the Dispose method when you are finished using the NSThread ensures that all external resources used by this managed object are released as soon as possible.  Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.</para>
228
 
          <para>  For more information on how to override this method and on the Dispose/IDisposable pattern, read the ``Implementing a Dispose Method'' document at http://msdn.microsoft.com/en-us/library/fs2xkftw.aspx</para>
229
 
        </remarks>
230
 
      </Docs>
231
 
    </Member>
232
211
    <Member MemberName="Exit">
233
212
      <MemberSignature Language="C#" Value="public static void Exit ();" />
234
213
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig void Exit() cil managed" />
313
292
        <remarks>To be added.</remarks>
314
293
      </Docs>
315
294
    </Member>
 
295
    <Member MemberName="IsMain">
 
296
      <MemberSignature Language="C#" Value="public static bool IsMain { get; }" />
 
297
      <MemberSignature Language="ILAsm" Value=".property bool IsMain" />
 
298
      <MemberType>Property</MemberType>
 
299
      <AssemblyInfo>
 
300
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
301
      </AssemblyInfo>
 
302
      <Attributes>
 
303
        <Attribute>
 
304
          <AttributeName>get: MonoMac.Foundation.Export("isMainThread")</AttributeName>
 
305
        </Attribute>
 
306
      </Attributes>
 
307
      <ReturnValue>
 
308
        <ReturnType>System.Boolean</ReturnType>
 
309
      </ReturnValue>
 
310
      <Docs>
 
311
        <summary>To be added.</summary>
 
312
        <value>To be added.</value>
 
313
        <remarks>To be added.</remarks>
 
314
      </Docs>
 
315
    </Member>
316
316
    <Member MemberName="IsMainThread">
317
317
      <MemberSignature Language="C#" Value="public virtual bool IsMainThread { get; }" />
318
318
      <MemberSignature Language="ILAsm" Value=".property instance bool IsMainThread" />
377
377
      </Docs>
378
378
    </Member>
379
379
    <Member MemberName="MainThread">
380
 
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSThread MainThread { get; }" />
381
 
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSThread MainThread" />
 
380
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSThread MainThread { get; }" />
 
381
      <MemberSignature Language="ILAsm" Value=".property class MonoMac.Foundation.NSThread MainThread" />
382
382
      <MemberType>Property</MemberType>
383
383
      <AssemblyInfo>
384
384
        <AssemblyVersion>0.0.0.0</AssemblyVersion>