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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.ImageKit/IKImageBrowserItem.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:
33
33
        <Attribute>
34
34
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
35
35
        </Attribute>
 
36
        <Attribute>
 
37
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
38
        </Attribute>
36
39
      </Attributes>
37
40
      <Parameters />
38
41
      <Docs>
52
55
        <Attribute>
53
56
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
54
57
        </Attribute>
 
58
        <Attribute>
 
59
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
60
        </Attribute>
55
61
      </Attributes>
56
62
      <Parameters>
57
63
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
69
75
      <AssemblyInfo>
70
76
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
71
77
      </AssemblyInfo>
 
78
      <Attributes>
 
79
        <Attribute>
 
80
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
81
        </Attribute>
 
82
      </Attributes>
72
83
      <Parameters>
73
84
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
74
85
      </Parameters>
75
86
      <Docs>
76
87
        <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>
 
88
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
78
89
        <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>
 
90
          <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
91
          <example>
85
92
            <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
 
}
 
93
public class MyClass : BaseClass {
 
94
    [Export ("initWithFoo:")]
 
95
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
96
    {
 
97
        ...
 
98
    }
103
99
</code>
104
100
          </example>
105
101
        </remarks>
112
108
      <AssemblyInfo>
113
109
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
114
110
      </AssemblyInfo>
 
111
      <Attributes>
 
112
        <Attribute>
 
113
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
114
        </Attribute>
 
115
      </Attributes>
115
116
      <Parameters>
116
117
        <Parameter Name="handle" Type="System.IntPtr" />
117
118
      </Parameters>
134
135
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
135
136
      </ReturnValue>
136
137
      <Docs>
137
 
        <summary>To be added.</summary>
138
 
        <value>To be added.</value>
 
138
        <summary>Represents the value associated with the constant IKImageBrowserCGImageRepresentationType</summary>
 
139
        <value>
 
140
        </value>
139
141
        <remarks>To be added.</remarks>
140
142
      </Docs>
141
143
    </Member>
150
152
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
151
153
      </ReturnValue>
152
154
      <Docs>
153
 
        <summary>To be added.</summary>
154
 
        <value>To be added.</value>
 
155
        <summary>Represents the value associated with the constant IKImageBrowserCGImageSourceRepresentationType</summary>
 
156
        <value>
 
157
        </value>
155
158
        <remarks>To be added.</remarks>
156
159
      </Docs>
157
160
    </Member>
166
169
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
167
170
      </ReturnValue>
168
171
      <Docs>
169
 
        <summary>To be added.</summary>
170
 
        <value>To be added.</value>
 
172
        <summary>Represents the value associated with the constant IKImageBrowserIconRefPathRepresentationType</summary>
 
173
        <value>
 
174
        </value>
171
175
        <remarks>To be added.</remarks>
172
176
      </Docs>
173
177
    </Member>
182
186
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
183
187
      </ReturnValue>
184
188
      <Docs>
185
 
        <summary>To be added.</summary>
186
 
        <value>To be added.</value>
 
189
        <summary>Represents the value associated with the constant IKImageBrowserIconRefRepresentationType</summary>
 
190
        <value>
 
191
        </value>
187
192
        <remarks>To be added.</remarks>
188
193
      </Docs>
189
194
    </Member>
345
350
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
346
351
      </ReturnValue>
347
352
      <Docs>
348
 
        <summary>To be added.</summary>
349
 
        <value>To be added.</value>
 
353
        <summary>Represents the value associated with the constant IKImageBrowserNSBitmapImageRepresentationType</summary>
 
354
        <value>
 
355
        </value>
350
356
        <remarks>To be added.</remarks>
351
357
      </Docs>
352
358
    </Member>
361
367
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
362
368
      </ReturnValue>
363
369
      <Docs>
364
 
        <summary>To be added.</summary>
365
 
