All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

Drafting2DLInterfaces Interface CATI2DLayoutLayout

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

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


interface CATI2DLayoutLayout

This interface manages the 2D Layout.

Role: The 2D Layout is the root object of the 2D Layout for 3D Design Application.


Method Index


o AddSheet(CATI2DLayoutSheet**,wchar_t*,CATI2DLayoutSheet*,CATI2DLayoutSheet*)
This method is used to create a 2DL sheet in the 2D Layout.
o GetActiveSheet(CATI2DLayoutSheet**)
Gets the active sheet in the 2D Layout.
o GetActiveView(CATI2DLayoutView**)
Gets the active view in the 2D Layout.
o GetSheets(CATIUnknownList**)
Returns the sheets referenced by the 2D Layout.
o GetViews(CATIUnknownList**)
Returns the views referenced by the 2D Layout.
o GetVisuIn3DMode(CATBoolean&)
Gets the 3D visualization mode of the layout in the 3D Viewer
o RemoveSheet(CATI2DLayoutSheet*)
This method is used to remove a sheet in the 2D Layout.
o ReorderSheets(CATLISTV(CATISpecObject_var)&)
Changes the positions of the sheets in a 2D Layout according to the given ordered list.
o SetActiveSheet(CATI2DLayoutSheet*)
Sets the active sheet in the 2D Layout.
o SetVisuIn3DMode(CATBoolean)
Sets the 3D visualization mode of the layout in the 3D Viewer
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(CATI2DLayoutSheet** o2DLSheet,
wchar_t* iName= NULL,
CATI2DLayoutSheet* iSheetBefore= 0,
CATI2DLayoutSheet* iSheetAfter= 0) = 0
This method is used to create a 2DL sheet in the 2D Layout.
Parameters:
oSheet
[out, CATBaseUnknown#Release] The new created sheet
iName
The sheet name, automatic if NULL pointer (default)
iSheetBefore
The sheet XXXXXXXXXXXXXXXX
iSheetAfter
The sheet XXXXXXXXXXXXXXXX
Returns:
S_OK
if the sheet is added.
E_FAIL
if the operation failed.
o GetActiveSheet
public virtual HRESULT GetActiveSheet(CATI2DLayoutSheet** o2DLSheet) = 0
Gets the active sheet in the 2D Layout.
The active sheet is the working sheet.
Parameters:
o2DLSheet
[out, CATBaseUnknown#Release] The active sheet in the 2D Layout.
Returns:
S_OK
if the sheet is retrieved.
E_FAIL
if the operation failed.
o GetActiveView
public virtual HRESULT GetActiveView(CATI2DLayoutView** o2DLView) = 0
Gets the active view in the 2D Layout.
The active view is the view in edition.
Parameters:
o2DLView
[out, CATBaseUnknown#Release] The active view in the 2D Layout.
Returns:
S_OK
if the view is retrieved.
E_FAIL
if the operation failed.
o GetSheets
public virtual HRESULT GetSheets(CATIUnknownList** oLstResult) = 0
Returns the sheets referenced by the 2D Layout.
Parameters:
oLstResult
[out, CATBaseUnknown#Release] Founded sheets are added to the list
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation failed.
o GetViews
public virtual HRESULT GetViews(CATIUnknownList** oLstResult) = 0
Returns the views referenced by the 2D Layout.
Parameters:
oLstResult
[out, CATBaseUnknown#Release] Founded views are added to the list
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation failed.
o GetVisuIn3DMode
public virtual HRESULT GetVisuIn3DMode(CATBoolean& obVisuMode)= 0
Gets the 3D visualization mode of the layout in the 3D Viewer
Parameters:
obVisuMode:
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation failed.
o RemoveSheet
public virtual HRESULT RemoveSheet(CATI2DLayoutSheet* iSheet) = 0
This method is used to remove a sheet in the 2D Layout.
Parameters:
iSheet
Sheet to remove
Returns:
S_OK
if the sheet is removed.
E_FAIL
if the operation failed.
o ReorderSheets
public virtual HRESULT ReorderSheets(CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Changes the positions of the sheets in a 2D Layout according to the given ordered list.
Parameters:
const
CATLISTV(CATISpecObject_var) &iOrderedSheets [in] The ordered list of the sheets in this 2D Layout. 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 SetActiveSheet
public virtual HRESULT SetActiveSheet( const CATI2DLayoutSheet* i2DLSheet) = 0
Sets the active sheet in the 2D Layout.
The active sheet is the working sheet.
Parameters:
iSheet
The active sheet in the 2D Layout.
Returns:
S_OK
if the sheet is activated.
E_FAIL
if the operation failed.
o SetVisuIn3DMode
public virtual HRESULT SetVisuIn3DMode(CATBoolean ibVisuMode) = 0
Sets the 3D visualization mode of the layout in the 3D Viewer
Parameters:
ibVisuMode:
Returns:
S_OK
if the operation is successful.
E_FAIL
if the operation failed.
o ValidateSheetOrder
public virtual HRESULT ValidateSheetOrder(CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Validates that the given ordered list can be used as an input for ReorderSheet.
Role: i.e. validates that: iOrderedSheets is the result of a permutation applied to the list of all the sheets of this 2D Layout, 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: CATI2DLayoutLayout.h
If needed, your Imakefile.mk should include the module: CATDrafting2DLItfCPP

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