|
DrawKit
Vector and illustration framework for Mac OS X
|
This class is a simple document type that owns a drawing instance. More...
Instance Methods | |
| (NSSet *) | - allRegisteredStyles |
| Returns all registered styles used by the document's drawing. More... | |
| (NSSet *) | - allStyles |
| Returns all styles used by the document's drawing. More... | |
| (Class) | - classOfDefaultDrawingLayer |
| Return the class of the layer for New Layer and default drawing construction. More... | |
| (IBAction) | - deleteActiveLayer: |
| High-level method to delete the active layer from the drawing. More... | |
| (NSString *) | - documentStyleCategoryName |
| Returns a name that can be used for a style registry category for this document. More... | |
| (DKDrawing *) | - drawing |
| Return the document's drawing object. More... | |
| (DKDrawingTool *) | - drawingTool |
| Returns the main view's current drawing tool. More... | |
| (DKDrawingView *) | - mainView |
| Return the document's main view. More... | |
| (DKViewController *) | - makeControllerForView: |
| Create a controller object to connect the given view to the document's drawing. More... | |
| (DKDrawing *) | - makeDefaultDrawing |
| Create a drawing object to be used when the document is not opened from a file on disk. More... | |
| (DKDrawingView *) | - makePrintDrawingView |
| Creates a view used to handle printing. More... | |
| (IBAction) | - newDrawingLayer: |
| High-level method to add a new drawing layer to the document. More... | |
| (IBAction) | - newLayerWithSelection: |
| High-level method to add a new drawing layer to the document and move the selected objects to it. More... | |
| (void) | - remergeStyles:readFromURL: |
| The first step in reconsolidating a newly opened document's registered styles with the current style registry. More... | |
| (void) | - replaceDocumentStylesWithMatchingStylesFromSet: |
| The second step in reconsolidating a newly opened document's registered styles with the current style registry. More... | |
| (void) | - setDrawing: |
| Set the document's drawing object. More... | |
| (void) | - setDrawingTool: |
| Sets the main view's drawing tool to the given tool. More... | |
| (BOOL) | - wantsInfoLayer |
| Return whether an info layer should be added to the default drawing. More... | |
Class Methods | |
| (void) | + bindFileExportType:toSelector: |
| Establishes a mapping between a file type and a method that can export that file type. More... | |
| (void) | + bindFileImportType:toSelector: |
| Establishes a mapping between a file type and a method that can import that file type. More... | |
| (NSUInteger) | + defaultLevelsOfUndo |
| Return the default levels of undo assigned to new documents. More... | |
| (void) | + setDefaultLevelsOfUndo: |
| Set the default levels of undo assigned to new documents. More... | |
| (NSUndoManager *) | + sharedDrawkitUndoManager |
| Returns an undo manager that can be shared by multiple documents. More... | |
This class is a simple document type that owns a drawing instance.
This class is a simple document type that owns a drawing instance. It can be used as the basis for any drawing-based document, where there is a 1:1 relationship between the documnent, the drawing and the main drawing view.
You can subclass to add functionality without having to rewrite the drawing ownership stuff.
This also handles standard printing of the drawing
Note that this is expected to be set up via the associated nib file. The outlet m_mainView should be set to the DKDrawingView in the window. Inherited outlets such as window should be set as normal (File's Owner is of course, this object). If you forget to set the m_mainView outlet things won't work properly because the document won't know which view to link to the drawing it creates. What will happen is that the unconnected view will work, and the first time it goes to draw it will detect it has no back-end, and create one automatically. This is a feature, but in this case can be misleading, in that the drawing you see is NOT the drawing that the document owns. The m_mainView outlet is the only way the document has to know about the view it's supposed to connect to its drawing.
If you subclass this to have more views, etc, bear this in mind - you have to consider how the document's drawing gets hooked up to the views you want. Outlets like this are one easy way to do it, but not the only way.
| - (NSSet*) allRegisteredStyles |
Returns all registered styles used by the document's drawing.
This method actually returns all styles flagged as formerly registered immediately after the document has been opened - all subsequent calls return the actual registered styles. Thus take care that this is only called once after loading a document if it's the flagged styles you require.
| - (NSSet*) allStyles |
Returns all styles used by the document's drawing.
Establishes a mapping between a file type and a method that can export that file type.
The selector is used to build an invocation on the DKDrawing instance to export the type. The app will generally provide the method as part of a category extending DKDrawing, and use this method to forge the binding between the two. This class will then invoke the category method as required without the need to modify or subclass this class.
| fileType | a filetype or UTI string for a file type |
| selector | a selector for the method that implements the file export |
Establishes a mapping between a file type and a method that can import that file type.
The selector is used to build an invocation on the DKDrawing class to import the type. The app will generally provide the method as part of a category extending DKDrawing, and use this method to forge the binding between the two. This class will then invoke the category method as required without the need to modify or subclass this class.
| fileType | a filetype or UTI string for a file type |
| aSelector | a class method of DKDrawing that can import the file type |
| - (Class) classOfDefaultDrawingLayer |
Return the class of the layer for New Layer and default drawing construction.
Subclasses can override this to insert a different layer type without having to override each separate command. Note that the returned class is expected to be a subclass of DKObjectDrawingLayer by some methods, most notably the -newLayerWithSelection method.
| + (NSUInteger) defaultLevelsOfUndo |
Return the default levels of undo assigned to new documents.
If the value wasn't found in the defaults, DEFAULT_LEVELS_OF_UNDO is returned
| - (IBAction) deleteActiveLayer: | (id) | sender |
High-level method to delete the active layer from the drawing.
After this the active layer will be nil, and should be set to something before further use.
| sender | the sender of the message |
| - (NSString*) documentStyleCategoryName |
Returns a name that can be used for a style registry category for this document.
| - (DKDrawing*) drawing |
Return the document's drawing object.
The document owns the drawing
| - (DKDrawingTool*) drawingTool |
Returns the main view's current drawing tool.
This is a convenience for UI controllers to find the tool from the main view. If there are multiple drawing views you'll need another approach
| - (DKDrawingView*) mainView |
Return the document's main view.
If the document has a main view, this returns it. Normally this is set up in the nib. A document isn't required to have an outlet to the main view but it makes setting everything up easier.
| - (DKViewController*) makeControllerForView: | (NSView *) | aView |
Create a controller object to connect the given view to the document's drawing.
Usually you won't call this yourself but you can override it to supply different types of controllers. The default supplies a general purpose drawing tool controller. Note that the relationship between the view and the controller is set up by this, but NOT the relationship between the drawing and the controller - the controller must be added to the drawing using -addController. (Other parts of this class handle that).
| aView | the view the controller will be used with |
| - (DKDrawing*) makeDefaultDrawing |
Create a drawing object to be used when the document is not opened from a file on disk.
You can override to make a different initial drawing or modify the existing one
| - (DKDrawingView*) makePrintDrawingView |
Creates a view used to handle printing.
This may be overridden to customise the print view. Called by printShowingPrintPanel:
| - (IBAction) newDrawingLayer: | (id) | sender |
High-level method to add a new drawing layer to the document.
The added layer is made the active layer
| sender | the sender of the message |
| - (IBAction) newLayerWithSelection: | (id) | sender |
High-level method to add a new drawing layer to the document and move the selected objects to it.
The added layer is made the active layer, the objects are added to the new layer and selected, and removed from their current layer.
| sender | the sender of the message |
| - (void) remergeStyles: | (NSSet *) | stylesToMerge | |
| readFromURL: | (NSURL *) | url | |
The first step in reconsolidating a newly opened document's registered styles with the current style registry.
You should override this to handle style remerging in a different way if you need to. The default implementation allows the current registry to update the document and also adds the document's name as a category to the current registry.
| stylesToMerge | a set of styles loaded with the document that are flagged as having been registered |
| url | the url from whence the document was loaded (ignored by default) |
| - (void) replaceDocumentStylesWithMatchingStylesFromSet: | (NSSet *) | aSetOfStyles |
The second step in reconsolidating a newly opened document's registered styles with the current style registry.
This should only be called if the registry actually returned anything from the remerge operation
| aSetOfStyles | the styles returned from the registry that should replace those in the document |
| + (void) setDefaultLevelsOfUndo: | (NSUInteger) | levels |
Set the default levels of undo assigned to new documents.
| levels | the number of undo levels |
| - (void) setDrawing: | (DKDrawing *) | drwg |
Set the document's drawing object.
The document owns the drawing
| drwg | a drawing object |
| - (void) setDrawingTool: | (DKDrawingTool *) | aTool |
Sets the main view's drawing tool to the given tool.
This helps DKDrawingTool's -set method work even when a document window contains several views that can be first responder. First the -set method will act directly on first responder, or a responder further up the chain. If that fails to find a responder, it then looks for an active document that responds to this method.
| aTool | a drawing tool object |
| + (NSUndoManager*) sharedDrawkitUndoManager |
Returns an undo manager that can be shared by multiple documents.
Some applications might be set up to use a global undo stack instead of havin gone per document.
| - (BOOL) wantsInfoLayer |
Return whether an info layer should be added to the default drawing.
Subclasses can override this to return NO if they don't want the info layer
1.8.9.1
