Merge Chromium + Blink git repositories
[chromium-blink-merge.git] / chrome / browser / ui / cocoa / applescript / scripting.sdef
blob854330b9b72bf2b72f11e638ee299ab070e6a676
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE dictionary SYSTEM "file://localhost/System/Library/DTDs/sdef.dtd">
3 <dictionary title="Dictionary">
4 <!--
5 STANDARD SUITE
6 -->
7 <suite name="Standard Suite" code="core" description="Common classes and commands for all applications.">
8 <cocoa name="NSCoreSuite"/>
9 <class name="application" code="capp" description="The application&apos;s top-level scripting object.">
10 <cocoa class="BrowserCrApplication"/>
11 <element description="The windows contained within this application, ordered front to back." type="window">
12 <cocoa key="appleScriptWindows"/>
13 </element>
14 <property name="name" code="pnam" description="The name of the application." type="text" access="r"/>
15 <property name="frontmost" code="pisf" description="Is this the frontmost (active) application?" type="boolean" access="r">
16 <cocoa key="isActive"/>
17 </property>
18 <property name="version" code="vers" description="The version of the application." type="text" access="r"/>
19 <responds-to command="quit">
20 <cocoa method="handleQuitScriptCommand:"/>
21 </responds-to>
22 </class>
23 <class name="window" code="cwin" description="A window.">
24 <cocoa class="WindowAppleScript"/>
25 <element description="The tabs contained within the window." type="tab">
26 <cocoa key="tabs"/>
27 </element>
28 <property name="name" code="pnam" description="The full title of the window." type="text" access="r">
29 <cocoa key="title"/>
30 </property>
31 <property name="id" code="ID " description="The unique identifier of the window." type="integer" access="r">
32 <cocoa key="uniqueID"/>
33 </property>
34 <property name="index" code="pidx" description="The index of the window, ordered front to back." type="integer">
35 <cocoa key="orderedIndex"/>
36 </property>
37 <property name="bounds" code="pbnd" description="The bounding rectangle of the window." type="rectangle">
38 <cocoa key="boundsAsQDRect"/>
39 </property>
40 <property name="closeable" code="hclb" description="Whether the window has a close box." type="boolean" access="r">
41 <cocoa key="hasCloseBox"/>
42 </property>
43 <property name="minimizable" code="ismn" description="Whether the window can be minimized." type="boolean" access="r">
44 <cocoa key="isMiniaturizable"/>
45 </property>
46 <property name="minimized" code="pmnd" description="Whether the window is currently minimized." type="boolean">
47 <cocoa key="isMiniaturized"/>
48 </property>
49 <property name="resizable" code="prsz" description="Whether the window can be resized." type="boolean" access="r">
50 <cocoa key="isResizable"/>
51 </property>
52 <property name="visible" code="pvis" description="Whether the window is currently visible." type="boolean">
53 <cocoa key="isVisible"/>
54 </property>
55 <property name="zoomable" code="iszm" description="Whether the window can be zoomed." type="boolean" access="r">
56 <cocoa key="isZoomable"/>
57 </property>
58 <property name="zoomed" code="pzum" description="Whether the window is currently zoomed." type="boolean">
59 <cocoa key="isZoomed"/>
60 </property>
61 <property name="active tab" code="acTa" description="Returns the currently selected tab" type="tab" access="r">
62 <cocoa key="activeTab"/>
63 </property>
64 <property name="mode" code="mode" description="Represents the mode of the window which can be &apos;normal&apos; or &apos;incognito&apos;, can be set only once during creation of the window." type="text">
65 <cocoa key="mode"/>
66 </property>
67 <property name="active tab index" code="acTI" description="The index of the active tab." type="integer"/>
68 <responds-to command="close">
69 <cocoa method="handlesCloseScriptCommand:"/>
70 </responds-to>
71 </class>
72 <command name="save" code="coresave" description="Save an object.">
73 <direct-parameter description="the object to save, usually a document or window" type="specifier"/>
74 <parameter name="in" code="kfil" description="The file in which to save the object." type="file" optional="yes">
75 <cocoa key="File"/>
76 </parameter>
77 <parameter name="as" code="fltp" description="The file type in which to save the data. Can be &apos;only html&apos; or &apos;complete html&apos;, default is &apos;complete html&apos;." type="text" optional="yes">
78 <cocoa key="FileType"/>
79 </parameter>
80 </command>
81 <!--
82 According to TN2106, 'open' should return the resulting document
83 object. However, the Cocoa implementation does not do this yet.
84 <result type="specifier"/>
85 -->
86 <command name="open" code="aevtodoc" description="Open a document.">
87 <direct-parameter description="The file(s) to be opened.">
88 <type type="file" list="yes"/>
89 </direct-parameter>
90 </command>
91 <command name="close" code="coreclos" description="Close a window.">
92 <cocoa class="NSCloseCommand"/>
93 <direct-parameter description="the document(s) or window(s) to close." type="specifier"/>
94 </command>
95 <command name="quit" code="aevtquit" description="Quit the application.">
96 <cocoa class="NSQuitCommand"/>
97 </command>
98 <command name="count" code="corecnte" description="Return the number of elements of a particular class within an object.">
99 <cocoa class="NSCountCommand"/>
100 <direct-parameter description="the object whose elements are to be counted" type="specifier"/>
101 <parameter name="each" code="kocl" description="The class of objects to be counted." type="type" optional="yes">
102 <cocoa key="ObjectClass"/>
103 </parameter>
104 <result description="the number of elements" type="integer"/>
105 </command>
106 <command name="delete" code="coredelo" description="Delete an object.">
107 <cocoa class="NSDeleteCommand"/>
108 <direct-parameter description="the object to delete" type="specifier"/>
109 </command>
110 <command name="duplicate" code="coreclon" description="Copy object(s) and put the copies at a new location.">
111 <cocoa class="NSCloneCommand"/>
112 <direct-parameter description="the object(s) to duplicate" type="specifier"/>
113 <parameter name="to" code="insh" description="The location for the new object(s)." type="location specifier" optional="yes">
114 <cocoa key="ToLocation"/>
115 </parameter>
116 <parameter name="with properties" code="prdt" description="Properties to be set in the new duplicated object(s)." type="record" optional="yes">
117 <cocoa key="WithProperties"/>
118 </parameter>
119 <result description="the duplicated object(s)" type="specifier"/>
120 </command>
121 <command name="exists" code="coredoex" description="Verify if an object exists.">
122 <cocoa class="NSExistsCommand"/>
123 <direct-parameter description="the object in question" type="any"/>
124 <result description="true if it exists, false if not" type="boolean"/>
125 </command>
126 <command name="make" code="corecrel" description="Make a new object.">
127 <cocoa class="NSCreateCommand"/>
128 <parameter name="new" code="kocl" description="The class of the new object." type="type">
129 <cocoa key="ObjectClass"/>
130 </parameter>
131 <parameter name="at" code="insh" description="The location at which to insert the object." type="location specifier" optional="yes">
132 <cocoa key="Location"/>
133 </parameter>
134 <parameter name="with data" code="data" description="The initial contents of the object." type="any" optional="yes">
135 <cocoa key="ObjectData"/>
136 </parameter>
137 <parameter name="with properties" code="prdt" description="The initial values for properties of the object." type="record" optional="yes">
138 <cocoa key="KeyDictionary"/>
139 </parameter>
140 <result description="to the new object" type="specifier"/>
141 </command>
142 <command name="move" code="coremove" description="Move object(s) to a new location.">
143 <cocoa class="NSMoveCommand"/>
144 <direct-parameter description="the object(s) to move" type="specifier"/>
145 <parameter name="to" code="insh" description="The new location for the object(s)." type="location specifier">
146 <cocoa key="ToLocation"/>
147 </parameter>
148 <result description="the moved object(s)" type="specifier"/>
149 </command>
150 <!-- NSCoreSuite doesn't define these.
151 <command name="run" code="aevtoapp" description="Run an application. Most applications will open an empty, untitled window."/>
152 <command name="reopen" code="aevtrapp" description="Reactivate a running application. Some applications will open a new untitled window if no window is open."/>
154 <command name="print" code="aevtpdoc" description="Print an object.">
155 <!-- type would be better written as "file | document". -->
156 <direct-parameter description="The file(s) or document(s) to be printed." type="specifier"/>
157 </command>
158 <!-- "set" is supposed to be hidden. -->
159 <command name="set" code="coresetd" description="Set an object&apos;s data.">
160 <cocoa class="NSSetCommand"/>
161 <direct-parameter type="specifier"/>
162 <!-- "set" is supposed to return the fully evaluated "to" data.
163 <result type="any"/>
165 <parameter name="to" code="data" description="The new value." type="any">
166 <cocoa key="Value"/>
167 </parameter>
168 </command>
169 <!-- "get" is supposed to be hidden. -->
170 <command name="get" code="coregetd" description="Get the data for an object.">
171 <cocoa class="NSGetCommand"/>
172 <direct-parameter type="specifier"/>
173 <result type="any"/>
174 </command>
175 </suite>
176 <suite name="Chromium Suite" code="CrSu" description="Common classes and commands for Chrome.">
177 <class-extension description="The application&apos;s top-level scripting object." extends="application">
178 <cocoa class="BrowserCrApplication"/>
179 <element description="Contains the bookmarks bar and other bookmarks folder." type="bookmark folder" access="r">
180 <cocoa key="bookmarkFolders"/>
181 </element>
182 <property name="bookmarks bar" code="ChBB" description="The bookmarks bar bookmark folder." type="bookmark folder" access="r">
183 <cocoa key="bookmarksBar"/>
184 </property>
185 <property name="other bookmarks" code="ChOB" description="The other bookmarks bookmark folder." type="bookmark folder" access="r">
186 <cocoa key="otherBookmarks"/>
187 </property>
188 </class-extension>
189 <class name="tab" code="CrTb" description="A tab.">
190 <cocoa class="TabAppleScript"/>
191 <property name="id" code="ID " description="Unique ID of the tab." type="integer" access="r">
192 <cocoa key="uniqueID"/>
193 </property>
194 <property name="title" code="pnam" description="The title of the tab." type="text" access="r"/>
195 <property name="URL" code="URL " description="The url visible to the user." type="text"/>
196 <property name="loading" code="ldng" description="Is loading?" type="boolean" access="r"/>
197 <responds-to command="undo">
198 <cocoa method="handlesUndoScriptCommand:"/>
199 </responds-to>
200 <responds-to command="redo">
201 <cocoa method="handlesRedoScriptCommand:"/>
202 </responds-to>
203 <responds-to command="cut selection">
204 <cocoa method="handlesCutScriptCommand:"/>
205 </responds-to>
206 <responds-to command="copy selection">
207 <cocoa method="handlesCopyScriptCommand:"/>
208 </responds-to>
209 <responds-to command="paste selection">
210 <cocoa method="handlesPasteScriptCommand:"/>
211 </responds-to>
212 <responds-to command="select all">
213 <cocoa method="handlesSelectAllScriptCommand:"/>
214 </responds-to>
215 <responds-to command="go back">
216 <cocoa method="handlesGoBackScriptCommand:"/>
217 </responds-to>
218 <responds-to command="go forward">
219 <cocoa method="handlesGoForwardScriptCommand:"/>
220 </responds-to>
221 <responds-to command="reload">
222 <cocoa method="handlesReloadScriptCommand:"/>
223 </responds-to>
224 <responds-to command="stop">
225 <cocoa method="handlesStopScriptCommand:"/>
226 </responds-to>
227 <responds-to command="print">
228 <cocoa method="handlesPrintScriptCommand:"/>
229 </responds-to>
230 <responds-to command="view source">
231 <cocoa method="handlesViewSourceScriptCommand:"/>
232 </responds-to>
233 <responds-to command="save">
234 <cocoa method="handlesSaveScriptCommand:"/>
235 </responds-to>
236 <responds-to command="close">
237 <cocoa method="handlesCloseScriptCommand:"/>
238 </responds-to>
239 <responds-to command="execute">
240 <cocoa method="handlesExecuteJavascriptScriptCommand:"/>
241 </responds-to>
242 </class>
243 <class name="bookmark folder" code="CrBF" description="A bookmarks folder that contains other bookmarks folder and bookmark items.">
244 <cocoa class="BookmarkFolderAppleScript"/>
245 <element description="The bookmark folders present within." type="bookmark folder">
246 <cocoa key="bookmarkFolders"/>
247 </element>
248 <element description="The bookmarks present within." type="bookmark item">
249 <cocoa key="bookmarkItems"/>
250 </element>
251 <property name="id" code="ID " description="Unique ID of the bookmark folder." type="number" access="r">
252 <cocoa key="uniqueID"/>
253 </property>
254 <property name="title" code="pnam" description="The title of the folder." type="text"/>
255 <property name="index" code="indx" description="Returns the index with respect to its parent bookmark folder" type="number" access="r"/>
256 </class>
257 <class name="bookmark item" code="CrBI" description="An item consists of an URL and the title of a bookmark">
258 <cocoa class="BookmarkItemAppleScript"/>
259 <property name="id" code="ID " description="Unique ID of the bookmark item." type="integer" access="r">
260 <cocoa key="uniqueID"/>
261 </property>
262 <property name="title" code="pnam" description="The title of the bookmark item." type="text"/>
263 <property name="URL" code="URL " description="The URL of the bookmark." type="text"/>
264 <property name="index" code="indx" description="Returns the index with respect to its parent bookmark folder" type="number" access="r"/>
265 </class>
266 <class-extension extends="window">
267 <property name="presenting" code="pres" description="Whether the window is in presentation mode." type="boolean" access="r">
268 <cocoa key="presenting"/>
269 </property>
270 <responds-to command="enter presentation mode">
271 <cocoa method="handlesEnterPresentationMode:"/>
272 </responds-to>
273 <responds-to command="exit presentation mode">
274 <cocoa method="handlesExitPresentationMode:"/>
275 </responds-to>
276 </class-extension>
277 <command name="reload" code="CrSuRlod" description="Reload a tab.">
278 <direct-parameter description="The tab to execute the command in." type="specifier"/>
279 </command>
280 <command name="go back" code="CrSuBack" description="Go Back (If Possible).">
281 <direct-parameter description="The tab to execute the command in." type="specifier"/>
282 </command>
283 <command name="go forward" code="CrSuFwd " description="Go Forward (If Possible).">
284 <direct-parameter description="The tab to execute the command in." type="specifier"/>
285 </command>
286 <command name="select all" code="CrSuSlAl" description="Select all.">
287 <direct-parameter description="The tab to execute the command in." type="specifier"/>
288 </command>
289 <command name="cut selection" code="CrSuCut " description="Cut selected text (If Possible).">
290 <direct-parameter description="The tab to execute the command in." type="specifier"/>
291 </command>
292 <command name="copy selection" code="CrSuCop " description="Copy text.">
293 <direct-parameter description="The tab to execute the command in." type="specifier"/>
294 </command>
295 <command name="paste selection" code="CrSuPast" description="Paste text (If Possible).">
296 <direct-parameter description="The tab to execute the command in." type="specifier"/>
297 </command>
298 <command name="undo" code="CrSuUndo" description="Undo the last change.">
299 <direct-parameter description="The tab to execute the command in." type="specifier"/>
300 </command>
301 <command name="redo" code="CrSuRedo" description="Redo the last change.">
302 <direct-parameter description="The tab to execute the command in." type="specifier"/>
303 </command>
304 <command name="stop" code="CrSustop" description="Stop the current tab from loading.">
305 <direct-parameter description="The tab to execute the command in." type="specifier"/>
306 </command>
307 <command name="view source" code="CrSuVSrc" description="View the HTML source of the tab.">
308 <direct-parameter description="The tab to execute the command in." type="specifier"/>
309 </command>
310 <command name="execute" code="CrSuExJa" description="Execute a piece of javascript.">
311 <direct-parameter description="The tab to execute the command in." type="specifier"/>
312 <parameter name="javascript" code="JvSc" description="The javascript code to execute." type="text">
313 <cocoa key="javascript"/>
314 </parameter>
315 <result type="any"/>
316 </command>
317 <command name="enter presentation mode" code="CrSuEnPM" description="Enter presentation mode in window.">
318 <direct-parameter description="The window to enter presentation mode." type="specifier"/>
319 </command>
320 <command name="exit presentation mode" code="CrSuExPM" description="Exit presentation mode in window.">
321 <direct-parameter description="The window to exit presentation mode." type="specifier"/>
322 </command>
323 </suite>
324 </dictionary>