← 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.AppKit/NSLayoutConstraint.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.AppKit/NSLayoutConstraint.xml
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>
120
121
        </remarks>
121
122
      </Docs>
122
123
    </Member>
 
124
    <Member MemberName="AnimationFor">
 
125
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSObject AnimationFor (MonoMac.Foundation.NSString key);" />
 
126
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class MonoMac.Foundation.NSObject AnimationFor(class MonoMac.Foundation.NSString key) cil managed" />
 
127
      <MemberType>Method</MemberType>
 
128
      <AssemblyInfo>
 
129
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
130
      </AssemblyInfo>
 
131
      <Attributes>
 
132
        <Attribute>
 
133
          <AttributeName>MonoMac.Foundation.Export("animationForKey:")</AttributeName>
 
134
        </Attribute>
 
135
      </Attributes>
 
136
      <ReturnValue>
 
137
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
138
      </ReturnValue>
 
139
      <Parameters>
 
140
        <Parameter Name="key" Type="MonoMac.Foundation.NSString" />
 
141
      </Parameters>
 
142
      <Docs>
 
143
        <param name="key">To be added.</param>
 
144
        <summary>To be added.</summary>
 
145
        <returns>To be added.</returns>
 
146
        <remarks>To be added.</remarks>
 
147
      </Docs>
 
148
    </Member>
123
149
    <Member MemberName="Animations">
124
150
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSDictionary Animations { get; set; }" />
125
151
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSDictionary Animations" />
190
216
      </AssemblyInfo>
191
217
      <Attributes>
192
218
        <Attribute>
193
 
          <AttributeName>get: MonoMac.Foundation.Export("CGFloat")</AttributeName>
 
219
          <AttributeName>get: MonoMac.Foundation.Export("constant")</AttributeName>
194
220
        </Attribute>
195
221
        <Attribute>
196
 
          <AttributeName>set: MonoMac.Foundation.Export("setCGFloat:")</AttributeName>
 
222
          <AttributeName>set: MonoMac.Foundation.Export("setConstant:")</AttributeName>
197
223
        </Attribute>
198
224
      </Attributes>
199
225
      <ReturnValue>
242
268
        <remarks>To be added.</remarks>
243
269
      </Docs>
244
270
    </Member>
 
271
    <Member MemberName="DefaultAnimationFor">
 
272
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject DefaultAnimationFor (MonoMac.Foundation.NSString key);" />
 
273
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject DefaultAnimationFor(class MonoMac.Foundation.NSString key) cil managed" />
 
274
      <MemberType>Method</MemberType>
 
275
      <AssemblyInfo>
 
276
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
277
      </AssemblyInfo>
 
278
      <Attributes>
 
279
        <Attribute>
 
280
          <AttributeName>MonoMac.Foundation.Export("defaultAnimationForKey:")</AttributeName>
 
281
        </Attribute>
 
282
      </Attributes>
 
283
      <ReturnValue>
 
284
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
285
      </ReturnValue>
 
286
      <Parameters>
 
287
        <Parameter Name="key" Type="MonoMac.Foundation.NSString" />
 
288
      </Parameters>
 
289
      <Docs>
 
290
        <param name="key">To be added.</param>
 
291
        <summary>To be added.</summary>
 
292
        <returns>To be added.</returns>
 
293
        <remarks>To be added.</remarks>
 
294
      </Docs>
 
295
    </Member>
245
296
    <Member MemberName="Dispose">
246
297
      <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
247
298
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
259
310
        <param name="disposing">
260
311
          <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>
261
312
        </param>
262
 
        <summary>Releases the resourced used by the NSLayoutConstraint object.</summary>
 
313
        <summary>Releases the resources used by the NSLayoutConstraint object.</summary>
263
314
        <remarks>
264
315
          <para>This Dispose method releases the resources used by the NSLayoutConstraint class.</para>
265
316
          <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>
371
422
      </AssemblyInfo>
372
423
      <Attributes>
373
424
        <Attribute>
374
 
          <AttributeName>get: MonoMac.Foundation.Export("NSLayoutPriority")</AttributeName>
 
425
          <AttributeName>get: MonoMac.Foundation.Export("priority")</AttributeName>
375
426
        </Attribute>
376
427
        <Attribute>
377
 
          <AttributeName>set: MonoMac.Foundation.Export("setNSLayoutPriority:")</AttributeName>
 
428
          <AttributeName>set: MonoMac.Foundation.Export("setPriority:")</AttributeName>
378
429
        </Attribute>
379
430
      </Attributes>
380
431
      <ReturnValue>