# GormDocument documentation

### Authors

Generated by heron

### Contents -

1. Software documentation for the GormDocument class
2. Software documentation for the GormEditorToParent class
3. Software documentation for the GormFirstResponder class
4. Software documentation for the GormObjectToEditor class
5. Software documentation for the GormDocument(MenuValidation) category

# Software documentation for the GormDocument class

## GormDocument : NSDocument

> Declared in:
>   GormCore/GormDocument.h

> Conforms to:
>   IBDocuments
>   GSNibContainer
>   NSCoding

Description forthcoming.

Instance Variables
Method summary

- -isEditingClasses
- -isEditingImages
- -isEditingObjects
- -isEditingSounds
- -addAttributeToClass:
- -alignSelectedObjects:
- -allManagedPboardTypes
- -arrangeSelectedObjects:
- -changeToTopLevelEditorAcceptingTypes:andFileType:
- -changeToViewWithTag:
- -classIsSelected
- -classManager
- -closeAllEditors
- -createClassFiles:
- -createResourceManagers
- -createSubclass:
- -deactivateEditors
- -deferredWindows
- -exportStrings:
- -filePrefsManager
- -filesOwner
- -firstResponder
- -fontManager
- -handleNotification:
- -images
- -infoData
- -instantiateClass:
- -isActive
- -isDocumentOpen
- -isOlderArchive
- -isTopLevelObject:
- -loadClass:
- -objectIsDeferred:
- -objectIsVisibleAtLaunch:
- -openImage:
- -openSound:
- -reactivateEditors
- -rebuildObjToNameMapping
- -recentDocumentsMenu
- -refreshConnectionsForClassNamed:
- -remove:
- -removeAllInstancesOfClass:
- -removeConnectionsForClassNamed:
- -removeConnectionsWithLabel:forClassNamed:isAction:
- -renameConnectionsForClassNamed:toName:
- -resourceManagerForPasteboard:
- -resourceManagers
- -retrieveObjectsForParent:recursively:
- -scmWrapper
- -selectClass:
- -selectClass:editClass:
- -servicesMenu
- -setDocumentActive:
- -setDocumentOpen:
- -setImages:
- -setInfoData:
- -setObject:isDeferred:
- -setObject:isVisibleAtLaunch:
- -setOlderArchive:
- -setRecentDocumentsMenu:
- -setSCMWrapper:
- -setServicesMenu:
- -setSounds:
- -setWindowsMenu:
- -sounds
- -translate:
- -viewWithTag:
- -visibleWindows
- -window
- -windowAndRect:forObject:
- -windowsMenu

### addAttributeToClass:

- (id) addAttributeToClass: (id)sender;
Add an outlet/action to the classes view.

### alignSelectedObjects:

- (void) alignSelectedObjects: (id)sender;
Aligns selected objects on a given axis.
Align objects to center, left, right, top, bottom.

### allManagedPboardTypes

- (NSArray*) allManagedPboardTypes;
Returns all pasteboard types registered for with the IBResourceManager.
Get all pasteboard types managed by the resource manager.

### arrangeSelectedObjects:

- (void) arrangeSelectedObjects: (id)sender;
Arrages selected objects based on the either in front of or in back of the view stack.
Arrange views in front or in back of one another.

### changeToTopLevelEditorAcceptingTypes: andFileType:

- (void) changeToTopLevelEditorAcceptingTypes: (NSArray*)types andFileType: (NSString*)fileType;
Switch to the top level editor responsible for a given type. This allows the document in the view to switch to the view which is appropriate for the resource being dragged in.

### changeToViewWithTag:

- (void) changeToViewWithTag: (int)tag;
Switches to the view using the specified tag. They are 0=objects, 1=images, 2=sounds, 3=classes, 4=file prefs.

### classIsSelected

- (BOOL) classIsSelected;
Returns `YES`, if the current select on the classes view is a class.

### classManager

- (GormClassManager*) classManager;
The class manager.

### closeAllEditors

