← 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/NSCollectionViewItem.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/NSCollectionViewItem.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=".ctor">
 
125
      <MemberSignature Language="C#" Value="public NSCollectionViewItem (string nibNameOrNull, MonoMac.Foundation.NSBundle nibBundleOrNull);" />
 
126
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string nibNameOrNull, class MonoMac.Foundation.NSBundle nibBundleOrNull) cil managed" />
 
127
      <MemberType>Constructor</MemberType>
 
128
      <AssemblyInfo>
 
129
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
130
      </AssemblyInfo>
 
131
      <Attributes>
 
132
        <Attribute>
 
133
          <AttributeName>MonoMac.Foundation.Export("initWithNibName:bundle:")</AttributeName>
 
134
        </Attribute>
 
135
      </Attributes>
 
136
      <Parameters>
 
137
        <Parameter Name="nibNameOrNull" Type="System.String" />
 
138
        <Parameter Name="nibBundleOrNull" Type="MonoMac.Foundation.NSBundle" />
 
139
      </Parameters>
 
140
      <Docs>
 
141
        <param name="nibNameOrNull">To be added.</param>
 
142
        <param name="nibBundleOrNull">To be added.</param>
 
143
        <summary>To be added.</summary>
 
144
        <remarks>To be added.</remarks>
 
145
      </Docs>
 
146
    </Member>
123
147
    <Member MemberName="ClassHandle">
124
148
      <MemberSignature Language="C#" Value="public override IntPtr ClassHandle { get; }" />
125
149
      <MemberSignature Language="ILAsm" Value=".property instance native int ClassHandle" />
174
198
        <param name="disposing">
175
199
          <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>
176
200
        </param>
177
 
        <summary>Releases the resourced used by the NSCollectionViewItem object.</summary>
 
201
        <summary>Releases the resources used by the NSCollectionViewItem object.</summary>
178
202
        <remarks>
179
203
          <para>This Dispose method releases the resources used by the NSCollectionViewItem class.</para>
180
204
          <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>
183
207
        </remarks>
184
208
      </Docs>
185
209
    </Member>
 
210
    <Member MemberName="DraggingImageComponents">
 
211
      <MemberSignature Language="C#" Value="public virtual MonoMac.AppKit.NSDraggingImageComponent[] DraggingImageComponents { get; }" />
 
212
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AppKit.NSDraggingImageComponent[] DraggingImageComponents" />
 
213
      <MemberType>Property</MemberType>
 
214
      <AssemblyInfo>
 
215
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
216
      </AssemblyInfo>
 
217
      <Attributes>
 
218
        <Attribute>
 
219
          <AttributeName>get: MonoMac.Foundation.Export("draggingImageComponents")</AttributeName>
 
220
        </Attribute>
 
221
      </Attributes>
 
222
      <ReturnValue>
 
223
        <ReturnType>MonoMac.AppKit.NSDraggingImageComponent[]</ReturnType>
 
224
      </ReturnValue>
 
225
      <Docs>
 
226
        <summary>To be added.</summary>
 
227
        <value>To be added.</value>
 
228
        <remarks>To be added.</remarks>
 
229
      </Docs>
 
230
    </Member>
 
231
    <Member MemberName="ImageView">
 
232
      <MemberSignature Language="C#" Value="public virtual MonoMac.AppKit.NSImageView ImageView { get; set; }" />
 
233
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AppKit.NSImageView ImageView" />
 
234
      <MemberType>Property</MemberType>
 
235
      <AssemblyInfo>
 
236
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
237
      </AssemblyInfo>
 
238
      <Attributes>
 
239
        <Attribute>
 
240
          <AttributeName>get: MonoMac.Foundation.Export("imageView")</AttributeName>
 
241
        </Attribute>
 
242
        <Attribute>
 
243
          <AttributeName>set: MonoMac.Foundation.Export("setImageView:")</AttributeName>
 
244
        </Attribute>
 
245
      </Attributes>
 
246
      <ReturnValue>
 
247
        <ReturnType>MonoMac.AppKit.NSImageView</ReturnType>
 
248
      </ReturnValue>
 
249
      <Docs>
 
250
        <summary>To be added.</summary>
 
251
        <value>To be added.</value>
 
252
        <remarks>To be added.</remarks>
 
253
      </Docs>
 
254
    </Member>
186
255
    <Member MemberName="Selected">
187
256
      <MemberSignature Language="C#" Value="public virtual bool Selected { get; set; }" />
188
257
      <MemberSignature Language="ILAsm" Value=".property instance bool Selected" />
207
276
        <remarks>To be added.</remarks>
208
277
      </Docs>
209
278
    </Member>
 
279
    <Member MemberName="TextField">
 
280
      <MemberSignature Language="C#" Value="public virtual MonoMac.AppKit.NSTextField TextField { get; set; }" />
 
281
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.AppKit.NSTextField TextField" />
 
282
      <MemberType>Property</MemberType>
 
283
      <AssemblyInfo>
 
284
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
285
      </AssemblyInfo>
 
286
      <Attributes>
 
287
        <Attribute>
 
288
          <AttributeName>get: MonoMac.Foundation.Export("textField")</AttributeName>
 
289
        </Attribute>
 
290
        <Attribute>
 
291
          <AttributeName>set: MonoMac.Foundation.Export("setTextField:")</AttributeName>
 
292
        </Attribute>
 
293
      </Attributes>
 
294
      <ReturnValue>
 
295
        <ReturnType>MonoMac.AppKit.NSTextField</ReturnType>
 
296
      </ReturnValue>
 
297
      <Docs>
 
298
        <summary>To be added.</summary>
 
299
        <value>To be added.</value>
 
300
        <remarks>To be added.</remarks>
 
301
      </Docs>
 
302
    </Member>
210
303
  </Members>
211
304
</Type>