OLD | NEW |
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> |
(...skipping 197 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
208 <a href="#apiReference">API reference: chrome.experimental.fontS
ettings</a> | 208 <a href="#apiReference">API reference: chrome.experimental.fontS
ettings</a> |
209 <ol> | 209 <ol> |
210 <li> | 210 <li> |
211 <a href="#global-methods">Methods</a> | 211 <a href="#global-methods">Methods</a> |
212 <ol> | 212 <ol> |
213 <li> | 213 <li> |
214 <a href="#method-getDefaultFixedFontSize">getDefaultFixedFontSiz
e</a> | 214 <a href="#method-getDefaultFixedFontSize">getDefaultFixedFontSiz
e</a> |
215 </li><li> | 215 </li><li> |
216 <a href="#method-getDefaultFontSize">getDefaultFontSize</a> | 216 <a href="#method-getDefaultFontSize">getDefaultFontSize</a> |
217 </li><li> | 217 </li><li> |
| 218 <a href="#method-getFont">getFont</a> |
| 219 </li><li> |
218 <a href="#method-getFontList">getFontList</a> | 220 <a href="#method-getFontList">getFontList</a> |
219 </li><li> | 221 </li><li> |
220 <a href="#method-getFontName">getFontName</a> | |
221 </li><li> | |
222 <a href="#method-getMinimumFontSize">getMinimumFontSize</a> | 222 <a href="#method-getMinimumFontSize">getMinimumFontSize</a> |
223 </li><li> | 223 </li><li> |
224 <a href="#method-setDefaultFixedFontSize">setDefaultFixedFontSiz
e</a> | 224 <a href="#method-setDefaultFixedFontSize">setDefaultFixedFontSiz
e</a> |
225 </li><li> | 225 </li><li> |
226 <a href="#method-setDefaultFontSize">setDefaultFontSize</a> | 226 <a href="#method-setDefaultFontSize">setDefaultFontSize</a> |
227 </li><li> | 227 </li><li> |
228 <a href="#method-setFontName">setFontName</a> | 228 <a href="#method-setFont">setFont</a> |
229 </li><li> | 229 </li><li> |
230 <a href="#method-setMinimumFontSize">setMinimumFontSize</a> | 230 <a href="#method-setMinimumFontSize">setMinimumFontSize</a> |
231 </li> | 231 </li> |
232 </ol> | 232 </ol> |
233 </li> | 233 </li> |
234 <li> | 234 <li> |
235 <a href="#global-events">Events</a> | 235 <a href="#global-events">Events</a> |
236 <ol> | 236 <ol> |
237 <li> | 237 <li> |
238 <a href="#event-onFontNameChanged">onFontNameChanged</a> | 238 <a href="#event-onFontChanged">onFontChanged</a> |
239 </li> | 239 </li> |
240 </ol> | 240 </ol> |
241 </li> | 241 </li> |
242 <li> | 242 <li> |
243 <a href="#types">Types</a> | 243 <a href="#types">Types</a> |
244 <ol> | 244 <ol> |
245 <li> | 245 <li> |
246 <a href="#type-FontName">FontName</a> | 246 <a href="#type-FontName">FontName</a> |
247 <ol> | 247 <ol> |
248 </ol> | 248 </ol> |
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
295 in the API reference below. Technically, Chrome settings are not strictly | 295 in the API reference below. Technically, Chrome settings are not strictly |
296 per-script but also depend on language. For example, Chrome chooses the font for | 296 per-script but also depend on language. For example, Chrome chooses the font for |
297 Hangul (ISO 15924 script code "Hang") when a webpage specifies Korean language, | 297 Hangul (ISO 15924 script code "Hang") when a webpage specifies Korean language, |
298 and uses this font not just for Hangul script but for everything the font | 298 and uses this font not just for Hangul script but for everything the font |
299 covers, such as Hanja.</p> | 299 covers, such as Hanja.</p> |
300 <p>Although ISO 15924 provides script codes like "Japn" for Japanese and "Kore" | 300 <p>Although ISO 15924 provides script codes like "Japn" for Japanese and "Kore" |
301 for Korean, these codes are newer than "Hrkt" and "Hang" which Chrome continues | 301 for Korean, these codes are newer than "Hrkt" and "Hang" which Chrome continues |
302 to use for compatibility purposes.</p> | 302 to use for compatibility purposes.</p> |
303 <h2 id="examples">Examples</h2> | 303 <h2 id="examples">Examples</h2> |
304 <p>The following code gets the standard font for Arabic.</p> | 304 <p>The following code gets the standard font for Arabic.</p> |
305 <pre>chrome.experimental.fontSettings.getFontName( | 305 <pre>chrome.experimental.fontSettings.getFont( |
306 { genericFamily: 'standard', script: 'Arab' }, | 306 { genericFamily: 'standard', script: 'Arab' }, |
307 function(details) { console.log(details.fontName); } | 307 function(details) { console.log(details.fontName); } |
308 ); | 308 ); |
309 </pre> | 309 </pre> |
310 <p>The next snippet sets the sans-serif font for Japanese.</p> | 310 <p>The next snippet sets the sans-serif font for Japanese.</p> |
311 <pre>chrome.experimental.fontSettings.setFontName( | 311 <pre>chrome.experimental.fontSettings.setFont( |
312 { genericFamily: 'sansserif', script: 'Hrkt', fontName: 'IPAPGothic' } | 312 { genericFamily: 'sansserif', script: 'Hrkt', fontName: 'IPAPGothic' } |
313 ); | 313 ); |
314 </pre> | 314 </pre> |
315 <p>You can find a sample extension using the Font Settings API in the | 315 <p>You can find a sample extension using the Font Settings API in the |
316 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension
s/docs/examples/api/fontSettings/">examples/api/fontSettings</a> | 316 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension
s/docs/examples/api/fontSettings/">examples/api/fontSettings</a> |
317 directory. For other examples and for help in viewing the source code, see | 317 directory. For other examples and for help in viewing the source code, see |
318 <a href="samples.html">Samples</a>.</p> | 318 <a href="samples.html">Samples</a>.</p> |
319 <!-- END AUTHORED CONTENT --> | 319 <!-- END AUTHORED CONTENT --> |
320 </div> | 320 </div> |
321 <!-- API PAGE --> | 321 <!-- API PAGE --> |
(...skipping 277 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
599 <!-- OBJECT EVENT FIELDS --> | 599 <!-- OBJECT EVENT FIELDS --> |
600 <!-- FUNCTION PARAMETERS --> | 600 <!-- FUNCTION PARAMETERS --> |
601 </div> | 601 </div> |
602 </div> | 602 </div> |
603 </dl> | 603 </dl> |
604 </div> | 604 </div> |
605 </div> | 605 </div> |
606 <!-- MIN_VERSION --> | 606 <!-- MIN_VERSION --> |
607 </div> <!-- /description --> | 607 </div> <!-- /description --> |
608 </div><div class="apiItem"> | 608 </div><div class="apiItem"> |
609 <a name="method-getFontList"></a> <!-- method-anchor --> | 609 <a name="method-getFont"></a> <!-- method-anchor --> |
610 <h4>getFontList</h4> | 610 <h4>getFont</h4> |
611 <div class="summary"> | 611 <div class="summary"> |
612 <!-- Note: intentionally longer 80 columns --> | 612 <!-- Note: intentionally longer 80 columns --> |
613 <span>chrome.experimental.fontSettings.getFontList</span>(<spa
n class="null"><span>function</span> | 613 <span>chrome.experimental.fontSettings.getFont</span>(<span cl
ass="null"><span>object</span> |
| 614 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
614 <var><span>callback</span></var></span>)</div> | 615 <var><span>callback</span></var></span>)</div> |
615 <div class="description"> | 616 <div class="description"> |
616 <p>Gets a list of fonts on the system.</p> | 617 <p>Gets the current font setting for a given script and generic
font family.</p> |
617 <!-- PARAMETERS --> | 618 <!-- PARAMETERS --> |
618 <h4>Parameters</h4> | 619 <h4>Parameters</h4> |
619 <dl> | 620 <dl> |
620 <div> | |
621 <div> | |
622 <dt> | |
623 <var>callback</var> | |
624 <em> | |
625 <!-- TYPE --> | |
626 <div style="display:inline"> | |
627 ( | |
628 <span id="typeTemplate"> | |
629 <span> | |
630 <span>function</span> | |
631 </span> | |
632 </span> | |
633 ) | |
634 </div> | |
635 </em> | |
636 </dt> | |
637 <dd class="todo"> | |
638 Undocumented. | |
639 </dd> | |
640 <!-- OBJECT PROPERTIES --> | |
641 <!-- OBJECT METHODS --> | |
642 <!-- OBJECT EVENT FIELDS --> | |
643 <!-- FUNCTION PARAMETERS --> | |
644 </div> | |
645 </div> | |
646 </dl> | |
647 <!-- RETURNS --> | |
648 <dl> | |
649 </dl> | |
650 <!-- CALLBACK --> | |
651 <div> | |
652 <div> | |
653 <h4>Callback function</h4> | |
654 <p> | |
655 The callback <em>parameter</em> should specify a function | |
656 that looks like this: | |
657 </p> | |
658 <!-- Note: intentionally longer 80 columns --> | |
659 <pre>function(<span>array of FontName results</span>) <span cl
ass="subdued">{...}</span>;</pre> | |
660 <dl> | |
661 <div> | |
662 <div> | |
663 <dt> | |
664 <var>results</var> | |
665 <em> | |
666 <!-- TYPE --> | |
667 <div style="display:inline"> | |
668 ( | |
669 <span id="typeTemplate"> | |
670 <span> | |
671 <span> | |
672 array of <span><span> | |
673 <span> | |
674 <a href="experimental.fontSettings.html#type-FontName">F
ontName</a> | |
675 </span> | |
676 </span></span> | |
677 </span> | |
678 </span> | |
679 </span> | |
680 ) | |
681 </div> | |
682 </em> | |
683 </dt> | |
684 <dd class="todo"> | |
685 Undocumented. | |
686 </dd> | |
687 <!-- OBJECT PROPERTIES --> | |
688 <!-- OBJECT METHODS --> | |
689 <!-- OBJECT EVENT FIELDS --> | |
690 <!-- FUNCTION PARAMETERS --> | |
691 </div> | |
692 </div> | |
693 </dl> | |
694 </div> | |
695 </div> | |
696 <!-- MIN_VERSION --> | |
697 </div> <!-- /description --> | |
698 </div><div class="apiItem"> | |
699 <a name="method-getFontName"></a> <!-- method-anchor --> | |
700 <h4>getFontName</h4> | |
701 <div class="summary"> | |
702 <!-- Note: intentionally longer 80 columns --> | |
703 <span>chrome.experimental.fontSettings.getFontName</span>(<spa
n class="null"><span>object</span> | |
704 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | |
705 <var><span>callback</span></var></span>)</div> | |
706 <div class="description"> | |
707 <p>Gets the font name of the current setting for a given script
and generic font family.</p> | |
708 <!-- PARAMETERS --> | |
709 <h4>Parameters</h4> | |
710 <dl> | |
711 <div> | 621 <div> |
712 <div> | 622 <div> |
713 <dt> | 623 <dt> |
714 <var>details</var> | 624 <var>details</var> |
715 <em> | 625 <em> |
716 <!-- TYPE --> | 626 <!-- TYPE --> |
717 <div style="display:inline"> | 627 <div style="display:inline"> |
718 ( | 628 ( |
719 <span id="typeTemplate"> | 629 <span id="typeTemplate"> |
720 <span> | 630 <span> |
(...skipping 159 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
880 <!-- OBJECT EVENT FIELDS --> | 790 <!-- OBJECT EVENT FIELDS --> |
881 <!-- FUNCTION PARAMETERS --> | 791 <!-- FUNCTION PARAMETERS --> |
882 </div> | 792 </div> |
883 </div> | 793 </div> |
884 </dl> | 794 </dl> |
885 </div> | 795 </div> |
886 </div> | 796 </div> |
887 <!-- MIN_VERSION --> | 797 <!-- MIN_VERSION --> |
888 </div> <!-- /description --> | 798 </div> <!-- /description --> |
889 </div><div class="apiItem"> | 799 </div><div class="apiItem"> |
| 800 <a name="method-getFontList"></a> <!-- method-anchor --> |
| 801 <h4>getFontList</h4> |
| 802 <div class="summary"> |
| 803 <!-- Note: intentionally longer 80 columns --> |
| 804 <span>chrome.experimental.fontSettings.getFontList</span>(<spa
n class="null"><span>function</span> |
| 805 <var><span>callback</span></var></span>)</div> |
| 806 <div class="description"> |
| 807 <p>Gets a list of fonts on the system.</p> |
| 808 <!-- PARAMETERS --> |
| 809 <h4>Parameters</h4> |
| 810 <dl> |
| 811 <div> |
| 812 <div> |
| 813 <dt> |
| 814 <var>callback</var> |
| 815 <em> |
| 816 <!-- TYPE --> |
| 817 <div style="display:inline"> |
| 818 ( |
| 819 <span id="typeTemplate"> |
| 820 <span> |
| 821 <span>function</span> |
| 822 </span> |
| 823 </span> |
| 824 ) |
| 825 </div> |
| 826 </em> |
| 827 </dt> |
| 828 <dd class="todo"> |
| 829 Undocumented. |
| 830 </dd> |
| 831 <!-- OBJECT PROPERTIES --> |
| 832 <!-- OBJECT METHODS --> |
| 833 <!-- OBJECT EVENT FIELDS --> |
| 834 <!-- FUNCTION PARAMETERS --> |
| 835 </div> |
| 836 </div> |
| 837 </dl> |
| 838 <!-- RETURNS --> |
| 839 <dl> |
| 840 </dl> |
| 841 <!-- CALLBACK --> |
| 842 <div> |
| 843 <div> |
| 844 <h4>Callback function</h4> |
| 845 <p> |
| 846 The callback <em>parameter</em> should specify a function |
| 847 that looks like this: |
| 848 </p> |
| 849 <!-- Note: intentionally longer 80 columns --> |
| 850 <pre>function(<span>array of FontName results</span>) <span cl
ass="subdued">{...}</span>;</pre> |
| 851 <dl> |
| 852 <div> |
| 853 <div> |
| 854 <dt> |
| 855 <var>results</var> |
| 856 <em> |
| 857 <!-- TYPE --> |
| 858 <div style="display:inline"> |
| 859 ( |
| 860 <span id="typeTemplate"> |
| 861 <span> |
| 862 <span> |
| 863 array of <span><span> |
| 864 <span> |
| 865 <a href="experimental.fontSettings.html#type-FontName">F
ontName</a> |
| 866 </span> |
| 867 </span></span> |
| 868 </span> |
| 869 </span> |
| 870 </span> |
| 871 ) |
| 872 </div> |
| 873 </em> |
| 874 </dt> |
| 875 <dd class="todo"> |
| 876 Undocumented. |
| 877 </dd> |
| 878 <!-- OBJECT PROPERTIES --> |
| 879 <!-- OBJECT METHODS --> |
| 880 <!-- OBJECT EVENT FIELDS --> |
| 881 <!-- FUNCTION PARAMETERS --> |
| 882 </div> |
| 883 </div> |
| 884 </dl> |
| 885 </div> |
| 886 </div> |
| 887 <!-- MIN_VERSION --> |
| 888 </div> <!-- /description --> |
| 889 </div><div class="apiItem"> |
890 <a name="method-getMinimumFontSize"></a> <!-- method-anchor --> | 890 <a name="method-getMinimumFontSize"></a> <!-- method-anchor --> |
891 <h4>getMinimumFontSize</h4> | 891 <h4>getMinimumFontSize</h4> |
892 <div class="summary"> | 892 <div class="summary"> |
893 <!-- Note: intentionally longer 80 columns --> | 893 <!-- Note: intentionally longer 80 columns --> |
894 <span>chrome.experimental.fontSettings.getMinimumFontSize</spa
n>(<span class="optional"><span>object</span> | 894 <span>chrome.experimental.fontSettings.getMinimumFontSize</spa
n>(<span class="optional"><span>object</span> |
895 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | 895 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
896 <var><span>callback</span></var></span>)</div> | 896 <var><span>callback</span></var></span>)</div> |
897 <div class="description"> | 897 <div class="description"> |
898 <p>Gets the minimum font size.</p> | 898 <p>Gets the minimum font size.</p> |
899 <!-- PARAMETERS --> | 899 <!-- PARAMETERS --> |
(...skipping 344 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1244 </p> | 1244 </p> |
1245 <!-- Note: intentionally longer 80 columns --> | 1245 <!-- Note: intentionally longer 80 columns --> |
1246 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> | 1246 <pre>function(<span></span>) <span class="subdued">{...}</span
>;</pre> |
1247 <dl> | 1247 <dl> |
1248 </dl> | 1248 </dl> |
1249 </div> | 1249 </div> |
1250 </div> | 1250 </div> |
1251 <!-- MIN_VERSION --> | 1251 <!-- MIN_VERSION --> |
1252 </div> <!-- /description --> | 1252 </div> <!-- /description --> |
1253 </div><div class="apiItem"> | 1253 </div><div class="apiItem"> |
1254 <a name="method-setFontName"></a> <!-- method-anchor --> | 1254 <a name="method-setFont"></a> <!-- method-anchor --> |
1255 <h4>setFontName</h4> | 1255 <h4>setFont</h4> |
1256 <div class="summary"> | 1256 <div class="summary"> |
1257 <!-- Note: intentionally longer 80 columns --> | 1257 <!-- Note: intentionally longer 80 columns --> |
1258 <span>chrome.experimental.fontSettings.setFontName</span>(<spa
n class="null"><span>object</span> | 1258 <span>chrome.experimental.fontSettings.setFont</span>(<span cl
ass="null"><span>object</span> |
1259 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | 1259 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
1260 <var><span>callback</span></var></span>)</div> | 1260 <var><span>callback</span></var></span>)</div> |
1261 <div class="description"> | 1261 <div class="description"> |
1262 <p>Sets the font name of the current setting for a given script
and generic font family.</p> | 1262 <p>Sets the font setting for a given script and generic font fam
ily.</p> |
1263 <!-- PARAMETERS --> | 1263 <!-- PARAMETERS --> |
1264 <h4>Parameters</h4> | 1264 <h4>Parameters</h4> |
1265 <dl> | 1265 <dl> |
1266 <div> | 1266 <div> |
1267 <div> | 1267 <div> |
1268 <dt> | 1268 <dt> |
1269 <var>details</var> | 1269 <var>details</var> |
1270 <em> | 1270 <em> |
1271 <!-- TYPE --> | 1271 <!-- TYPE --> |
1272 <div style="display:inline"> | 1272 <div style="display:inline"> |
(...skipping 251 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1524 <!-- MIN_VERSION --> | 1524 <!-- MIN_VERSION --> |
1525 </div> <!-- /description --> | 1525 </div> <!-- /description --> |
1526 </div> <!-- /apiItem --> | 1526 </div> <!-- /apiItem --> |
1527 </div> <!-- /apiGroup --> | 1527 </div> <!-- /apiGroup --> |
1528 <!-- EVENTS --> | 1528 <!-- EVENTS --> |
1529 <div id="eventsTemplate" class="apiGroup"> | 1529 <div id="eventsTemplate" class="apiGroup"> |
1530 <a name="global-events"></a> | 1530 <a name="global-events"></a> |
1531 <h3>Events</h3> | 1531 <h3>Events</h3> |
1532 <!-- iterates over all events --> | 1532 <!-- iterates over all events --> |
1533 <div class="apiItem"> | 1533 <div class="apiItem"> |
1534 <a name="event-onFontNameChanged"></a> | 1534 <a name="event-onFontChanged"></a> |
1535 <h4>onFontNameChanged</h4> | 1535 <h4>onFontChanged</h4> |
1536 <div class="summary"> | 1536 <div class="summary"> |
1537 <!-- Note: intentionally longer 80 columns --> | 1537 <!-- Note: intentionally longer 80 columns --> |
1538 <span class="subdued">chrome.experimental.fontSettings.</span><s
pan>onFontNameChanged</span><span class="subdued">.addListener</span>(function(<
span>object details</span>) <span class="subdued">{...}</span><span></span>); | 1538 <span class="subdued">chrome.experimental.fontSettings.</span><s
pan>onFontChanged</span><span class="subdued">.addListener</span>(function(<span
>object details</span>) <span class="subdued">{...}</span><span></span>); |
1539 </div> | 1539 </div> |
1540 <div class="description"> | 1540 <div class="description"> |
1541 <p>Fired when a font name preference changes.</p> | 1541 <p>Fired when a font setting changes.</p> |
1542 <!-- LISTENER PARAMETERS --> | 1542 <!-- LISTENER PARAMETERS --> |
1543 <div> | 1543 <div> |
1544 <h4>Listener parameters</h4> | 1544 <h4>Listener parameters</h4> |
1545 <dl> | 1545 <dl> |
1546 <div> | 1546 <div> |
1547 <div> | 1547 <div> |
1548 <dt> | 1548 <dt> |
1549 <var>details</var> | 1549 <var>details</var> |
1550 <em> | 1550 <em> |
1551 <!-- TYPE --> | 1551 <!-- TYPE --> |
(...skipping 293 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1845 _uff=0; | 1845 _uff=0; |
1846 urchinTracker(); | 1846 urchinTracker(); |
1847 } | 1847 } |
1848 catch(e) {/* urchinTracker not available. */} | 1848 catch(e) {/* urchinTracker not available. */} |
1849 </script> | 1849 </script> |
1850 <!-- end analytics --> | 1850 <!-- end analytics --> |
1851 </div> | 1851 </div> |
1852 </div> <!-- /gc-footer --> | 1852 </div> <!-- /gc-footer --> |
1853 </div> <!-- /gc-container --> | 1853 </div> <!-- /gc-container --> |
1854 </body></html> | 1854 </body></html> |
OLD | NEW |