All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftDrawing

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDftDrawing

Interface of the drawing object.
Role: The drawing is the root feature of a CATDrawing Document. It manages the sheets.


Method Index


o AddSheet(CATIDftSheet**,wchar_t*,CATIDftSheet*,CATIDftSheet*)
This method is used to create a sheet in the drawing.
o GetActiveSheet(CATIDftSheet**)
Gets the active sheet in the drawing.
o GetActiveView(CATIDftView**)
Gets the active view in the drawing.
o GetSheets(CATIUnknownList**)
Returns the sheets referenced by the drawing.
o GetViews(CATIUnknownList**)
Description : returns the views referenced by the drawing.
o MoveSheet(CATIDftSheet*,CATIDftSheet*,CATIDftSheet*)
o RemoveSheet(CATIDftSheet*)
this method is used to remove a sheet in the drawing.
o ReorderSheets(CATLISTV(CATISpecObject_var)&)
Change the positions of the sheets in a drawing according to the given ordered list.
o ValidateSheetOrder(CATLISTV(CATISpecObject_var)&)
Validates that the given ordered list can be used as an input for ReorderSheet.

Methods


o AddSheet
public virtual HRESULT AddSheet(CATIDftSheet** oSheet,
const wchar_t* iName= NULL,
const CATIDftSheet* iSheetBefore= 0,
const CATIDftSheet* iSheetAfter= 0) = 0
This method is used to create a sheet in the drawing.
Parameters:
oSheet
The new sheet to create
iName
The sheet name, automatic if NULL pointer (default)
iSheetBefore
The sheet XXXXXXXXXXXXXXXX
iSheetAfter
The sheet XXXXXXXXXXXXXXXX
o GetActiveSheet
public virtual HRESULT GetActiveSheet(CATIDftSheet** oView) const = 0
Gets the active sheet in the drawing.
The active sheet is the working sheet.
Parameters:
oSheet
The active sheet in the drawing.
o GetActiveView
public virtual HRESULT GetActiveView(CATIDftView** oView) const = 0
Gets the active view in the drawing.
The active view is the view in edition.
Parameters:
oView
The active view in the drawing.
o GetSheets
public virtual HRESULT GetSheets(CATIUnknownList** oLstResult) const = 0
Returns the sheets referenced by the drawing.
Parameters:
oLstResult
Founded sheets are added to the list
o GetViews
public virtual HRESULT GetViews(CATIUnknownList** oLstResult) const = 0
Description : returns the views referenced by the drawing.
Parameters:
oLstResult
: Founded views are added to the list
o MoveSheet
public virtual HRESULT MoveSheet( const CATIDftSheet* iSheet,
const CATIDftSheet* iSheetBefore= 0,
const CATIDftSheet* iSheetAfter= 0) = 0
Deprecated:
V5R18 use #ReorderSheets this method is used to move a sheet in the drawing.
Parameters:
iSheet
Sheet to remove
iSheetBefore
The sheet XXXXXXXXXXXXXXXX
iSheetBefore
The sheet XXXXXXXXXXXXXXXX
o RemoveSheet
public virtual HRESULT RemoveSheet( const CATIDftSheet* iSheet) = 0
this method is used to remove a sheet in the drawing.
Parameters:
iSheet
Sheet to remove
o ReorderSheets
public virtual HRESULT ReorderSheets( const CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Change the positions of the sheets in a drawing according to the given ordered list.
Parameters:
const
CATLISTV(CATISpecObject_var) &iOrderedSheets [in] The ordered list of the sheets in this drawing. Preconditions:
ValidateSheetOrder(iOrderedSheets) must succeed. @see ValidateSheetOrder.
Returns:
A HRESULT
S_OK
Sheets were reordered.
E_UNEXPECTED
Preconditions not met.
E_FAIL
Internal error.
o ValidateSheetOrder
public virtual HRESULT ValidateSheetOrder( const CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Validates that the given ordered list can be used as an input for ReorderSheet. i.e. validates that: iOrderedSheets is the result of a permutation applied to the list of all the sheets of this drawing, with the following constraint: for every non-detail sheet, there isnt any detail sheet appearing before in iOrderedSheets.
Parameters:
iOrderedSheets
The list of sheets to validate.
Returns:
An HRESULT value.
Legal values:
S_OK
iOrderedSheets is a valid input.
E_XXX
iOrderedSheet is not a valid input.

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

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