← 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.Foundation/NSOrthography.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.Foundation/NSOrthography.xml
20
20
  </Docs>
21
21
  <Members>
22
22
    <Member MemberName=".ctor">
23
 
      <MemberSignature Language="C#" Value="public NSOrthography ();" />
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
23
      <MemberSignature Language="C#" Value="public NSOrthography (MonoMac.Foundation.NSCoder coder);" />
43
24
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class MonoMac.Foundation.NSCoder coder) cil managed" />
44
25
      <MemberType>Constructor</MemberType>
49
30
        <Attribute>
50
31
          <AttributeName>MonoMac.Foundation.Export("initWithCoder:")</AttributeName>
51
32
        </Attribute>
 
33
        <Attribute>
 
34
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
35
        </Attribute>
52
36
      </Attributes>
53
37
      <Parameters>
54
38
        <Parameter Name="coder" Type="MonoMac.Foundation.NSCoder" />
66
50
      <AssemblyInfo>
67
51
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
68
52
      </AssemblyInfo>
 
53
      <Attributes>
 
54
        <Attribute>
 
55
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
56
        </Attribute>
 
57
      </Attributes>
69
58
      <Parameters>
70
59
        <Parameter Name="t" Type="MonoMac.Foundation.NSObjectFlag" />
71
60
      </Parameters>
72
61
      <Docs>
73
62
        <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>
 
63
        <summary>Constructor to call on derived classes when the derived class has an [Export] constructor.</summary>
75
64
        <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>
 
65
          <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
66
          <example>
82
67
            <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
 
}
 
68
public class MyClass : BaseClass {
 
69
    [Export ("initWithFoo:")]
 
70
    public MyClass (string foo) : base (NSObjectFlag.Empty)
 
71
    {
 
72
        ...
 
73
    }
100
74
</code>
101
75
          </example>
102
76
        </remarks>
109
83
      <AssemblyInfo>
110
84
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
111
85
      </AssemblyInfo>
 
86
      <Attributes>
 
87
        <Attribute>
 
88
          <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)</AttributeName>
 
89
        </Attribute>
 
90
      </Attributes>
112
91
      <Parameters>
113
92
        <Parameter Name="handle" Type="System.IntPtr" />
114
93
      </Parameters>
121
100
      </Docs>
122
101
    </Member>
123
102
    <Member MemberName=".ctor">
124
 
      <MemberSignature Language="C#" Value="public NSOrthography (string script, MonoMac.Foundation.NSDictionary map);" />
125
 
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string script, class MonoMac.Foundation.NSDictionary map) cil managed" />
 
103
      <MemberSignature Language="C#" Value="public NSOrthography (string dominantScript, MonoMac.Foundation.NSDictionary languageMap);" />
 
104
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string dominantScript, class MonoMac.Foundation.NSDictionary languageMap) cil managed" />
126
105
      <MemberType>Constructor</MemberType>
127
106
      <AssemblyInfo>
128
107
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
133
112
        </Attribute>
134
113
      </Attributes>
135
114
      <Parameters>
136
 
        <Parameter Name="script" Type="System.String" />
137
 
        <Parameter Name="map" Type="MonoMac.Foundation.NSDictionary" />
 
115
        <Parameter Name="dominantScript" Type="System.String" />
 
116
        <Parameter Name="languageMap" Type="MonoMac.Foundation.NSDictionary" />
138
117
      </Parameters>
139
118
      <Docs>
140
 
        <param name="script">To be added.</param>
141
 
        <param name="map">To be added.</param>
 
119
        <param name="dominantScript">To be added.</param>
 
120
        <param name="languageMap">To be added.</param>
142
121
        <summary>To be added.</summary>
143
122
        <remarks>To be added.</remarks>
144
123
      </Docs>
218
197
        <param name="disposing">
219
198
          <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>
220
199
        </param>
