← Back to branch summary

~ubuntu-branches/ubuntu/wily/monodevelop/wily

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.AppKit/NSMatrixDelegate.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2012-05-27 18:08:20 UTC
  • mfrom: (19.1.8 experimental)
  • Revision ID: package-import@ubuntu.com-20120527180820-fydl21qnbnfr8w2t
Tags: 3.0.2+dfsg-3
* [fcecfe7] Fix monodevelop-core-addins.pc.in to point to actual 
  installed location of assemblies.
* [26e1a07] DebSrc 3.0 does not support Quilt's -p parameter, so 
  manually adjust the path in the patch file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.AppKit/NSMatrixDelegate.xml
 
1
<Type Name="NSMatrixDelegate" FullName="MonoMac.AppKit.NSMatrixDelegate">
 
2
  <TypeSignature Language="C#" Value="public class NSMatrixDelegate : MonoMac.Foundation.NSObject" />
 
3
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NSMatrixDelegate extends MonoMac.Foundation.NSObject" />
 
4
  <AssemblyInfo>
 
5
    <AssemblyName>MonoMac</AssemblyName>
 
6
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>MonoMac.Foundation.NSObject</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Attributes>
 
13
    <Attribute>
 
14
      <AttributeName>MonoMac.Foundation.Model</AttributeName>
 
15
    </Attribute>
 
16
    <Attribute>
 
17
      <AttributeName>MonoMac.Foundation.Register("NSMatrixDelegate", true)</AttributeName>
 
18
    </Attribute>
 
19
  </Attributes>
 
20
  <Docs>
 
21
    <summary>To be added.</summary>
 
22
    <remarks>To be added.</remarks>
 
23
  </Docs>
 
24
  <Members>
 
25
    <Member MemberName=".ctor">
 
26
      <MemberSignature Language="C#" Value="public NSMatrixDelegate ();" />
 
27
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
 
28
      <MemberType>Constructor</MemberType>
 
29
      <AssemblyInfo>
 
30
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
31
      </AssemblyInfo>
 
32
      <Attributes>
 
33
        <Attribute>
 
34
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
 
35
        </Attribute>
 
36
      </Attributes>
 
37
      <Parameters />
 
38
      <Docs>
 
39
        <summary>Default constructor, initializes a new instance of this class.</summary>
 
40
        <remarks>
 
41
        </remarks>
 
42
      </Docs>
 
43
    </Member>
 
44
    <Member MemberName=".ctor">
 
45
      <MemberSignature Language="C#" Value="public NSMatrixDelegate (MonoMac.Foundation.NSCoder coder);" />
 
46
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSCoder coder) cil managed" />
 
47
      <MemberType>Constructor</MemberType>
 
48
      <AssemblyInfo>
 
49
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
50
      </AssemblyInfo>
 
51
      <Attributes>
 
52
        <Attribute>
 
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
 
54
        </Attribute>
 
55
      </Attributes>
 
56
      <Parameters>
 
57
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
 
58
      </Parameters>
 
59
      <Docs>
 
60
        <param name="coder">The unarchiver object.</param>
 
61
        <summary>A constructor that initializes the object from the data stored in the unarchiver object.</summary>
 
62
        <remarks>This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization).</remarks>
 
63
      </Docs>
 
64
    </Member>
 
65
    <Member MemberName=".ctor">
 
66
      <MemberSignature Language="C#" Value="public NSMatrixDelegate (MonoMac.Foundation.NSObjectFlag t);" />
 
67
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSObjectFlag t) cil managed" />
 
68
      <MemberType>Constructor</MemberType>
 
69
      <AssemblyInfo>
 
70
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
71
      </AssemblyInfo>
 
72
      <Parameters>
 
73
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
 
74
      </Parameters>
 
75
      <Docs>
 
76
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
 
77
        <summary>Constructor to call on derived classes to skip initialization and merely allocate the object.</summary>
 
78
        <remarks>
 
79
          <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>
 
80
          <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>
 
81
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
 
82
          <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>
 
83
          <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>
 
84
          <example>
 
85
            <code lang="C#">
 
86
//
 
87
// The NSObjectFlag merely allocates the object and registers the
 
88
// C# class with the Objective-C runtime if necessary, but no actual
 
