API 参考
对象参考
此部分显示了 Google Gadgets API 中与脚本相关的不同对象，包括它们的属性、方法和相关事件。注意，许多对象继承了 basicElement 的属性、方法和事件。
同样，如果说一个方法返回了一个元素，这意味着在小工具的 XML 定义中定义了一个元素，它继承自 basicElement。
gadget.debug
列出了可用于开发和调试小工具的 API。要以调试模式运行，请解压缩您的小工具，并双击所获得的文件中的 gadget.gmanifest 文件。 |
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
error(string Message)
|
当小工具以调试模式运行时，在调试控制台中作为错误消息显示字符串消息。
|
void
|
|
trace(string Message)
|
当小工具以调试模式运行时，在调试控制台中显示字符串消息。
|
void
|
|
warning(string Message)
|
当小工具以调试模式运行时，在调试控制台中作为警告显示字符串消息。
|
void
|
gadget.storage
提供对小工具包内容的访问权。 |
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
extract(string filename)
|
将文件从小工具包解压到临时文件夹，并返回该解压文件的完整路径。
|
字符串
|
|
openStream(string filename)
|
通过小工具包打开一个文件，并作为流返回内容。
|
流
|
|
openText(string filename)
|
通过小工具包打开一个文件，并作为字符串返回内容。
|
字符串
|
view
注意：与其子对象/内容对象不同，view不从 basicElement 继承。
您必须在单独的文件中为小工具的每个面板用户界面定义 view 对象。
|
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
caption
|
此视图的标题，默认情况下当小工具处于浮动/扩展模式时显示此标题，当小工具位于补充工具栏中时不显示此标题。另请参阅 showCaptionAlways 属性。
|
字符串
|
读-写
|
|
children
|
返回包含此视图元素的直接子元素的集合。它们全部是 basicElement 的子对象。只能通过脚本访问，不能通过 XML 定义访问。
|
元素
|
只读
|
|
event
|
事件句柄脚本获得 event 对象的方式。
|
事件
|
读
|
|
height
|
设置或返回视图高度，以像素表示。
|
整数
|
读-写
|
|
width
|
设置或返回视图宽度，以像素表示。
|
整数
|
读-写
|
|
resizable
|
值为 true 时，用户可以调整视图的大小。
|
布尔
|
读-写
|
|
showCaptionAlways
|
值为 true 时，补充工具栏一直显示此视图的标题（在caption 属性中指定）。默认情况下或当此值为 false 时，如果小工具在补充工具栏中则不显示此标题，如果小工具处于浮动或扩展模式则显示此标题。
|
布尔
|
读-写
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
void alert(string message)
|
显示包含消息字符串的消息框。
|
void
|
|
element appendElement(string xml)
|
解析所提供的元素定义（以 XML 格式给定），并将此元素附加为此视图的最后一个子视图。
|
新元素。
|
|
integer beginAnimation(string script, integer startValue, integer endValue, integer duration)
|
启动动画计时器。此计时器运行 duration 毫秒。在此时间段内使用 StartValue 和 EndValue 之间的值定期执行脚本。
|
可用于取消此动画的标识符。
注意：调用 Callback 的次数由系统的性能和当前负载决定。最高为 100 fps。
|
|
void cancelAnimation(integer Token)
|
取消当前运行的动画。Token 是 beginAnimation 返回的标识符。
|
void
|
|
void clearInterval(integer Token)
|
取消间隔或超时。
|
void
|
|
boolean confirm(string message)
|
显示包含消息字符串的确认框。如果按“确定”，返回 true，否则返回 false。
|
布尔
|
|
element insertElement(string xml, element InsertBefore)
|
解析提供的 XML，并将此元素插入紧挨 InsertBefore 元素之前的位置。
|
新元素。
|
|
void removeElement(element Item)
|
删除指定元素。
|
void
|
|
void resizeBy(integer width, integer height)
|
根据视图当前的宽度和高度，将视图大小更改指定的宽度和高度。以像素为单位。
|
void
|
|
Void resizeTo(integer width, integer height)
|
将视图大小更改为指定的宽度和高度（以像素为单位）。
|
void
|
|
integer setTimeout(string Script, integer Duration)
|
创建单次运行计时器。在 Duration 毫秒之后脚本将执行一次。
|
可用于取消超时的令牌。
|
|
integer setInterval(string Script, integer Duration)
|
创建一个永久运行计时器。在取消之前，脚本将每 Duration 毫秒执行一次。
|
可用于取消间隔的令牌。
|
|
事件
|
|
名称
|
说明
|
|
onclick
|
点击鼠标左键时触发。
|
|
onclose
|
视图将关闭时触发。
|
|
ondblclick
|
双击鼠标左键时触发。
|
|
onkeydown
|
当按下某键时触发。
|
|
onkeypress
|
当按下某键然后释放时触发。
|
|
onkeyup
|
当释放某键时触发。
|
|
onminimize
|
当小工具最小化时触发。
|
|
onmousedown
|
当按下鼠标左键时触发。
|
|
onmouseout
|
当鼠标光标离开视图时触发。
|
|
onmouseover
|
当鼠标光标进入视图时触发。
|
|
onmouseup
|
当释放鼠标左键时触发。
|
|
onopen
|
视图第一次打开时触发。
|
|
onoptionchanged
|
当添加、更改或删除 options 对象中的属性时触发。event.propertyName 指定更改的项目。
|
|
onrestore
|
当小工具从最小化状态恢复时触发。
|
|
onsizing
|
当用户更改小工具大小时触发。只有 resizable 设置为 true 时才触发。event.width 和 event.height 包含用户请求的新宽度和高度。事件代码可以取消该事件（event.returnValue = false），这将使小工具保持当前大小。事件代码可以修改 event.width 和 event.height，以忽略用户选择进行更改。
|
|
onsize
|
在脚本代码修改大小（例如，设置 view.width 或 view.height，或调用 view.resizeBy 或 view.resizeTo）后，或在调用 onsizing 并指定新的大小后，视图更改到新的大小，然后触发此事件。此事件无法取消。
|
basicElement
对象
定义可用于所有元素的属性、方法和事件，特定元素将继承此处定义的内容。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
cursor
|
设置或检索光标，以在鼠标位于此元素之上时进行显示。
可能值：arrow、 ibeam、 wait、 cross、 uparrow、 size、 sizenwse、 sizenesw、 sizewe、 sizens、 sizeall、 no、 hand、 busy、 help
|
字符串
|
读-写
|
|
dropTarget
|
设置或检索此元素是否是拖/放操作的目标。如果为 true，当用户启动拖/放操作时，ondrag* 事件将触发。
|
布尔
|
读-写
|
|
enabled
|
设置或检索是否启用此元素。禁用事件不触发任何鼠标或键盘事件。
|
布尔
|
读-写
|
|
height
|
设置或检索高度。 可以按像素或父对象的高度的百分比表示此值。
|
可变
|
读-写
|
|
hitTest
|
设置或检索此事件的点击测试值。
可能值：httransparent， htnowhere， htclient, htcaption， htsysmenu， htsize, htmenu， hthscroll， htvscroll， htminbutton， htmaxbutton， htleft， htright， httop， httopleft， httopright， htbottom， htbottomleft， htbottomright， htborder， htobject， htclose, hthelp
|
字符串
|
读-写
|
|
mask
|
设置或检索定义此元素剪切路径的掩码位图。
|
字符串
|
读-写
|
|
name
|
检索元素名称。
|
字符串
|
只读
|
|
offsetHeight
|
检索元素相对于父元素的高度，以像素表示。该属性类似于相同名称的 DHTML 属性。只能通过脚本访问，不能通过 XML 定义访问。
|
整数
|
只读
|
|
offsetWidth
|
检索元素相对于父元素的宽度，以像素表示。该属性类似于相同名称的 DHTML 属性。只能通过脚本访问，不能通过 XML 定义访问。
|
整数
|
只读
|
|
offsetX
|
检索元素相对于父元素的 x 位置，以像素表示。该属性类似于相同名称的 DHTML 属性。只能通过脚本访问，不能通过 XML 定义访问。
|
整数
|
只读
|
|
offsetY
|
检索元素相对于父元素的 y 位置，以像素表示。该属性类似于相同名称的 DHTML 属性。只能通过脚本访问，不能通过 XML 定义访问。
|
整数
|
只读
|
|
opacity
|
设置或检索元素的不透明度。
有效值：0-255
|
整数
|
读-写
|
|
parentElement
|
检索父元素。只能通过脚本访问，不能通过 XML 定义访问。
|
元素
|
只读
|
|
pinX
|
设置或检索水平针型标记。
|
整数
|
读-写
|
|
pinY
|
设置或检索垂直针型标记。
|
整数
|
读-写
|
|
rotation
|
设置或检索元素的旋转，以度数表示。
|
浮点
|
读-写
|
|
tagName
|
检索标志名称。只能通过脚本访问，不能通过 XML 定义访问。
|
字符串
|
只读
|
|
tooltip
|
设置或检索鼠标在此元素之上停留时显示的工具提示。
|
字符串
|
读-写
|
|
width
|
设置或检索宽度。可以按像素或父对象的宽度的百分比表示此值。
|
可变
|
读-写
|
|
visible
|
设置或检索此元素是否可见。
|
布尔
|
读-写
|
|
x
|
设置或检索水平位置。可以按像素或父对象的宽度的百分比表示此值。
|
可变
|
读-写
|
|
y
|
设置或检索垂直位置。可以按像素或父对象的高度的百分比表示此值。
|
可变
|
读-写
|
事件
|
|
名称
|
说明
|
|
onclick
|
当用户点击此元素时触发。
|
|
ondblclick
|
当用户双击此元素时触发。
|
|
ondragdrop
|
当用户将对象拖动到此元素上时触发。
|
|
ondragout
|
当用户取消拖/放操作时触发。
|
|
ondragover
|
当用户将一个对象拖动到此元素上时触发。
|
|
onfocusin
|
当元素获得键盘焦点时触发。
|
|
onfocusout
|
当元素失去键盘焦点时触发。
|
|
onkeydown
|
当用户按下某键时触发。
|
|
onkeypress
|
当用户按下然后释放某键时触发。
|
|
onkeyup
|
当用户释放某键时触发。
|
|
onmousedown
|
当用户按下鼠标键时触发。
|
|
onmousemove
|
当用户在元素上移动鼠标时触发。
|
|
onmouseout
|
当用户将鼠标移出元素之外时触发。
|
|
onmouseover
|
当用户将鼠标移动到元素上时触发。
|
|
onmouseup
|
当用户释放鼠标键时触发。
|
|
onmousewheel
|
当用户滚动鼠标滚轮时触发。
|
元素
表示元素对象的容器。支持 Javascript 枚举器和集合元素访问，例如 elements("foo")，而不是 elements.item("foo")。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
count
|
返回集合中的元素数。
|
整数
|
只读
|
|
item (string Name)
|
返回 Name 参数确定的元素。如果使用同一名称定义了多个元素，则返回第一个。如果没有匹配元素，返回空值。
|
元素
|
只读，默认（对于某些脚本语言， .item 标识可选）
|
<button> 元素，button 对象
Button 对象，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
disabledImage
|
设置或检索禁用按钮时显示的图象。
|
字符串
|
读-写
|
|
downImage
|
设置或检索按下按钮时显示的图片。
|
字符串
|
读-写
|
|
image
|
设置或检索按钮的默认图片。
|
字符串
|
读-写
|
|
overImage
|
设置或检索当鼠标移动到按钮上时显示的图片。
|
字符串
|
读-写
|
<checkbox> 元素，checkbox 对象
Checkbox 对象，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
image
|
设置或检索复选框的默认图片。
|
字符串
|
读-写
|
|
checkedDisabledImage
|
设置或检索选中和禁用复选框时显示的图片。
|
字符串
|
读-写
|
|
checkedDownImage
|
设置或检索选中和按下复选框时显示的图片。
|
字符串
|
读-写
|
|
checkedOverImage
|
设置或检索选中复选框时以及鼠标位于复选框之上时显示的图片。
|
字符串
|
读-写
|
|
checkedImage
|
设置或检索选中复选框时显示的默认图片。
|
字符串
|
读-写
|
|
disabledImage
|
设置或检索禁用复选框时显示的图片。
|
字符串
|
读-写
|
|
downImage
|
设置或检索按下复选框时显示的图片。
|
字符串
|
读-写
|
|
overImage
|
设置或检索当鼠标移动到按钮上时显示的图片。
|
字符串
|
读-写
|
|
value
|
如果选中复选框，返回 true。
|
布尔
|
读-写
|
事件
|
|
名称
|
说明
|
|
onchange
|
value 属性更改时触发。
|
<object> 元素object 对象
嵌入式对象，它是无窗口 ActiveX 控件，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
classId
|
检索创建 ActiveX 控件所使用的 classId。注意，以 XML 格式定义 objectElement 时，classId 的值应使用 "clsid:GUID_value" 或 "progid:progid_value" 的格式，包括引号。
|
字符串
|
只读
|
|
object
|
检索托管的 ActiveX 控件。
|
对象
|
只读
|
|
wmpServiceType
|
当对象是 Windows Media Player 时，设置或检索该嵌入式对象的服务类型。
|
字符串
|
读-写
|
|
wmpSkin
|
设置或检索要在小工具中托管的 Windows Media Player 外观文件的名称。外观文件应该打包在 .gg 文件中。
|
字符串
|
读-写
|
<contentArea>
元素contentArea 对象
一般内容包容对象。虽然来源于 basicElement，但是不支持许多 basicElement 属性。仅支持 x、y、width、height 和 name 等 basicElement 属性。这包括 ContentItem 对象；详细信息请参见其参考材料。在 view 对象中只能定义一个 contentArea。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
contentFlags
|
一个或多个 gddContentFlagXXXX 标记的组合。
|
整数
|
只写
|
|
maxContentItems
|
允许的内容项最大数，默认值为 25。
|
整数
|
读-写
|
|
contentItems
|
内容项组。
|
可变
|
读-写
|
|
pinImages
|
图片组；您可以使用 framework.graphics.loadImage() 加载图片。
|
可变
|
读-写
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
void addContentItem(item, options)
|
添加新内容项。
|
void
|
|
void removeContentItem(item)
|
删除指定内容项。
|
void
|
|
void removeAllContentItems()
|
删除所有内容项。
|
void
|
<div> 元素，div 对象
div 对象，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
background
|
设置或检索元素的背景颜色或背景图片。
|
字符串
|
读-写
|
|
children
|
检索包含此元素的直接子元素的集合。只能通过脚本访问，不能通过 XML 定义访问。
|
元素
|
只读
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
appendElement(string xml)
|
解析提供的 XML，并将此元素附加为这一元素的最后一个子元素。
|
新
元素
|
|
insertElement(string xml, element InsertBefore)
|
解析提供的 XML，并将此元素插入紧挨 InsertBefore 元素之前的位置。
|
新
元素
|
|
removeElement(element Item)
|
删除指定元素。
|
void
|
<edit>
元素，edit 对象
编辑区域对象，同样继承了 basicElement 对象的所有属性和方法。颜色值格式只能是：
color="#RRGGBB"（类似于 HTML）
不支持 Alpha 和图片纹理值。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
background
|
设置或检索元素的背景颜色。
|
字符串
|
读-写
|
|
bold
|
设置或检索文本是否应该为粗体。
|
布尔
|
读-写
|
|
color
|
设置或检索文本颜色。
|
字符串
|
读-写
|
|
font
|
设置或检索文本字体。
|
字符串
|
读-写
|
|
italic
|
设置或检索文本是否应该为斜体。
|
布尔
|
读-写
|
|
size
|
设置或检索文本文字大小，以磅表示。
|
整数
|
读-写
|
|
strikeout
|
设置或检索是否应该删除文本。
|
布尔
|
读-写
|
|
underline
|
设置或检索是否应该为文本添加下划线。
|
布尔
|
读-写
|
|
value
|
设置或检索元素值。
|
字符串
|
读-写
|
事件
|
|
名称
|
说明
|
|
onchange
|
属性值更改时触发。
|
<img>
元素，img 对象
图片对象，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
src
|
设置或检索要显示的图片。
|
字符串
|
读-写
|
|
srcHeight
|
检索所显示图片的原始高度。
|
整数
|
只读
|
|
srcWidth
|
检索所显示图片的原始宽度。
|
整数
|
只读
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
setSrcSize(integer Width, integer Height)
|
通过降低分辨率，将图片大小调整为指定的宽度和高度。如果源图片大于显示区域，通过使用此方法将图片大小更改为输出大小，可以节省内存，改善呈现效果。
|
void
|
<label> 元素，label对象
标签对象，同样继承了 color="#RRGGBB"（类似于 HTML）
color="#AARRGGBB"（类似于 HTML，其中 AA 为 alpha 值）
color="some_image.png"（将此图片作为重复纹理） |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
align
|
设置或检索文本对齐方式。
可能值：center、left 和 right
|
字符串
|
读-写
|
|
bold
|
设置或检索文本是否应该为粗体。
|
布尔
|
读-写
|
|
color
|
设置或检索文本颜色。
|
字符串
|
读-写
|
|
font
|
设置或检索文本字体。
|
字符串
|
读-写
|
|
innerText
|
设置或检索显示的文本。只能通过脚本访问，不能通过 XML 定义访问。
|
字符串
|
读-写
|
|
italic
|
设置或检索文本是否应该为斜体。
|
布尔
|
读-写
|
|
size
|
设置或检索文本文字大小，以磅表示。
|
整数
|
读-写
|
|
strikeout
|
设置或检索是否应该删除文本。
|
布尔
|
读-写
|
|
trimming
|
如果文本太大无法显示，设置或检索剪裁模式。
可能值：none、character、word、character-ellipsis、word-ellipsis、path-ellipsis
|
字符串
|
读-写
|
|
underline
|
设置或检索是否应该为文本添加下划线。
|
布尔
|
读-写
|
|
vAlign
|
设置或检索垂直对齐方式。
可能值：top（靠上）、middle（居中）、bottom（靠下）
|
字符串
|
读-写
|
|
wordWrap
|
设置或检索文本是否应该换行。
|
布尔
|
读-写
|
<a>
元素，a 对象
定义一个链接，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
align
|
设置或检索文本对齐方式。
可能值：center、left 和 right
|
字符串
|
读-写
|
|
bold
|
设置或检索文本是否应该为粗体。
|
布尔
|
读-写
|
|
color
|
设置或检索文本颜色。
|
字符串
|
读-写
|
|
font
|
设置或检索文本字体。
|
字符串
|
读-写
|
|
href
|
设置后，点击此链接将在默认浏览器中启动此网址。只能启动 http:、https: 和 ftp:网址。
|
字符串
|
读-写
|
|
innerText
|
设置或检索显示的文本。只能通过脚本访问，不能通过 XML 定义访问。
|
字符串
|
读-写
|
|
italic
|
设置或检索文本是否应该为斜体。
|
布尔
|
读-写
|
|
overColor
|
设置或检索当鼠标移动到元素上时文本的颜色。
|
字符串
|
读-写
|
|
size
|
设置或检索文本文字大小，以磅表示。
|
整数
|
读-写
|
|
strikeout
|
设置或检索是否应该删除文本。
|
布尔
|
读-写
|
|
trimming
|
如果文本太大无法显示，设置或检索剪裁模式。
可能值：none、character、word、character-ellipsis、word-ellipsis、path-ellipsis
|
字符串
|
读-写
|
|
underline
|
设置或检索是否应该为文本添加下划线。
|
布尔
|
读-写
|
|
vAlign
|
设置或检索垂直对齐方式。
可能值：top（靠上）、middle（居中）、bottom（靠下）
|
字符串
|
读-写
|
|
wordWrap
|
设置或检索文本是否应该换行。
|
布尔
|
读-写
|
<progressBar> 元素，progressBar 对象。
进度条对象，同样继承了 basicElement 对象的所有属性和方法。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
emptyImage
|
设置或检索滑块为空时显示的图片。
|
字符串
|
读-写
|
|
fullImage
|
设置或检索滑块充满时显示的图片。
|
字符串
|
读-写
|
|
max
|
设置或检索最大值 - 滑块充满时的值。
|
整数
|
读-写
|
|
min
|
设置或检索最小值 - 滑块为空时的值。
|
整数
|
读-写
|
|
orientation
|
设置或检索滑块的方向。
可能值：horizontal（水平）、vertical（垂直）
|
字符串
|
读-写
|
|
thumbDisabledImage
|
设置或检索禁用滑块时显示的缩略图。
|
字符串
|
读-写
|
|
thumbDownImage
|
设置或检索当按缩略图时显示的图片。
|
字符串
|
读-写
|
|
thumbOverImage
|
设置或检索当鼠标移动到缩略图上时显示的图片。
|
字符串
|
读-写
|
|
thumbImage
|
设置或检索缩略图的默认图片。
|
字符串
|
读-写
|
|
value
|
设置或检索该值。
|
整数
|
读-写
|
事件
|
|
名称
|
说明
|
|
onchange
|
value 属性更改时触发。
|
options
独立对象，不会从其他任何对象继承。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
count
|
返回字典中的项目数。
|
整数
|
只读
|
|
defaultValue (string name)
|
设置或返回 name 的 defaultValue。
|
字符串
|
读-写
|
|
item (string name)
|
设置或返回 name 的当前值。这是默认属性。
|
字符串
|
读-写
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
add(string name, variant value)
|
如果某项未包含在字典中，添加此项。
|
void
|
|
exists(string name)
|
如果已经设置 name 值，返回 true。
|
布尔
|
|
remove(string name)
|
从字典中删除此值。
|
void
|
|
removeAll()
|
从字典中删除所有值。
|
void
|
googleTalk
4.0 版本之前的对象，其事件句柄使用 4.0 版本之前的事件处理模式。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
friends
|
返回在线朋友姓名。
|
一组friend 对象。
|
只读
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
SendTalkData(friend_id, data)
|
向朋友发送字符串。friend_id 来自 friend 对象的 user_id 属性。
|
不返回任何值。
|
|
SendTalkText(friend_id, message)
|
向朋友发送作为即时消息的文本消息。friend_id 来自 friend 对象的 user_id 属性。
|
不返回任何值。
|
事件句柄
|
|
名称
|
原型
|
说明
|
返回值
|
|
onReceiveTalkData
|
OnReceiveTalkData(friend, data)
|
当某位朋友机器上的同一插件发送数据时调用。friend 为 friend 对象，data 为字符串。
|
不返回任何值。
|
Friend 对象
此对象由
googleTalk 返回。Google 小工具无法创建此类型的变量。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
name
|
朋友的可见用户名。
|
字符串
|
只读
|
|
user_id
|
朋友的用户 ID，此 ID 被作为参数传递给
SendTalkText
和
SendTalkData 等方法。 |
字符串
|
只读
|
|
email_address
|
朋友的电子邮件地址。
|
字符串
|
只读
|
|
has_sidebar
|
朋友是否安装了补充工具栏。
|
布尔
|
只读
|
|
status
|
朋友的状态（例如，在线/空闲/忙碌）。
|
整数
|
只读
|
ContentItem
对象
4.0 版本之前的对象，其事件句柄使用 4.0 版本之前的事件处理模式。 |
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
image
|
项目中显示的图片。
|
图片
|
读/写
|
|
notifier_image
|
通知程序中显示的图片。
|
图片
|
读/写
|
|
time_created
|
时间（在 JavaScript 中，指可变时间值）。
|
时间
|
读/写
|
|
heading
|
项目显示的标题。
|
字符串
|
读/写
|
|
source
|
项目显示的网站/新闻来源。
|
字符串
|
读/写
|
|
snippet
|
项目显示的摘录。
|
字符串
|
读/写
|
|
open_command
|
用户打开/双击项目时打开的网址/文件路径。
|
字符串
|
读/写
|
|
layout
|
项目的布局表明项目的显示格式。
|
整数
|
读/写
|
|
flags
|
内容项标记组合。
|
整数
|
只写
|
|
tooltip
|
工具提示文本，例如完整路径、完整标题等等。
|
字符串
|
只写
|
|
friend_name
|
如果此项目来自其他用户，则包含发送项目的用户名。
|
字符串
|
读/写
|
|
time_received
|
如果此项目来自其他用户，则包含接收的日期和时间（使用通用协调时间）。
|
字符串
|
读/写
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
SetRect(x, y, width, height)
|
设置项目的显示位置。在设置任何项目的位置之前，启用插件的 MANUAL_LAYOUT 标记。如果未启用，此项目将显示在插件给定的默认位置。
|
无
|
事件句柄
|
|
名称
|
原型
|
说明
|
返回值
|
|
onDrawItem
|
DrawItem(item, display_target, graphics, x, y, width, height)
|
调用以绘制项目。
|
不返回任何值。
|
|
onGetHeight
|
GetHeight(item, display_target, graphics, width)
|
调用以获取项目在宽度给定时的高度，以像素数表示。
|
返回 integer，按像素数给出项目高度。
|
|
onOpenItem
|
OpenItem(item)
|
用户打开/双击项目时调用。
|
不返回任何值。
|
|
onToggleItemPinnedState
|
ToggleItemPinnedState(item)
|
用户点击项目的“针形标记”按钮时调用
|
不返回任何值。
|
|
onGetIsTooltipRequired
|
GetIsTooltipRequired(item, display_target, graphics, x, y, width, height)
|
调用以检查显示在给定位置的项目是否需要工具提示
|
返回布尔值，true 显示工具提示，false 不显示工具提示。
|
|
onDetailsView
|
OnDetailsView(item)
|
在为给定项目显示详细视图之前调用
|
不返回任何值，将取消详细视图；或返回一个具有以下属性的对象：
-
obj.title
- 详细视图显示的标题
-
obj.details_control
- 应该在详细视图中显示的 activeX 控件
-
obj.flags
- 控制详细视图布局/使用的标记
对于以上每个参数的详细信息，请参阅界面 IGoogleDesktopDisplayContentItemHandler 中有关 OnDetailsView 的文档。
|
|
onProcessDetailsViewFeedback
|
ProcessDetailsViewFeedback(item, details_view_flags)
|
调用以处理用户在详细视图中的操作。
|
不返回任何值。
|
|
onRemoveItem
|
RemoveItem(item)
|
当用户从显示中删除一项时调用
|
返回 true 取消删除，保留此项目；返回 false 继续操作，删除此项目。
|
DetailsView
对象
4.0 版本之前的对象，其事件句柄使用 4.0 版本之前的事件处理模式。 |
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
SetContent(source, time_created, text, time_absolute, content_layout)
|
设置要在“详细视图”内容窗格中显示的内容。
|
无
|
|
SetContentFromItem(item)
|
设置从项目直接显示的内容。
|
无
|
|
menu
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
AddItem(item_text, style, handler)
|
添加一个菜单项。style 是 gddMenuItemFlagXXXX 的组合。handler 的函数原型是 OnMenuItem(item_text)。
|
不返回任何值。
|
|
SetItemStyle(item_text, style)
|
设置给定菜单项的样式。Style 是 gddMenuItemFlagXXXX 的组合。
|
不返回任何值。
|
|
AddPopup(popup_text)
|
添加显示给定文本的子菜单/弹出式菜单。
|
返回新弹出式菜单的菜单对象。
|
Framework 命名空间
framework
如果指向其子对象，则 framework 关键字可选。例如，framework.system.battery 等同于 system.battery
|
|
对象
|
说明
|
|
system
|
返回收集计算机系统相关信息的对象。
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
BrowseForFile( string Filter)
|
显示文件对话的标准浏览，并返回所选文件的文件名；如果取消此对话，则显示空字符串。过滤器字符串的形式为“显示名称|类型列表”，并可以为其添加多个条目。例如“音乐文件|*.mp3;*.wma|所有文件|*.*”通过对话的“文件类型”下拉菜单定义了两种可能选择：音乐文件，符合 *.mp3 或 *.wma 的任何文件；所有文件，符合 *.* 的任何文件。
|
字符串
|
|
BrowseForFiles( string Filter)
|
显示文件对话的标准浏览，并返回包含所选文件名称的集合；如果取消此对话，则显示空字符串。查看 BrowseForFile，获得对 Filter 参数的说明。
|
collection
|
|
framework.graphics
|
|
对象
|
说明
|
|
createPoint
|
返回 Point 对象。
|
|
createSize
|
返回 Size 对象。
|
|
loadImage(image_src)
|
加载和返回（作为 image 对象）给定的图片文件。
image_src 可以是本地文件（不支持远程网址）的路径，也可以是 XMLHttp 对象的 responseStream 成员（通过它，小工具可以使用 XMLHttp 对象下载和加载图片）。您可以将图片文件对象用作 contentItem.image 属性的值，或修改旧的 API 的 plugin 对象的 <smallIcon> 和 <icon> 属性。
|
framework.system
有关这些对象属性的信息，请参阅以下条目
|
|
对象
|
说明
|
|
cursor
|
返回提供鼠标光标相关信息的对象。 |
|
filesystem
|
返回提供对 Windows 标准 Scripting.FileSystemObject 对象访问权的对象。 |
|
memory
|
返回提供系统内存相关信息的对象。 |
|
network
|
提供系统无线连接相关信息的对象的父对象。目前，framework.system.network 自身不具有属性，本身也不作为对象使用。 |
|
perfmon
|
返回提供类似于 Windows PerfMon 的信息的对象。 |
|
power
|
返回提供系统节能状态相关信息的对象。 |
|
processor
|
返回提供系统处理器相关信息的对象，可以提供诸如批次，型号，名称，速度，厂家等信息。 |
|
screen
|
返回提供屏幕相关信息的对象。 |
|
framework.system.cursor
|
|
属性
|
类型
|
说明
|
|
position
|
point
|
返回 Point 对象，它包含当前光标相对于屏幕的位置。
|
|
framework.system.memory
|
|
属性
|
类型
|
说明
|
|
free
|
整数
|
当前可用的虚拟内存（物理 + 转换）的字节数。
|
|
total
|
整数
|
虚拟内存（物理 + 转换）的总字节数。
|
|
used
|
整数
|
当前正在使用的虚拟内存（物理 + 转换）的字节数。
|
|
freePhysical
|
整数
|
当前可用的物理内存的字节数。
|
|
totalPhysical
|
整数
|
物理内存的总字节数。
|
|
usedPhysical
|
整数
|
当前使用的物理内存的字节数。
|
|
framework.system.network.wireless
|
|
属性
|
类型
|
说明
|
|
available
|
布尔
|
如果可以使用无线则为 True。
|
|
connected
|
布尔
|
如果已连接到无线网络此值为 True。
|
|
name
|
字符串
|
返回无线适配器的名称。
|
|
networkName
|
字符串
|
返回无线网络的名称。
|
|
signalStrength
|
整数
|
返回无线连接的信号强度。值为 0-100。
|
|
framework.system.perfmon
|
|
属性
|
类型
|
说明
|
|
currentValue ("counter_path")
|
可变
|
返回所指定计数器的当前值。应该已经使用 addCounter 添加计数器。计数器路径由 Windows PerfMon 应用程序定义和记录，类似 “\Processor(_Total)\% Processor Time” 或 “\LogicalDisk(_Total)\% Disk Time”。
|
|
方法
|
|
名称和参数
|
说明
|
返回值
|
|
addCounter(string counter_path, string script_code)
|
开始监控指定计数器。只要计数器值改变，此脚本代码就会运行。
|
void
|
|
removeCounter(string counter_path)
|
停止监控指定计数器。
|
void
|
framework.system.power
注意：如果此计算机没有电池或 Windows 无法确定电池的值，整数类型属性将返回 -1。 |
|
属性
|
类型
|
说明
|
|
charging
|
布尔
|
如果电池正在充电，值为 true。
|
|
percentRemaining
|
整数
|
剩余电池电量（百分比）
|
|
pluggedIn
|
布尔
|
如果计算机已插上电源，则为 true。
|
|
timeRemaining
|
整数
|
所估计的电池需要充电之前的剩余时间（以秒表示）。
|
|
timeTotal
|
整数
|
所估计的电池完全充满后的工作时间（以秒表示）。
|
|
framework.system.processor
|
|
属性
|
类型
|
说明
|
|
architecture
|
字符串
|
处理器架构（例如 x86）。
|
|
count
|
整数
|
安装的处理器数量。
|
|
family
|
整数
|
处理器系列的标识。
|
|
model
|
整数
|
标记的处理器型号。
|
|
name
|
字符串
|
处理器名称（用于显示）。
|
|
speed
|
字符串
|
处理器速度，以 mhz 表示。
|
|
stepping
|
整数
|
处理器的步进标识。
|
|
vendor
|
字符串
|
处理器供应商名称。
|
|
framework.system.screen
|
|
属性
|
类型
|
说明
|
|
size
|
尺寸
|
返回包含屏幕尺寸信息的 size 对象。
|
Point 对象
表示一个由其位置确定的点。坐标值与哪些因素相关取决于指定这些值的方法或属性。
|
point
|
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
x
|
X-坐标值。
|
整数
|
读-写
|
|
y
|
Y-坐标值。
|
整数
|
读-写
|
Size 对象
表示某一对象的大小。
|
size
|
|
属性
|
|
名称
|
说明
|
类型
|
读/写
|
|
height
|
高度值。
|
整数
|
读-写
|
|
width
|
宽度值。
|
整数
|
读-写
|
|
常量和标记
|
|
详细视图标记
|
|
名称
|
说明
|
|
gddDetailsViewFlagNone
|
没有传递任何标记。 |
|
gddDetailsViewFlagToolbarOpen
|
使详细视图标题像按钮一样可以点击。 |
|
gddDetailsViewFlagNegativeFeedback
|
在详细视图中添加否定反馈按钮（例如，“不要显示这样的项目”）。 |
|
gddDetailsViewFlagRemoveButton
|
在详细视图中添加“删除”按钮。 |
|
gddDetailsViewFlagShareWithButton
|
在详细视图中添加按钮，以在点击时显示朋友列表，用户还可以与其朋友共享内容项目。 |
|
插件标记
|
|
名称
|
说明
|
|
gddPluginFlagNone
|
没有传递任何标记。 |
|
gddPluginFlagToolbarBack
|
在插件工具栏中添加“返回”按钮。 |
|
gddPluginFlagToolbarForward
|
在插件工具栏中添加“前进”按钮。 |
|
信息掩码
|
|
名称
|
说明
|
|
gddInfoMaskNone
|
没有传递任何标记。 |
|
gddInfoMaskMinSize
|
返回显示插件内容所需大小的下限 |
|
gddInfoMaskMaxSize
|
返回显示插件内容所需大小的上限 |
|
gddInfoMaskIdealSize
|
返回显示插件内容所需大小的理想值 |
|
插件命令
|
|
名称
|
说明
|
|
gddCmdAboutDialog
|
显示“关于”对话。 |
|
gddCmdToolbarBack
|
用户点击了“返回”按钮。 |
|
gddCmdToolbarForward
|
用户点击了“前进”按钮 |
|
内容项布局
|
|
名称
|
说明
|
|
gddContentItemLayoutNowrapItems
|
只有标题和图标时为单行。 |
|
gddContentItemLayoutNews
|
显示标题、来源和时间的布局。 |
|
gddContentItemLayoutEmail
|
显示标题、来源、时间和摘录的布局。 |
|
内容标记
|
|
名称
|
说明
|
|
gddContentFlagNone
|
没有传递任何标记。 |
|
gddContentFlagHaveDetails
|
当用户点击内容项时显示详细视图。 |
|
gddContentFlagPinnable
|
使用户可以固定内容项，以便一直显示这些项目。 |
|
gddContentFlagManualLayout
|
通过给定每个项目的显示位置，插件可以管理项目布局 |
|
内容项标记
|
|
名称
|
说明
|
|
gddContentItemFlagNone
|
没有传递任何标记。 |
|
gddContentItemFlagStatic
|
项目不接受用户输入。 |
|
gddContentItemFlagHighlighted
|
项目突出显示/显示为粗体。 |
|
gddContentItemFlagPinned
|
项目被固定在列表顶部。 |
|
gddContentItemFlagTimeAbsolute
|
项目时间显示为绝对时间，与当前时间无关。 |
|
gddContentItemFlagNegativeFeedback
|
项目可以从用户那里获得否定反馈。 |
|
gddContentItemFlagLeftIcon
|
项目图标应该显示在左侧。 |
|
gddContentItemFlagNoRemove
|
不在上下文菜单中显示此项目的“删除”选项。 |
|
gddContentItemFlagShareable
|
可以与朋友共享项目。这将启用上下文菜单中的特定菜单项，并启用详细视图中的按钮。 |
|
gddContentItemFlagShared
|
说明此项目来自其他用户。 |
|
gddContentItemFlagInteracted
|
说明该用户已经与此项目交互（查看详细信息/打开等等）。 |
|
小工具显示状态
|
|
名称
|
说明
|
|
gddTileDisplayStateHidden
|
平铺窗格不可见。 |
|
gddTileDisplayStateRestored
|
从最小化或伸出状态恢复平铺窗格。 |
|
gddTileDisplayStateMinimized
|
平铺窗格已经最小化，只有标题栏可见。 |
|
gddTileDisplayStatePoppedOut
|
平铺窗格“伸出”补充工具栏另外展开一个窗口。 |
|
gddTileDisplayStateResized
|
平铺窗格重新调整大小。 |
|
目标设备
|
|
名称
|
说明
|
|
gddTargetSidebar
|
正在补充工具栏中显示/绘制项目。 |
|
gddTargetNotifier
|
正在通知窗口中显示/绘制项目。 |
|
gddTargetFloatingView
|
插件/项目正显示在浮动于桌面上的自己的窗口中。 |
|
ContentItem 显示选项
|
|
名称
|
说明
|
|
gddItemDisplayInSidebar
|
在补充工具栏中显示此项目。 |
|
gddItemDisplayInSidebarIfVisible
|
如果补充工具栏可见，则在其中显示此项目。 |
|
gddItemDisplayAsNotification
|
在通知窗口中显示此项目。 |
|
gddItemDisplayAsNotificationIfSidebarHidden
|
如果补充工具栏隐藏，则在通知窗口中显示此项目。 |
|
窗口类
|
|
名称
|
说明
|
|
gddWndCtrlClassLabel
|
标准窗口静态/标签控件。 |
|
gddWndCtrlClassEdit
|
标准窗口单行编辑控件。 |
|
gddWndCtrlClassList
|
标准窗口列表框/下拉列表组合框控件。 |
|
gddWndCtrlClassButton
|
标准窗口按钮控件（还包括复选框）。 |
|
控件类型
|
|
名称
|
说明
|
|
gddWndCtrlTypeNone
|
未传递任何值。 |
|
编辑控件类型
|
|
名称
|
说明
|
|
gddWndCtrlTypeEditPassword
|
用户可以输入密码的编辑框，该框可以隐藏实际输入的字符。 |
|
列表控件类型
|
|
名称
|
说明
|
|
gddWndCtrlTypeListOpen
|
标准列表控件，在可滚动窗口中显示所有选项。 |
|
gddWndCtrlTypeListDrop
|
下拉列表控件（也称为没有现场编辑功能的组合框控件）。 |
|
按钮控件类型
|
|
名称
|
说明
|
|
gddWndCtrlTypeButtonPush
|
标准按钮。 |
|
gddWndCtrlTypeButtonCheck
|
复选框控件。 |
|
字体 ID
|
|
名称
|
说明
|
|
gddFontNormal
|
用于常规文本的字体。 |
|
gddFontSnippet
|
用于摘录文本的字体（可能稍小于常规字体）。 |
|
gddFontExtraInfo
|
用于项目其他信息（例如来源和时间）的字体。 |
|
文本颜色 ID
|
|
名称
|
说明
|
|
gddColorNormalText
|
常规文本所使用的颜色。 |
|
gddColorNormalBackground
|
补充工具栏背景所使用的颜色。 |
|
gddColorSnippet
|
摘录文本所使用的颜色。 |
|
gddColorExtraInfo
|
项目其他信息（例如来源和时间）所使用的颜色。 |
|
文本标记
|
|
名称
|
说明
|
|
gddTextFlagCenter
|
文本水平居中。 |
|
gddTextFlagRight
|
文本右对齐。 |
|
gddTextFlagVCenter
|
文本垂直居中。 |
|
gddTextFlagBottom
|
文本底部对齐。 |
|
gddTextFlagWordBreak
|
当换行时在字的分界处截断文本。 |
|
gddTextFlagSingleLine
|
在一行中显示文本，不换行。 |
|
菜单项标记
|
|
名称
|
说明
|
|
gddMenuItemFlagGrayed
|
禁用的菜单项。 |
|
gddMenuItemFlagChecked
|
选中的菜单项。 |
|
出现在选项对话框中的按钮 ID
|
|
名称
|
说明
|
|
gddIdOK
|
“确定”按钮 |
|
gddIdCancel
|
“取消”按钮。 |
|
写入插件日志的消息级别
|
|
名称
|
说明
|
|
gddLogLevelDebug
|
用于正常诊断消息。 |
|
gddLogLevelInfo
|
用于可能属于不正常行为的提供信息的消息。 |
|
gddLogLevelWarning
|
用于输入/数据不正常、需要注意的情况。 |
|
gddLogLevelError
|
用于重大错误。 |
|
好友列表中联系人的状态
|
|
名称
|
说明
|
|
gddFriendStatusOnline
|
好友在线。 |
|
gddFriendStatusIdle
|
好友空闲，最近没有使用此 PC。 |
|
gddFriendStatusBusy
|
好友正忙。 |
|
“发送至”目标
|
|
名称
|
说明
|
|
gddSendToSidebar
|
将此数据发送至给定用户的补充工具栏。 |
|
gddSendToIM
|
使用即时消息将此数据发送至给定用户。 |
|
gddSendToEmail
|
使用电子邮件将此数据发送至给定用户。 |