221
 
        <summary>Releases the resourced used by the NSOrthography object.</summary>
 
200
        <summary>Releases the resources used by the NSOrthography object.</summary>
222
201
        <remarks>
223
202
          <para>This Dispose method releases the resources used by the NSOrthography class.</para>
224
203
          <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>
248
227
        <remarks>To be added.</remarks>
249
228
      </Docs>
250
229
    </Member>
 
230
    <Member MemberName="DominantLanguageForScript">
 
231
      <MemberSignature Language="C#" Value="public virtual string DominantLanguageForScript (string script);" />
 
232
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string DominantLanguageForScript(string script) cil managed" />
 
233
      <MemberType>Method</MemberType>
 
234
      <AssemblyInfo>
 
235
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
236
      </AssemblyInfo>
 
237
      <Attributes>
 
238
        <Attribute>
 
239
          <AttributeName>MonoMac.Foundation.Export("dominantLanguageForScript:")</AttributeName>
 
240
        </Attribute>
 
241
      </Attributes>
 
242
      <ReturnValue>
 
243
        <ReturnType>System.String</ReturnType>
 
244
      </ReturnValue>
 
245
      <Parameters>
 
246
        <Parameter Name="script" Type="System.String" />
 
247
      </Parameters>
 
248
      <Docs>
 
249
        <param name="script">To be added.</param>
 
250
        <summary>To be added.</summary>
 
251
        <returns>To be added.</returns>
 
252
        <remarks>To be added.</remarks>
 
253
      </Docs>
 
254
    </Member>
251
255
    <Member MemberName="DominantScript">
252
 
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSString DominantScript { get; }" />
253
 
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSString DominantScript" />
 
256
      <MemberSignature Language="C#" Value="public virtual string DominantScript { get; }" />
 
257
      <MemberSignature Language="ILAsm" Value=".property instance string DominantScript" />
254
258
      <MemberType>Property</MemberType>
255
259
      <AssemblyInfo>
256
260
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
261
265
        </Attribute>
262
266
      </Attributes>
263
267
      <ReturnValue>
264
 
        <ReturnType>MonoMac.Foundation.NSString</ReturnType>
 
268
        <ReturnType>System.String</ReturnType>
265
269
      </ReturnValue>
266
270
      <Docs>
267
271
        <summary>To be added.</summary>
269
273
        <remarks>To be added.</remarks>
270
274
      </Docs>
271
275
    </Member>
272
 
    <Member MemberName="GetDominantLanguageForScript">
273
 
      <MemberSignature Language="C#" Value="public virtual string GetDominantLanguageForScript (string forScript);" />
274
 
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetDominantLanguageForScript(string forScript) cil managed" />
275
 
      <MemberType>Method</MemberType>
276
 
      <AssemblyInfo>
277
 
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
278
 
      </AssemblyInfo>
279
 
      <Attributes>
280
 
        <Attribute>
281
 
          <AttributeName>MonoMac.Foundation.Export("dominantLanguageForScript:")</AttributeName>
282
 
        </Attribute>
283
 
      </Attributes>
284
 
      <ReturnValue>
285
 
        <ReturnType>System.String</ReturnType>
286
 
      </ReturnValue>
287
 
      <Parameters>
288
 
        <Parameter Name="forScript" Type="System.String" />
289
 
      </Parameters>
290
 
      <Docs>
291
 
        <param name="forScript">To be added.</param>
292
 
        <summary>To be added.</summary>
293
 
        <returns>To be added.</returns>
294
 
        <remarks>To be added.</remarks>
295
 
      </Docs>
296
 
    </Member>
297
276
    <Member MemberName="LanguageMap">
298
277
      <MemberSignature Language="C#" Value="public virtual MonoMac.Foundation.NSDictionary LanguageMap { get; }" />
299
278
      <MemberSignature Language="ILAsm" Value=".property instance class MonoMac.Foundation.NSDictionary LanguageMap" />