Update browserAction.setIcon and pageAction.setIcon for hidpi

chrome/common/extensions/api/browser_action.json

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 [
   {
     "namespace": "browserAction",
     "dependencies": [ "tabs" ],
     "types": [
       {
         "id": "ColorArray",
         "type": "array",
         "items": {
           "type": "integer",
           "minimum": 0,
           "maximum": 255
         },
         "minItems": 4,
         "maxItems": 4
+      },
+      {
+        "id": "ImageDataType",
+        "type": "object",
+        "isInstanceOf": "ImageData",
+        "additionalProperties": { "type": "any" },
+        "description": "Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element)."

[Jeffrey Yasskin, 2012/08/21 20:10:38]

Ok, we should document that here. Would you like to do that in this CL, or
should I try it in a subsequent one?

[tbarzic, 2012/08/22 00:12:49]

ok, I'll add something tomorrow.

[tbarzic, 2012/08/22 18:43:16]

On second thought, I'm not too sure this is the best place to document that we
don't support canvas.getImageDataHD.
We shouldn't really care how we get the ImageData object..

       }
     ],
     "functions": [
       {
         "name": "setTitle",
         "type": "function",
         "description": "Sets the title of the browser action. This shows up in the tooltip.",
         "parameters": [
           {
             "name": "details",
@@ skipping 36 matching lines @@
                 "name": "result",
                 "type": "string"
               }
             ]
           }
         ]
       },
       {
         "name": "setIcon",
         "type": "function",
-        "description": "Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
+        "description": "Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element, or as dictionary of either one of those. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
         "parameters": [
           {
             "name": "details",
             "type": "object",
             "properties": {
               "imageData": {
-                "type": "object",
-                "isInstanceOf": "ImageData",
-                "additionalProperties": { "type": "any" },
-                "description": "Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).",
+                "choices": [
+                  { "$ref": "ImageDataType" },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "19": {"$ref": "ImageDataType", "optional": true},
+                      "38": {"$ref": "ImageDataType", "optional": true}
+                     }
+                  }
+                ],
+                "description": "Either ImageData object or dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image should be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}'",

[Jeffrey Yasskin, 2012/08/21 20:10:38]

Great comment!

Nits: It would be nice to call out 'scale' as a variable. I think these sections
support html, so surrounding it with <code> or <code><var> should work.

"Either an ImageData object or a dictionary {size -> ImageData}"

s/If number/If the number/

s/should/must/?

[tbarzic, 2012/08/22 00:12:49]

Done.

                 "optional": true
               },
               "path": {
-                "type": "string",
-                "description": "Relative path to an image in the extension to show in the browser action.",
+                "choices": [
+                  { "type": "string" },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "19": {"type": "string", "optional": true},
+                      "38": {"type": "string", "optional": true}
+                    }
+                  }
+                ],
+                "description": "Either relative image path or dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image should be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'",

[Jeffrey Yasskin, 2012/08/21 20:10:38]

Same nits as above.

[tbarzic, 2012/08/22 00:12:49]

Done.

                 "optional": true
               },
               "tabId": {
                 "type": "integer",
                 "optional": true,
                 "description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
               }
             }
           },
           {
@@ skipping 195 matching lines @@
         "parameters": [
           {
             "name": "tab",
             "$ref": "tabs.Tab"
           }
         ]
       }
     ]
   }
 ]