All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchGRRCntr

System.IUnknown
  |
  +---CATISchGRRCntr
 

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


interface CATISchGRRCntr

Interface to manage the representation of Schematic connector graphic objects.
Role: To modify or query a connector's symbol or graphic representation.


Method Index


o GetSymbol(CATISchGRR**,CATSchCntrSymbolType*)
Get the graphical primitive of a connector.
o RemoveSymbol()
Remove the graphical primitive used as the connector's symbol.
o SetSymbol(CATISchGRR*,CATSchCntrSymbolType)
Set the symbol or graphics used to represent a connector.

Methods


o GetSymbol
public virtual HRESULT GetSymbol(CATISchGRR** oGRR,
CATSchCntrSymbolType* oESymbolType) = 0
Get the graphical primitive of a connector.
Parameters:
oGRR
The graphical primitive (ditto) used to represent a connector.
oESymbolType
Connector symbol type such as: point, point/vector, OnOffSheet, LineBoundary.
See also:
CATSchCntrSymbolType
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o RemoveSymbol
public virtual HRESULT RemoveSymbol()= 0
Remove the graphical primitive used as the connector's symbol. The default connector's symbol type will be set to point.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetSymbol
public virtual HRESULT SetSymbol(CATISchGRR* iGRRSymbol,
CATSchCntrSymbolType iESymbolType) = 0
Set the symbol or graphics used to represent a connector.
Parameters:
iGRRSymbol
The graphical primitive (detail) to be used as the connector's symbol. iGRRSymbol can be NULL if iESymbolType is a point or point/vector.
iESymbolType
Connector symbol type such as: point, point/vector, OnOffSheet, LineBoundary.
See also:
CATSchCntrSymbolType
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATISchGRRCntr.h

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