MODocumentWell.rtf

This is MODocumentWell.rtf in view mode; [Download] [Up]

Version 1.0 Copyright ©1992, 1993, 1994 by Mike Ferris. All Rights Reserved.
Mike Ferris - October 9th, 1993

MODocumentWell

Inherits From: View : Responder : Object

Declared In: MOKit/MODocumentWell.h

Class Description

MODocumentWell is a subclass of View which implements a document well. The well has a current path and a current icon. It displays as an inset box with the icon drawn in the center. If the path is set and an icon is provided, the path does not have to be valid, the icon is just displayed. If the path is set without an icon being provided, the well asks the workspace to provide the icon for the file and displays that.

The well normally has a bezeled border, but it can be made to be borderless and transparent (except for the icon). The well can also do any combination of the following three things: accept files dragged from elsewhere, allow its file to be dragged elsewhere, and allow its file to be opened by double-clicking the icon. These features can be turned on and off independantly. The whole well can be disabled without upsetting these options as well.

Instance Variables

id pathString;
id icon;
id delegate;
BOOL enabled;
BOOL isDragDestination;
BOOL isDragSource;
BOOL opensFiles;
BOOL bordered;
id ghostHighlight;
BOOL isReceiving;
char *dragPath;
id dragImage;
id ghostImage;
BOOL isDragging;

pathString A MOString object which holds the current path of the well.

icon An NXImage object which holds the current icon of the well.

delegate The object which will be notified of goings on in the well.

enabled Whether or not the well is enabled.

isDragDestination Whether the well accepts dragged files when enabled.

isDragSource Whether the well can drag its file out when enabled.

opensFile Whether double-clicking the well will cause its document to be opened via Workspace.

bordered Whether the well is bordered or not.

ghostHighlight An NXImage object used by the well to do ghost highlighting during drag operations.

isReceiving An internally used state variable which is set to YES while the well is in the process of accepting a dragged file.

dragPath An internally used state variable used to hold the path of a file currently in the process of being dragged into the well.

dragImage An internally used NXImage object which holds the icon of the file in the process of being dragged into the well.

ghostImage An internally used NXImage object which holds the icon to use as a ghost image during dragging. This image is created by compositing the ghostHighlight onto the dragImage.

isDragging An internally used state variable which is set to YES while the well is in the process of dragging its file out.

Method Types

Initializing the class +initialize

Creating and freeing instances - initFrame:
- copyFromZone:
- free

Dealing with the well attributes - setPath:andIcon:
- path
- icon
- setDelegate:
- delegate
- setEnabled:
- enabled
- setIsDragDestination:
- isDragDestination
- setIsDragSource:
- isDragSource
- setDoesOpenFiles:
- doesOpenFiles
- setBordered:
- bordered

The meaty methods - drawSelf::
- mosueDown:
- openDocument:

Dragging destination methods - draggingEntered:
- draggingExited:
- prepareForDragOperation:
- performDragOperation:
- concludeDragOperation:

Dragging source methods - draggingSourceOperationMaskForLocal:

Internally useful methods - getFilenameFromPborad:
- getOrigin:forImage:

Archiving - read:
- write:
- awake

Class Methods

initialize
+ initialize

Initializes the class instance doing things like setting the version number.

Instance Methods

awake
- awake

Initializes all the temporary stuff that doesn't get restored by a read.