Inheritance diagram for CP_Document_Base:
A CP_Document_Base associates a CP_Document_BaseWindow and a CP_File so that the data in the window can be written out as a persistant state.
This class inherits from CP_Persistant which has method you can override to handle opening and saving the contents of this class.
In order for the relationship between the CP_Document_BaseWindow class and this document class to handle saving of the windows contents automatically you need to ensure you have only 1 CP_Document_BaseWindow associated with this class.
Documents
|
|
|
|
||||||||||||
|
Constructor.
|
|
|
Destructor.
|
|
|
Return a count of the objects of inType contained in ourselves. This needs to be overriden, this method just returns 0.
Reimplemented from CP_ScriptableObject_Imp. |
|
||||||||||||
|
Return the object contained inourselves based on the name passed in.
Reimplemented from CP_ScriptableObject_Imp. |
|
||||||||||||
|
Return the object contained inourselves based on the position passed in.
Reimplemented from CP_ScriptableObject_Imp. |
|
||||||||||||||||
|
Handles the get data Apple Event to return some type of data about this window.
Reimplemented from CP_ScriptableObject_Imp. |
|
|
Loads the proxy icon based on the saved status of this document.
|
|
||||||||||||
|
|
|
|
Called when the user is attempting to close this document, or the main CP_DocumentWindow associated with this document. If the document is dirty, the user will be prompted if they want to save the contents.
|
|
|
Called when the user is done with this document. The default is to just delete this object. This will be called automatically by the framework.
|
|
|
Returns the CP_EventHandler for this class. If the document has a window associated with it, then that handler is returned, otherwise a dummy handler is returned. Since documents don't have an associated event handling object associated with them, the event handler for the main window is returned.
|
|
|
|
|
|
Returns the file name used with this document.
|
|
|
Returns the file extension used with files created for this document. The default is txt. Users should set this field based on the extensions used for their document.
|
|
|
|
|
|
Returns the default icon for this document.
|
|
|
Returns the default file name for this document. This is "Untitled" followed by a count, based on the number of default documents created.
|
|
|
User overrideable method to be called when the user wants to open a document. This method does nothing here, users must override.
|
|
|
This is called right after the document class is created. The default is to call HandleCreateDocumentUI which you need to override in your document subclass to handle creation of the main UI elements for this class.
|
|
||||||||||||||||||||||||
|
Called when the user needs to save the documents contents to a file. Normally you do not need to override this, but just supply a CP_PersistantWriter object that will do the actual writing of the documents data.
the original file if we have saved to a temp file. Reimplemented from CP_Persistant. |
|
|
|
|
||||||||||||||||
|
Called when the status of the save command needs to be updated.
|
|
|
Handle the save command.
|
|
||||||||||||||||
|
Called when the status of the save as command needs to be updated.
|
|
|
Handle the save as command.
|
|
||||||||||||||||
|
Called when the status of the revert command needs to be updated.
|
|
|
Handle the revert command.
|
|
||||||||||||||||
|
Reimplemented in CP_Document< UNDO_POLICY, PRINT_POLICY >. |
|
||||||||||||
|
Reimplemented in CP_Document< UNDO_POLICY, PRINT_POLICY >. |
|
||||||||||||||||
|
Reimplemented in CP_Document< UNDO_POLICY, PRINT_POLICY >. |
|
||||||||||||
|
Reimplemented in CP_Document< UNDO_POLICY, PRINT_POLICY >. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
User overrideable method to handle creation of the document main UI and windows.
|
|
|
Make this document visible. The default is to just call the main window and show that window. However if you have other UI elements such as palettes you can override this and handle showing them here.
|
|
|
Make this document hidden. The default is to just call the main window and hide that window. However if you have other UI elements such as palettes you can override this and handle hiding them here.
|
|
|
Return the main document window.
|
|
|
Sets the CP_DocumentWindow that is associated with this document. This is the window that will check with this object before it closes itself to ensure that any data is saved first. This will also broadcast a document message of type kCP_Message_DocumentWindowSet so that any listeners will be notified when the main window has changed for this object.
|
|
|
Return a CP_AskSaveChangesDialog so the user will be notified if the document has any changes that need saving. Before returning the dialog, we fill in values that the dialog will display, based on information in this document.
|
|
|
|
|
|
Return a CP_PutFileDialog so the user can choose the location to save the file to. Before returning the dialog, we fill in values that the dialog will display, based on information in this document.
|
|
|
Returns the file spec used for this documents main file.
|
|
|
Sets the file spec used for this documents main file.
|
|
|
|
|
|
Returns the AppleEvent document class for this object. The default is to return cDocument.
Implements CP_ScriptableObject_Imp. |
|
||||||||||||
|
Add a specifier to ourselves. This is by default a specifier for an object of typeNull.
Reimplemented from CP_ScriptableObject_Imp. |
|
|
User overrideable method to handle an Undo event.
Reimplemented in CP_Document< UNDO_POLICY, PRINT_POLICY >. |
|
|
Event sent to this document when we have requested a save command.
|
|
||||||||||||
|
Callback from the AskSaveChanges dialog when the user wants to save their changes.
|
|
||||||||||||
|
Callback from the AskSaveChanges dialog when the user does't want to save their changes.
|
|
||||||||||||||||
|
Callback from the PutFile dialog when the user chooses to save the file.
|
|
||||||||||||
|
Callback from the Revert dialog when the user wants to revert their changes.
|
|
||||||||||||||||
|
Handle the passed in Apple Event. You should not need to override this. Either call the one of the default handlers for the core events, or to override the default handlers, register an event handler for the event. Registered event handlers will be handled first, then the built in functions will be called if there is no overriding event handler for the event.
Reimplemented in CP_ScriptableObject_Property. |
|
||||||||||||||||||||
|
Handles AppleEvents for this object and any sub scriptable objects that this object might contain.
|
|
|
Set the default object. This is the object that subsequent events will use when they refer to the default object.
|
|
|
|
|
|
Gets the scriptable object that an event corresponds to, by extracting our CP_ModelToken from the descriptor.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||||||||||||
|
Compare Apple Event objects. This method returns false, and subclasses need to override it.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||
|
Return the object contained in ourselves based on the unique ID passed in. Subclasses need to override this function. This routine just returns NULL.
|
|
||||||||||||
|
Return the object contained in ourselves based on the position passed in. Subclasses need to override this function. This routine just returns NULL.
|
|
||||||||||||||||||||
|
Subclasses need to override this to handle the create element event.
Reimplemented in CP_Application< DOC_POLICY, PRINT_POLICY, UNDO_POLICY >. |
|
||||||||||||
|
Adds the passed in CP_AppleEventSignal to the list of AppleEvents we will handle through a signal / slot connection.
|
|
|
Removes a previously added event handler from the list of the events handled by the object.
|
|
|
Returns true if there is a registered signal handler for the passed in event.
|
|
|
Finds and returns the signal for the passed in event.
|
|
||||||||||||||||||||
|
Tries to get the CP_ModelToken from the passed in descriptor and return in outToken.
|
|
||||||||||||
|
Places the passed in scriptable object into a CP_ModelToken and then packages it up in a descriptor and returns in outToken.
|
|
|
|
|
||||||||||||||||
|
Subclasses should override this to handle the set data event.
Reimplemented in CP_Window_Imp. |
|
||||||||||||||||
|
Send an Apple Event to ourselves. Used to record events.
|
|
|
Make the specifier for our object. This method will recruisvely travel the object heirachy to make the correct specifier.
|
|
|
Check to make sure that the required params for the event are present, and throw an OSErr exception if they are missing.
|
|
|
Initialize our Apple Event handling by installing the Apple Event dispatcher and its object handlers.
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
Reimplemented in CP_Window_Imp. |
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||
|
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||||||||||
|
Return the object contained in the passed in container based upon the inForm criteria.
|
|
||||||||||||
|
Subclasses need to override to return the position of their sub objects.
|
|
|
|
|
|
|
|
||||||||||||
|
Method call by our persistant writer to write out the data from the CP_Persistant class.
|
|
||||||||||||||||||||
|
|
|
||||||||||||
|
Updates the status of a command.
|
|
||||||||||||||||
|
Updates the status of a command based on the current state of the application.
|
|
|
Handles the processing of a command. If the command has been registered with this class, then its signal will be called. If the command has not been registered, then this function does nothing with the passed in command.
|
|
||||||||||||
|
Signal called when a menu item is selected with no associated command. |
|
|
Returns the signal called when a menu item is selected and has no command associated with it.
|
|
||||||||||||||||
|
Registers the passed in command. This places the command in a list of commands we will handle updating the status for, and when called executing the signal registered for the command.
|
|
||||||||||||||||
|
Registers the passed in command. This places the command in a list of commands we will handle updating the status for, and when called executing the signal registered for the command.
|
|
||||||||||||
|
Registers the passed in command. This places the command in a list of commands we will handle updating the status for. You are returned the signal object that you need to connect your slot to.
|
|
|
Registers the passed in command, returning the command status signal. If the command already exists, we will return the existing command status signal if there is one, otherwise we create a new signal, and return that signal. If there is already a signal, then return the existing signal.
|
|
|
Registers the passed in command, returning the command handling signal. If the command already exists, we will return the existing command handler signal if there is one, otherwise we create a new signal, and return that signal. If there is already a signal, then return the existing signal.
|
|
|
Returns true if the passed in command is known to this class.
|
|
||||||||||||
|
Replaces a CP_Command for the passed in command number.
|
|
|
Unregisters a command.
|
|
|
Returns the CP_Command object associated with the passed in command number.
|
|
||||||||||||
|
MacOS - Handles the processing of the passed in HICommand. This will translate the HICommand into a CPLAT CP_CommandNo for processing and updating the status of the command.
|
|
||||||||||||||||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This is the main window for this class, and allows communication between the window and this document so closing the window will also cause this document to close. |
|
|
Flag used to indicate if a close is in progress. Used with non-modal file dialogs to monitor progress. |
|
|
|
|
|
Default event handler returnned for this class. |
|
|
Default file creator used with documents. Users should provide actual creator if different than the applications. |
|
|
Defaualt file type code for documents created with this class. Default is 'TEXT'. |
|
|
File name for the default document of this class. |
|
|
|
|
|
The default object that events will be dispatched to. |
|
|
Flag to indicate if this class has been initialized. |
|
|
Map that contains all of the registered handlers. |
|
|
Scriptable object that is our container. |
|
|
Default scriptable object that is contained by this object. |
|
|
|
|
|
|
|
|
|
|
|
List of commands managed by this class. |
|
|
|
1.4.0