root / trunk / Tag.sdef

Revision 14, 19.6 kB (checked in by stephen_booth, 3 years ago)

Basic AppleScript? support

  • Property svn:keywords set to Id
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE dictionary SYSTEM "file://localhost/System/Library/DTDs/sdef.dtd">
3
4<!--
5
6  $Id$
7
8  Copyright (C) 2005, 2006 Stephen F. Booth <me@sbooth.org>
9
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License
21  along with this program; if not, write to the Free Software
22  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23
24-->
25
26<dictionary title="Tag terminology">
27
28        <!--
29                STANDARD SUITE
30        -->
31        <suite name="Standard Suite" code="core"
32                description="Common classes and commands for all applications.">
33
34                <cocoa name="NSCoreSuite"/>
35
36                <command name="open" code="aevtodoc"
37                        description="Open a document.">
38                        <direct-parameter description="The file(s) to be opened.">
39                                <type type="file"/>
40                                <type type="file" list="yes"/>
41                        </direct-parameter>
42                        <!--
43                                According to TN2106, 'open' should return the resulting document
44                                object.  However, the Cocoa implementation does not do this yet.
45                        <result type="specifier"/>
46                        -->
47                </command>
48
49                <enumeration name="save options" code="savo">
50                        <enumerator name="yes" code="yes " description="Save the file."/>
51                        <enumerator name="no" code="no  " description="Do not save the file."/>
52                        <enumerator name="ask" code="ask "
53                                description="Ask the user whether or not to save the file."/>
54                </enumeration>
55
56                <command name="close" code="coreclos" description="Close a document.">
57                        <cocoa class="NSCloseCommand"/>
58                        <direct-parameter type="specifier"
59                                description="the document(s) or window(s) to close."/>
60                        <parameter name="saving" code="savo" type="save options" optional="yes"
61                                description="Whether or not changes should be saved before closing.">
62                                <cocoa key="SaveOptions"/>
63                        </parameter>
64                        <parameter name="saving in" code="kfil" type="file" optional="yes"
65                                description="The file in which to save the document.">
66                                <cocoa key="File"/>
67                        </parameter>
68                </command>
69
70                <command name="save" code="coresave" description="Save a document.">
71                        <direct-parameter type="specifier"
72                                description="The document(s) or window(s) to save."/>
73                        <parameter name="in" code="kfil" type="file" optional="yes"
74                                description="The file in which to save the document.">
75                                <cocoa key="File"/>
76                        </parameter>
77                        <parameter name="as" code="fltp" type="text" optional="yes"
78                                description="The type of file to save.">
79                                <cocoa key="FileType"/>
80                        </parameter>
81                </command>
82
83                <!--
84                <enumeration name="printing error handling" code="enum">
85                        <enumerator name="standard" code="lwst"
86                                description="Standard PostScript error handling"/>
87                        <enumerator name="detailed" code="lwdt"
88                                description="print a detailed report of PostScript errors"/>
89                </enumeration>
90
91                <record-type name="print settings" code="pset">
92                        <property name="copies" code="lwcp" type="integer"
93                                description="the number of copies of a document to be printed">
94                                <cocoa key="NSCopies"/>
95                        </property>
96                        <property name="collating" code="lwcl" type="boolean"
97                                description="Should printed copies be collated?">
98                                <cocoa key="NSMustCollate"/>
99                        </property>
100                        <property name="starting page" code="lwfp" type="integer"
101                                description="the first page of the document to be printed">
102                                <cocoa key="NSFirstPage"/>
103                        </property>
104                        <property name="ending page" code="lwlp" type="integer"
105                                description="the last page of the document to be printed">
106                                <cocoa key="NSLastPage"/>
107                        </property>
108                        <property name="pages across" code="lwla" type="integer"
109                                description="number of logical pages laid across a physical page">
110                                <cocoa key="NSPagesAcross"/>
111                        </property>
112                        <property name="pages down" code="lwld" type="integer"
113                                description="number of logical pages laid out down a physical page">
114                                <cocoa key="NSPagesDown"/>
115                        </property>
116                        <property name="error handling" code="lweh" type="printing error handling"
117                                description="how errors are handled">
118                                <cocoa key="NSDetailedErrorReporting"/>
119                        </property>
120                        <property name="fax number" code="faxn" type="text"
121                                description="for fax number">
122                                <cocoa key="NSFaxNumber"/>
123                        </property>
124                        <property name="target printer" code="trpr" type="text"
125                                description="for target printer">
126                                <cocoa key="NSPrinterName"/>
127                        </property>
128                </record-type>
129
130                <command name="print" code="aevtpdoc" description="Print a document.">
131                        <direct-parameter
132                                description="The file(s), document(s), or window(s) to be printed.">
133                                <type type="file" list="yes"/>
134                                <type type="specifier"/>
135                        </direct-parameter>
136                        <parameter name="with properties" code="prdt" type="print settings" optional="yes"
137                                description="The print settings to use.">
138                                <cocoa key="PrintSettings"/>
139                        </parameter>
140                        <parameter name="print dialog" code="pdlg" type="boolean" optional="yes"
141                                description="Should the application show the print dialog?">
142                                <cocoa key="ShowPrintDialog"/>
143                        </parameter>
144                </command>
145                -->
146
147                <command name="quit" code="aevtquit" description="Quit the application.">
148                        <cocoa class="NSQuitCommand"/>
149                        <parameter name="saving" code="savo" type="save options" optional="yes"
150                                description="Whether or not changed documents should be saved before closing.">
151                                <cocoa key="SaveOptions"/>
152                        </parameter>
153                </command>
154
155                <command name="count" code="corecnte"
156                        description="Return the number of elements of a particular class within an object.">
157                        <cocoa class="NSCountCommand"/>
158                        <direct-parameter type="specifier"
159                                description="the object whose elements are to be counted"/>
160                        <parameter name="each" code="kocl" type="type" optional="yes"
161                                description="The class of objects to be counted.">
162                                <cocoa key="ObjectClass"/>
163                        </parameter>
164                        <result type="integer" description="the number of elements"/>
165                </command>
166
167                <command name="delete" code="coredelo" description="Delete an object.">
168                        <cocoa class="NSDeleteCommand"/>
169                        <direct-parameter type="specifier" description="the object to delete"/>
170                </command>
171
172                <command name="duplicate" code="coreclon"
173                        description="Copy object(s) and put the copies at a new location.">
174                        <cocoa class="NSCloneCommand"/>
175                        <direct-parameter type="specifier"
176                                description="the object(s) to duplicate"/>
177                        <parameter name="to" code="insh" type="location specifier" optional="yes"
178                                description="The location for the new object(s).">
179                                <cocoa key="ToLocation"/>
180                        </parameter>
181                        <parameter name="with properties" code="prdt" type="record" optional="yes"
182                                description="Properties to be set in the new duplicated object(s).">
183                                <cocoa key="WithProperties"/>
184                        </parameter>
185                        <result type="specifier" description="the duplicated object(s)"/>
186                </command>
187
188                <command name="exists" code="coredoex" description="Verify if an object exists.">
189                        <cocoa class="NSExistsCommand"/>
190                        <direct-parameter type="any" description="the object in question"/>
191                        <result type="boolean" description="true if it exists, false if not"/>
192                </command>
193
194                <command name="make" code="corecrel" description="Make a new object.">
195                        <cocoa class="NSCreateCommand"/>
196                        <parameter name="new" code="kocl" type="type"
197                                description="The class of the new object.">
198                                <cocoa key="ObjectClass"/>
199                        </parameter>
200                        <parameter name="at" code="insh" type="location specifier" optional="yes"
201                                description="The location at which to insert the object.">
202                                <cocoa key="Location"/>
203                        </parameter>
204                        <parameter name="with data" code="data" type="any" optional="yes"
205                                description="The initial contents of the object.">
206                                <cocoa key="ObjectData"/>
207                        </parameter>
208                        <parameter name="with properties" code="prdt" type="record" optional="yes"
209                                description="The initial values for properties of the object.">
210                                <cocoa key="KeyDictionary"/>
211                        </parameter>
212                        <result type="specifier" description="to the new object"/>
213                </command>
214
215                <command name="move" code="coremove" description="Move object(s) to a new location.">
216                        <cocoa class="NSMoveCommand"/>
217                        <direct-parameter type="specifier" description="the object(s) to move"/>
218                        <parameter name="to" code="insh" type="location specifier"
219                                description="The new location for the object(s).">
220                                <cocoa key="ToLocation"/>
221                        </parameter>
222                        <result type="specifier" description="the moved object(s)"/>
223                </command>
224
225                <class name="application" code="capp"
226                        description="Tag's top-level scripting object.">
227                        <cocoa class="NSApplication"/>
228                        <property name="name" code="pnam" type="text" access="r"
229                                description="The name of the application."/>
230                        <property name="frontmost" code="pisf" type="boolean" access="r"
231                                description="Is this the frontmost (active) application?">
232                                <cocoa key="isActive"/>
233                        </property>
234                        <property name="version" code="vers" type="text" access="r"
235                                description="The version of the application."/>
236                        <element type="document">
237                                <cocoa key="files"/>
238                        </element>
239                        <element type="window" access="r">
240                                <cocoa key="orderedWindows"/>
241                        </element>
242                        <responds-to name="open">
243                                <cocoa method="handleOpenScriptCommand:"/>
244                        </responds-to>
245                        <!--
246                        <responds-to name="print">
247                                <cocoa method="handlePrintScriptCommand:"/>
248                        </responds-to>
249                        -->
250                        <responds-to name="quit">
251                                <cocoa method="handleQuitScriptCommand:"/>
252                        </responds-to>
253                </class>
254
255                <class name="document" code="docu" description="An audio file.">
256                        <cocoa class="KeyValueTaggedFile"/>
257                        <property name="name" code="pnam" type="text" access="r"
258                                description="The document's name.">
259                                <cocoa key="displayName"/>
260                        </property>
261                        <property name="modified" code="imod" type="boolean" access="r"
262                                description="Has the document been modified since the last save?">
263                                <cocoa key="dirty"/>
264                        </property>
265                        <property name="file" code="file" type="file" access="r"
266                                description="The document's location on disk.">
267                                <cocoa key="fileURL"/>
268                        </property>
269                        <property name="title" code="titl" type="text"
270                                description="The track's title.">
271                                <cocoa key="title"/>
272                        </property>
273                        <property name="artist" code="arts" type="text"
274                                description="The track's artist.">
275                                <cocoa key="artist"/>
276                        </property>
277                        <property name="album" code="albm" type="text"
278                                description="The track's album.">
279                                <cocoa key="album"/>
280                        </property>
281                        <property name="year" code="year" type="integer"
282                                description="The track's year.">
283                                <cocoa key="year"/>
284                        </property>
285                        <property name="genre" code="genr" type="text"
286                                description="The track's genre.">
287                                <cocoa key="genre"/>
288                        </property>
289                        <property name="composer" code="comp" type="text"
290                                description="The track's composer.">
291                                <cocoa key="composer"/>
292                        </property>
293                        <property name="MCN" code="mcn " type="text"
294                                description="The track's disc media catalog number (MCN).">
295                                <cocoa key="MCN"/>
296                        </property>
297                        <property name="ISRC" code="isrc" type="text"
298                                description="The track's internation standard recording code (ISRC).">
299                                <cocoa key="ISRC"/>
300                        </property>
301                        <property name="encoder" code="encd" type="text"
302                                description="The track's encoding software.">
303                                <cocoa key="encoder"/>
304                        </property>
305                        <property name="comment" code="comm" type="text"
306                                description="The track's comment.">
307                                <cocoa key="comment"/>
308                        </property>
309                        <property name="trackNumber" code="tnum" type="integer"
310                                description="The number of this track.">
311                                <cocoa key="trackNumber"/>
312                        </property>
313                        <property name="trackTotal" code="ttot" type="integer"
314                                description="The total number of tracks on the disc.">
315                                <cocoa key="trackTotal"/>
316                        </property>
317                        <property name="discNumber" code="dnum" type="integer"
318                                description="The number of this disc in the set.">
319                                <cocoa key="discNumber"/>
320                        </property>
321                        <property name="discTotal" code="dtot" type="integer"
322                                description="The total number of discs in the set.">
323                                <cocoa key="discTotal"/>
324                        </property>
325                        <property name="compilation" code="cmpl" type="boolean"
326                                description="Is this track part of a compilation?">
327                                <cocoa key="compilation"/>
328                        </property>
329                        <responds-to name="close">
330                                <cocoa method="handleCloseScriptCommand:"/>
331                        </responds-to>
332                        <!--
333                        <responds-to name="print">
334                                <cocoa method="handlePrintScriptCommand:"/>
335                        </responds-to>
336                        -->
337                        <responds-to name="save">
338                                <cocoa method="handleSaveScriptCommand:"/>
339                        </responds-to>
340                </class>
341
342                <class name="window" code="cwin" description="A window.">
343                        <cocoa class="NSWindow"/>
344                        <property name="name" code="pnam" type="text" access="r"
345                                description="The full title of the window.">
346                                <cocoa key="title"/>
347                        </property>
348                        <property name="id" code="ID  " type="integer" access="r"
349                                description="The unique identifier of the window.">
350                                <cocoa key="uniqueID"/>
351                        </property>
352                        <property name="index" code="pidx" type="integer"
353                                description="The index of the window, ordered front to back.">
354                                <cocoa key="orderedIndex"/>
355                        </property>
356                        <property name="bounds" code="pbnd" type="rectangle"
357                                description="The bounding rectangle of the window.">
358                                <cocoa key="boundsAsQDRect"/>
359                        </property>
360                        <property name="closeable" code="hclb" type="boolean" access="r"
361                                description="Whether the window has a close box.">
362                                <cocoa key="hasCloseBox"/>
363                        </property>
364                        <property name="minimizable" code="ismn" type="boolean" access="r"
365                                description="Whether the window can be minimized.">
366                                <cocoa key="isMiniaturizable"/>
367                        </property>
368                        <property name="minimized" code="pmnd" type="boolean"
369                                description="Whether the window is currently minimized.">
370                                <cocoa key="isMiniaturized"/>
371                        </property>
372                        <property name="resizable" code="prsz" type="boolean" access="r"
373                                description="Whether the window can be resized.">
374                                <cocoa key="isResizable"/>
375                        </property>
376                        <property name="visible" code="pvis" type="boolean"
377                                description="Whether the window is currently visible.">
378                                <cocoa key="isVisible"/>
379                        </property>
380                        <property name="zoomable" code="iszm" type="boolean" access="r"
381                                description="Whether the window can be zoomed.">
382                                <cocoa key="isZoomable"/>
383                        </property>
384                        <property name="zoomed" code="pzum" type="boolean"
385                                description="Whether the window is currently zoomed.">
386                                <cocoa key="isZoomed"/>
387                        </property>
388                        <property name="document" code="docu" type="document" access="r"
389                                description="The document whose contents are being displayed in the window."/>
390                        <responds-to name="close">
391                                <cocoa method="handleCloseScriptCommand:"/>
392                        </responds-to>
393                        <responds-to name="print">
394                                <cocoa method="handlePrintScriptCommand:"/>
395                        </responds-to>
396                        <responds-to name="save">
397                                <cocoa method="handleSaveScriptCommand:"/>
398                        </responds-to>
399                </class>
400
401        </suite>
402
403
404        <!--
405                TEXT SUITE
406        -->
407        <suite name="Text Suite" code="TEXT"
408                description="A set of basic classes for text processing.">
409
410                <cocoa name="NSTextSuite"/>
411
412                <value-type name="color" code="cRGB">
413                        <cocoa class="NSColor"/>
414                </value-type>
415
416                <class name="rich text" plural="rich text" code="ctxt"
417                        description="Rich (styled) text">
418                        <cocoa class="NSTextStorage"/>
419                        <!-- this "type" element and the ones that follow, while they
420                                contradict the DTD, are NOT errors.  Cocoa Scripting in 10.4
421                                uses them to accomplish certain type conversions. -->
422                        <type type="text"/>
423                        <property name="color" code="colr" type="color"
424                                description="The color of the first character.">
425                                <cocoa key="foregroundColor"/>
426                        </property>
427                        <property name="font" code="font" type="text"
428                                description="The name of the font of the first character.">
429                                <cocoa key="fontName"/>
430                        </property>
431                        <property name="size" code="ptsz" type="integer"
432                                description="The size in points of the first character.">
433                                <cocoa key="fontSize"/>
434                        </property>
435                        <element type="character"/>
436                        <element type="paragraph"/>
437                        <element type="word"/>
438                        <element type="attribute run"/>
439                        <element type="attachment"/>
440                </class>
441
442                <class name="character" code="cha "
443                        description="This subdivides the text into characters.">
444                        <cocoa class="NSTextStorage"/>
445                        <type type="text"/>
446                        <property name="color" code="colr" type="color"
447                                description="The color of the first character.">
448                                <cocoa key="foregroundColor"/>
449                        </property>
450                        <property name="font" code="font" type="text"
451                                description="The name of the font of the first character.">
452                                <cocoa key="fontName"/>
453                        </property>
454                        <property name="size" code="ptsz" type="integer"
455                                description="The size in points of the first character.">
456                                <cocoa key="fontSize"/>
457                        </property>
458                        <element type="character"/>
459                        <element type="paragraph"/>
460                        <element type="word"/>
461                        <element type="attribute run"/>
462                        <element type="attachment"/>
463                </class>
464
465                <class name="paragraph" code="cpar"
466                        description="This subdivides the text into paragraphs.">
467                        <cocoa class="NSTextStorage"/>
468                        <type type="text"/>
469                        <property name="color" code="colr" type="color"
470                                description="The color of the first character.">
471                                <cocoa key="foregroundColor"/>
472                        </property>
473                        <property name="font" code="font" type="text"
474                                description="The name of the font of the first character.">
475                                <cocoa key="fontName"/>
476                        </property>
477                        <property name="size" code="ptsz" type="integer"
478                                description="The size in points of the first character.">
479                                <cocoa key="fontSize"/>
480                        </property>
481                        <element type="character"/>
482                        <element type="paragraph"/>
483                        <element type="word"/>
484                        <element type="attribute run"/>
485                        <element type="attachment"/>
486                </class>
487
488                <class name="word" code="cwor"
489                        description="This subdivides the text into words.">
490                        <cocoa class="NSTextStorage"/>
491                        <type type="text"/>
492                        <property name="color" code="colr" type="color"
493                                description="The color of the first character.">
494                                <cocoa key="foregroundColor"/>
495                        </property>
496                        <property name="font" code="font" type="text"
497                                description="The name of the font of the first character.">
498                                <cocoa key="fontName"/>
499                        </property>
500                        <property name="size" code="ptsz" type="integer"
501                                description="The size in points of the first character.">
502                                <cocoa key="fontSize"/>
503                        </property>
504                        <element type="character"/>
505                        <element type="paragraph"/>
506                        <element type="word"/>
507                        <element type="attribute run"/>
508                        <element type="attachment"/>
509                </class>
510
511                <class name="attribute run" code="catr"
512                        description="This subdivides the text into chunks that all have the same attributes.">
513                        <cocoa class="NSTextStorage"/>
514                        <type type="text"/>
515                        <property name="color" code="colr" type="color"
516                                description="The color of the first character.">
517                                <cocoa key="foregroundColor"/>
518                        </property>
519                        <property name="font" code="font" type="text"
520                                description="The name of the font of the first character.">
521                                <cocoa key="fontName"/>
522                        </property>
523                        <property name="size" code="ptsz" type="integer"
524                                description="The size in points of the first character.">
525                                <cocoa key="fontSize"/>
526                        </property>
527                        <element type="character"/>
528                        <element type="paragraph"/>
529                        <element type="word"/>
530                        <element type="attribute run"/>
531                        <element type="attachment"/>
532                </class>
533
534                <class name="attachment" code="atts" inherits="rich text"
535                        description="Represents an inline text attachment. This class is used mainly for make commands.">
536                        <cocoa class="NSAttachmentTextStorage"/>
537                        <property name="file name" code="atfn" type="text"
538                                description="The path to the file for the attachment">
539                                <cocoa key="filename"/>
540                        </property>
541                </class>
542
543        </suite>
544
545        <!--
546                TAG SUITE
547        -->
548        <suite name="Tag Suite" code="Tagg"
549                description="Tag specific classes.">
550       
551        </suite>
552
553</dictionary>
Note: See TracBrowser for help on using the browser.