All Frameworks Class Hierarchy This Framework Previous Next Indexes
DraftingInterfaces Interface CATIDftView
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDftView
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDftView
Interface of the drawing view object.
Role: The view is a workspace containing geometries and annotations.
The view may also contain the generative drafting results.
The view positionning in a sheet is managed using the view make-up object.
The generative drafting specifications are available using the CATIGenerSpec
interface.
- See also:
- CATIDftViewMakeUp
- See also:
- CATIGenerSpec
Method Index
- o
Activate()
- Used to Activate the view.
- o
AddApplicativeExtension(IID&,IUnknown**)
- Adds an extension to the view to deal with a specific applicative behavior.
- o
GetApplicativeExtension(IID&,IUnknown**)
- Returns the extension of the view which deals with a specific applicative behavior.
- o
GetComponents(IID,CATIUnknownList**)
- Used to get the view components (annotations, geometry, callout, .
- o
GetGenerSpec(CATIGenerSpec**)
- Gets the generative specifications of the view.
- o
GetViewName(wchar_t**)
- Gets the view name as a string.
- o
GetViewNameFormula(IUnknown**)
- Gets the view name formula.
- o
GetViewType(CATDftViewType*)
- Gets the view type.
- o
IsActive(boolean*)
- Used to know if this view is active.
- o
SetViewName(wchar_t*)
- Sets the view name as a string.
Methods
o Activate
public virtual HRESULT Activate( | )const = 0 |
-
Used to Activate the view.
The active view is the view in edition.
There is only one active view per sheet in a Drawing.
- Returns:
- HRESULT
- S_OK
- View is activated.
- E_FAIL
- View isn't activated.
o AddApplicativeExtension
-
Adds an extension to the view to deal with a specific applicative behavior.
- Parameters:
-
- interfaceID
- The interface which describe the extension to be added
- oExtension
- The added extension. If the extension already exists, it is returned also
- Returns:
- HRESULT
- S_OK
- Execution successfully.
- E_UNEXPECTED
- f internal problem.
- E_INVALIDARG
- if not recognize interfaceID.
- E_FAIL
- Execution failed.
o GetApplicativeExtension
-
Returns the extension of the view which deals with a specific applicative behavior.
- Parameters:
-
- interfaceID
- The interface which describes the extension.
- oExtension
- The result of the query
- Returns:
- HRESULT
- S_OK
- Execution successfully.
- E_UNEXPECTED
- f internal problem.
- E_INVALIDARG
- if not recognize interfaceID.
- E_FAIL
- Execution failed.
o GetComponents
-
Used to get the view components (annotations, geometry, callout, ...).
- Parameters:
-
- IID
- The interface filter.
- oElems
- List of elements found.
- Returns:
- HRESULT
- S_OK
- Elements found
- E_FAIL
- Execution failed.
o GetGenerSpec
-
Gets the generative specifications of the view.
Postcondition: Don't forget to RELEASE the resulting oProduct after use.
- Parameters:
-
- oGenerSpec
- The generative specification interface.
- Returns:
- HRESULT
- S_OK
- Execution successfully.
- E_FAIL
- Execution failed.
o GetViewName
public virtual HRESULT GetViewName( | wchar_t** | oName) const = 0 |
-
Gets the view name as a string.
- Parameters:
-
- oName
- The view name
- Returns:
- HRESULT
- S_OK
- View name has been found
- E_FAIL
- No view name found.
o GetViewNameFormula
-
Gets the view name formula. This object is a CKE formula computing the view name.
from different inputs.
- Parameters:
-
- oVNameFormula
- The view name formula
- Returns:
- HRESULT
- S_OK
- View name formula has been modified
- E_FAIL
- No view name formula found.
o GetViewType
-
Gets the view type.
- Parameters:
-
- oType
- The view type
- Returns:
- HRESULT
- S_OK
- View type has been found
- E_FAIL
- No view type found.
o IsActive
public virtual HRESULT IsActive( | boolean* | oActive) const = 0 |
-
Used to know if this view is active.
The active view is the view in edition.
There is only one active view int the drawing.
- Parameters:
-
- oActive
- TRUE if the view is active.
- Returns:
- HRESULT
- S_OK
- Execution successfully.
- E_FAIL
- Execution failed.
o SetViewName
public virtual HRESULT SetViewName( | const wchar_t* | iName) = 0 |
-
Sets the view name as a string. This name can override an existing formula.
- Parameters:
-
- iName
- The view name
- Returns:
- HRESULT
- S_OK
- View name has been modified
- E_FAIL
- No modification applied.
This object is included in the file: CATIDftView.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces