All Frameworks  Class Hierarchy  This Framework  Indexes

CATSchPlatformModeler Class CATSchEventServices

CATSchEventServices
 

Usage: you must use this class as is. You should never derive it.


public class CATSchEventServices

Tools to manage events in the schematic platform.
Role: Used for updating visualization after creation, modification, deletion of an object.


Method Index


o ConnectToCntr(CATISpecObject*,CATBoolean)
Connect this object to the graphic representations of all its connectors for visualization events.
o ConnectToGRR(CATISpecObject*,CATBoolean)
Connect this object to its graphic representation for visualization events.
o ModifyConnectToCntr(CATISpecObject*)
Send a modify event to the connectors of the input object.
o RedrawGraphViewerFromRoot(CATISpecObject*,CATIRedrawEvent*)
Refresh the specification tree from the input object.
o RestoreAllEventConnections(CATDocument*,CATIContainer*,CATIContainer*)
Given a document, reconnect all the schematic objects in the schematic extension container and related drafting objects in the drafting container to their graphical representations for visualization events.
o RunningODT()
o SendCreateEvent(CATISpecObject*,CATISpecObject*)
Send a create event for an object that has been modified.
o SendDeleteEvent(CATISpecObject*)
Send a delete event for an object that has been deleted.
o SendEventByComponentGroup(CATSchEventType,CATISchComponentGroup*)
Send an event to a component group object.
o SendModifyEvent(CATISpecObject*)
Send a modify event for an object that has been modified.
o SendModifyEventToAllCntrs()
Send a modify event for all the connectors in the current document.

Enumerated Type Index


o CATSchEventType
Event type.

Methods


o ConnectToCntr
public static void ConnectToCntr( const CATISpecObject* iObj,
CATBoolean iBCreateEvent=FALSE)
Connect this object to the graphic representations of all its connectors for visualization events.
Parameters:
iObj
Pointer to the object.
iBCreateEvent
If TRUE, a create event is also sent.
o ConnectToGRR
public static void ConnectToGRR( const CATISpecObject* iObj,
CATBoolean iBCreateEvent=FALSE)
Connect this object to its graphic representation for visualization events.
Parameters:
iObj
Pointer to the object.
iBCreateEvent
If TRUE, a create event is also sent.
o ModifyConnectToCntr
public static void ModifyConnectToCntr( const CATISpecObject* iObj)
Send a modify event to the connectors of the input object.
Parameters:
iObj
Pointer to the object.
o RedrawGraphViewerFromRoot
public static void RedrawGraphViewerFromRoot( const CATISpecObject* iObj,
CATIRedrawEvent* iRootRedraw= NULL)
Refresh the specification tree from the input object.
Parameters:
iObj
Pointer to the object.
iRootRedraw
Pointer to root to start redrawing.
o RestoreAllEventConnections
public static void RestoreAllEventConnections(CATDocument* iDoc,
CATIContainer* iSchCont,
CATIContainer* iDrwCont)
Given a document, reconnect all the schematic objects in the schematic extension container and related drafting objects in the drafting container to their graphical representations for visualization events.
Parameters:
iDoc
Pointer to the document
iSchCont
Pointer to the schematic extension container
iSchCont
Pointer to the drafting container
o RunningODT
public static CATBoolean RunningODT()
Deprecated:
V5R15
This interface will be deleted in V5R17 and it will not been implemented.
o SendCreateEvent
public static void SendCreateEvent( const CATISpecObject* iObj,
const CATISpecObject* iAncestor=NULL)
Send a create event for an object that has been modified.
Parameters:
iObj
Pointer to the object.
iAncestor
Pointer to the ancestor of the object.
o SendDeleteEvent
public static void SendDeleteEvent( const CATISpecObject* iObj)
Send a delete event for an object that has been deleted.
Parameters:
iObj
Pointer to the object.
o SendEventByComponentGroup
public static void SendEventByComponentGroup(CATSchEventType iEventType,
CATISchComponentGroup* iCompGroup)
Send an event to a component group object.
Parameters:
iEventType
Event type.
iCompGroup
Pointer to the component group object.
o SendModifyEvent
public static void SendModifyEvent( const CATISpecObject* iObj)
Send a modify event for an object that has been modified.
Parameters:
iObj
Pointer to the object.
o SendModifyEventToAllCntrs
public static void SendModifyEventToAllCntrs()
Send a modify event for all the connectors in the current document.

Enumerated Types


o CATSchEventType
enum CATSchEventType {
  SchCreateEvent,
  SchModifyEvent,
  SchDeleteEvent
}
Event type. Role: Types of events.
Parameters:
SchCreateEvent
Event to be sent when a schematic object has been created.
SchModifyEvent
Event to be sent when a schematic object has been modified.
SchDeleteEvent
Event to be sent when a schematic object has been deleted.

This object is included in the file: CATSchEventServices.h
If needed, your Imakefile.mk should include the module: CATSchUtilities

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