All Frameworks Class Hierarchy This Framework Indexes
CATSchPlatformInterfaces Interface CATISchCompGraphic
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchCompGraphic
Interface to manage Schematic component's association with its
graphical representations.
Role: To modify component's links to its
graphical representations.
Method Index
- o
Activate2(CATUnicodeString&,double*,CATISchGRRComp**)
- To add a new image to an existing object.
- o
Activate(char*,double*,CATISchGRRComp**)
-
- o
AddGraphicalRepresentation(CATISchGRRComp*)
- Add a graphical representation to a component.
- o
Deactivate(CATISchGRRComp*)
- To remove an image to an existing object.
- o
ListGraphicalImages(CATIUnknownList**)
- List all graphical images (instances of the rep) of a component.
- o
ListGraphicalRepresentations(CATIUnknownList**)
- List all graphical representation of a component.
- o
RemoveGraphicalRepresentation(CATISchGRRComp*)
- Remove a graphical representation from a component.
- o
Switch2(CATISchGRRComp*,CATUnicodeString&,CATISchGRRComp**)
- Replace the input image object with an image of the graphical.
- o
SwitchAll2(CATUnicodeString&)
- Replace all occurances of the images of this component with those of
the graphical representation with the input name.
- o
SwitchAll(char*)
-
- o
Switch(CATISchGRRComp*,char*,CATISchGRRComp**)
-
Methods
o Activate2
| public virtual Activate2( | const | iGRRName, |
| | iDb2WhereAt, |
| | oGRR) |
-
To add a new image to an existing object. This new image is
an instance of graphical representation with the input
name.
- Parameters:
-
- iGRRName
- The name of the graphic representation
- iDb2WhereAt
- The x-y coordinates of the image position. If NULL, the image
will be positioned at the origin.
- oGRR
- Pointer to the new graphical image of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Activate
| public virtual Activate( | const | iGRRName, |
| | iDb2WhereAt, |
| | oGRR) |
-
- Deprecated:
- V5R15
Use
CATISchCompGraphic.Activate2 instead. To add a new image to an existing object. This new image is
an instance of graphical representation with the input
name.
- Parameters:
-
- iGRRName
- The name of the graphic representation
- iDb2WhereAt
- The x-y coordinates of the image position. If NULL, the image
will be positioned at the origin.
- oGRR
- Pointer to the new graphical image of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o AddGraphicalRepresentation
| public virtual AddGraphicalRepresentation( | | iGRRToAdd) |
-
Add a graphical representation to a component.
- Parameters:
-
- iGRRToAdd
- The graphical representation to be added to the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Deactivate
| public virtual Deactivate( | | iGRR) |
-
To remove an image to an existing object.
- Parameters:
-
- iGRR
- The graphical image to be removed from the component.
- iDb2WhereAt
- The x-y coordinates of the image position. If NULL, the image
will be positioned at the origin.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListGraphicalImages
| public virtual ListGraphicalImages( | | oLGRR) |
-
List all graphical images (instances of the rep) of a component.
- Parameters:
-
- oLGRR
- A list of graphical images
(members are CATISchGRRComp interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o ListGraphicalRepresentations
| public virtual ListGraphicalRepresentations( | | oLGRR) |
-
List all graphical representation of a component.
- Parameters:
-
- oLGRR
- A list of graphical representations
(members are CATISchGRRComp interface pointers).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o RemoveGraphicalRepresentation
| public virtual RemoveGraphicalRepresentation( | | iGRRToRemove) |
-
Remove a graphical representation from a component.
- Parameters:
-
- iGRRToRemove
- The graphical representation to be removed from the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Switch2
| public virtual Switch2( | | iGRR, |
| const | iGRRName, |
| | oGRR) |
-
Replace the input image object with an image of the graphical.
representation with the input name
- Parameters:
-
- iGRR
- Pointer to the component graphical image to be switched.
- oGRR
- Pointer to the new graphical image of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SwitchAll2
| public virtual SwitchAll2( | const | iGRRName) |
-
Replace all occurances of the images of this component with those of
the graphical representation with the input name.
- Parameters:
-
- iGRRName
- The name of the graphical representation
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SwitchAll
| public virtual SwitchAll( | const | iGRRName) |
-
- Deprecated:
- V5R15
Use
CATISchCompGraphic.SwitchAll2 instead. Replace all occurances of the images of this component with those of
the graphical representation with the input name.
- Parameters:
-
- iGRRName
- The name of the graphical representation
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o Switch
| public virtual Switch( | | iGRR, |
| const | iGRRName, |
| | oGRR) |
-
- Deprecated:
- V5R15
Use
CATISchCompGraphic.Switch2 instead. Replace the input image object with an image of the graphical.
representation with the input name
- Parameters:
-
- iGRR
- Pointer to the component graphical image to be switched.
- oGRR
- Pointer to the new graphical image of the component.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchCompGraphic.h