89
// initXxx method is invoked, that is done later in the constructor
 
90
//
 
91
// This is taken from MonoMac's source code:
 
92
//
 
93
[Export ("initWithFrame:")]
 
94
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
 
95
{
 
96
// Invoke the init method now.
 
97
        var initWithFrame = new Selector ("initWithFrame:").Handle;
 
98
        if (IsDirectBinding)
 
99
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
 
100
        else
 
101
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
 
102
}
 
103
</code>
 
104
          </example>
 
105
        </remarks>
 
106
      </Docs>
 
107
    </Member>
 
108
    <Member MemberName=".ctor">
 
109
      <MemberSignature Language="C#" Value="public NSMatrixDelegate (IntPtr handle);" />
 
110
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
 
111
      <MemberType>Constructor</MemberType>
 
112
      <AssemblyInfo>
 
113
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
114
      </AssemblyInfo>
 
115
      <Parameters>
 
116
        <Parameter Name="handle" Type="System.IntPtr" />
 
117
      </Parameters>
 
118
      <Docs>
 
119
        <param name="handle">Pointer (handle) to the unmanaged object.</param>
 
120
        <summary>A constructor used when creating managed representations of unmanaged objects;  Called by the runtime.</summary>
 
121
        <remarks>
 
122
          <para>This constructor is invoked by the runtime infrastructure (<see cref="M:MonoMac.ObjCRuntime.GetNSObject (System.IntPtr)" />) to create a new managed representation for a pointer to an unmanaged Objective-C object.    You should not invoke this method directly, instead you should call the GetNSObject method as it will prevent two instances of a managed object to point to the same native object.</para>
 
123
        </remarks>
 
124
      </Docs>
 
125
    </Member>
 
126
    <Member MemberName="DidFailToFormatString">
 
127
      <MemberSignature Language="C#" Value="public virtual bool DidFailToFormatString (MonoMac.AppKit.NSControl control, string str, string error);" />
 
128
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool DidFailToFormatString(class MonoMac.AppKit.NSControl control, string str, string error) cil managed" />
 
129
      <MemberType>Method</MemberType>
 
130
      <AssemblyInfo>
 
131
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
132
      </AssemblyInfo>
 
133
      <Attributes>
 
134
        <Attribute>
 
135
          <AttributeName>MonoMac.Foundation.Export("control:didFailToFormatString:errorDescription:")</AttributeName>
 
136
        </Attribute>
 
137
      </Attributes>
 
138
      <ReturnValue>
 
139
        <ReturnType>System.Boolean</ReturnType>
 
140
      </ReturnValue>
 
141
      <Parameters>
 
142
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
143
        <Parameter Name="str" Type="System.String" />
 
144
        <Parameter Name="error" Type="System.String" />
 
145
      </Parameters>
 
146
      <Docs>
 
147
        <param name="control">To be added.</param>
 
148
        <param name="str">To be added.</param>
 
149
        <param name="error">To be added.</param>
 
150
        <summary>To be added.</summary>
 
151
        <returns>To be added.</returns>
 
152
        <remarks>To be added.</remarks>
 
153
      </Docs>
 
154
    </Member>
 
155
    <Member MemberName="DidFailToValidatePartialString">
 
156
      <MemberSignature Language="C#" Value="public virtual void DidFailToValidatePartialString (MonoMac.AppKit.NSControl control, string str, string error);" />
 
157
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DidFailToValidatePartialString(class MonoMac.AppKit.NSControl control, string str, string error) cil managed" />
 
158
      <MemberType>Method</MemberType>
 
159
      <AssemblyInfo>
 
160
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
161
      </AssemblyInfo>
 
162
      <Attributes>
 
163
        <Attribute>
 
164
          <AttributeName>MonoMac.Foundation.Export("control:didFailToValidatePartialString:errorDescription:")</AttributeName>
 
165
        </Attribute>
 
166
      </Attributes>
 
167
      <ReturnValue>
 
168
        <ReturnType>System.Void</ReturnType>
 
169
      </ReturnValue>
 
170
      <Parameters>
 
171
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
172
        <Parameter Name="str" Type="System.String" />
 
173
        <Parameter Name="error" Type="System.String" />
 
