← 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.CoreText/CTFont.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.CoreText/CTFont.xml
22
22
    </Attribute>
23
23
  </Attributes>
24
24
  <Docs>
25
 
    <summary>To be added.</summary>
26
 
    <remarks>To be added.</remarks>
 
25
    <summary>Represents a CoreText Font.</summary>
 
26
    <remarks>
 
27
      <para>
 
28
 
 
29
        CoreText does not synthesize font styles (italic and bold).
 
30
        This means that if you pick a font that has neither a Bolded
 
31
        or Italicized versions available, CoreText will not create a
 
32
        dynamic font that is merely a slanted version of the font for
 
33
        italic, or a boldened version from the original font.  In
 
34
        those cases, if you want to synthesize the font, you could
 
35
        apply a Matrix transformation to slant the font (it will still
 
36
        be wrong, but will look slanted).  For bolding, you could
 
37
        stroke the font twice, or manually extend the glyph path.
 
38
 
 
39
      </para>
 
40
    </remarks>
 
41
    <related type="sample" href="http://samples.xamarin.com/Samples/ByGuid?guid=cb71419a-f5de-4239-aa70-260ce1813e55">SimpleTextInput</related>
27
42
  </Docs>
28
43
  <Members>
29
44
    <Member MemberName=".ctor">
38
53
        <Parameter Name="size" Type="System.Single" />
39
54
      </Parameters>
40
55
      <Docs>
41
 
        <param name="descriptor">To be added.</param>
42
 
        <param name="size">To be added.</param>
 
56
        <param name="descriptor">Font descriptor to use to create the font.</param>
 
57
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
43
58
        <summary>To be added.</summary>
44
59
        <remarks>To be added.</remarks>
45
60
      </Docs>
56
71
        <Parameter Name="size" Type="System.Single" />
57
72
      </Parameters>
58
73
      <Docs>
59
 
        <param name="name">To be added.</param>
60
 
        <param name="size">To be added.</param>
 
74
        <param name="name">The name of the font.   Use PostScript names (for example "HelveticaNeue").</param>
 
75
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
61
76
        <summary>To be added.</summary>
62
 
        <remarks>To be added.</remarks>
 
77
        <remarks>
 
78
          <para>
 
79
 
 
80
            Although currently iOS this allows the "name" parameter to
 
81
            use aliases to the font, in addition to the Postscript
 
82
            name, use of non-Postscript names for this parameter has
 
83
            been deprecated, due to the slow and expensive fallback
 
84
            scan.   
 
85
 
 
86
          </para>
 
87
          <para>
 
88
 
 
89
            If you want to create fonts from other names (like the fullname "Helvetica Neue" instead of the PostScript name "HelveticaNeue") you can use <see cref="C:MonoMac.CoreText.CTFontDescriptor(MonoMac.CoreText.CTFontDescriptorAttributes)" />. 
 
90
 
 
91
          </para>
 
92
        </remarks>
63
93
      </Docs>
64
94
    </Member>
65
95
    <Member MemberName=".ctor">
76
106
      </Parameters>
77
107
      <Docs>
78
108
        <param name="font">To be added.</param>
79
 
        <param name="size">To be added.</param>
80
 
        <param name="transform">To be added.</param>
 
109
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
110
        <param name="transform">Transformation matrix for the font, if null, it uses the identity matrix.</param>
81
111
        <summary>To be added.</summary>
82
112
        <remarks>To be added.</remarks>
83
113
      </Docs>
95
125
        <Parameter Name="descriptor" Type="MonoMac.CoreText.CTFontDescriptor" />
96
126
      </Parameters>
97
127
      <Docs>
98
 
        <param name="font">To be added.</param>
99
 
        <param name="size">To be added.</param>
100
 
        <param name="descriptor">To be added.</param>
101
 
        <summary>To be added.</summary>
 
128
        <param name="font">The CoreGraphics CGFont.</param>
 
129
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
130
        <param name="descriptor">Font descriptor to use to create the font.</param>
 
131
        <summary>Creates a CTFont from a CoreGraphics CGFont.</summary>
102
132
        <remarks>To be added.</remarks>
103
133
      </Docs>
104
134
    </Member>
115
145
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
116
146
      </Parameters>
117
147
      <Docs>
118
 
        <param name="descriptor">To be added.</param>
119
 
        <param name="size">To be added.</param>
120
 
        <param name="matrix">To be added.</param>
