← 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.CoreImage/CIColor.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.CoreImage/CIColor.xml
17
17
  <Docs>
18
18
    <summary>To be added.</summary>
19
19
    <remarks>To be added.</remarks>
 
20
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=e2a0ccca-ab10-4e41-9c09-11831a8c1380">coreimage</related>
20
21
  </Docs>
21
22
  <Members>
22
23
    <Member MemberName=".ctor">
23
 
      <MemberSignature Language="C#" Value="public CIColor ();" />
24
 
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
25
 
      <MemberType>Constructor</MemberType>
26
 
      <AssemblyInfo>
27
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
28
 
      </AssemblyInfo>
29
 
      <Attributes>
30
 
        <Attribute>
31
 
          <AttributeName>MonoMac.Foundation.Export("init")</AttributeName>
32
 
        </Attribute>
33
 
      </Attributes>
34
 
      <Parameters />
35
 
      <Docs>
36
 
        <summary>Default constructor that initializes a new instance of this class with no parameters.</summary>
37
 
        <remarks>
38
 
        </remarks>
39
 
      </Docs>
40
 
    </Member>
41
 
    <Member MemberName=".ctor">
42
24
      <MemberSignature Language="C#" Value="public CIColor (MonoMac.CoreGraphics.CGColor c);" />
43
25
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.CoreGraphics.CGColor c) cil managed" />
44
26
      <MemberType>Constructor</MemberType>
70
52
        <Attribute>
71
53
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
72
54
        </Attribute>
 
55
        <Attribute>
 
56
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
57
        </Attribute>
73
58
      </Attributes>
74
59
      <Parameters>
75
60
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
87
72
      <AssemblyInfo>
88
73
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
89
74
      </AssemblyInfo>
 
75
      <Attributes>
 
76
        <Attribute>
 
77
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
78
        </Attribute>
 
79
      </Attributes>
90
80
      <Parameters>
91
81
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
92
82
      </Parameters>
93
83
      <Docs>
94
84
        <param name="t">Unused sentinel value, pass NSObjectFlag.Empty.</param>
95
 
        <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>
96
86
        <remarks>
97
 
          <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>
98
 
          <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>
99
 
          <para>It is your responsability to completely initialize the object if you chain up using the NSObjectFlag.Empty path.</para>
100
 
          <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>
101
 
          <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>
102
88
          <example>
103
89
            <code lang="C#">
104
 
//
105
 
// The NSObjectFlag merely allocates the object and registers the
106
 
// C# class with the Objective-C runtime if necessary, but no actual
107
 
// initXxx method is invoked, that is done later in the constructor
108
 
//
109
 
// This is taken from MonoMac's source code:
110
 
//
111
 
[Export ("initWithFrame:")]
112
 
public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
113
 
{
114
 
// Invoke the init method now.
115
 
        var initWithFrame = new Selector ("initWithFrame:").Handle;
116
 
        if (IsDirectBinding)
117
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSend_RectangleF (this.Handle, initWithFrame, frame);
118
 
        else
119
 
                Handle = MonoMac.ObjCRuntime.Messaging.IntPtr_objc_msgSendSuper_RectangleF (this.SuperHandle, initWithFrame, frame);
120
 
}
 
90
public class MyClass : BaseClass {
 
91
    [Export ("initWithFoo:")]
 
92
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
93
    {
 
94
        ...
 
95
    }
121
96
</code>
122
97
          </example>
123
98
        </remarks>
130
105
      <AssemblyInfo>
131
106
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
132
107
      </AssemblyInfo>
 
108
      <Attributes>
 
109
        <Attribute>
 
110
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
111
        </Attribute>
 
112
      </Attributes>
133
113
      <Parameters>
134
114
        <Parameter Name="handle" Type="System.IntPtr" />
135
115
      </Parameters>
246
226
      </Docs>
247
227
    </Member>
248
228
    <Member MemberName="FromRgb">
249
 
      <MemberSignature Language="C#" Value="public static MonoMac.CoreImage.CIColor FromRgb (float r, float g, float b);" />
250
 
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreImage.CIColor FromRgb(float32 r, float32 g, float32 b) cil managed" />
 
229
      <MemberSignature Language="C#" Value="public static MonoMac.CoreImage.CIColor FromRgb (float red, float green, float blue);" />
 
230
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreImage.CIColor FromRgb(float32 red, float32 green, float32 blue) cil managed" />
251
231
      <MemberType>Method</MemberType>
252
232
      <AssemblyInfo>
253
233
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
261
241
        <ReturnType>MonoMac.CoreImage.CIColor</ReturnType>
262
242
      </ReturnValue>
263
243
      <Parameters>
264
 
        <Parameter Name="r" Type="System.Single" />
265
 
        <Parameter Name="g" Type="System.Single" />
266
 
        <Parameter Name="b" Type="System.Single" />
 
244
        <Parameter Name="red" Type="System.Single" />
 
245
        <Parameter Name="green" Type="System.Single" />
 
246
        <Parameter Name="blue" Type="System.Single" />
267
247
      </Parameters>
268
248
      <Docs>
269
 
        <param name="r">To be added.</param>
270
 
        <param name="g">To be added.</param>
271
 
        <param name="b">To be added.</param>
 
249
        <param name="red">To be added.</param>
 
250
        <param name="green">To be added.</param>
 
251
        <param name="blue">To be added.</param>
272
252
        <summary>To be added.</summary>
273
253
        <returns>To be added.</returns>
274
254
        <remarks>To be added.</remarks>
275
255
      </Docs>
276
256
    </Member>
277
257
    <Member MemberName="FromRgba">
278
 
      <MemberSignature Language="C#" Value="public static MonoMac.CoreImage.CIColor FromRgba (float r, float g, float b, float a);" />
279
 
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreImage.CIColor FromRgba(float32 r, float32 g, float32 b, float32 a) cil managed" />
 
258
      <MemberSignature Language="C#" Value="public static MonoMac.CoreImage.CIColor FromRgba (float red, float green, float blue, float alpha);" />
 
259
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.CoreImage.CIColor FromRgba(float32 red, float32 green, float32 blue, float32 alpha) cil managed" />
280
260
      <MemberType>Method</MemberType>
281
261
      <AssemblyInfo>
282
262
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
290
270
        <ReturnType>MonoMac.CoreImage.CIColor</ReturnType>
291
271
      </ReturnValue>
292
272
      <Parameters>
293
 
        <Parameter Name="r" Type="System.Single" />
294
 
        <Parameter Name="g" Type="System.Single" />
295
 
        <Parameter Name="b" Type="System.Single" />
296
 
        <Parameter Name="a" Type="System.Single" />
 
273
        <Parameter Name="red" Type="System.Single" />
 
274
        <Parameter Name="green" Type="System.Single" />
 
275
        <Parameter Name="blue" Type="System.Single" />
 
276
        <Parameter Name="alpha" Type="System.Single" />
297
277
      </Parameters>
298
278
      <Docs>
299
 
        <param name="r">To be added.</param>
300
 
        <param name="g">To be added.</param>
301
 
        <param name="b">To be added.</param>
302
 
        <param name="a">To be added.</param>
 
279
        <param name="red">To be added.</param>
 
280
        <param name="green">To be added.</param>
 
281
        <param name="blue">To be added.</param>
 
282
        <param name="alpha">To be added.</param>
303
283
        <summary>To be added.</summary>
304
284
        <returns>To be added.</returns>
305
285
        <remarks>To be added.</remarks>