All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Interface CATIDocumentEdit

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDocumentEdit
 

Usage: you can freely reimplement this interface.


interface CATIDocumentEdit

Interface to enable the correct behaviour of a document in the MDI (Multiple Document Interface) CATIA application.
Role:

Every document must implement this interface by an extension of a late type that stands for the document type.


Method Index


o Activate()
Unused method.
o CreateDefaultWindow(CATFrmEditor*)
Creates a window to display a document.
o Deactivate()
Unused method.
o GetActiveObject()
Returns a path to the first object to ui-activate.
o MemoryDraw(unsigned short,int,int)
Returns a picture containing a snapshot of the document in OLE context.

Methods


o Activate
public virtual void Activate()= 0
Unused method. It is by-passed by the equivalent method of the editor. An empty implementation of this method is mandatory.
o CreateDefaultWindow
public virtual CATFrmWindow * CreateDefaultWindow(CATFrmEditor* iEditor) = 0
Creates a window to display a document.
Role: This method is called to create the first document's window (called the default window).
Parameters:
iEditor
The editor associated to the document implementing this interface
Returns:
The new window.
See also:
CATFrmWindow
o Deactivate
public virtual void Deactivate()= 0
Unused method. It is by-passed by the equivalent method of the editor. An empty implementation of this method is mandatory.
o GetActiveObject
public virtual CATPathElement GetActiveObject()= 0
Returns a path to the first object to ui-activate.
Role: The ui-activation manager can't know about the initial object to ui-activate for a newly opened or created document. So the purpose of this method is to create a new CATPathElement containing a path in the model to the first ui-activable object to ui-activate.
Returns:
A path to the first object to ui-activate.
See also:
CATIUIActivate
o MemoryDraw
public virtual void * MemoryDraw(unsigned short iFormat,
int iWidth,
int iHeight) = 0
Returns a picture containing a snapshot of the document in OLE context.
Note: Used on Win9x and WinNT platforms only.
Role: The purpose of this method is to return an picture of width iWidth and height iHeight containing a snapshot of the document. The desired picture format is controlled via the iFormat argument which real type is the win32 CLIPFORMAT type. The return value is a win32 handle to the picture.
Parameters:
iFormat
A win32 CLIPFORMAT telling the desired output picture's format.
iWidth
The desired output picture's width
iHeight
The desired output picture's height
Returns:
A win32 handle (HANDLE) to the rendered picture.

This object is included in the file: CATIDocumentEdit.h
If needed, your Imakefile.mk should include the module: CATApplicationFrame

Copyright © 2003, Dassault Systèmes. All rights reserved.