121
 
        <summary>To be added.</summary>
122
 
        <remarks>To be added.</remarks>
 
148
        <param name="descriptor">Font descriptor to use to create the font.</param>
 
149
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
150
        <param name="matrix">Transformation matrix for the font, if null, it uses the identity matrix.</param>
 
151
        <summary>Creates a CTFont from a CTFontDescriptor.</summary>
 
152
        <remarks>
 
153
        </remarks>
123
154
      </Docs>
124
155
    </Member>
125
156
    <Member MemberName=".ctor">
135
166
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontOptions" />
136
167
      </Parameters>
137
168
      <Docs>
138
 
        <param name="descriptor">To be added.</param>
139
 
        <param name="size">To be added.</param>
140
 
        <param name="options">To be added.</param>
 
169
        <param name="descriptor">Font descriptor to use to create the font.</param>
 
170
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
171
        <param name="options">Configuration options for the font creation.</param>
141
172
        <summary>To be added.</summary>
142
173
        <remarks>To be added.</remarks>
143
174
      </Docs>
156
187
      </Parameters>
157
188
      <Docs>
158
189
        <param name="uiType">To be added.</param>
159
 
        <param name="size">To be added.</param>
 
190
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
160
191
        <param name="language">To be added.</param>
161
192
        <summary>To be added.</summary>
162
193
        <remarks>To be added.</remarks>
175
206
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
176
207
      </Parameters>
177
208
      <Docs>
178
 
        <param name="name">To be added.</param>
179
 
        <param name="size">To be added.</param>
180
 
        <param name="matrix">To be added.</param>
 
209
        <param name="name">The name of the font.   Use PostScript names (for example "HelveticaNeue").</param>
 
210
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
211
        <param name="matrix">Transformation matrix for the font, if null, it uses the identity matrix.</param>
181
212
        <summary>To be added.</summary>
182
213
        <remarks>To be added.</remarks>
183
214
      </Docs>
195
226
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontOptions" />
196
227
      </Parameters>
197
228
      <Docs>
198
 
        <param name="name">To be added.</param>
199
 
        <param name="size">To be added.</param>
200
 
        <param name="options">To be added.</param>
 
229
        <param name="name">The name of the font.   Use PostScript names (for example "HelveticaNeue").</param>
 
230
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
231
        <param name="options">Configuration options for the font creation.</param>
201
232
        <summary>To be added.</summary>
202
233
        <remarks>To be added.</remarks>
203
234
      </Docs>
217
248
      </Parameters>
218
249
      <Docs>
219
250
        <param name="font">To be added.</param>
220
 
        <param name="size">To be added.</param>
221
 
        <param name="transform">To be added.</param>
222
 
        <param name="descriptor">To be added.</param>
 
251
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
252
        <param name="transform">Transformation matrix for the font, if null, it uses the identity matrix.</param>
 
253
        <param name="descriptor">Font descriptor to use to create the font.</param>
223
254
        <summary>To be added.</summary>
224
255
        <remarks>To be added.</remarks>
225
256
      </Docs>
238
269
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
239
270
      </Parameters>
240
271
      <Docs>
241
 
        <param name="descriptor">To be added.</param>
242
 
        <param name="size">To be added.</param>
243
 
        <param name="options">To be added.</param>
244
 
        <param name="matrix">To be added.</param>
 
272
        <param name="descriptor">Font descriptor to use to create the font.</param>
 
273
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
274
        <param name="options">Configuration options for the font creation.</param>
 
275
        <param name="matrix">Transformation matrix for the font, if null, it uses the identity matrix.</param>
245
276
        <summary>To be added.</summary>
246
277
        <remarks>To be added.</remarks>
247
278
      </Docs>
260
291
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontOptions" />
261
292
      </Parameters>
262
293
      <Docs>
263
 
        <param name="name">To be added.</param>
264
 
        <param name="size">To be added.</param>
265
 
        <param name="matrix">To be added.</param>
266
 
        <param name="options">To be added.</param>
 
294
        <param name="name">The name of the font.   Use PostScript names (for example "HelveticaNeue").</param>
 
295
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
 
296
        <param name="matrix">Transformation matrix for the font, if null, it uses the identity matrix.</param>
 
297
        <param name="options">Configuration options for the font creation.</param>
267
298
        <summary>To be added.</summary>
268
299
        <remarks>To be added.</remarks>
