 |
Rogue Wave Views Application Framework Package API Reference Guide |
Rogue Wave Views Documentation Home |
|
Rogue Wave Views Application Framework Package API Reference Guide |
Rogue Wave Views Documentation Home |
Application Framework manager document class. More...
#include <ilviews/appframe/manager/managdoc.h>
Public Member Functions | |
| virtual void | clean () |
| Deletes the manager of the document. | |
| IlvManager * | getManager () const |
| Returns the manager of the document. More... | |
| virtual IlBoolean | initializeDocument (IlAny=0) |
| Creates a new empty manager. More... | |
| virtual void | serialize (IlvDvStream &stream) |
| Serializes the manager of the document into the stream given by the stream parameter. | |
 Public Member Functions inherited from IlvDvDocument | |
| IlvDvDocument () | |
| Constructor. More... | |
| virtual | ~IlvDvDocument () |
| Destructor. More... | |
| virtual void | activated (IlBoolean active=IlTrue) |
| Notification of the document activation. More... | |
| void | addDoneCommand (IlvDvCommand *command, IlBoolean updateUI=IlTrue, IlBoolean modified=IlTrue) |
| Adds an executed command. More... | |
| void | addView (IlvDvDocViewInterface *, IlBoolean update=IlTrue) |
| Adds the document view view to the list of owned document views. More... | |
| virtual IlBoolean | canCloseViewContainer (IlvDvViewContainerInterface *v) |
Returns IlTrue if the given view container can be closed. More... | |
| virtual IlBoolean | canRedo () const |
Returns IlTrue if the last undone command can be executed. More... | |
| virtual IlBoolean | canRepeat () const |
Returns IlTrue if the last command to be executed can be repeated. More... | |
| virtual IlBoolean | canUndo () const |
Returns IlTrue if the last executed command can be undone. More... | |
| virtual void | doCommand (IlvDvCommand *command, IlBoolean updateUI=IlTrue, IlBoolean modified=IlTrue) |
| Executes the command command. More... | |
| IlvDisplay * | getDisplay () const |
| Returns the display of the application. More... | |
| IlvDvDocTemplate * | getDocTemplate () const |
| Returns the document template associated with the document. More... | |
| IlvDvDocViewInterface * | getDocView (IlUInt index) const |
| Returns a document view. More... | |
| IlvDvDocViewInterface ** | getDocViews (IlUInt &count, IlBoolean create=IlTrue) const |
| Returns document views. More... | |
| IlvDvApplication * | getDvApplication () const |
| Returns the application object. More... | |
| IlUInt | getNumberOfViews () const |
| Counts owned document views. More... | |
| const IlvPathName & | getPathName () const |
| Returns the path of the document. It can be empty if the document is a new empty document. More... | |
| const IlString & | getTitle () const |
| Returns the title of the document. More... | |
| IlUInt | getViewContainersCount (IlBoolean vis=IlTrue) const |
| Returns the number of containers associated with the document view. More... | |
| IlBoolean | isAutoDelete () const |
| Returns the auto deletion mode. More... | |
| IlBoolean | isModified () const |
| Returns the modification state of the document. More... | |
| virtual IlBoolean | open (const IlvPathName &pathname) |
Loads data from the file that has the path pathname. It cleans the document if the associated document template specifies a Single Document Interface mode. It manages the modified state to IlFalse, and updates internal data, before calling the real reading method readDocument. Therefore, it is recommended not to override this method. It may be more sensible to override method readDocument. More... | |
| virtual IlBoolean | readDocument (const IlvPathName &pathname) |
| Initializes document data from a file. More... | |
| virtual void | redo (IlBoolean updateUI=IlTrue) |
| To redo the last undone command. More... | |
| IlBoolean | removeView (IlvDvDocViewInterface *view, IlBoolean destroyIt=IlTrue, IlBoolean update=IlTrue) |
| Removes a document view. More... | |
| void | removeViews (IlBoolean destroyThem=IlFalse) |
| Removes document views. More... | |
| virtual void | repeat (IlBoolean updateUI=IlTrue) |
| Repeats the last executed command. More... | |
| IlBoolean | revert () |
| Reloads the document data from the document file. More... | |
| IlBoolean | save () |
| Saves the document data in the current document file. More... | |
| IlBoolean | save (IlvPathName &pathName, IlBoolean replace=IlTrue) |
| Saves the document in a file. More... | |
| IlBoolean | saveAs () |
| Saves the document in a new file. More... | |
| virtual IlBoolean | saveDocument (const IlvPathName &pathName) |
| Saves the document data in the file with the path pathname. More... | |
| virtual IlBoolean | saveModifications () |
| Saves the document only if it has been modified. More... | |
| void | setAutoDelete (IlBoolean autoDelete) |
| Sets the auto deletion mode of the document to the parameter autoDelete. | |
| void | setDocTemplate (IlvDvDocTemplate *docTemplate) |
| Associates the document template docTemplate with the document. More... | |
| virtual void | setModified (IlBoolean modified, IlBoolean notify=IlTrue) |
| Forces the modification state of the document. More... | |
| virtual void | setPathName (const IlvPathName &pathName, IlBoolean addToMRU=IlTrue) |
| Sets the path of the document to the parameter pathName. More... | |
| virtual void | setTitle (const char *title, IlBoolean update=IlTrue) |
| Sets the title of the document. More... | |
| virtual void | undo (IlBoolean updateUI=IlTrue) |
| To undo the last executed command. More... | |
| void | updateViewContainerTitles () |
| Updates the view container titles. More... | |
| Public Member Functions inherited from IlvDvInterface | |
| IlBoolean | callMethod (const IlSymbol *methodName, IlvDvValue *returnedValue,...) |
| Generic method for calling a method that is exported in a class interface. More... | |
| IlvDvValue & | getFieldValue (const IlSymbol *fieldName, IlvDvValue &value) const |
| Gets a field value. More... | |
| virtual IlBoolean | isProcessingAction (const IlSymbol *methodName) const |
Returns IlTrue if the given action can be processed by the class. More... | |
| virtual IlBoolean | processAction (const IlSymbol *actionName) |
| Processes an action. More... | |
| virtual IlBoolean | refreshAction (const IlSymbol *actionName, IlvDvActionDescriptor *desc) const |
| Refresh all the menu items that reference the action given by the parameter actionName. More... | |
| void | setFieldValue (const IlSymbol *fieldName, const IlvDvValue &value) |
| Sets a field value. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from IlvDvDocument | |
| IlvDvDocViewInterface * | getCurrentCallerView () const |
| Returns the document view that is sending a message to the document. More... | |
| void | notifyViews (const IlSymbol *name, IlvDvDocViewInterface *except,...) |
| Notifies the associated document views of an event. More... | |
Application Framework manager document class.
Library: ilvappmgr
IlvDvManagerDocument is a subclass of IlvDvDocument The document data is a manager object that is loaded and saved using standard IlvManager serialization methods read and save.
| IlvManager* IlvDvManagerDocument::getManager | ( | ) | const |
Returns the manager of the document.
Creates a new empty manager.
Creates a new empty manager. Accelerators Ctrl+C, Ctrl+V, and Ctrl+X are automatically added to the manager to generate actions Copy, Paste, and Cut respectively.
IlFalse if the initialization of the manager failed. Reimplemented from IlvDvDocument.
Reimplemented in IlvDvGrapherDocument.
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.