174
      </Parameters>
 
175
      <Docs>
 
176
        <param name="control">To be added.</param>
 
177
        <param name="str">To be added.</param>
 
178
        <param name="error">To be added.</param>
 
179
        <summary>To be added.</summary>
 
180
        <remarks>To be added.</remarks>
 
181
      </Docs>
 
182
    </Member>
 
183
    <Member MemberName="DoCommandBySelector">
 
184
      <MemberSignature Language="C#" Value="public virtual bool DoCommandBySelector (MonoMac.AppKit.NSControl control, MonoMac.AppKit.NSTextView textView, MonoMac.ObjCRuntime.Selector commandSelector);" />
 
185
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool DoCommandBySelector(class MonoMac.AppKit.NSControl control, class MonoMac.AppKit.NSTextView textView, class MonoMac.ObjCRuntime.Selector commandSelector) cil managed" />
 
186
      <MemberType>Method</MemberType>
 
187
      <AssemblyInfo>
 
188
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
189
      </AssemblyInfo>
 
190
      <Attributes>
 
191
        <Attribute>
 
192
          <AttributeName>MonoMac.Foundation.Export("control:textView:doCommandBySelector:")</AttributeName>
 
193
        </Attribute>
 
194
      </Attributes>
 
195
      <ReturnValue>
 
196
        <ReturnType>System.Boolean</ReturnType>
 
197
      </ReturnValue>
 
198
      <Parameters>
 
199
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
200
        <Parameter Name="textView" Type="MonoMac.AppKit.NSTextView" />
 
201
        <Parameter Name="commandSelector" Type="MonoMac.ObjCRuntime.Selector" />
 
202
      </Parameters>
 
203
      <Docs>
 
204
        <param name="control">To be added.</param>
 
205
        <param name="textView">To be added.</param>
 
206
        <param name="commandSelector">To be added.</param>
 
207
        <summary>To be added.</summary>
 
208
        <returns>To be added.</returns>
 
209
        <remarks>To be added.</remarks>
 
210
      </Docs>
 
211
    </Member>
 
212
    <Member MemberName="GetCompletions">
 
213
      <MemberSignature Language="C#" Value="public virtual string[] GetCompletions (MonoMac.AppKit.NSControl control, MonoMac.AppKit.NSTextView textView, string[] words, MonoMac.Foundation.NSRange charRange, int index);" />
 
214
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string[] GetCompletions(class MonoMac.AppKit.NSControl control, class MonoMac.AppKit.NSTextView textView, string[] words, valuetype MonoMac.Foundation.NSRange charRange, int32 index) cil managed" />
 
215
      <MemberType>Method</MemberType>
 
216
      <AssemblyInfo>
 
217
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
218
      </AssemblyInfo>
 
219
      <Attributes>
 
220
        <Attribute>
 
221
          <AttributeName>MonoMac.Foundation.Export("control:textView:completions:forPartialWordRange:indexOfSelectedItem:")</AttributeName>
 
222
        </Attribute>
 
223
      </Attributes>
 
224
      <ReturnValue>
 
225
        <ReturnType>System.String[]</ReturnType>
 
226
      </ReturnValue>
 
227
      <Parameters>
 
228
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
229
        <Parameter Name="textView" Type="MonoMac.AppKit.NSTextView" />
 
230
        <Parameter Name="words" Type="System.String[]" />
 
231
        <Parameter Name="charRange" Type="MonoMac.Foundation.NSRange" />
 
232
        <Parameter Name="index" Type="System.Int32" />
 
233
      </Parameters>
 
234
      <Docs>
 
235
        <param name="control">To be added.</param>
 
236
        <param name="textView">To be added.</param>
 
237
        <param name="words">To be added.</param>
 
238
        <param name="charRange">To be added.</param>
 
239
        <param name="index">To be added.</param>
 
240
        <summary>To be added.</summary>
 
241
        <returns>To be added.</returns>
 
242
        <remarks>To be added.</remarks>
 
243
      </Docs>
 
244
    </Member>
 
245
    <Member MemberName="IsValidObject">
 
246
      <MemberSignature Language="C#" Value="public virtual bool IsValidObject (MonoMac.AppKit.NSControl control, MonoMac.Foundation.NSObject objectToValidate);" />
 
