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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.ScriptingBridge/SBObject.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" />
108
114
      <AssemblyInfo>
109
115
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
110
116
      </AssemblyInfo>
 
117
      <Attributes>
 
118
        <Attribute>
 
119
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
120
        </Attribute>
 
121
      </Attributes>
111
122
      <Parameters>
112
123
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
113
124
      </Parameters>
114
125
      <Docs>
115
126
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
116
 
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
127
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
117
128
        <remarks>
118
 
          <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>
119
 
          <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>
120
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
121
 
          <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>
122
 
          <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>
 
129
          <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>
123
130
          <example>
124
131
            <code lang="C#">
125
 
//
126
 
// The NSObjectFlag merely allocates the object and registers the
127
 
// C# class with the Objective-C runtime if necessary, but no actual
128
 
// initXxx method is invoked, that is done later in the constructor
129
 
//
130
 
// This is taken from MonoMac's source code:
131
 
//
132
 
[Export ("initWithFrame:")]
133
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
134
 
{
135
 
// Invoke the init method now.
136
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
137
 
        if (IsDirectBinding)
138
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
139
 
        else
140
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
141
 
}
 
132
public class MyClass : BaseClass {
 
133
    [Export ("initWithFoo:")]
 
134
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
135
    {
 
136
        ...
 
137
    }
142
138
</code>
143
139
          </example>
144
140
        </remarks>
151
147
      <AssemblyInfo>
152
148
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
153
149
      </AssemblyInfo>
 
150
      <Attributes>
 
151
        <Attribute>
 
152
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
153
        </Attribute>
 
154
      </Attributes>
154
155
      <Parameters>
155
156
        <Parameter Name="handle" Type="System.IntPtr" />
156
157
      </Parameters>
195
196
        <param name="disposing">
196
197
          <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>
197
198
        </param>
198
 
        <summary>Releases the resourced used by the SBObject object.</summary>
 
199
        <summary>Releases the resources used by the SBObject object.</summary>
199
200
        <remarks>
200
201
          <para>This Dispose method releases the resources used by the SBObject class.</para>
201
202
          <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>