DraftingUseItf Interface 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 drawing representation.
It manages the sheets.
Method Index
- o
AddSheet(CATIDftSheet**,wchar_t*,CATBoolean)
- 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
GetDrawingFactory(CATIDftFactory**)
- Description : returns the Drawing factory.
- o
GetSheets(CATIUnknownList**)
- Returns the sheets referenced by the drawing.
- o
GetStandardManager(CATIDftStandardManager**)
- Description : returns the standard manager.
- o
GetViews(CATIUnknownList**)
- Description : returns the views referenced by the drawing.
- o
RemoveSheet(CATIDftSheet*)
- this method is used to remove a sheet in the drawing.
- o
ReorderSheets(CATIUnknownList*)
- Change the positions of the sheets in a drawing according to the given
ordered list.
- o
SetActiveSheet(CATIDftSheet*)
- Sets the active sheet in the drawing.
- o
ValidateSheetOrder(CATIUnknownList*)
- Validates that the given ordered list can be used as an input
for ReorderSheet.
Methods
o AddSheet
| public virtual AddSheet( | | oSheet, |
| const | iName | = NULL, |
| const | ibDetailSheet | = FALSE) |
-
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)
- ibDetailSheet
- if true, a detail sheet is created.
o GetActiveSheet
| public virtual GetActiveSheet( | | oSheet) |
-
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 GetActiveView( | | oView) |
-
Gets the active view in the drawing.
The active view is the view in edition.
- Parameters:
-
- oView
- The active view in the drawing.
o GetDrawingFactory
| public virtual GetDrawingFactory( | | opiDftFact) |
-
Description : returns the Drawing factory.
- Parameters:
-
- opiDftfact
- : The drawing factory
o GetSheets
| public virtual GetSheets( | | oLstResult) |
-
Returns the sheets referenced by the drawing.
- Parameters:
-
- oLstResult
- Founded sheets are added to the list
o GetStandardManager
| public virtual GetStandardManager( | | opiDftStdMngt) |
-
Description : returns the standard manager.
- Parameters:
-
- opiDftStdMngt
- : The standard manager
o GetViews
| public virtual GetViews( | | oLstResult) |
-
Description : returns the views referenced by the drawing.
- Parameters:
-
- oLstResult
- : Founded views are added to the list
o RemoveSheet
| public virtual RemoveSheet( | const | iSheet) |
-
this method is used to remove a sheet in the drawing.
- Parameters:
-
- iSheet
- Sheet to remove
o ReorderSheets
| public virtual ReorderSheets( | | ipListOrderedSheets) |
-
Change the positions of the sheets in a drawing according to the given
ordered list.
- Parameters:
-
- CATIUnknownList
- *ipListOrderedSheets
[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 SetActiveSheet
| public virtual SetActiveSheet( | const | iSheet) |
-
Sets the active sheet in the drawing.
The active sheet is the working sheet.
- Parameters:
-
- iSheet
- The active sheet in the drawing.
o ValidateSheetOrder
| public virtual ValidateSheetOrder( | | ipListOrderedSheets) |
-
Validates that the given ordered list can be used as an input
for ReorderSheet.
i.e. validates that:
ipListOrderedSheets 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 ipListOrderedSheets.
- Parameters:
-
- CATIUnknownList
- *ipListOrderedSheets
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: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.