← 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/CTFontDescriptorAttributes.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/CTFontDescriptorAttributes.xml
15
15
    </Attribute>
16
16
  </Attributes>
17
17
  <Docs>
18
 
    <summary>To be added.</summary>
19
 
    <remarks>To be added.</remarks>
 
18
    <summary>Strongly typed class that contains font attributes.</summary>
 
19
    <remarks>
 
20
      <para>
 
21
        This is a class that allows developers to easily consume and configure font descriptor attributes.
 
22
      </para>
 
23
      <example>
 
24
        <code lang="c#">
 
25
var attributes = new CTFontDescriptorAttributes () {
 
26
        FamilyName = "Times New Roman"
 
27
};
 
28
 
 
29
var fontDescriptor = new CTFontDescriptor (attributes);
 
30
        </code>
 
31
      </example>
 
32
    </remarks>
20
33
  </Docs>
21
34
  <Members>
22
35
    <Member MemberName=".ctor">
28
41
      </AssemblyInfo>
29
42
      <Parameters />
30
43
      <Docs>
31
 
        <summary>To be added.</summary>
32
 
        <remarks>To be added.</remarks>
 
44
        <summary>Default constructor.</summary>
 
45
        <remarks>
 
46
          <para>Typically used to initialize objects with the C# initializer syntax.</para>
 
47
          <example>
 
48
            <code lang="c#">
 
49
var attributes = new CTFontDescriptorAttributes () {
 
50
        FamilyName = "Times New Roman"
 
51
};
 
52
 
 
53
var fontDescriptor = new CTFontDescriptor (attributes);
 
54
</code>
 
55
          </example>
 
56
        </remarks>
33
57
      </Docs>
34
58
    </Member>
35
59
    <Member MemberName=".ctor">
43
67
        <Parameter Name="dictionary" Type="MonoMac.Foundation.NSDictionary" />
44
68
      </Parameters>
45
69
      <Docs>
46
 
        <param name="dictionary">To be added.</param>
47
 
        <summary>To be added.</summary>
48
 
        <remarks>To be added.</remarks>
 
70
        <param name="dictionary">An NSDictionary containing CTFontDescriptorAttributes keys and values.</param>
 
71
        <summary>Creates a strongly typed CTFontDescriptorAttributes from a weakly typed NSDictionary.</summary>
 
72
        <remarks>
 
73
        </remarks>
49
74
      </Docs>
50
75
    </Member>
51
76
    <Member MemberName="BaselineAdjust">
59
84
        <ReturnType>System.Nullable&lt;System.Single&gt;</ReturnType>
60
85
      </ReturnValue>
61
86
      <Docs>
62
 
        <summary>To be added.</summary>
63
 
        <value>To be added.</value>
64
 
        <remarks>To be added.</remarks>
 
87
        <summary>The Baseline Adjustment.</summary>
 
88
        <value>
 
89
        </value>
 
90
        <remarks>
 
91
        </remarks>
65
92
      </Docs>
66
93
    </Member>
67
94
    <Member MemberName="CascadeList">
75
102
        <ReturnType>System.Collections.Generic.IEnumerable&lt;MonoMac.CoreText.CTFontDescriptor&gt;</ReturnType>
76
103
      </ReturnValue>
77
104
      <Docs>
78
 
        <summary>To be added.</summary>
79
 
        <value>To be added.</value>
80
 
        <remarks>To be added.</remarks>
 
105
        <summary>Cascade list of font descriptors.</summary>
 
106
        <value>
 
107
        </value>
 
108
        <remarks>
 
109
        </remarks>
81
110
      </Docs>
82
111
    </Member>
83
112
    <Member MemberName="CharacterSet">
91
120
        <ReturnType>MonoMac.Foundation.NSCharacterSet</ReturnType>
92
121
      </ReturnValue>
93
122
      <Docs>
94
 
        <summary>To be added.</summary>
95
 
        <value>To be added.</value>
96
 
        <remarks>To be added.</remarks>
 
