# IBDocuments documentation

### Authors

Generated by heron

# Software documentation for the IBDocuments protocol

## IBDocuments

> Declared in:
>   InterfaceBuilder/IBDocuments.h

> Conforms to:
>   NSObject

Description forthcoming.
Method summary

- -actionsOfClass:
- -addConnector:
- -allConnectors
- -attachObject:toParent:
- -attachObjects:toParent:
- -classForObject:
- -connectorsForDestination:
- -connectorsForDestination:ofClass:
- -connectorsForSource:
- -connectorsForSource:ofClass:
- -containsObject:
- -containsObjectWithName:forParent:
- -copyObject:type:toPasteboard:
- -copyObjects:type:toPasteboard:
- -detachObject:
- -detachObjects:
- -documentPath
- -editor:didCloseForObject:
- -editorForObject:create:
- -editorForObject:inEditor:create:
- -nameForObject:
- -objectForName:
- -objects
- -openEditorForObject:
- -outletsOfClass:
- -parentEditorForEditor:
- -parentOfObject:
- -pasteType:fromPasteboard:parent:
- -removeConnector:
- -resignSelectionForEditor:
- -setName:forObject:
- -setSelectionFromEditor:
- -touch

### actionsOfClass:

- (NSArray*) actionsOfClass: (NSString*)className;
Description forthcoming.

### addConnector:

- (void) addConnector: (id<IBConnectors>)aConnector;
Add a connection

### allConnectors

- (NSArray*) allConnectors;
Returns an array containing all connections for the receiver.

### attachObject: toParent:

- (void) attachObject: (id)anObject toParent: (id)aParent;
Attaches an object to the document and makes the association with the parent.

### attachObjects: toParent:

- (void) attachObjects: (NSArray*)anArray toParent: (id)aParent;
Iterates over anArray and attaches all objects in it to the receiver with aParent as the parent.

### classForObject:

- (NSString*) classForObject: (id)obj;
Returns a string with the name of the class for the given object.

### connectorsForDestination:

- (NSArray*) connectorsForDestination: (id)destination;
Returns an autoreleased array containing all connections for the given destination.

### connectorsForDestination: ofClass:

- (NSArray*) connectorsForDestination: (id)destination ofClass: (Class)aConnectorClass;
Returns an autoreleased array containing all connectors of the given class for the destination.

### connectorsForSource:

- (NSArray*) connectorsForSource: (id)source;
Returns an autoreleased array containing all connections for the given source.

### connectorsForSource: ofClass:

- (NSArray*) connectorsForSource: (id)source ofClass: (Class)aConnectorClass;
Returns an autoreleased array containing all connectors of the given class for the source.

### containsObject:

- (BOOL) containsObject: (id)anObject;
Returns `YES`, if the receiver contains anObject.

### containsObjectWithName: forParent:

- (BOOL) containsObjectWithName: (NSString*)aName forParent: (id)parent;
Returns `YES`, if the receiver contains an object with the given name and parent.

### copyObject: type: toPasteboard:

- (BOOL) copyObject: (id)anObject type: (NSString*)aType toPasteboard: (NSPasteboard*)aPasteboard;
Copies anObject to the pasteboard with the aType.

### copyObjects: type: toPasteboard:

- (BOOL) copyObjects: (NSArray*)anArray type: (NSString*)aType toPasteboard: (NSPasteboard*)aPasteboard;
Copues an array of objects to aPasteboard with aType.

### detachObject:

- (void) detachObject: (id)anObject;
Detaches anObject from the receiver.

### detachObjects:

- (void) detachObjects: (NSArray*)anArray;
Detaches an array of objects from the receiver.

### documentPath

- (NSString*) documentPath;
The path of the file which represents the document.

### editor: didCloseForObject:

- (void) editor: (id<IBEditors>)anEditor didCloseForObject: (id)anObject;
Called when an editor is closed.

### editorForObject: create:

- (id<IBEditors>) editorForObject: (id)anObject create: (BOOL)flag;
Returns the associated editor for anObject, if flag is `YES`, it will create an instance of the editor class if one does not already exist for the given object.

### editorForObject: inEditor: create:

- (id<IBEditors>) editorForObject: (id)anObject inEditor: (id<IBEditors>)anEditor create: (BOOL)flag;
Returns the associated subeditor for anObject, if flag is `YES`, it will create an instance of the editor.

### nameForObject:

- (NSString*) nameForObject: (id)anObject;
Returns the name associated with the object.

### objectForName:

- (id) objectForName: (NSString*)aName;
Returns the object for the given aName.

### objects

- (NSArray*) objects;
Returns all objects in the receiver's name table.

### openEditorForObject:

- (id<IBEditors>) openEditorForObject: (id)anObject;
Creates an editor, if necessary using editorForObject:create:, opens it and brings the window containing the editor to the front.

### outletsOfClass:

- (NSArray*) outletsOfClass: (NSString*)className;
Description forthcoming.

### parentEditorForEditor:

- (id<IBEditors,IBSelectionOwners>) parentEditorForEditor: (id<IBEditors>)anEditor;
Returns the parent of the given editor.

### parentOfObject:

- (id) parentOfObject: (id)anObject;
Return the parent of anObject. The File's Owner is the root object in the hierarchy, if anObject's parent is the Files's Owner, this method should return `nil`.

### pasteType: fromPasteboard: parent:

- (NSArray*) pasteType: (NSString*)aType fromPasteboard: (NSPasteboard*)aPasteboard parent: (id)parent;
Pastes the given type from the aPasteboard.

### removeConnector:

- (void) removeConnector: (id<IBConnectors>)aConnector;
Remove aConnector from the receiver.

### resignSelectionForEditor:

- (void) resignSelectionForEditor: (id<IBEditors>)editor;
The current editor wants to give up the selection, this method iterates over all editors and determines if any editors will take over the selection. If one is found it is activated.

### setName: forObject:

- (void) setName: (NSString*)aName forObject: (id)object;
Set aName for object in the receiver. This replaces any name the object may have previously had.

### setSelectionFromEditor:

- (void) setSelectionFromEditor: (id<IBEditors>)anEditor;
Sets the currently selected object from the given editor.

### touch

- (void) touch;
Mark document as having been changed.