diff options
author | falken@google.com <falken@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-03-15 06:09:17 +0000 |
---|---|---|
committer | falken@google.com <falken@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-03-15 06:09:17 +0000 |
commit | eaeeda8e2ddde17ba2e7698b5a72cc101f2a7e28 (patch) | |
tree | f9d2695ed42332dc4c1bbdd39839b723cf933345 | |
parent | 2b06b74c7da002be672a05d66e31ecd5219dfc9c (diff) | |
download | chromium_src-eaeeda8e2ddde17ba2e7698b5a72cc101f2a7e28.zip chromium_src-eaeeda8e2ddde17ba2e7698b5a72cc101f2a7e28.tar.gz chromium_src-eaeeda8e2ddde17ba2e7698b5a72cc101f2a7e28.tar.bz2 |
Generate documentation for experimental Font Settings Extension API.
It seems it needed to be added to api_page_generator.js. Also, renamed
experimental.fonts.json to experimental.fontSettings.json for consistency.
BUG=114148
TEST=none
Review URL: https://chromiumcodereview.appspot.com/9689054
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@126853 0039d316-1c4b-4281-b951-d872f2087c98
-rw-r--r-- | chrome/common/common_resources.grd | 2 | ||||
-rw-r--r-- | chrome/common/extensions/api/experimental.fontSettings.json (renamed from chrome/common/extensions/api/experimental.fonts.json) | 4 | ||||
-rw-r--r-- | chrome/common/extensions/docs/examples/api/fontSettings.zip | bin | 0 -> 21553 bytes | |||
-rw-r--r-- | chrome/common/extensions/docs/examples/api/fontSettings/fonts128.png | bin | 0 -> 3099 bytes | |||
-rw-r--r-- | chrome/common/extensions/docs/examples/api/fontSettings/fonts16.png | bin | 0 -> 485 bytes | |||
-rw-r--r-- | chrome/common/extensions/docs/experimental.fontSettings.html | 586 | ||||
-rw-r--r-- | chrome/common/extensions/docs/experimental.html | 1 | ||||
-rw-r--r-- | chrome/common/extensions/docs/js/api_page_generator.js | 1 | ||||
-rw-r--r-- | chrome/common/pref_names.cc | 2 |
9 files changed, 589 insertions, 7 deletions
diff --git a/chrome/common/common_resources.grd b/chrome/common/common_resources.grd index 49c1665..6bcd0b2 100644 --- a/chrome/common/common_resources.grd +++ b/chrome/common/common_resources.grd @@ -28,7 +28,7 @@ <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_DNS" file="extensions\api\experimental.dns.json" type="BINDATA" /> <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_DOWNLOADS" file="extensions\api\experimental.downloads.json" type="BINDATA" /> <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_EXTENSIONS" file="extensions\api\experimental.extension.json" type="BINDATA" /> - <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_FONTS" file="extensions\api\experimental.fonts.json" type="BINDATA" /> + <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_FONTS" file="extensions\api\experimental.fontSettings.json" type="BINDATA" /> <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_INFOBARS" file="extensions\api\experimental.infobars.json" type="BINDATA" /> <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_INPUT_UI" file="extensions\api\experimental.input.ui.json" type="BINDATA" /> <include name="IDR_EXTENSION_API_JSON_EXPERIMENTAL_INPUT_VIRTUALKEYBOARD" file="extensions\api\experimental.input.virtualKeyboard.json" type="BINDATA" /> diff --git a/chrome/common/extensions/api/experimental.fonts.json b/chrome/common/extensions/api/experimental.fontSettings.json index 98ce2eb..3ca1085 100644 --- a/chrome/common/extensions/api/experimental.fonts.json +++ b/chrome/common/extensions/api/experimental.fontSettings.json @@ -76,13 +76,13 @@ "script": { "type": "string", "enum": ["Arab", "Hang", "Hans", "Hant", "Hrkt"], - "description": "The ISO 15924 script code for which the font setting should be retrieved. If omitted, the global script font setting is retrieved.", + "description": "The ISO 15924 script code for which the font setting should be set. If omitted, the global script font setting is set.", "optional": true }, "genericFamily": { "type": "string", "enum": ["standard", "sansserif", "serif", "fixed", "cursive", "fantasy"], - "description": "The CSS generic font family for which the font setting should be retrieved." + "description": "The CSS generic font family for which the font setting should be set." }, "fontName": { "type": "string", diff --git a/chrome/common/extensions/docs/examples/api/fontSettings.zip b/chrome/common/extensions/docs/examples/api/fontSettings.zip Binary files differindex e69de29..96fef84 100644 --- a/chrome/common/extensions/docs/examples/api/fontSettings.zip +++ b/chrome/common/extensions/docs/examples/api/fontSettings.zip diff --git a/chrome/common/extensions/docs/examples/api/fontSettings/fonts128.png b/chrome/common/extensions/docs/examples/api/fontSettings/fonts128.png Binary files differindex e69de29..32a435a 100644 --- a/chrome/common/extensions/docs/examples/api/fontSettings/fonts128.png +++ b/chrome/common/extensions/docs/examples/api/fontSettings/fonts128.png diff --git a/chrome/common/extensions/docs/examples/api/fontSettings/fonts16.png b/chrome/common/extensions/docs/examples/api/fontSettings/fonts16.png Binary files differindex e69de29..990f26b 100644 --- a/chrome/common/extensions/docs/examples/api/fontSettings/fonts16.png +++ b/chrome/common/extensions/docs/examples/api/fontSettings/fonts16.png diff --git a/chrome/common/extensions/docs/experimental.fontSettings.html b/chrome/common/extensions/docs/experimental.fontSettings.html index 2d8e81d..8792f47 100644 --- a/chrome/common/extensions/docs/experimental.fontSettings.html +++ b/chrome/common/extensions/docs/experimental.fontSettings.html @@ -18,7 +18,7 @@ <script type="text/javascript" src="js/api_page_generator.js"></script> <script type="text/javascript" src="js/bootstrap.js"></script> <script type="text/javascript" src="js/sidebar.js"></script> - <title>Experimental.font Settings - Google Chrome Extensions - Google Code</title></head> + <meta name="description" content="Documentation for the chrome.experimental.fontSettings module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.fontSettings - Google Chrome Extensions - Google Code</title></head> <body> <div id="devModeWarning" class="displayModeWarning"> You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. </div> @@ -185,15 +185,595 @@ </script> <div class="g-unit" id="gc-pagecontent"> <div id="pageTitle"> - <h1 class="page_title">Experimental.font Settings</h1> + <h1 class="page_title">chrome.experimental.fontSettings</h1> </div> <!-- TABLE OF CONTENTS --> + <div id="toc"> + <h2>Contents</h2> + <ol> + <li> + <a href="#apiReference">API reference: chrome.experimental.fontSettings</a> + <ol> + <li> + <a href="#global-methods">Methods</a> + <ol> + <li> + <a href="#method-getFontList">getFontList</a> + </li><li> + <a href="#method-getFontName">getFontName</a> + </li><li> + <a href="#method-setFontName">setFontName</a> + </li> + </ol> + </li> + <li> + <a href="#types">Types</a> + <ol> + <li> + <a href="#type-FontName">FontName</a> + <ol> + </ol> + </li> + </ol> + </li> + </ol> + </li> + </ol> + </div> <!-- /TABLE OF CONTENTS --> <!-- Standard content lead-in for experimental API pages --> + <p id="classSummary"> + For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. + </p> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static"></div> <!-- API PAGE --> - <!-- /apiPage --> + <div class="apiPage"> + <a name="apiReference"></a> + <h2>API reference: chrome.experimental.fontSettings</h2> + <!-- PROPERTIES --> + <!-- /apiGroup --> + <!-- METHODS --> + <div id="methodsTemplate" class="apiGroup"> + <a name="global-methods"></a> + <h3>Methods</h3> + <!-- iterates over all functions --> + <div class="apiItem"> + <a name="method-getFontList"></a> <!-- method-anchor --> + <h4>getFontList</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.fontSettings.getFontList</span>(<span class="null"><span>function</span> + <var><span>callback</span></var></span>)</div> + <div class="description"> + <p>Gets a list of fonts on the system.</p> + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>callback</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>function</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + <!-- RETURNS --> + <dl> + </dl> + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + The callback <em>parameter</em> should specify a function + that looks like this: + </p> + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>array of FontName results</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div> + <div> + <dt> + <var>results</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span> + array of <span><span> + <span> + <a href="experimental.fontSettings.html#type-FontName">FontName</a> + </span> + </span></span> + </span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </div> + </div> + <!-- MIN_VERSION --> + </div> <!-- /description --> + </div><div class="apiItem"> + <a name="method-getFontName"></a> <!-- method-anchor --> + <h4>getFontName</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.fontSettings.getFontName</span>(<span class="null"><span>object</span> + <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + <div class="description"> + <p>Gets the font name of the current setting for a given script and generic font family.</p> + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>details</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>object</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>script</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <span>string</span> + <span>["Arab", "Hang", "Hans", "Hant", "Hrkt"]</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The ISO 15924 script code for which the font setting should be retrieved. If omitted, the global script font setting is retrieved.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>genericFamily</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <span>string</span> + <span>["standard", "sansserif", "serif", "fixed", "cursive", "fantasy"]</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The CSS generic font family for which the font setting should be retrieved.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </dd> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span> + <span>function</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + <!-- RETURNS --> + <dl> + </dl> + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + If you specify the <em>callback</em> parameter, it should + specify a function that looks like this: + </p> + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>object details</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div> + <div> + <dt> + <var>details</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>object</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>fontName</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>string</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The font name.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </dd> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </div> + </div> + <!-- MIN_VERSION --> + </div> <!-- /description --> + </div><div class="apiItem"> + <a name="method-setFontName"></a> <!-- method-anchor --> + <h4>setFontName</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.fontSettings.setFontName</span>(<span class="null"><span>object</span> + <var><span>details</span></var></span><span class="optional"><span>, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + <div class="description"> + <p>Sets the font name of the current setting for a given script and generic font family.</p> + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>details</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>object</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>script</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <span>string</span> + <span>["Arab", "Hang", "Hans", "Hant", "Hrkt"]</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The ISO 15924 script code for which the font setting should be set. If omitted, the global script font setting is set.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>genericFamily</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <span>string</span> + <span>["standard", "sansserif", "serif", "fixed", "cursive", "fantasy"]</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The CSS generic font family for which the font setting should be set.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>fontName</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>string</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The font name.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </dd> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>callback</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span> + <span>function</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + <!-- RETURNS --> + <dl> + </dl> + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + If you specify the <em>callback</em> parameter, it should + specify a function that looks like this: + </p> + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> + <dl> + </dl> + </div> + </div> + <!-- MIN_VERSION --> + </div> <!-- /description --> + </div> <!-- /apiItem --> + </div> <!-- /apiGroup --> + <!-- EVENTS --> + <!-- /apiGroup --> + <!-- TYPES --> + <div class="apiGroup"> + <a name="types"></a> + <h3 id="types">Types</h3> + <!-- iterates over all types --> + <div class="apiItem"> + <a name="type-FontName"></a> + <h4>FontName</h4> + <div> + <dt> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>object</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>Represents a font name.</dd> + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>fontName</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>string</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The font name.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div><div> + <div> + <dt> + <var>localizedName</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span id="typeTemplate"> + <span> + <span>string</span> + </span> + </span> + ) + </div> + </em> + </dt> + <dd>The font name localized for the current locale.</dd> + <!-- OBJECT PROPERTIES --> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> + </dl> + </dd> + <!-- OBJECT METHODS --> + <!-- OBJECT EVENT FIELDS --> + <!-- FUNCTION PARAMETERS --> + </div> + </div> <!-- /apiItem --> + </div> <!-- /apiGroup --> + </div> <!-- /apiPage --> </div> <!-- /gc-pagecontent --> </div> <!-- /g-section --> </div> <!-- /codesiteContent --> diff --git a/chrome/common/extensions/docs/experimental.html b/chrome/common/extensions/docs/experimental.html index 881f110..3713d1f 100644 --- a/chrome/common/extensions/docs/experimental.html +++ b/chrome/common/extensions/docs/experimental.html @@ -242,6 +242,7 @@ on the following experimental APIs: <a href="experimental.devtools.console.html">experimental.devtools.console</a></li><li> <a href="experimental.downloads.html">experimental.downloads</a></li><li> <a href="experimental.extension.html">experimental.extension</a></li><li> + <a href="experimental.fontSettings.html">experimental.fontSettings</a></li><li> <a href="experimental.infobars.html">experimental.infobars</a></li><li> <a href="experimental.keybinding.html">experimental.keybinding</a></li><li> <a href="experimental.managedMode.html">experimental.managedMode</a></li><li> diff --git a/chrome/common/extensions/docs/js/api_page_generator.js b/chrome/common/extensions/docs/js/api_page_generator.js index 6f93ae9..9d06222 100644 --- a/chrome/common/extensions/docs/js/api_page_generator.js +++ b/chrome/common/extensions/docs/js/api_page_generator.js @@ -37,6 +37,7 @@ var MODULE_SCHEMAS = [ '../api/experimental.dns.json', '../api/experimental.downloads.json', '../api/experimental.extension.json', + '../api/experimental.fontSettings.json', '../api/experimental.infobars.json', '../api/experimental.input.ui.json', '../api/experimental.input.virtualKeyboard.json', diff --git a/chrome/common/pref_names.cc b/chrome/common/pref_names.cc index c5668a8..211ddcd 100644 --- a/chrome/common/pref_names.cc +++ b/chrome/common/pref_names.cc @@ -140,7 +140,7 @@ const char kWebKitFantasyFontFamilyMap[] = "webkit.webprefs.fonts.fantasy"; // If these change, the corresponding enums in the extension API -// experimental.fonts.json must also change. +// experimental.fontSettings.json must also change. // TODO(falken): Add all the scripts we should support. const char* const kWebKitScriptsForFontFamilyMaps[] = { "Arab", "Hang", "Hans", "Hant", "Hrkt" }; |