123
        <summary>The character set.</summary>
 
124
        <value>
 
125
        </value>
 
126
        <remarks>
 
127
        </remarks>
97
128
      </Docs>
98
129
    </Member>
99
130
    <Member MemberName="Dictionary">
107
138
        <ReturnType>MonoMac.Foundation.NSDictionary</ReturnType>
108
139
      </ReturnValue>
109
140
      <Docs>
110
 
        <summary>To be added.</summary>
111
 
        <value>To be added.</value>
112
 
        <remarks>To be added.</remarks>
 
141
        <summary>The NSDictionary that reflects the current values in the strongly typed CTFontDescriptorAttributes.</summary>
 
142
        <value>
 
143
        </value>
 
144
        <remarks>
 
145
        </remarks>
113
146
      </Docs>
114
147
    </Member>
115
148
    <Member MemberName="DisplayName">
123
156
        <ReturnType>System.String</ReturnType>
124
157
      </ReturnValue>
125
158
      <Docs>
126
 
        <summary>To be added.</summary>
127
 
        <value>To be added.</value>
128
 
        <remarks>To be added.</remarks>
 
159
        <summary>The font display name</summary>
 
160
        <value>
 
161
        </value>
 
162
        <remarks>For example the display name for the PostScript name "HelveticaNeue" is "Helvetica Neue".</remarks>
129
163
      </Docs>
130
164
    </Member>
131
165
    <Member MemberName="Enabled">
139
173
        <ReturnType>System.Boolean</ReturnType>
140
174
      </ReturnValue>
141
175
      <Docs>
142
 
        <summary>To be added.</summary>
143
 
        <value>To be added.</value>
144
 
        <remarks>To be added.</remarks>
 
176
        <summary>Enabled state.</summary>
 
177
        <value>
 
178
        </value>
 
179
        <remarks>
 
180
        </remarks>
145
181
      </Docs>
146
182
    </Member>
147
183
    <Member MemberName="FamilyName">
155
191
        <ReturnType>System.String</ReturnType>
156
192
      </ReturnValue>
157
193
      <Docs>
158
 
        <summary>To be added.</summary>
159
 
        <value>To be added.</value>
160
 
        <remarks>To be added.</remarks>
 
194
        <summary>The font family name.</summary>
 
195
        <value>
 
196
        </value>
 
197
        <remarks>
 
198
          <example>
 
199
            <code lang="c#">
 
200
var attributes = new CTFontDescriptorAttributes () {
 
201
        FamilyName = "Times New Roman"
 
202
};
 
203
 
 
204
var fontDescriptor = new CTFontDescriptor (attributes);
 
205
        </code>
 
206
          </example>
 
207
        </remarks>
161
208
      </Docs>
162
209
    </Member>
163
210
    <Member MemberName="Features">
171
218
        <ReturnType>System.Collections.Generic.IEnumerable&lt;MonoMac.CoreText.CTFontFeatures&gt;</ReturnType>
172
219
      </ReturnValue>
173
220
      <Docs>
174
 
        <summary>To be added.</summary>
175
 
        <value>To be added.</value>
176
 
        <remarks>To be added.</remarks>
 
221
        <summary>The font features for a font reference.</summary>
 
222
        <value>
 
223
        </value>
 
224
        <remarks>
 
225
        </remarks>
177
226
      </Docs>
178
227
    </Member>
179
228
    <Member MemberName="FeatureSettings">
187
236
        <ReturnType>System.Collections.Generic.IEnumerable&lt;MonoMac.CoreText.CTFontFeatureSettings&gt;</ReturnType>
188
237
      </ReturnValue>
189
238
      <Docs>
190
 
        <summary>To be added.</summary>
191
 
        <value>To be added.</value>
192
 
        <remarks>To be added.</remarks>
 
239
        <summary>Feature settings for the font.</summary>
 
240
        <value>
 
241
        </value>
 
242
        <remarks>
 
243
        </remarks>
193
244
      </Docs>
194
245
    </Member>