269
300
      </Docs>
376
407
      </ReturnValue>
377
408
      <Parameters />
378
409
      <Docs>
379
 
        <summary>Releases the resourced used by the CTFont object.</summary>
 
410
        <summary>Releases the resources used by the CTFont object.</summary>
380
411
        <remarks>
381
412
          <para>The Dispose method releases the resources used by the CTFont class.</para>
382
413
          <para>Calling the Dispose method when you are finished using the CTFont ensures that all external resources used by this managed object are released as soon as possible.  Once you have invoked the Dispose method, the object is no longer useful and you should no longer make any calls to it.  For more information on releasing resources see ``Cleaning up Unmananaged Resources'' at http://msdn.microsoft.com/en-us/library/498928w2.aspx</para>
400
431
        <param name="disposing">
401
432
          <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>
402
433
        </param>
403
 
        <summary>Releases the resourced used by the CTFont object.</summary>
 
434
        <summary>Releases the resources used by the CTFont object.</summary>
404
435
        <remarks>
405
436
          <para>This Dispose method releases the resources used by the CTFont class.</para>
406
437
          <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>
644
675
        <remarks>To be added.</remarks>
645
676
      </Docs>
646
677
    </Member>
 
678
    <Member MemberName="GetDefaultCascadeList">
 
679
      <MemberSignature Language="C#" Value="public MonoMac.CoreText.CTFontDescriptor[] GetDefaultCascadeList (string[] languages);" />
 
680
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreText.CTFontDescriptor[] GetDefaultCascadeList(string[] languages) cil managed" />
 
681
      <MemberType>Method</MemberType>
 
682
      <AssemblyInfo>
 
683
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
684
      </AssemblyInfo>
 
685
      <Attributes>
 
686
        <Attribute>
 
687
          <AttributeName>MonoMac.ObjCRuntime.Since(6, 0)</AttributeName>
 
688
        </Attribute>
 
689
      </Attributes>
 
690
      <ReturnValue>
 
691
        <ReturnType>MonoMac.CoreText.CTFontDescriptor[]</ReturnType>
 
692
      </ReturnValue>
 
693
      <Parameters>
 
694
        <Parameter Name="languages" Type="System.String[]" />
 
695
      </Parameters>
 
696
      <Docs>
 
697
        <param name="languages">To be added.</param>
 
698
        <summary>To be added.</summary>
 
699
        <returns>To be added.</returns>
 
700
        <remarks>To be added.</remarks>
 
701
      </Docs>
 
702
    </Member>
647
703
    <Member MemberName="GetFeatures">
648
704
      <MemberSignature Language="C#" Value="public MonoMac.CoreText.CTFontFeatures[] GetFeatures ();" />
649
705
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreText.CTFontFeatures[] GetFeatures() cil managed" />
850
906
        <remarks>To be added.</remarks>
851
907
      </Docs>
852
908
    </Member>
 
909
    <Member MemberName="GetOpticalBounds">
 
910
      <MemberSignature Language="C#" Value="public System.Drawing.RectangleF GetOpticalBounds (ushort[] glyphs, System.Drawing.RectangleF[] boundingRects, int count, MonoMac.CoreText.CTFontOptions options = MonoMac.CoreText.CTFontOptions.Default);" />
 
911
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Drawing.RectangleF GetOpticalBounds(unsigned int16[] glyphs, valuetype System.Drawing.RectangleF[] boundingRects, int32 count, valuetype MonoMac.CoreText.CTFontOptions options) cil managed" />
 
912
      <MemberType>Method</MemberType>
 
913
      <AssemblyInfo>
 
914
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
915
      </AssemblyInfo>
 
916
      <Attributes>
 
917
        <Attribute>
 
918
          <AttributeName>MonoMac.ObjCRuntime.Since(6, 0)</AttributeName>
 
919
        </Attribute>
 
920
      </Attributes>
 
921
      <ReturnValue>
 
922
        <ReturnType>System.Drawing.RectangleF</ReturnType>
 
923
      </ReturnValue>
 
924
      <Parameters>
 
925
        <Parameter Name="glyphs" Type="System.UInt16[]" />
 
926
        <Parameter Name="boundingRects" Type="System.Drawing.RectangleF[]" />
 
927
        <Parameter Name="count" Type="System.Int32" />
 
928
        <Parameter Name="options" Type="MonoMac.CoreText.CTFontOptions" />
 
