Class

NSPositional​Specifier

Instances of NSPositional​Specifier specify an insertion point in a container relative to another object in the container, for example, before first word or after paragraph 4. The container is specified by an instance of NSScript​Object​Specifier. NSPositional​Specifier objects commonly encapsulate object specifiers used as arguments to the make (create) and move commands and indicate where the created or moved object is to be inserted relative to the object represented by an object specifier.

Overview

Invoking an accessor method to obtain information about an instance of NSPositional​Specifier causes the object to be evaluated if it hasn’t been already.

You don’t normally subclass NSPositional​Specifier.

Nested Types

NSPositional​Specifier.Insertion​Position

The following constants are defined by NSPositional​Specifier to specify an insertion position.

Symbols

Initializing a positional specifier

init(position:​ NSPositional​Specifier.Insertion​Position, object​Specifier:​ NSScript​Object​Specifier)

Initializes a positional specifier with a given position relative to another given specifier.

Accessing information about a positional specifier

var insertion​Container:​ Any?

Returns the container in which the new or copied object or objects should be placed.

var insertion​Index:​ Int

Returns an insertion index that indicates where the new or copied object or objects should be placed.

var insertion​Key:​ String?

Returns the key that identifies the relationship into which the new or copied object or objects should be inserted.

var insertion​Replaces:​ Bool

Returns a Boolean value that indicates whether evaluation has been successful and the object to be inserted should actually replace the keyed, indexed object in the insertion container.

var object​Specifier:​ NSScript​Object​Specifier

Returns the object specifier specified at initialization time.

var position:​ NSPositional​Specifier.Insertion​Position

Returns the insertion position specified at initialization time.

func set​Insertion​Class​Description(NSScript​Class​Description)

Sets the class description for the object or objects to be inserted.

Evaluating a positional specifier

func evaluate()

Causes the receiver to evaluate its position.

Constants

NSPositional​Specifier.Insertion​Position

The following constants are defined by NSPositional​Specifier to specify an insertion position.

Relationships

Inherits From