AfrInterfaces Interface CATIDocumentEdit
Usage: you can freely reimplement this interface.
interface CATIDocumentEdit
- Deprecated:
- R217 - Obsolete in V6.
Interface to enable the correct behaviour of a document in the
MDI (Multiple Document Interface) CATIA application.
Role:
- providing data needed for a document's user-interface
intialization (see
,
),
- providing informations to the document's about its
user interface's state (see
,
),
- providing a snapshot of the document in the OLE context
(see
)
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 Activate( | ) |
-
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 CreateDefaultWindow( | | iEditor) |
-
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:
-
o Deactivate
| public virtual Deactivate( | ) |
-
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 GetActiveObject( | ) |
-
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
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:
-
o MemoryDraw
| public virtual MemoryDraw( | | iFormat, |
| | iWidth, |
| | iHeight) |
-
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: CATAfrItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.