        <value>To be added.</value>
 
370
        <summary>Represents the value associated with the constant IKImageBrowserNSDataRepresentationType</summary>
 
371
        <value>
 
372
        </value>
366
373
        <remarks>To be added.</remarks>
367
374
      </Docs>
368
375
    </Member>
377
384
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
378
385
      </ReturnValue>
379
386
      <Docs>
380
 
        <summary>To be added.</summary>
381
 
        <value>To be added.</value>
 
387
        <summary>Represents the value associated with the constant IKImageBrowserNSImageRepresentationType</summary>
 
388
        <value>
 
389
        </value>
382
390
        <remarks>To be added.</remarks>
383
391
      </Docs>
384
392
    </Member>
393
401
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
394
402
      </ReturnValue>
395
403
      <Docs>
396
 
        <summary>To be added.</summary>
397
 
        <value>To be added.</value>
 
404
        <summary>Represents the value associated with the constant IKImageBrowserNSURLRepresentationType</summary>
 
405
        <value>
 
406
        </value>
398
407
        <remarks>To be added.</remarks>
399
408
      </Docs>
400
409
    </Member>
409
418
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
410
419
      </ReturnValue>
411
420
      <Docs>
412
 
        <summary>To be added.</summary>
413
 
        <value>To be added.</value>
 
421
        <summary>Represents the value associated with the constant IKImageBrowserPathRepresentationType</summary>
 
422
        <value>
 
423
        </value>
414
424
        <remarks>To be added.</remarks>
415
425
      </Docs>
416
426
    </Member>
425
435
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
426
436
      </ReturnValue>
427
437
      <Docs>
428
 
        <summary>To be added.</summary>
429
 
        <value>To be added.</value>
 
438
        <summary>Represents the value associated with the constant IKImageBrowserPDFPageRepresentationType</summary>
 
439
        <value>
 
440
        </value>
430
441
        <remarks>To be added.</remarks>
431
442
      </Docs>
432
443
    </Member>
441
452
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
442
453
      </ReturnValue>
443
454
      <Docs>
444
 
        <summary>To be added.</summary>
445
 
        <value>To be added.</value>
 
455
        <summary>Represents the value associated with the constant IKImageBrowserQCCompositionPathRepresentationType</summary>
 
456
        <value>
 
457
        </value>
446
458
        <remarks>To be added.</remarks>
447
459
      </Docs>
448
460
    </Member>
457
469
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
458
470
      </ReturnValue>
459
471
      <Docs>
460
 
        <summary>To be added.</summary>
461
 
        <value>To be added.</value>
 
472
        <summary>Represents the value associated with the constant IKImageBrowserQCCompositionRepresentationType</summary>
 
473
        <value>
 
474
        </value>
462
475
        <remarks>To be added.</remarks>
463
476
      </Docs>
464
477
    </Member>
473
486
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
474
487
      </ReturnValue>
475
488
      <Docs>
476
 
        <summary>To be added.</summary>
477
 
        <value>To be added.</value>
 
489
        <summary>Represents the value associated with the constant IKImageBrowserQTMoviePathRepresentationType</summary>
 
490
        <value>
 
491
        </value>
478
492
        <remarks>To be added.</remarks>
479
493
      </Docs>
480
494
    </Member>
489
503
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
490
504
      </ReturnValue>
491
505
      <Docs>
492
 
        <summary>To be added.</summary>
493
 
        <value>To be added.</value>
 
506
        <summary>Represents the value associated with the constant IKImageBrowserQTMovieRepresentationType</summary>
 
507
        <value>
 
508
        </value>
494
509
        <remarks>To be added.</remarks>
495
510
      </Docs>
496
511
    </Member>
505
520
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
506
521
      </ReturnValue>
507
522
      <Docs>
508
 
        <summary>To be added.</summary>
509
 
        <value>To be added.</value>
 
523
        <summary>Represents the value associated with the constant IKImageBrowserQuickLookPathRepresentationType</summary>
 
524
        <value>
 
525
        </value>
510
526
        <remarks>To be added.</remarks>
511
527
      </Docs>
512
528
    </Member>