VECTOREVENT

Summary

The VECTOREVENT structure holds information about an event.

Syntax

typedef struct tagVECTOREVENT 
{ 
   L_INT nSize; 
   L_UINT uType; 
   VECTOR_EVENT_STATUS Status; 
   L_INT nErrorCode; 
   pVECTOROBJECT pObject; 
   L_VOID *pObjectDesc; 
   pVECTORLAYER pLayer; 
   pVECTORLAYERDESC pLayerDesc; 
   pVECTORGROUP pGroup; 
   pVECTORGROUPDESC pGroupDesc; 
   pVECTORPOINT pPoint1; 
   pVECTORPOINT pPoint2; 
   L_UINT32 dwFlags; 
   L_VOID *pUserData; 
} VECTOREVENT, * pVECTOREVENT; 

Members

L_INT nSize

Size of this structure. Used for versioning.

L_UINT uType

The type of event that was generated. For a list of possible values, refer to the Comments section below.

VECTOR_EVENT_STATUS Status

Status of the event. Possible values are:

L_INT nErrorCode

Error code associated with the event. For a list of possible values, refer to the Return Codes.

pVECTOROBJECT pObject

Pointer to the vector object associated with the event. This structure member is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

L_VOID *pObjectDesc

Pointer to an object descriptor. This structure is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORLAYER pLayer

Pointer to the vector layer associated with the event. This structure member is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORLAYERDESC pLayerDesc

Pointer to a layer descriptor. This structure is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORGROUP pGroup

Pointer to the vector group associated with the event. This structure member is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORGROUPDESC pGroupDesc

Pointer to a group descriptor. This structure is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORPOINT pPoint1

Pointer to a general point 1. This structure is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

pVECTORPOINT pPoint2

Pointer to a general point 2. This structure is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

L_UINT32 dwFlags

Flag that provides processing information. This member is only valid for certain event types. For a list of the events for which this member is valid, refer to the table in the Comments section below.

L_VOID *pUserData

User defined data.

Comments

The uType member will correspond to the vector function called, for example if you call L_VecSetObject, an event of type VECTOR_EVENT_SETOBJECT will be fired.

The following table lists all the defined event types plus values for the structure variables, when defined. Not all structure members are defined for every event. For example, the Object pObject member is not defined for a VECTOR_EVENT_FREE event, but it is defined for the VECTOR_EVENT_TRANSLATION event. The pObject structure member is the same as the L_VecSetTranslation function.

The events VECTOR_EVENT_USER to (VECTOR_EVENT_RESRVED-1) are user-defined. You can use any of these values when implementing your own events using L_VecEvent.

Note that when using Vector automation, dwFlags should be ORed with VECTOR_FLAGS_ADD_UNDO_NODE in order for the event to add an undo node.

pVECTOREVENT is a pointer to a VECTOREVENT structure.

Usage

• L_VecEvent