# IBEditors documentation

### Authors

Generated by heron

### Contents -

1. Software documentation for the IBEditors protocol
2. Software documentation for the IBSelectionOwners protocol

# Software documentation for the IBEditors protocol

## IBEditors

> Declared in:
>   InterfaceBuilder/IBEditors.h

> Conforms to:
>   NSObject

The IBEditors protocol defines the methods an editor must implement.
Method summary

- -acceptsTypeFromArray:
- -activate
- -close
- -closeSubeditors
- -deactivate
- -deleteSelection
- -document
- -editedObject
- -initWithObject:inDocument:
- -openSubeditorForObject:
- -orderFront
- -pasteInSelection
- -resetObject:
- -validateEditing
- -wantsSelection
- -window

### acceptsTypeFromArray:

- (BOOL) acceptsTypeFromArray: (NSArray*)types;
Decide whether an editor can accept data from the pasteboard.

### activate

- (BOOL) activate;
Activate an editor - inserts it into the view hierarchy or whatever is needed for the editor to be able to provide its functionality. This method should be called by the document when an editor is created or opened. It should be safe to call repeatedly.

### close

- (void) close;
Close an editor - this destroys the editor. In this method the editor should tell its document that it has been closed, so that the document can remove all its references to the editor.

### closeSubeditors

- (void) closeSubeditors;
Close all subeditors associated with this editor.

### deactivate

- (void) deactivate;
Deactivate an editor - removes it from the view hierarchy so that objects can be archived without including the editor. This method should be called automatically by the 'close' method. It should be safe to call repeatedly.

### deleteSelection

- (void) deleteSelection;
This method deletes all the objects in the current selection in the editor.

### document

- (id/*<IBDocuments>*/) document;
This method returns the document that owns the object that the editor edits.

### editedObject

- (id) editedObject;
This method returns the object that the editor is editing.

### initWithObject: inDocument:

- (id) initWithObject: (id)anObject inDocument: (id/*<IBDocuments>*/)aDocument;
Initializes the editor with object for the specified document.

### openSubeditorForObject:

- (id<IBEditors>) openSubeditorForObject: (id)object;
Opens the subeditor for an object when the object being edited is double clicked by the user. If there is no sub-editor, return `nil`, otherwise method will return the editor for the object.

### orderFront

- (void) orderFront;
This method is used to ensure that the editor is visible on screen.

### pasteInSelection

- (void) pasteInSelection;
This method is used to add the contents of the pasteboard to the current selection of objects within the editor.

### resetObject:

- (void) resetObject: (id)anObject;
Redraws the edited object

### validateEditing

- (void) validateEditing;
Causes the editor to select the text being edited in the current text field.

### wantsSelection

- (BOOL) wantsSelection;
When an editor resigns the selection ownership, all editors are asked if they want selection ownership, and the first one to return `YES` gets made into the current selection owner.

### window

- (NSWindow*) window;
This returns the window in which the editor is drawn.

# Software documentation for the IBSelectionOwners protocol

## IBSelectionOwners

> Declared in:
>   InterfaceBuilder/IBEditors.h

> Conforms to:
>   NSObject

The IBSelectionOwners protocol defines the methods that a selection owner must implement.
Method summary

- -copySelection
- -drawSelection
- -makeSelectionVisible:
- -selectObjects:
- -selection
- -selectionCount

### copySelection

- (void) copySelection;
This method places the current selection from the editor on the pasteboard.

### drawSelection

- (void) drawSelection;
Draw the selection.

### makeSelectionVisible:

- (void) makeSelectionVisible: (BOOL)flag;
This method is used to draw or remove markup that identifies selected objects within the object being edited.

### selectObjects:

- (void) selectObjects: (NSArray*)objects;
This method changes the current selection to those objects in the array.

### selection

- (NSArray*) selection;
Return the selection in an array.

### selectionCount

- (NSUInteger) selectionCount;
The number of currently selected objects.