195
246
    <Member MemberName="FixedAdvance">
203
254
        <ReturnType>System.Nullable&lt;System.Single&gt;</ReturnType>
204
255
      </ReturnValue>
205
256
      <Docs>
206
 
        <summary>To be added.</summary>
207
 
        <value>To be added.</value>
208
 
        <remarks>To be added.</remarks>
 
257
        <summary>If set, overrides the font built-in constant advance.</summary>
 
258
        <value>
 
259
        </value>
 
260
        <remarks>
 
261
        </remarks>
209
262
      </Docs>
210
263
    </Member>
211
264
    <Member MemberName="FontFormat">
219
272
        <ReturnType>System.Nullable&lt;MonoMac.CoreText.CTFontFormat&gt;</ReturnType>
220
273
      </ReturnValue>
221
274
      <Docs>
222
 
        <summary>To be added.</summary>
223
 
        <value>To be added.</value>
224
 
        <remarks>To be added.</remarks>
 
275
        <summary>Font format.</summary>
 
276
        <value>
 
277
        </value>
 
278
        <remarks>
 
279
        </remarks>
225
280
      </Docs>
226
281
    </Member>
227
282
    <Member MemberName="FontOrientation">
235
290
        <ReturnType>System.Nullable&lt;MonoMac.CoreText.CTFontOrientation&gt;</ReturnType>
236
291
      </ReturnValue>
237
292
      <Docs>
238
 
        <summary>To be added.</summary>
239
 
        <value>To be added.</value>
240
 
        <remarks>To be added.</remarks>
 
293
        <summary>The font orientation.</summary>
 
294
        <value>
 
295
        </value>
 
296
        <remarks>
 
297
        </remarks>
241
298
      </Docs>
242
299
    </Member>
243
300
    <Member MemberName="Languages">
251
308
        <ReturnType>System.Collections.Generic.IEnumerable&lt;System.String&gt;</ReturnType>
252
309
      </ReturnValue>
253
310
      <Docs>
254
 
        <summary>To be added.</summary>
255
 
        <value>To be added.</value>
256
 
        <remarks>To be added.</remarks>
 
311
        <summary>List of supported languages by the font, must be encoded in RFC3066bis standard.</summary>
 
312
        <value>
 
313
        </value>
 
314
        <remarks>
 
315
        </remarks>
257
316
      </Docs>
258
317
    </Member>
259
318
    <Member MemberName="MacintoshEncodings">
267
326
        <ReturnType>System.Nullable&lt;System.Single&gt;</ReturnType>
268
327
      </ReturnValue>
269
328
      <Docs>
270
 
        <summary>To be added.</summary>
271
 
        <value>To be added.</value>
272
 
        <remarks>To be added.</remarks>
 
329
        <summary>If set, the Macintosh encodings for this font.</summary>
 
330
        <value>
 
331
        </value>
 
332
        <remarks>
 
333
        </remarks>
273
334
      </Docs>
274
335
    </Member>
275
336
    <Member MemberName="Matrix">
283
344
        <ReturnType>System.Nullable&lt;MonoMac.CoreGraphics.CGAffineTransform&gt;</ReturnType>
284
345
      </ReturnValue>
285
346
      <Docs>
286
 
        <summary>To be added.</summary>
287
 
        <value>To be added.</value>
288
 
        <remarks>To be added.</remarks>
 
347
        <summary>If set, the transformation matrix used when creating the font.</summary>
 
348
        <value>
 
349
        </value>
 
350
        <remarks>
 
351
        </remarks>
289
352
      </Docs>
290
353
    </Member>
291
354
    <Member MemberName="Name">
299
362
        <ReturnType>System.String</ReturnType>
300
363
      </ReturnValue>
301
364
      <Docs>
302
 
        <summary>To be added.</summary>
303
 
        <value>To be added.</value>
304
 
        <remarks>To be added.</remarks>
 
365
        <summary>The PostScript name for the font.</summary>
 
366
        <value>
 
367
        </value>
 
