Developer Documentation
PATH  Mac OS X Documentation > Cocoa > Creating Suite Definitions and Suite Terminology


Previous | Chapter contents | Book PDF

Example of Suite Terminology

The following example is the Core suite ( NSCoreSuite.scriptTerminology ) provided by the Yellow Box frameworks. This file has probably changed since its inclusion in this document; you can obtain an updated version of this file in /System/Library/Frameworks/Scripting.framework/Resources/English.lproj .

{
    "Name" = "Standard Suite";
    "Description" = "Common classes and commands for most applications.";
    "Classes" = {
			"AbstractObject" = {
	    			"Name" = "Abstract object";
	    			"Description" = "Abstract object provides a base class for scripting classes.  It is never used directly.";
	    			"Attributes" = {
							    "className" = {
		                 "Name" = "classname";
		                 "Description" = "The name of the class of the object.";
		            };
		            "classCode" = {
		                 "Name" = "class";
		                 "Description" = "The class of the object.";
		            };
	 			};
			};
			"NSApplication" = {
	    			"Name" = "application";
	    			"Description" = "An application's top level scripting object.";
            "PluralName" = "applications";
	    		   "Attributes" = {
		            "name" = {
		                 "Name" = "name";
		                 "Description" = "The name of the application.";
		            };
		            "isActive" = {
		                 "Name" = "frontmost";
		                 "Description" = "Is this the frontmost (active) application?";
		            };
		            "version" = {
		                 "Name" = "version";
		                 "Description" = "The version of the application.";
		            };
	         	};
	    		};
			"NSDocument" = {
	    			"Name" = "document";
	    			"Description" = "A document.";
            "PluralName" = "documents";
	    			"Attributes" = {
		            "lastComponentOfFileName" = {
		                 "Name" = "name";
		                 "Description" = "The document's name.";
		            };
		            "fileName" = {
		                 "Name" = "path";
		                 "Description" = "The document's path.";
		            };
		            "isDocumentEdited" = {
		                 "Name" = "modified";
		                 "Description" = "Has the document been modified since the last save?";
		            };
	         			};
	    		};
			"NSWindow" = {
	    			"Name" = "window";
	    			"Description" = "A window.";
				"PluralName" = "windows";
	    			"Attributes" = {
				    "hasCloseBox" = {
		                 "Name" = "has close box";
		                 "Description" = "Whether the window has a close box.";
		            };
		            "hasTitleBar" = {
		                 "Name" = "has title bar";
		                 "Description" = "Whether the window has a title bar.";
		            };
		            "orderedIndex" = {
		                 "Name" = "index";
		                 "Description" = "The index of the window in the back-to-front window ordering.";
		            };
		            "isFloatingPanel" = {
		                 "Name" = "is floating";
		                 "Description" = "Whether the window floats.";
		            };
		            "isModalPanel" = {
		                "Name" = "is running modal";
		                 "Description" = "Whether the window is the application's current modal window.";
		            };
		            "isResizable" = {
		                 "Name" = "is resizable";
		                 "Description" = "Whether the window can be resized.";
		            };
		            "isZoomable" = {
		                 "Name" = "is zoomable";
		                 "Description" = "Whether the window can be zoomed.";
		            };
		            "isZoomed" = {
		                 "Name" = "is zoomed";
		                 "Description" = "Whether the window is currently zoomed.";
		            };
		            "isMiniaturizable" = {
		                 "Name" = "is miniaturizable";
		                 "Description" = "Whether the window can be miniaturized.";
		            };
		            "isMiniaturized" = {
		                 "Name" = "is miniaturized";
		                 "Description" = "Whether the window is currently miniaturized.";
		            };
		            "title" = {
		                 "Name" = "name";
		                 "Description" = "The full title of the window.";
		            };
		            "isVisible" = {
		                 "Name" = "is visible";
		                 "Description" = "Whether the window is currently visible.";
		            };
					};
			};
			"NSColor" = {
	    			"Name" = "color";
	    			"Description" = "A color.";
	    			"PluralName" = "colors";
			};
    };


    "Commands" = {
			"Get" = {
	    			"Name" = "get";
	    			"Description" = "Get the data for an object.";
	};
			"Set" = {
	    			"Name" = "set";
	    			"Description" = "Set an object's data.";
	    			"Arguments" = {
				    "Value" = {
		             "Name" = "to";
		             "Description" = "The new value.";
		            };
	         };
	    };
			"Count" = {
	    			"Name" = "count";
	    			"Description" = "Return the number of elements of a particular class within an object.";
			};
			"Exists" = {
	    			"Name" = "exists";
	    			"Description" = "Verify if an object exists.";
			};
			"Delete" = {
	    			"Name" = "delete";
	    			"Description" = "Delete an object.";
			};
			"Move" = {
	    			"Name" = "move";
	    			"Description" = "Move object(s) to a new location.";
	    			"Arguments" = {
				    "ToLocation" = {
		             "Name" = "to";
		             "Description" = "The new location for the object(s).";
		            };
	            };
	        };
			"Copy" = {
	    			"Name" = "duplicate";
	    			"Description" = "Copy object(s) and put the copies at a new location.";
	    			"Arguments" = {
				    "ToLocation" = {
		             "Name" = "to";
		             "Description" = "The location for the new object(s).";
		            };
	             };
	        };
			"Create" = {
	    			"Name" = "make";
	    			"Description" = "Make a new object.";
	    			"Arguments" = {
				    "Location" = {
		                 "Name" = "at";
		                 "Description" = "The location at which to insert the object.";
		        };
		            "ObjectClass" = {
		                 "Name" = "new";
		                 "Description" = "The class of the new object.";
		            };
		            "ObjectData" = {
		                 "Name" = "with data";
		                 "Description" = "The initial data for the object.";
		            };
		            "KeyDictionary" = {
		                 "Name" = "with properties";
		                 "Description" = "The initial values for properties of the object.";
		            };
	             };
	        };
			"Save" = {
	    			"Name" = "save";
	    			"Description" = "Save an object.";
	    			"Arguments" = {
				    "File" = {
		               "Name" = "in";
		               "Description" = "The file in which to save the object.";
				    };
				    "FileType" = {
		               "Name" = "as";
		               "Description" = "The file type in which to save the data.";
		           };
	    			};
			};
			"Close" = {
	    			"Name" = "close";
	    			"Description" = "Close an object.";
	    			"Arguments" = {
				    "File" = {
		               "Name" = "saving in";
		               "Description" = "The file in which to save the object.";
				    };
				    "SaveOptions" = {
		               "Name" = "saving";
		               "Description" = "Specifies whether changes should be saved before closing.";
				    }};
	    			};
			};
			"Open" = {
	    			"Name" = "open";
	    			"Description" = "Open an object.";
			};
			"Print" = {
	   			"Name" = "print";
	    			"Description" = "Print an object.";
			};
    };
}

Creating Suite Definitions and Suite Terminology

Previous | Chapter contents | Book PDF