← 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.CoreLocation/CLLocationManagerDelegate.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.CoreLocation/CLLocationManagerDelegate.xml
20
20
  <Docs>
21
21
    <summary>Virtual methods on this class receive notifications from the CLLocationManager.</summary>
22
22
    <remarks>To be added.</remarks>
 
23
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=747bae48-05f5-4dec-a9fa-4cb979056b2d">Example_CoreLocation</related>
23
24
  </Docs>
24
25
  <Members>
25
26
    <Member MemberName=".ctor">
33
34
        <Attribute>
34
35
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
35
36
        </Attribute>
 
37
        <Attribute>
 
38
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
39
        </Attribute>
36
40
      </Attributes>
37
41
      <Parameters />
38
42
      <Docs>
52
56
        <Attribute>
53
57
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
54
58
        </Attribute>
 
59
        <Attribute>
 
60
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
61
        </Attribute>
55
62
      </Attributes>
56
63
      <Parameters>
57
64
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
69
76
      <AssemblyInfo>
70
77
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
71
78
      </AssemblyInfo>
 
79
      <Attributes>
 
80
        <Attribute>
 
81
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
82
        </Attribute>
 
83
      </Attributes>
72
84
      <Parameters>
73
85
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
74
86
      </Parameters>
75
87
      <Docs>
76
88
        <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>
 
89
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
78
90
        <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>
 
91
          <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>
84
92
          <example>
85
93
            <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
 
}
 