368
        <remarks>
 
369
        </remarks>
305
370
      </Docs>
306
371
    </Member>
307
372
    <Member MemberName="Priority">
315
380
        <ReturnType>System.Nullable&lt;MonoMac.CoreText.CTFontPriority&gt;</ReturnType>
316
381
      </ReturnValue>
317
382
      <Docs>
318
 
        <summary>To be added.</summary>
319
 
        <value>To be added.</value>
320
 
        <remarks>To be added.</remarks>
 
383
        <summary>The font priority used when resolving font duplicates.</summary>
 
384
        <value>
 
385
        </value>
 
386
        <remarks>
 
387
        </remarks>
321
388
      </Docs>
322
389
    </Member>
323
390
    <Member MemberName="RegistrationScope">
331
398
        <ReturnType>MonoMac.Foundation.NSNumber</ReturnType>
332
399
      </ReturnValue>
333
400
      <Docs>
334
 
        <summary>To be added.</summary>
335
 
        <value>To be added.</value>
336
 
        <remarks>To be added.</remarks>
 
401
        <summary>The font registration scope.</summary>
 
402
        <value>
 
403
        </value>
 
404
        <remarks>
 
405
        </remarks>
337
406
      </Docs>
338
407
    </Member>
339
408
    <Member MemberName="Size">
347
416
        <ReturnType>System.Nullable&lt;System.Single&gt;</ReturnType>
348
417
      </ReturnValue>
349
418
      <Docs>
350
 
        <summary>To be added.</summary>
351
 
        <value>To be added.</value>
352
 
        <remarks>To be added.</remarks>
 
419
        <summary>The font point size, if not specified, the default 12.0 is used.</summary>
 
420
        <value>
 
421
        </value>
 
422
        <remarks>
 
423
        </remarks>
353
424
      </Docs>
354
425
    </Member>
355
426
    <Member MemberName="StyleName">
363
434
        <ReturnType>System.String</ReturnType>
364
435
      </ReturnValue>
365
436
      <Docs>
366
 
        <summary>To be added.</summary>
367
 
        <value>To be added.</value>
368
 
        <remarks>To be added.</remarks>
 
437
        <summary>The font stylename</summary>
 
438
        <value>
 
439
        </value>
 
440
        <remarks>
 
441
        </remarks>
369
442
      </Docs>
370
443
    </Member>
371
444
    <Member MemberName="Traits">
379
452
        <ReturnType>MonoMac.CoreText.CTFontTraits</ReturnType>
380
453
      </ReturnValue>
381
454
      <Docs>
382
 
        <summary>To be added.</summary>
383
 
        <value>To be added.</value>
384
 
        <remarks>To be added.</remarks>
 
455
        <summary>The font traits.</summary>
 
456
        <value>
 
457
        </value>
 
458
        <remarks>
 
459
        </remarks>
385
460
      </Docs>
386
461
    </Member>
387
462
    <Member MemberName="Url">
395
470
        <ReturnType>MonoMac.Foundation.NSUrl</ReturnType>
396
471
      </ReturnValue>
397
472
      <Docs>
398
 
        <summary>To be added.</summary>
399
 
        <value>To be added.</value>
400
 
        <remarks>To be added.</remarks>
 
473
        <summary>Used to access the URL for the font.</summary>
 
474
        <value>
 
475
        </value>
 
476
        <remarks>
 
477
        </remarks>
401
478
      </Docs>
402
479
    </Member>
403
480
    <Member MemberName="Variation">
411
488
        <ReturnType>MonoMac.CoreText.CTFontVariation</ReturnType>
412
489
      </ReturnValue>
413
490
      <Docs>
414
 
        <summary>To be added.</summary>
415
 
        <value>To be added.</value>
416
 
        <remarks>To be added.</remarks>
 
491
        <summary>Font variation.</summary>
 
492
        <value>
 
493
        </value>
 
494
        <remarks>
 
495
        </remarks>
417
496
      </Docs>
418
497
    </Member>
419
498
  </Members>