- (void) closeAllEditors;
Forces the closing of all editors in the document.

### createClassFiles:

- (id) createClassFiles: (id)sender;
Create the class files for the selected class.

### createResourceManagers

- (void) createResourceManagers;
Create resource manager instances for all registered classes.

### createSubclass:

- (id) createSubclass: (id)sender;
Create a subclass of the currently selected class in the classes view.

### deactivateEditors

- (void) deactivateEditors;
Deactivate the editors for archiving..

### deferredWindows

- (NSSet*) deferredWindows;
Windows deferred.
All windows marked, deferred.

### exportStrings:

- (void) exportStrings: (id)sender;
This method is used to export all strings in a document to a file for Language translation. This allows the user to see all of the strings which can be translated and allows the user to provide a translateion for each of them.

### filePrefsManager

- (GormFilePrefsManager*) filePrefsManager;
File preferences.
Gorm file prefs manager.

### filesOwner

- (GormFilesOwner*) filesOwner;
File's Owner
File's owner...

### firstResponder

- (id) firstResponder;
Returns stand-in object for firstResponder
Return first responder stand in.

### fontManager

- (id) fontManager;
Returns stand-in object for fontManager.
Return font manager stand in.

### handleNotification:

- (void) handleNotification: (NSNotification*)aNotification;
Handle all notifications. Checks the value of [ aNotification name] against the set of notifications this class responds to and takes appropriate action.

### images

- (NSArray*) images;
Images

### infoData

- (NSData*) infoData;
return the file info.

### instantiateClass:

- (id) instantiateClass: (id)sender;
Create an instance of a given class.

### isActive

- (BOOL) isActive;
Returns `YES`, if document is active.

### isDocumentOpen

- (BOOL) isDocumentOpen;
Return the document open flag.

### isOlderArchive

- (BOOL) isOlderArchive;
Return `YES` if this is an older archive.

### isTopLevelObject:

- (BOOL) isTopLevelObject: (id)obj;
Returns `YES`, if obj is a top level object.

### loadClass:

- (id) loadClass: (id)sender;
Load a class into the document.
Parse a header into the classes view.

### objectIsDeferred:

- (BOOL) objectIsDeferred: (id)anObject;
Return `YES`, if anObject is deferred.
Return `YES`, if the anObject is in the deferred list.

### objectIsVisibleAtLaunch:

- (BOOL) objectIsVisibleAtLaunch: (id)anObject;
Return `YES`, if anObject is visible at launch time.

### openImage:

- (id) openImage: (id)sender;
Open an image and copy it into the document.

### openSound:

- (id) openSound: (id)sender;
Open a sound and load it into the document.

### reactivateEditors

- (void) reactivateEditors;
Reactivate all of the editors...

### rebuildObjToNameMapping

- (void) rebuildObjToNameMapping;
Build our reverse mapping information and other initialisation

### recentDocumentsMenu

- (NSMenu*) recentDocumentsMenu;
Returns the menu which will be the recent documents menu for the document.
Return the object that will be the receent documents menu.

### refreshConnectionsForClassNamed:

- (void) refreshConnectionsForClassNamed: (NSString*)className;
Refresh all connections to any and all instances of className. Checks if the class has the action/outlet present and deletes it, if it doesn't.

### remove:

- (id) remove: (id)sender;
Remove a class from the classes view

### removeAllInstancesOfClass:

- (void) removeAllInstancesOfClass: (NSString*)className;
Remove all instances of a given class.

### removeConnectionsForClassNamed:

- (BOOL) removeConnectionsForClassNamed: (NSString*)className;
Remove all connections to any and all instances of className.

### removeConnectionsWithLabel: forClassNamed: isAction:

- (BOOL) removeConnectionsWithLabel: (NSString*)name forClassNamed: (NSString*)className isAction: (BOOL)action;
Removes all connections given action or outlet with the specified label (paramter name) class name (parameter className).

### renameConnectionsForClassNamed: toName:

- (BOOL) renameConnectionsForClassNamed: (NSString*)className toName: (NSString*)newName;
Rename connections connected to an instance of on class to another.

### resourceManagerForPasteboard:

- (IBResourceManager*) resourceManagerForPasteboard: (NSPasteboard*)pboard;
Get the resource manager which handles the content on pboard.

### resourceManagers

- (NSArray*) resourceManagers;
The list of all resource managers.

### retrieveObjectsForParent: recursively:

- (NSArray*) retrieveObjectsForParent: (id)parent recursively: (BOOL)flag;
Retrieve all objects which have parent as thier parent. If flag is `YES`, then retrieve the entire graph of objects starting with the parent.
Pull all of the objects which are under a given parent. Returns an autoreleased array.

### scmWrapper

- (NSFileWrapper*) scmWrapper;
Save the SCM directory.

### selectClass:

- (void) selectClass: (NSString*)className;
Select a class in the classes view

### selectClass: editClass:

- (void) selectClass: (NSString*)className editClass: (BOOL)flag;
Select a class in the classes view

### servicesMenu

- (NSMenu*) servicesMenu;
Returns the services menu for the document.
Return the object that will be the services menu.

### setDocumentActive:

- (void) setDocumentActive: (BOOL)flag;
Marks this document as the currently active document. The active document is the one being edited by the user.

### setDocumentOpen:

- (void) setDocumentOpen: (BOOL)flag;
Set the document open flag.

### setImages:

- (void) setImages: (NSArray*)imgs;
Images

### setInfoData:

- (void) setInfoData: (NSData*)data;
Set the file info for this document.

### setObject: isDeferred:

- (void) setObject: (id)anObject isDeferred: (BOOL)flag;
Add object to the defferred list.
Add anObject to the deferred list.

### setObject: isVisibleAtLaunch:

- (void) setObject: (id)anObject isVisibleAtLaunch: (BOOL)flag;
Add object to the visible at launch list.

### setOlderArchive:

- (void) setOlderArchive: (BOOL)flag;
Set the "older archive" flag.

### setRecentDocumentsMenu:

- (void) setRecentDocumentsMenu: (NSMenu*)anObject;
Sets the recent documents menu.
Set the menu that will be the recent documents menu in the app.

### setSCMWrapper:

- (void) setSCMWrapper: (NSFileWrapper*)wrapper;
Save the SCM directory.

### setServicesMenu:

- (void) setServicesMenu: (NSMenu*)anObject;
Set the services menu.
Set the object that will be the services menu in the app.

### setSounds:

- (void) setSounds: (NSArray*)snds;
Sounds

### setWindowsMenu:

- (void) setWindowsMenu: (NSMenu*)anObject;
Sets the windows menu.
Set the windows menu.

### sounds

- (NSArray*) sounds;
Sounds

### translate:

- (void) translate: (id)sender;
This method is used to translate all of the strings in the file from one language into another. This is helpful when attempting to translate an application for use in different locales.

### viewWithTag:

- (NSView*) viewWithTag: (int)tag;
returns the view using the specified tag . They are 0=objects, 1=images, 2=sounds, 3=classes, 4=file prefs.

### visibleWindows

- (NSSet*) visibleWindows;
Windows visible at launch...
All windows marked, visible at launch.

### window

- (NSWindow*) window;
The document window.

### windowAndRect: forObject:

- (NSWindow*) windowAndRect: (NSRect*)r forObject: (id)object;
WindowAndRect:forObject: is called by Gorm to determine where it should draw selection markup
Returns the window and the rect r for object.

### windowsMenu

- (NSMenu*) windowsMenu;
Returns the menu which will be the windows menu for the document.
return the windows menu.

## Instance Variables for GormDocument Class

### classManager

@protected GormClassManager* classManager;
Description forthcoming.

### classesScrollView

@protected NSScrollView* classesScrollView;
Description forthcoming.

### classesView

@protected id classesView;
Description forthcoming.

### connections

@protected NSMutableArray* connections;
Description forthcoming.