247
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsValidObject(class MonoMac.AppKit.NSControl control, class MonoMac.Foundation.NSObject objectToValidate) cil managed" />
 
248
      <MemberType>Method</MemberType>
 
249
      <AssemblyInfo>
 
250
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
251
      </AssemblyInfo>
 
252
      <Attributes>
 
253
        <Attribute>
 
254
          <AttributeName>MonoMac.Foundation.Export("control:isValidObject:")</AttributeName>
 
255
        </Attribute>
 
256
      </Attributes>
 
257
      <ReturnValue>
 
258
        <ReturnType>System.Boolean</ReturnType>
 
259
      </ReturnValue>
 
260
      <Parameters>
 
261
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
262
        <Parameter Name="objectToValidate" Type="MonoMac.Foundation.NSObject" />
 
263
      </Parameters>
 
264
      <Docs>
 
265
        <param name="control">To be added.</param>
 
266
        <param name="objectToValidate">To be added.</param>
 
267
        <summary>To be added.</summary>
 
268
        <returns>To be added.</returns>
 
269
        <remarks>To be added.</remarks>
 
270
      </Docs>
 
271
    </Member>
 
272
    <Member MemberName="TextShouldBeginEditing">
 
273
      <MemberSignature Language="C#" Value="public virtual bool TextShouldBeginEditing (MonoMac.AppKit.NSControl control, MonoMac.AppKit.NSText fieldEditor);" />
 
274
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TextShouldBeginEditing(class MonoMac.AppKit.NSControl control, class MonoMac.AppKit.NSText fieldEditor) cil managed" />
 
275
      <MemberType>Method</MemberType>
 
276
      <AssemblyInfo>
 
277
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
278
      </AssemblyInfo>
 
279
      <Attributes>
 
280
        <Attribute>
 
281
          <AttributeName>MonoMac.Foundation.Export("control:textShouldBeginEditing:")</AttributeName>
 
282
        </Attribute>
 
283
      </Attributes>
 
284
      <ReturnValue>
 
285
        <ReturnType>System.Boolean</ReturnType>
 
286
      </ReturnValue>
 
287
      <Parameters>
 
288
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
289
        <Parameter Name="fieldEditor" Type="MonoMac.AppKit.NSText" />
 
290
      </Parameters>
 
291
      <Docs>
 
292
        <param name="control">To be added.</param>
 
293
        <param name="fieldEditor">To be added.</param>
 
294
        <summary>To be added.</summary>
 
295
        <returns>To be added.</returns>
 
296
        <remarks>To be added.</remarks>
 
297
      </Docs>
 
298
    </Member>
 
299
    <Member MemberName="TextShouldEndEditing">
 
300
      <MemberSignature Language="C#" Value="public virtual bool TextShouldEndEditing (MonoMac.AppKit.NSControl control, MonoMac.AppKit.NSText fieldEditor);" />
 
301
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TextShouldEndEditing(class MonoMac.AppKit.NSControl control, class MonoMac.AppKit.NSText fieldEditor) cil managed" />
 
302
      <MemberType>Method</MemberType>
 
303
      <AssemblyInfo>
 
304
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
305
      </AssemblyInfo>
 
306
      <Attributes>
 
307
        <Attribute>
 
308
          <AttributeName>MonoMac.Foundation.Export("control:textShouldEndEditing:")</AttributeName>
 
309
        </Attribute>
 
310
      </Attributes>
 
311
      <ReturnValue>
 
312
        <ReturnType>System.Boolean</ReturnType>
 
313
      </ReturnValue>
 
314
      <Parameters>
 
315
        <Parameter Name="control" Type="MonoMac.AppKit.NSControl" />
 
316
        <Parameter Name="fieldEditor" Type="MonoMac.AppKit.NSText" />
 
317
      </Parameters>
 
318
      <Docs>
 
319
        <param name="control">To be added.</param>
 
320
        <param name="fieldEditor">To be added.</param>
 
321
        <summary>To be added.</summary>
 
322
        <returns>To be added.</returns>
 
323
        <remarks>To be added.</remarks>
 
324
      </Docs>
 
325
    </Member>
 
326
  </Members>
 
327
</Type>