/* GormDocument.h * * Copyright (C) 1999, 2003 Free Software Foundation, Inc. * * Author: Richard Frith-Macdonald * Author: Gregory John Casamento * Date: 1999, 2003 * * This file is part of GNUstep. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111 USA. */ #ifndef INCLUDED_GormDocument_h #define INCLUDED_GormDocument_h #include #include #include #include @class GormClassManager, GormClassEditor, GormObjectProxy, GormFilesOwner; /* * Each document has a GormFirstResponder object that is used as a placeholder * for the first responder at any instant. */ @interface GormFirstResponder : NSObject { } @end @interface GormDocument : GSNibContainer { GormClassManager *classManager; GormFilesOwner *filesOwner; GormFirstResponder *firstResponder; GormObjectProxy *fontManager; NSString *documentPath; NSMapTable *objToName; NSWindow *window; NSBox *selectionBox; NSScrollView *scrollView; NSScrollView *classesScrollView; NSScrollView *soundsScrollView; NSScrollView *imagesScrollView; id classesView; id objectsView; id soundsView; id imagesView; BOOL hasSetDefaults; BOOL isActive; BOOL isDocumentOpen; NSMenu *savedMenu; NSMenuItem *quitItem; /* Replaced during test-mode */ NSMutableArray *savedEditors; NSMutableArray *hidden; NSMutableArray *openEditors; NSToolbar *toolbar; id lastEditor; BOOL isOlderArchive; id filePrefsView; id filePrefsManager; NSWindow *filePrefsWindow; NSMutableArray *resourceManagers; } /** * Return the types readable by this document class */ + (NSArray *) readableTypes; /* Archiving objects */ /** * Start the archiving process. */ - (void) beginArchiving; /** * Stop the archiving process. */ - (void) endArchiving; /* Handle notifications */ /** * Handle all notifications. Checks the value of [aNotification name] * against the set of notifications this class responds to and takes * appropriate action. */ - (void) handleNotification: (NSNotification*)aNotification; /* Document management */ /** * Returns YES, if document is active. */ - (BOOL) isActive; /** * Return YES, if anObject is visible at launch time. */ - (BOOL) objectIsVisibleAtLaunch: (id)anObject; /** * Return YES, if anObject is deferred. */ - (BOOL) objectIsDeferred: (id)anObject; /** * This assumes we have an empty document to start with - the loaded * document is merged in to it. */ - (id) loadDocument: (NSString*)path; /** * This assumes we have an empty document to start with - the loaded * document is merged in to it. */ - (id) openDocument: (id)sender; /** * Retrieve all objects which have parent as thier parent. If flag is YES, * then retrieve the entire graph of objects starting with the parent. */ - (NSArray *) retrieveObjectsForParent: (id)parent recursively: (BOOL)flag; /** * To revert to a saved version, we actually load a new document and * close the original document, returning the id of the new document. */ - (id) revertDocument: (id)sender; /** * Save the document. If this is called when documentPath is nil, * then saveGormDocument: will call it to define the path. */ - (BOOL) saveAsDocument: (id)sender; /** * Archives the .gorm file. Creates the directory and all of the * contents using the archiver and other class manager. */ - (BOOL) saveGormDocument: (id)sender; /** * Creates a blank document depending on the value of type. * If type is "Application", "Inspector" or "Palette" it creates * an appropriate blank document for the user to start with. */ - (void) setupDefaults: (NSString*)type; /** * Marks this document as the currently active document. The active document is * the one being edited by the user. */ - (void) setDocumentActive: (BOOL)flag; /** * Add object to the visible at launch list. */ - (void) setObject: (id)anObject isVisibleAtLaunch: (BOOL)flag; /** * Add object to the defferred list. */ - (void) setObject: (id)anObject isDeferred: (BOOL)flag; /** * The document window. */ - (NSWindow*) window; /** * Determine if the document should be closed or not. */ - (BOOL) couldCloseDocument; /** * Called when the document window close is selected. */ - (BOOL) windowShouldClose: (id)sender; /** * Returns YES, if obj is a top level object. */ - (BOOL) isTopLevelObject: (id)obj; /** * Forces the closing of all editors in the document. */ - (void) closeAllEditors; /** * Create resource manager instances for all registered classes. */ - (void) createResourceManagers; /** * The list of all resource managers. */ - (NSArray *) resourceManagers; /** * Get the resource manager which handles the content on pboard. */ - (IBResourceManager *) resourceManagerForPasteboard: (NSPasteboard *)pboard; /** * 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. */ - (void) changeToTopLevelEditorAcceptingTypes: (NSArray *)types andFileType: (NSString *)fileType; /** * Switches to the view using the specified tag. * They are 0=objects, 1=images, 2=sounds, 3=classes, 4=file prefs. */ - (void) changeToViewWithTag: (int)tag; /** * Returns all pasteboard types registered for with the IBResourceManager. */ - (NSArray *) allManagedPboardTypes; /* Language translation */ - (void) translate; - (void) exportStrings; /* Managing classes */ - (GormClassManager*) classManager; - (id) createSubclass: (id)sender; - (id) instantiateClass: (id)sender; - (id) createClassFiles: (id)sender; - (id) addAttributeToClass: (id)sender; - (id) remove: (id)sender; - (id) createClassFiles: (id)sender; - (id) instantiateClass: (id)sender; - (void) selectClass: (NSString *)className; - (void) selectClass: (NSString *)className editClass: (BOOL)flag; - (BOOL) classIsSelected; - (void) removeAllInstancesOfClass: (NSString *)classNamed; /* Sound & Image support */ /** * Open a sound and load it into the document. */ - (id) openSound: (id)sender; /** * Open an image and copy it into the document. */ - (id) openImage: (id)sender; /* Connections */ /** * Build our reverse mapping information and other initialisation */ - (void) rebuildObjToNameMapping; /** * Removes all connections given action or outlet with the specified label * (paramter name) class name (parameter className). */ - (BOOL) removeConnectionsWithLabel: (NSString *)name forClassNamed: (NSString *)className isAction: (BOOL)action; /** * Remove all connections to any and all instances of className. */ - (BOOL) removeConnectionsForClassNamed: (NSString *)name; /** * Rename connections connected to an instance of on class to another. */ - (BOOL) renameConnectionsForClassNamed: (NSString *)name toName: (NSString *)newName; /* class loading */ /** * Load a class into the document. */ - (id) loadClass: (id)sender; /*** services/windows menus... ***/ /** * Set the services menu. */ - (void) setServicesMenu: (NSMenu *)menu; /** * Returns the services menu for the document. */ - (NSMenu *) servicesMenu; /** * Sets the windows menu. */ - (void) setWindowsMenu: (NSMenu *)menu; /** * Returns the menu which will be the windows menu for the document. */ - (NSMenu *) windowsMenu; /*** first responder/font manager ***/ /** * Returns stand-in object for fontManager. */ - (id) fontManager; /** * Returns stand-in object for firstResponder */ - (id) firstResponder; /* Layout */ /** * Arrages selected objects based on the either in front of or in * back of the view stack. */ - (void) arrangeSelectedObjects: (id)sender; /** * Aligns selected objects on a given axis. */ - (void) alignSelectedObjects: (id)sender; /* * windowAndRect:forObject: is called by Gorm to determine where it should * draw selection markup */ - (NSWindow*) windowAndRect: (NSRect*)r forObject: (id)object; @end @interface GormDocument (MenuValidation) /** * Returns TRUE if the document is editing instance/objects. */ - (BOOL) isEditingObjects; /** * Returns TRUE if the document is editing images. */ - (BOOL) isEditingImages; /** * Returns TRUE if the document is editing sounds. */ - (BOOL) isEditingSounds; /** * Returns TRUE if the document is editing classes. */ - (BOOL) isEditingClasses; @end #endif