### deferredWindows

@protected NSMutableSet* deferredWindows;
Description forthcoming.

### filePrefsManager

@protected GormFilePrefsManager* filePrefsManager;
Description forthcoming.

### filePrefsView

@protected id filePrefsView;
Description forthcoming.

### filePrefsWindow

@protected NSWindow* filePrefsWindow;
Description forthcoming.

### filesOwner

@protected GormFilesOwner* filesOwner;
Description forthcoming.

### firstResponder

@protected GormFirstResponder* firstResponder;
Description forthcoming.

### fontManager

@protected GormObjectProxy* fontManager;
Description forthcoming.

### hidden

@protected NSMutableArray* hidden;
Description forthcoming.

### images

@protected NSMutableArray* images;
Description forthcoming.

### imagesScrollView

@protected NSScrollView* imagesScrollView;
Description forthcoming.

### imagesView

@protected id imagesView;
Description forthcoming.

### infoData

@protected NSData* infoData;
Description forthcoming.

### isActive

@protected BOOL isActive;
Description forthcoming.

### isDocumentOpen

@protected BOOL isDocumentOpen;
Description forthcoming.

### isOlderArchive

@protected BOOL isOlderArchive;
Description forthcoming.

### lastEditor

@protected id lastEditor;
Description forthcoming.

### nameTable

@protected NSMutableDictionary* nameTable;
Description forthcoming.

### objToName

@protected NSMapTable* objToName;
Description forthcoming.

### objectsView

@protected id objectsView;
Description forthcoming.

### openEditors

@protected NSMutableArray* openEditors;
Description forthcoming.

### quitItem

@protected NSMenuItem* quitItem;
Description forthcoming.

### resourceManagers

@protected NSMutableArray* resourceManagers;
Description forthcoming.

### savedEditors

@protected NSMutableArray* savedEditors;
Description forthcoming.

### savedMenu

@protected NSMenu* savedMenu;
Description forthcoming.

### scmWrapper

@protected NSFileWrapper* scmWrapper;
Description forthcoming.

### scrollView

@protected NSScrollView* scrollView;
Description forthcoming.

### selectionBox

@protected NSBox* selectionBox;
Description forthcoming.

### sounds

@protected NSMutableArray* sounds;
Description forthcoming.

### soundsScrollView

@protected NSScrollView* soundsScrollView;
Description forthcoming.

### soundsView

@protected id soundsView;
Description forthcoming.

### toolbar

@protected NSToolbar* toolbar;
Description forthcoming.

### topLevelObjects

@protected NSMutableSet* topLevelObjects;
Description forthcoming.

### visibleWindows

@protected NSMutableSet* visibleWindows;
Description forthcoming.

### window

@protected GormDocumentWindow* window;
Description forthcoming.

# Software documentation for the GormEditorToParent class

## GormEditorToParent : NSNibConnector

> Declared in:
>   GormCore/GormDocument.h

Description forthcoming.

# Software documentation for the GormFirstResponder class

## GormFirstResponder : NSObject

> Declared in:
>   GormCore/GormDocument.h

Description forthcoming.

# Software documentation for the GormObjectToEditor class

## GormObjectToEditor : NSNibConnector

> Declared in:
>   GormCore/GormDocument.h

Description forthcoming.

# Software documentation for the GormDocument(MenuValidation) category

## GormDocument(MenuValidation)

> Declared in:
>   GormCore/GormDocument.h

Description forthcoming.
Method summary

- -isEditingClasses
- -isEditingImages
- -isEditingObjects
- -isEditingSounds

### isEditingClasses

- (BOOL) isEditingClasses;
Returns `YES` if the document is editing classes.

### isEditingImages

- (BOOL) isEditingImages;
Returns `YES` if the document is editing images.

### isEditingObjects

- (BOOL) isEditingObjects;
Returns `YES` if the document is editing instance/objects.

### isEditingSounds

- (BOOL) isEditingSounds;
Returns `YES` if the document is editing sounds.