NSDeleteCommand Class Reference
| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/Foundation.framework |
| Availability | Available in OS X v10.0 and later. |
| Declared in | NSScriptStandardSuiteCommands.h |
| Companion guides |
Overview
An instance of NSDeleteCommand deletes the specified scriptable object or objects (such as words, paragraphs, and so on).
Suppose, for example, a user executes a script that sends the command delete the third rectangle in the first document to the Sketch sample application (located in /Developer/Examples/AppKit). Cocoa creates an NSDeleteCommand object to perform the operation. When the command is executed, it uses the key-value coding mechanism (by invoking removeValueAtIndex:fromPropertyWithKey:) to remove the specified object or objects from their container. See the description for removeValueAtIndex:fromPropertyWithKey: for related information.
NSDeleteCommand is part of Cocoa’s built-in scripting support. Most applications don’t need to subclass NSDeleteCommand or call its methods.
Instance Methods
keySpecifier
Returns a specifier for the object or objects to be deleted.
Return Value
A specifier for the object or objects to be deleted.
Discussion
Note that this may be different than the specifier or specifiers set by setReceiversSpecifier:.
Availability
- Available in OS X v10.0 and later.
Declared In
NSScriptStandardSuiteCommands.hsetReceiversSpecifier:
Sets the receiver’s object specifier.
Parameters
- receiversRef
The receiver’s object specifier.
Discussion
This method overrides setReceiversSpecifier: in NSScriptCommand. It performs the same function as the overridden method, with a critical difference: it causes the container specifier part of the passed-in object specifier to become the receiver specifier of the command, and the key part of the passed-in object specifier to become the key specifier. If, for example, receiversRef is a specifier for the third rectangle of the first document, the receiver specifier is the first document while the key specifier is the third rectangle.
Availability
- Available in OS X v10.0 and later.
Declared In
NSScriptStandardSuiteCommands.h© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)