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

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.ImageKit/IKImageBrowserView.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:
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>
133
129
      <AssemblyInfo>
134
130
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
135
131
      </AssemblyInfo>
 
132
      <Attributes>
 
133
        <Attribute>
 
134
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
135
        </Attribute>
 
136
      </Attributes>
136
137
      <Parameters>
137
138
        <Parameter Name="handle" Type="System.IntPtr" />
138
139
      </Parameters>
275
276
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
276
277
      </ReturnValue>
277
278
      <Docs>
278
 
        <summary>To be added.</summary>
279
 
        <value>To be added.</value>
 
279
        <summary>Represents the value associated with the constant IKImageBrowserBackgroundColorKey</summary>
 
280
        <value>
 
281
        </value>
280
282
        <remarks>To be added.</remarks>
281
283
      </Docs>
282
284
    </Member>
354
356
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
355
357
      </ReturnValue>
356
358
      <Docs>
357
 
        <summary>To be added.</summary>
358
 
        <value>To be added.</value>
 
359
        <summary>Represents the value associated with the constant IKImageBrowserCellsHighlightedTitleAttributesKey</summary>
 
360
        <value>
 
361
        </value>
359
362
        <remarks>To be added.</remarks>
360
363
      </Docs>
361
364
    </Member>
394
397
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
395
398
      </ReturnValue>
396
399
      <Docs>
397
 
        <summary>To be added.</summary>
398
 
        <value>To be added.</value>
 
400
        <summary>Represents the value associated with the constant IKImageBrowserCellsOutlineColorKey</summary>
 
401
        <value>
 
402
        </value>
399
403
        <remarks>To be added.</remarks>
400
404
      </Docs>
401
405
    </Member>
434
438
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
435
439
      </ReturnValue>
436
440
      <Docs>
437
 
        <summary>To be added.</summary>
438
 
        <value>To be added.</value>
 
441
        <summary>Represents the value associated with the constant IKImageBrowserCellsSubtitleAttributesKey</summary>
 
442
        <value>
 
443
        </value>
439
444
        <remarks>To be added.</remarks>
440
445
      </Docs>
441
446
    </Member>
450
455
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
451
456
      </ReturnValue>
452
457
      <Docs>
453
 
        <summary>To be added.</summary>
454
 
        <value>To be added.</value>
 
458
        <summary>Represents the value associated with the constant IKImageBrowserCellsTitleAttributesKey</summary>
 
459
        <value>
 
460
        </value>
455
461
        <remarks>To be added.</remarks>
456
462
      </Docs>
457
463
    </Member>
606
612
      </ReturnValue>
607
613
      <Docs>
608
614
        <summary>To be added.</summary>
609
 
        <value>To be added.</value>
 
615
        <value>
 
616
          <para>(More documentation for this node is coming)</para>
 
617
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
618
        </value>
610
619
        <remarks>To be added.</remarks>
611
620
      </Docs>
612
621
    </Member>
622
631
      </ReturnValue>
623
632
      <Docs>
624
633
        <summary>An instance of the MonoMac.ImageKit.IKImageBrowserDelegate model class which acts as the class delegate.</summary>
625
 
        <value>The instance of the MonoMac.ImageKit.IKImageBrowserDelegate model class</value>
 
634
        <value>
 
635
          <para>The instance of the MonoMac.ImageKit.IKImageBrowserDelegate model class</para>
 
636
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
637
        </value>
626
638
        <remarks>
627
639
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
628
640
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>
647
659
        <param name="disposing">
648
660
          <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>
649
661
        </param>
650
 
        <summary>Releases the resourced used by the IKImageBrowserView object.</summary>
 
662
        <summary>Releases the resources used by the IKImageBrowserView object.</summary>
651
663
        <remarks>
652
664
          <para>This Dispose method releases the resources used by the IKImageBrowserView class.</para>
653
665
          <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>
1120
1132
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
1121
1133
      </ReturnValue>
1122
1134
      <Docs>
1123
 
        <summary>To be added.</summary>
1124
 
        <value>To be added.</value>
 
1135
        <summary>Represents the value associated with the constant IKImageBrowserSelectionColorKey</summary>
 
1136
        <value>
 
1137
        </value>
1125
1138
        <remarks>To be added.</remarks>
1126
1139
      </Docs>
1127
1140
    </Member>
1233
1246
      </ReturnValue>
1234
1247
      <Docs>
1235
1248
        <summary>To be added.</summary>
1236
 
        <value>To be added.</value>
 
1249
        <value>
 
1250
          <para>(More documentation for this node is coming)</para>
 
1251
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
1252
        </value>
1237
1253
        <remarks>To be added.</remarks>
1238
1254
      </Docs>
1239
1255
    </Member>
1257
1273
      </ReturnValue>
1258
1274
      <Docs>
1259
1275
        <summary>An object that can respond to the delegate protocol for this type</summary>
1260
 
        <value>The instance that will respond to events and data requests.</value>
 
1276
        <value>
 
1277
          <para>The instance that will respond to events and data requests.</para>
 
1278
          <para tool="nullallowed">This value can be <see langword="null" />.</para>
 
1279
        </value>
1261
1280
        <remarks>
1262
1281
          <para>The delegate instance assigned to this object will be used to handle events or provide data on demand to this class.</para>
1263
1282
          <para>When setting the Delegate or WeakDelegate values events will be delivered to the specified instance instead of being delivered to the C#-style events</para>