周游世界

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	使用電子郵件將此數據發送至給定用戶。