← 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.ImageKit/IKFilterCustomUIProvider.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.ImageKit/IKFilterCustomUIProvider.xml
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 IKUIFlavorAllowFallback</summary>
 
139
        <value>
 
140
        </value>
139
141
        <remarks>To be added.</remarks>
140
142
      </Docs>
141
143
    </Member>
177
179
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
178
180
      </ReturnValue>
179
181
      <Docs>
180
 
        <summary>To be added.</summary>
181
 
        <value>To be added.</value>
 
182
        <summary>Represents the value associated with the constant IKUImaxSize</summary>
 
183
        <value>
 
184
        </value>
182
185
        <remarks>To be added.</remarks>
183
186
      </Docs>
184
187
    </Member>
193
196
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
194
197
      </ReturnValue>
195
198
      <Docs>
196
 
        <summary>To be added.</summary>
197
 
        <value>To be added.</value>
 
199
        <summary>Represents the value associated with the constant IKUISizeFlavor</summary>
 
200
        <value>
 
201
        </value>
198
202
        <remarks>To be added.</remarks>
199
203
      </Docs>
200
204
    </Member>
209
213
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
210
214
      </ReturnValue>
211
215
      <Docs>
212
 
        <summary>To be added.</summary>
213
 
        <value>To be added.</value>
 
216
        <summary>Represents the value associated with the constant IKUISizeMini</summary>
 
217
        <value>
 
218
        </value>
214
219
        <remarks>To be added.</remarks>
215
220
      </Docs>
216
221
    </Member>
225
230
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
226
231
      </ReturnValue>
227
232
      <Docs>
228
 
        <summary>To be added.</summary>
229
 
        <value>To be added.</value>
 
233
        <summary>Represents the value associated with the constant IKUISizeRegular</summary>
 
234
        <value>
 
235
        </value>
230
236
        <remarks>To be added.</remarks>
231
237
      </Docs>
232
238
    </Member>
241
247
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
242
248
      </ReturnValue>
243
249
      <Docs>
244
 
        <summary>To be added.</summary>
245
 
        <value>To be added.</value>
 
250
        <summary>Represents the value associated with the constant IKUISizeSmall</summary>
 
251
        <value>
 
252
        </value>
246
253
        <remarks>To be added.</remarks>
247
254
      </Docs>
248
255
    </Member>