Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(257)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.fontSettings.html

Issue 9689054: Generate documentation for experimental Font Settings Extension API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: sync Created 8 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js"> 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script> 15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js"> 16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script> 17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script> 18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script> 19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script> 20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <title>Experimental.font Settings - Google Chrome Extensions - Google Code</ti tle></head> 21 <meta name="description" content="Documentation for the chrome.experimental.fo ntSettings module, which is part of the Google Chrome extension APIs."><title>c hrome.experimental.fontSettings - Google Chrome Extensions - Google Code</title> </head>
22 <body> <div id="devModeWarning" class="displayModeWarning"> 22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files. 23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div> 24 </div>
25 <div id="branchWarning" class="displayModeWarning"> 25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span> 27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser"> 28 <select id="branchChooser">
29 <option>Choose a different version... 29 <option>Choose a different version...
30 </option><option value="">Stable 30 </option><option value="">Stable
31 </option><option value="beta">Beta 31 </option><option value="beta">Beta
(...skipping 146 matching lines...) Expand 10 before | Expand all | Expand 10 after
178 <li><a href="themes.html">Themes</a></li> 178 <li><a href="themes.html">Themes</a></li>
179 </ul> 179 </ul>
180 </li> 180 </li>
181 </ul> 181 </ul>
182 </div> 182 </div>
183 <script> 183 <script>
184 initToggles(); 184 initToggles();
185 </script> 185 </script>
186 <div class="g-unit" id="gc-pagecontent"> 186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle"> 187 <div id="pageTitle">
188 <h1 class="page_title">Experimental.font Settings</h1> 188 <h1 class="page_title">chrome.experimental.fontSettings</h1>
189 </div> 189 </div>
190 <!-- TABLE OF CONTENTS --> 190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.fontS ettings</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-getFontList">getFontList</a>
202 </li><li>
203 <a href="#method-getFontName">getFontName</a>
204 </li><li>
205 <a href="#method-setFontName">setFontName</a>
206 </li>
207 </ol>
208 </li>
209 <li>
210 <a href="#types">Types</a>
211 <ol>
212 <li>
213 <a href="#type-FontName">FontName</a>
214 <ol>
215 </ol>
216 </li>
217 </ol>
218 </li>
219 </ol>
220 </li>
221 </ol>
222 </div>
191 <!-- /TABLE OF CONTENTS --> 223 <!-- /TABLE OF CONTENTS -->
192 <!-- Standard content lead-in for experimental API pages --> 224 <!-- Standard content lead-in for experimental API pages -->
225 <p id="classSummary">
226 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
227 </p>
193 <!-- STATIC CONTENT PLACEHOLDER --> 228 <!-- STATIC CONTENT PLACEHOLDER -->
194 <div id="static"></div> 229 <div id="static"></div>
195 <!-- API PAGE --> 230 <!-- API PAGE -->
196 <!-- /apiPage --> 231 <div class="apiPage">
232 <a name="apiReference"></a>
233 <h2>API reference: chrome.experimental.fontSettings</h2>
234 <!-- PROPERTIES -->
235 <!-- /apiGroup -->
236 <!-- METHODS -->
237 <div id="methodsTemplate" class="apiGroup">
238 <a name="global-methods"></a>
239 <h3>Methods</h3>
240 <!-- iterates over all functions -->
241 <div class="apiItem">
242 <a name="method-getFontList"></a> <!-- method-anchor -->
243 <h4>getFontList</h4>
244 <div class="summary">
245 <!-- Note: intentionally longer 80 columns -->
246 <span>chrome.experimental.fontSettings.getFontList</span>(<spa n class="null"><span>function</span>
247 <var><span>callback</span></var></span>)</div>
248 <div class="description">
249 <p>Gets a list of fonts on the system.</p>
250 <!-- PARAMETERS -->
251 <h4>Parameters</h4>
252 <dl>
253 <div>
254 <div>
255 <dt>
256 <var>callback</var>
257 <em>
258 <!-- TYPE -->
259 <div style="display:inline">
260 (
261 <span id="typeTemplate">
262 <span>
263 <span>function</span>
264 </span>
265 </span>
266 )
267 </div>
268 </em>
269 </dt>
270 <dd class="todo">
271 Undocumented.
272 </dd>
273 <!-- OBJECT PROPERTIES -->
274 <!-- OBJECT METHODS -->
275 <!-- OBJECT EVENT FIELDS -->
276 <!-- FUNCTION PARAMETERS -->
277 </div>
278 </div>
279 </dl>
280 <!-- RETURNS -->
281 <dl>
282 </dl>
283 <!-- CALLBACK -->
284 <div>
285 <div>
286 <h4>Callback function</h4>
287 <p>
288 The callback <em>parameter</em> should specify a function
289 that looks like this:
290 </p>
291 <!-- Note: intentionally longer 80 columns -->
292 <pre>function(<span>array of FontName results</span>) <span cl ass="subdued">{...}</span>;</pre>
293 <dl>
294 <div>
295 <div>
296 <dt>
297 <var>results</var>
298 <em>
299 <!-- TYPE -->
300 <div style="display:inline">
301 (
302 <span id="typeTemplate">
303 <span>
304 <span>
305 array of <span><span>
306 <span>
307 <a href="experimental.fontSettings.html#type-FontName">F ontName</a>
308 </span>
309 </span></span>
310 </span>
311 </span>
312 </span>
313 )
314 </div>
315 </em>
316 </dt>
317 <dd class="todo">
318 Undocumented.
319 </dd>
320 <!-- OBJECT PROPERTIES -->
321 <!-- OBJECT METHODS -->
322 <!-- OBJECT EVENT FIELDS -->
323 <!-- FUNCTION PARAMETERS -->
324 </div>
325 </div>
326 </dl>
327 </div>
328 </div>
329 <!-- MIN_VERSION -->
330 </div> <!-- /description -->
331 </div><div class="apiItem">
332 <a name="method-getFontName"></a> <!-- method-anchor -->
333 <h4>getFontName</h4>
334 <div class="summary">
335 <!-- Note: intentionally longer 80 columns -->
336 <span>chrome.experimental.fontSettings.getFontName</span>(<spa n class="null"><span>object</span>
337 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
338 <var><span>callback</span></var></span>)</div>
339 <div class="description">
340 <p>Gets the font name of the current setting for a given script and generic font family.</p>
341 <!-- PARAMETERS -->
342 <h4>Parameters</h4>
343 <dl>
344 <div>
345 <div>
346 <dt>
347 <var>details</var>
348 <em>
349 <!-- TYPE -->
350 <div style="display:inline">
351 (
352 <span id="typeTemplate">
353 <span>
354 <span>object</span>
355 </span>
356 </span>
357 )
358 </div>
359 </em>
360 </dt>
361 <dd class="todo">
362 Undocumented.
363 </dd>
364 <!-- OBJECT PROPERTIES -->
365 <dd>
366 <dl>
367 <div>
368 <div>
369 <dt>
370 <var>script</var>
371 <em>
372 <!-- TYPE -->
373 <div style="display:inline">
374 (
375 <span class="optional">optional</span>
376 <span class="enum">enumerated</span>
377 <span id="typeTemplate">
378 <span>
379 <span>string</span>
380 <span>["Arab", "Hang", "Hans", "Hant", "Hrkt"]</span>
381 </span>
382 </span>
383 )
384 </div>
385 </em>
386 </dt>
387 <dd>The ISO 15924 script code for which the font setting should be ret rieved. If omitted, the global script font setting is retrieved.</dd>
388 <!-- OBJECT PROPERTIES -->
389 <!-- OBJECT METHODS -->
390 <!-- OBJECT EVENT FIELDS -->
391 <!-- FUNCTION PARAMETERS -->
392 </div>
393 </div><div>
394 <div>
395 <dt>
396 <var>genericFamily</var>
397 <em>
398 <!-- TYPE -->
399 <div style="display:inline">
400 (
401 <span class="enum">enumerated</span>
402 <span id="typeTemplate">
403 <span>
404 <span>string</span>
405 <span>["standard", "sansserif", "serif", "fixed", "cursi ve", "fantasy"]</span>
406 </span>
407 </span>
408 )
409 </div>
410 </em>
411 </dt>
412 <dd>The CSS generic font family for which the font setting should be r etrieved.</dd>
413 <!-- OBJECT PROPERTIES -->
414 <!-- OBJECT METHODS -->
415 <!-- OBJECT EVENT FIELDS -->
416 <!-- FUNCTION PARAMETERS -->
417 </div>
418 </div>
419 </dl>
420 </dd>
421 <!-- OBJECT METHODS -->
422 <!-- OBJECT EVENT FIELDS -->
423 <!-- FUNCTION PARAMETERS -->
424 </div>
425 </div><div>
426 <div>
427 <dt>
428 <var>callback</var>
429 <em>
430 <!-- TYPE -->
431 <div style="display:inline">
432 (
433 <span class="optional">optional</span>
434 <span id="typeTemplate">
435 <span>
436 <span>function</span>
437 </span>
438 </span>
439 )
440 </div>
441 </em>
442 </dt>
443 <dd class="todo">
444 Undocumented.
445 </dd>
446 <!-- OBJECT PROPERTIES -->
447 <!-- OBJECT METHODS -->
448 <!-- OBJECT EVENT FIELDS -->
449 <!-- FUNCTION PARAMETERS -->
450 </div>
451 </div>
452 </dl>
453 <!-- RETURNS -->
454 <dl>
455 </dl>
456 <!-- CALLBACK -->
457 <div>
458 <div>
459 <h4>Callback function</h4>
460 <p>
461 If you specify the <em>callback</em> parameter, it should
462 specify a function that looks like this:
463 </p>
464 <!-- Note: intentionally longer 80 columns -->
465 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
466 <dl>
467 <div>
468 <div>
469 <dt>
470 <var>details</var>
471 <em>
472 <!-- TYPE -->
473 <div style="display:inline">
474 (
475 <span id="typeTemplate">
476 <span>
477 <span>object</span>
478 </span>
479 </span>
480 )
481 </div>
482 </em>
483 </dt>
484 <dd class="todo">
485 Undocumented.
486 </dd>
487 <!-- OBJECT PROPERTIES -->
488 <dd>
489 <dl>
490 <div>
491 <div>
492 <dt>
493 <var>fontName</var>
494 <em>
495 <!-- TYPE -->
496 <div style="display:inline">
497 (
498 <span id="typeTemplate">
499 <span>
500 <span>string</span>
501 </span>
502 </span>
503 )
504 </div>
505 </em>
506 </dt>
507 <dd>The font name.</dd>
508 <!-- OBJECT PROPERTIES -->
509 <!-- OBJECT METHODS -->
510 <!-- OBJECT EVENT FIELDS -->
511 <!-- FUNCTION PARAMETERS -->
512 </div>
513 </div>
514 </dl>
515 </dd>
516 <!-- OBJECT METHODS -->
517 <!-- OBJECT EVENT FIELDS -->
518 <!-- FUNCTION PARAMETERS -->
519 </div>
520 </div>
521 </dl>
522 </div>
523 </div>
524 <!-- MIN_VERSION -->
525 </div> <!-- /description -->
526 </div><div class="apiItem">
527 <a name="method-setFontName"></a> <!-- method-anchor -->
528 <h4>setFontName</h4>
529 <div class="summary">
530 <!-- Note: intentionally longer 80 columns -->
531 <span>chrome.experimental.fontSettings.setFontName</span>(<spa n class="null"><span>object</span>
532 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
533 <var><span>callback</span></var></span>)</div>
534 <div class="description">
535 <p>Sets the font name of the current setting for a given script and generic font family.</p>
536 <!-- PARAMETERS -->
537 <h4>Parameters</h4>
538 <dl>
539 <div>
540 <div>
541 <dt>
542 <var>details</var>
543 <em>
544 <!-- TYPE -->
545 <div style="display:inline">
546 (
547 <span id="typeTemplate">
548 <span>
549 <span>object</span>
550 </span>
551 </span>
552 )
553 </div>
554 </em>
555 </dt>
556 <dd class="todo">
557 Undocumented.
558 </dd>
559 <!-- OBJECT PROPERTIES -->
560 <dd>
561 <dl>
562 <div>
563 <div>
564 <dt>
565 <var>script</var>
566 <em>
567 <!-- TYPE -->
568 <div style="display:inline">
569 (
570 <span class="optional">optional</span>
571 <span class="enum">enumerated</span>
572 <span id="typeTemplate">
573 <span>
574 <span>string</span>
575 <span>["Arab", "Hang", "Hans", "Hant", "Hrkt"]</span>
576 </span>
577 </span>
578 )
579 </div>
580 </em>
581 </dt>
582 <dd>The ISO 15924 script code for which the font setting should be set . If omitted, the global script font setting is set.</dd>
583 <!-- OBJECT PROPERTIES -->
584 <!-- OBJECT METHODS -->
585 <!-- OBJECT EVENT FIELDS -->
586 <!-- FUNCTION PARAMETERS -->
587 </div>
588 </div><div>
589 <div>
590 <dt>
591 <var>genericFamily</var>
592 <em>
593 <!-- TYPE -->
594 <div style="display:inline">
595 (
596 <span class="enum">enumerated</span>
597 <span id="typeTemplate">
598 <span>
599 <span>string</span>
600 <span>["standard", "sansserif", "serif", "fixed", "cursi ve", "fantasy"]</span>
601 </span>
602 </span>
603 )
604 </div>
605 </em>
606 </dt>
607 <dd>The CSS generic font family for which the font setting should be s et.</dd>
608 <!-- OBJECT PROPERTIES -->
609 <!-- OBJECT METHODS -->
610 <!-- OBJECT EVENT FIELDS -->
611 <!-- FUNCTION PARAMETERS -->
612 </div>
613 </div><div>
614 <div>
615 <dt>
616 <var>fontName</var>
617 <em>
618 <!-- TYPE -->
619 <div style="display:inline">
620 (
621 <span id="typeTemplate">
622 <span>
623 <span>string</span>
624 </span>
625 </span>
626 )
627 </div>
628 </em>
629 </dt>
630 <dd>The font name.</dd>
631 <!-- OBJECT PROPERTIES -->
632 <!-- OBJECT METHODS -->
633 <!-- OBJECT EVENT FIELDS -->
634 <!-- FUNCTION PARAMETERS -->
635 </div>
636 </div>
637 </dl>
638 </dd>
639 <!-- OBJECT METHODS -->
640 <!-- OBJECT EVENT FIELDS -->
641 <!-- FUNCTION PARAMETERS -->
642 </div>
643 </div><div>
644 <div>
645 <dt>
646 <var>callback</var>
647 <em>
648 <!-- TYPE -->
649 <div style="display:inline">
650 (
651 <span class="optional">optional</span>
652 <span id="typeTemplate">
653 <span>
654 <span>function</span>
655 </span>
656 </span>
657 )
658 </div>
659 </em>
660 </dt>
661 <dd class="todo">
662 Undocumented.
663 </dd>
664 <!-- OBJECT PROPERTIES -->
665 <!-- OBJECT METHODS -->
666 <!-- OBJECT EVENT FIELDS -->
667 <!-- FUNCTION PARAMETERS -->
668 </div>
669 </div>
670 </dl>
671 <!-- RETURNS -->
672 <dl>
673 </dl>
674 <!-- CALLBACK -->
675 <div>
676 <div>
677 <h4>Callback function</h4>
678 <p>
679 If you specify the <em>callback</em> parameter, it should
680 specify a function that looks like this:
681 </p>
682 <!-- Note: intentionally longer 80 columns -->
683 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
684 <dl>
685 </dl>
686 </div>
687 </div>
688 <!-- MIN_VERSION -->
689 </div> <!-- /description -->
690 </div> <!-- /apiItem -->
691 </div> <!-- /apiGroup -->
692 <!-- EVENTS -->
693 <!-- /apiGroup -->
694 <!-- TYPES -->
695 <div class="apiGroup">
696 <a name="types"></a>
697 <h3 id="types">Types</h3>
698 <!-- iterates over all types -->
699 <div class="apiItem">
700 <a name="type-FontName"></a>
701 <h4>FontName</h4>
702 <div>
703 <dt>
704 <em>
705 <!-- TYPE -->
706 <div style="display:inline">
707 (
708 <span id="typeTemplate">
709 <span>
710 <span>object</span>
711 </span>
712 </span>
713 )
714 </div>
715 </em>
716 </dt>
717 <dd>Represents a font name.</dd>
718 <!-- OBJECT PROPERTIES -->
719 <dd>
720 <dl>
721 <div>
722 <div>
723 <dt>
724 <var>fontName</var>
725 <em>
726 <!-- TYPE -->
727 <div style="display:inline">
728 (
729 <span id="typeTemplate">
730 <span>
731 <span>string</span>
732 </span>
733 </span>
734 )
735 </div>
736 </em>
737 </dt>
738 <dd>The font name.</dd>
739 <!-- OBJECT PROPERTIES -->
740 <!-- OBJECT METHODS -->
741 <!-- OBJECT EVENT FIELDS -->
742 <!-- FUNCTION PARAMETERS -->
743 </div>
744 </div><div>
745 <div>
746 <dt>
747 <var>localizedName</var>
748 <em>
749 <!-- TYPE -->
750 <div style="display:inline">
751 (
752 <span id="typeTemplate">
753 <span>
754 <span>string</span>
755 </span>
756 </span>
757 )
758 </div>
759 </em>
760 </dt>
761 <dd>The font name localized for the current locale.</dd>
762 <!-- OBJECT PROPERTIES -->
763 <!-- OBJECT METHODS -->
764 <!-- OBJECT EVENT FIELDS -->
765 <!-- FUNCTION PARAMETERS -->
766 </div>
767 </div>
768 </dl>
769 </dd>
770 <!-- OBJECT METHODS -->
771 <!-- OBJECT EVENT FIELDS -->
772 <!-- FUNCTION PARAMETERS -->
773 </div>
774 </div> <!-- /apiItem -->
775 </div> <!-- /apiGroup -->
776 </div> <!-- /apiPage -->
197 </div> <!-- /gc-pagecontent --> 777 </div> <!-- /gc-pagecontent -->
198 </div> <!-- /g-section --> 778 </div> <!-- /g-section -->
199 </div> <!-- /codesiteContent --> 779 </div> <!-- /codesiteContent -->
200 <div id="gc-footer" --=""> 780 <div id="gc-footer" --="">
201 <div class="text"> 781 <div class="text">
202 <p> 782 <p>
203 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 783 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
204 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons 784 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
205 Attribution 3.0 License</a>, and code samples are licensed under the 785 Attribution 3.0 License</a>, and code samples are licensed under the
206 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>. 786 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
(...skipping 17 matching lines...) Expand all
224 _uff=0; 804 _uff=0;
225 urchinTracker(); 805 urchinTracker();
226 } 806 }
227 catch(e) {/* urchinTracker not available. */} 807 catch(e) {/* urchinTracker not available. */}
228 </script> 808 </script>
229 <!-- end analytics --> 809 <!-- end analytics -->
230 </div> 810 </div>
231 </div> <!-- /gc-footer --> 811 </div> <!-- /gc-footer -->
232 </div> <!-- /gc-container --> 812 </div> <!-- /gc-container -->
233 </body></html> 813 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698