94
public class MyClass : BaseClass {
 
95
    [Export ("initWithFoo:")]
 
96
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
97
    {
 
98
        ...
 
99
    }
103
100
</code>
104
101
          </example>
105
102
        </remarks>
112
109
      <AssemblyInfo>
113
110
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
114
111
      </AssemblyInfo>
 
112
      <Attributes>
 
113
        <Attribute>
 
114
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
115
        </Attribute>
 
116
      </Attributes>
115
117
      <Parameters>
116
118
        <Parameter Name="handle" Type="System.IntPtr" />
117
119
      </Parameters>
149
151
        <remarks>To be added.</remarks>
150
152
      </Docs>
151
153
    </Member>
 
154
    <Member MemberName="DeferredUpdatesFinished">
 
155
      <MemberSignature Language="C#" Value="public virtual void DeferredUpdatesFinished (MonoMac.CoreLocation.CLLocationManager manager, MonoMac.Foundation.NSError error);" />
 
156
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DeferredUpdatesFinished(class MonoMac.CoreLocation.CLLocationManager manager, class MonoMac.Foundation.NSError error) cil managed" />
 
157
      <MemberType>Method</MemberType>
 
158
      <AssemblyInfo>
 
159
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
160
      </AssemblyInfo>
 
161
      <Attributes>
 
162
        <Attribute>
 
163
          <AttributeName>MonoMac.Foundation.Export("locationManager:didFinishDeferredUpdatesWithError:")</AttributeName>
 
164
        </Attribute>
 
165
      </Attributes>
 
166
      <ReturnValue>
 
167
        <ReturnType>System.Void</ReturnType>
 
168
      </ReturnValue>
 
169
      <Parameters>
 
170
        <Parameter Name="manager" Type="MonoMac.CoreLocation.CLLocationManager" />
 
171
        <Parameter Name="error" Type="MonoMac.Foundation.NSError" />
 
172
      </Parameters>
 
173
      <Docs>
 
174
        <param name="manager">To be added.</param>
 
175
        <param name="error">To be added.</param>
 
176
        <summary>To be added.</summary>
 
177
        <remarks>To be added.</remarks>
 
178
      </Docs>
 
179
    </Member>
152
180
    <Member MemberName="Failed">
153
181
      <MemberSignature Language="C#" Value="public virtual void Failed (MonoMac.CoreLocation.CLLocationManager manager, MonoMac.Foundation.NSError error);" />
154
182
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Failed(class MonoMac.CoreLocation.CLLocationManager manager, class MonoMac.Foundation.NSError error) cil managed" />
175
203
        <remarks>To be added.</remarks>
176
204
      </Docs>
177
205
    </Member>
 
206
    <Member MemberName="LocationsUpdated">
 
207
      <MemberSignature Language="C#" Value="public virtual void LocationsUpdated (MonoMac.CoreLocation.CLLocationManager manager, MonoMac.CoreLocation.CLLocation[] locations);" />
 
208
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LocationsUpdated(class MonoMac.CoreLocation.CLLocationManager manager, class MonoMac.CoreLocation.CLLocation[] locations) cil managed" />
 
209
      <MemberType>Method</MemberType>
 
210
      <AssemblyInfo>
 
211
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
212
      </AssemblyInfo>
 
213
      <Attributes>
 
214
        <Attribute>
 
215
          <AttributeName>MonoMac.Foundation.Export("locationManager:didUpdateLocations:")</AttributeName>
 
216
        </Attribute>
 
217
      </Attributes>
 
218
      <ReturnValue>
 
219
        <ReturnType>System.Void</ReturnType>
 
220
      </ReturnValue>
 
221
      <Parameters>
 
222
        <Parameter Name="manager" Type="MonoMac.CoreLocation.CLLocationManager" />
 
223
        <Parameter Name="locations" Type="MonoMac.CoreLocation.CLLocation[]" />
 
224
      </Parameters>
 
225
      <Docs>
 
226
        <param name="manager">To be added.</param>
 
227
        <param name="locations">To be added.</param>
 
228
        <summary>To be added.</summary>
 
229
        <remarks>To be added.</remarks>
 
230
      </Docs>
 
231
    </Member>
 
232
    <Member MemberName="LocationUpdatesPaused">
 
233
      <MemberSignature Language="C#" Value="public virtual void LocationUpdatesPaused (MonoMac.CoreLocation.CLLocationManager manager);" />
 
234
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LocationUpdatesPaused(class MonoMac.CoreLocation.CLLocationManager manager) cil managed" />
 
235
      <MemberType>Method</MemberType>
 
236
      <AssemblyInfo>
 
237
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
238
      </AssemblyInfo>
 
239
      <Attributes>
 
240
        <Attribute>
 
241
          <AttributeName>MonoMac.Foundation.Export("locationManagerDidPauseLocationUpdates:")</AttributeName>
 
242
        </Attribute>
 
243
      </Attributes>
 
244
      <ReturnValue>
 
245
        <ReturnType>System.Void</ReturnType>
 
246
      </ReturnValue>
 
247
      <Parameters>
 
248
        <Parameter Name="manager" Type="MonoMac.CoreLocation.CLLocationManager" />
 
249
      </Parameters>
 
250
      <Docs>
 
251
        <param name="manager">To be added.</param>
 
252
        <summary>To be added.</summary>
 
253
        <remarks>To be added.</remarks>
 
254
      </Docs>
 
255
    </Member>
 
256
    <Member MemberName="LocationUpdatesResumed">
 
257
      <MemberSignature Language="C#" Value="public virtual void LocationUpdatesResumed (MonoMac.CoreLocation.CLLocationManager manager);" />
 
258
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LocationUpdatesResumed(class MonoMac.CoreLocation.CLLocationManager manager) cil managed" />
 
259
      <MemberType>Method</MemberType>
 
260
      <AssemblyInfo>
 
261
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
262
      </AssemblyInfo>
 
263
      <Attributes>
 
264
        <Attribute>
 
265
          <AttributeName>MonoMac.Foundation.Export("locationManagerDidResumeLocationUpdates:")</AttributeName>
 
266
        </Attribute>
 
267
      </Attributes>
 
268
      <ReturnValue>
 
269
        <ReturnType>System.Void</ReturnType>
 
270
      </ReturnValue>
 
271
      <Parameters>
 
272
        <Parameter Name="manager" Type="MonoMac.CoreLocation.CLLocationManager" />
 
273
      </Parameters>
 
274
      <Docs>
 
275
        <param name="manager">To be added.</param>
 
276
        <summary>To be added.</summary>
 
277
        <remarks>To be added.</remarks>
 
278
      </Docs>
 
279
    </Member>
178
280
    <Member MemberName="ShouldDisplayHeadingCalibration">
179
281
      <MemberSignature Language="C#" Value="public virtual bool ShouldDisplayHeadingCalibration (MonoMac.CoreLocation.CLLocationManager manager);" />
180
282
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool ShouldDisplayHeadingCalibration(class MonoMac.CoreLocation.CLLocationManager manager) cil managed" />
211
313
        <Attribute>
212
314
          <AttributeName>MonoMac.Foundation.Export("locationManager:didUpdateToLocation:fromLocation:")</AttributeName>
213
315
        </Attribute>
 
316
        <Attribute>
 
317
          <AttributeName>System.Obsolete("Deprecated in iOS 6.0", false)</AttributeName>
 
318
        </Attribute>
214
319
      </Attributes>
215
320
      <ReturnValue>
216
321
        <ReturnType>System.Void</ReturnType>