Class

NSScriptObjectSpecifier

NSScriptObjectSpecifier is the abstract superclass for classes that instantiate objects called “object specifiers.” An object specifier represents an AppleScript reference form, which is a natural-language expression such as words 10 through 20 or front document or words whose color is red.

Overview

The scripting system maps these words or phrases to attributes and relationships of scriptable objects. A reference form rarely occurs in isolation; usually a script statement consists of a series of reference forms preceded by a command and typically connected to each other by of, such as:

get words whose color is blue of paragraph 10 of front document

The expression words whose color is blue of paragraph 10 of front document specifies a location in the application's AppleScript object model—the objects the application makes available to scripters. The classes of objects in the object model often closely match the classes of actual objects in the application, but they are not required to. An object specifier locates objects in the running application that correspond to the specified object model objects.

Your application typically creates object specifiers when it implements the objectSpecifier method for its scriptable classes. That method is defined by the NSScriptObjectSpecifiers protocol.

It is unlikely that you would ever need to create your own subclass of NSScriptObjectSpecifier; the set of valid AppleScript reference forms is determined by Apple Computer and object specifier classes are already implemented for this set. If for some reason you do need to create a subclass, you must override the primitive method indicesOfObjectsByEvaluating(withContainer:count:) to return indices to the elements within the container whose values are matched with the child specifier’s key. In addition, you probably need to declare any special instance variables and implement an initializer that invokes super’s designated initializer, init(containerClassDescription:containerSpecifier:key:), and initializes these variables.

For a comprehensive treatment of object specifiers, including sample code, see Object Specifiers in Cocoa Scripting Guide.

Symbols

Obtaining an object specifier for a descriptor

init?(descriptor: NSAppleEventDescriptor)

Returns a new object specifier for an Apple event descriptor.

Initializing an object specifier

init(containerClassDescription: NSScriptClassDescription, containerSpecifier: NSScriptObjectSpecifier?, key: String)

Returns an NSScriptObjectSpecifier object initialized with the given attributes.

init(containerSpecifier: NSScriptObjectSpecifier, key: String)

Returns an NSScriptObjectSpecifier object initialized with a given container specifier and key.

Evaluating an object specifier

func indicesOfObjectsByEvaluating(withContainer: Any, count: UnsafeMutablePointer<Int>)

This primitive method must be overridden by subclasses to return a pointer to an array of indices identifying objects in the key of a given container that are identified by the receiver of the message.

var objectsByEvaluatingSpecifier: Any?

Returns the actual object represented by the nested series of object specifiers.

func objectsByEvaluating(withContainers: Any)

Returns the actual object or objects specified by the receiver as evaluated in the context of given container object.

Getting, testing, and setting containers

var containerClassDescription: NSScriptClassDescription?

Sets the class description of the receiver’s container specifier to a given specifier.

var containerIsObjectBeingTested: Bool

Sets whether the receiver’s container should be an object involved in a filter reference or the top-level object.

var containerIsRangeContainerObject: Bool

Sets whether the receiver’s container is to be the container for a range specifier or a top-level object.

var container: NSScriptObjectSpecifier?

Sets the container specifier of the receiver.

Getting and setting child references

var child: NSScriptObjectSpecifier?

Sets the receiver’s child reference.

Getting and setting object keys

var key: String

Sets the key of the receiver.

var keyClassDescription: NSScriptClassDescription?

Returns the class description of the objects specified by the receiver.

Getting evaluation errors

var evaluationError: NSScriptObjectSpecifier?

Returns the object specifier in which an evaluation error occurred.

var evaluationErrorNumber: Int

Sets the value of the evaluation error.

Getting a descriptor for the object specifier

var descriptor: NSAppleEventDescriptor?

Returns an Apple event descriptor that represents the receiver.

Constants

NSScriptObjectSpecifier—Specifier Evaluation Errors

NSScriptObjectSpecifier provides the following constants for error codes for specific problems evaluating specifiers:

Relationships

Inherits From