929
      </Parameters>
 
930
      <Docs>
 
931
        <param name="glyphs">To be added.</param>
 
932
        <param name="boundingRects">To be added.</param>
 
933
        <param name="count">To be added.</param>
 
934
        <param name="options">To be added.</param>
 
935
        <summary>To be added.</summary>
 
936
        <returns>To be added.</returns>
 
937
        <remarks>To be added.</remarks>
 
938
      </Docs>
 
939
    </Member>
853
940
    <Member MemberName="GetPathForGlyph">
854
941
      <MemberSignature Language="C#" Value="public MonoMac.CoreGraphics.CGPath GetPathForGlyph (ushort glyph);" />
855
942
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class MonoMac.CoreGraphics.CGPath GetPathForGlyph(unsigned int16 glyph) cil managed" />
1059
1146
        <ReturnType>MonoMac.CoreGraphics.CGAffineTransform</ReturnType>
1060
1147
      </ReturnValue>
1061
1148
      <Docs>
1062
 
        <summary>To be added.</summary>
1063
 
        <value>To be added.</value>
1064
 
        <remarks>To be added.</remarks>
 
1149
        <summary>The transformation matrix used when this font was created.</summary>
 
1150
        <value>
 
1151
        </value>
 
1152
        <remarks>
 
1153
        </remarks>
1065
1154
      </Docs>
1066
1155
    </Member>
1067
1156
    <Member MemberName="PostScriptName">
1091
1180
        <ReturnType>System.Single</ReturnType>
1092
1181
      </ReturnValue>
1093
1182
      <Docs>
1094
 
        <summary>To be added.</summary>
1095
 
        <value>To be added.</value>
1096
 
        <remarks>To be added.</remarks>
 
1183
        <summary>The font size.</summary>
 
1184
        <value>
 
1185
        </value>
 
1186
        <remarks>This is the size that was used when the font was constructed.</remarks>
1097
1187
      </Docs>
1098
1188
    </Member>
1099
1189
    <Member MemberName="SlantAngle">
1261
1351
        <Parameter Name="attributes" Type="MonoMac.CoreText.CTFontDescriptor" />
1262
1352
      </Parameters>
1263
1353
      <Docs>
1264
 
        <param name="size">To be added.</param>
 
1354
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1265
1355
        <param name="attributes">To be added.</param>
1266
1356
        <summary>To be added.</summary>
1267
1357
        <returns>To be added.</returns>
1284
1374
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
1285
1375
      </Parameters>
1286
1376
      <Docs>
1287
 
        <param name="size">To be added.</param>
 
1377
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1288
1378
        <param name="attributes">To be added.</param>
1289
1379
        <param name="matrix">To be added.</param>
1290
1380
        <summary>To be added.</summary>
1307
1397
        <Parameter Name="family" Type="System.String" />
1308
1398
      </Parameters>
1309
1399
      <Docs>
1310
 
        <param name="size">To be added.</param>
 
1400
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1311
1401
        <param name="family">To be added.</param>
1312
1402
        <summary>To be added.</summary>
1313
1403
        <returns>To be added.</returns>
1330
1420
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
1331
1421
      </Parameters>
1332
1422
      <Docs>
1333
 
        <param name="size">To be added.</param>
 
1423
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1334
1424
        <param name="family">To be added.</param>
1335
1425
        <param name="matrix">To be added.</param>
1336
1426
        <summary>To be added.</summary>
1354
1444
        <Parameter Name="symTraitMask" Type="MonoMac.CoreText.CTFontSymbolicTraits" />
1355
1445
      </Parameters>
1356
1446
      <Docs>
1357
 
        <param name="size">To be added.</param>
 
1447
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1358
1448
        <param name="symTraitValue">To be added.</param>
1359
1449
        <param name="symTraitMask">To be added.</param>
1360
1450
        <summary>To be added.</summary>
1379
1469
        <Parameter Name="matrix" Type="MonoMac.CoreGraphics.CGAffineTransform&amp;" RefType="ref" />
1380
1470
      </Parameters>
1381
1471
      <Docs>
1382
 
        <param name="size">To be added.</param>
 
1472
        <param name="size">The desired font size.  If you specify zero, it will use the system default.</param>
1383
1473
        <param name="symTraitValue">To be added.</param>
1384
1474
        <param name="symTraitMask">To be added.</param>
1385
1475
        <param name="matrix">To be added.</param>