rgnman.h File Reference

<mi32/rgnman.h> Functions and structure for the region manager More...

#include <mi32/rvcdefns.h>

Include dependency graph for rgnman.h:

Go to the source code of this file.

Classes
struct	MrgnManagerCallbackStruct
Defines
#define	MrgnCR_RegionAdded   0x00000001
#define	MrgnCR_RegionRemoved   0x00000002
#define	MrgnCR_RegionSelected   0x00000010
#define	MrgnCR_SetTransparm   MrgnCR_SetTransParm
#define	MrgnCR_SetTransParm   0x00000004
#define	MrgnCR_Stop   0x00000008
Typedefs
typedef void *	RGNMANHANDLE
Functions
void	MrgnManagerAddCallback (RGNMANHANDLE vpdp, void(*CallbackFunc)(MrgnManagerCallbackStruct *, void *), void *udata, UINT32 reason)
int	MrgnManagerAddRegion (RGNMANHANDLE vpdp, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, REGION2D &region)
void	MrgnManagerFormBindTool (Widget rmform, void *vmxt)
void	MrgnManagerFormClearTool (Widget rmform)
void	MrgnManagerFormUpdateTool (Widget rmform)
int	MrgnManagerFree (RGNMANHANDLE vpdp)
int	MrgnManagerGetRegion (RGNMANHANDLE vpdp, INT32 ListNum, REGION2D &region)
int	MrgnManagerHasRegion (RGNMANHANDLE vpdp)
int	MrgnManagerInit (RGNMANHANDLE *vpdp)
void	MrgnManagerRemoveCallback (RGNMANHANDLE vpdp, void(*CallbackFunc)(MrgnManagerCallbackStruct *, void *), void *udata, UINT32 reason)
int	MrgnManagerSave (RGNMANHANDLE vpdp, void *Widget, UINT32 flags)

---

Detailed Description

<mi32/rgnman.h> Functions and structure for the region manager

Definition in file rgnman.h.

---

Define Documentation

#define MrgnCR_RegionAdded   0x00000001

Definition at line 57 of file rgnman.h.

#define MrgnCR_RegionRemoved   0x00000002

Definition at line 58 of file rgnman.h.

#define MrgnCR_RegionSelected   0x00000010

Definition at line 62 of file rgnman.h.

#define MrgnCR_SetTransparm   MrgnCR_SetTransParm

Definition at line 60 of file rgnman.h.

#define MrgnCR_SetTransParm   0x00000004

Definition at line 59 of file rgnman.h.

#define MrgnCR_Stop   0x00000008

Definition at line 61 of file rgnman.h.

---

Typedef Documentation

typedef void* RGNMANHANDLE

Definition at line 39 of file rgnman.h.

---

Function Documentation

void MrgnManagerAddCallback (  RGNMANHANDLE  vpdp, void(*  CallbackFunc)(MrgnManagerCallbackStruct *, void *), void *  udata, UINT32  reason )

Add callback to the region manager. Callback reasons: MrgnCR_RegionAdded Region has been added to the list MrgnCR_RegionRemoved Region has been removed from the list MrgnCR_SetTransParm Used to update the region to screen transparm MrgnCR_RegionSelected Region has been selected in list Parameters: vpdp  Region manager handle udata  Mcb callback function User data passed in callback reason  Callback reasons

int MrgnManagerAddRegion (  RGNMANHANDLE  vpdp, const RVC::OBJECTNAME &  name, const RVC::OBJECTDESC &  desc, REGION2D &  region )

Add a region to the region manager. Parameters: vpdp  Region manager handle region  The region to add

void MrgnManagerFormBindTool (  Widget  rmform, void *  vmxt )

Bind region manager form to ERegion GraphicTool. Parameters: rmform  Form created by MrgnManagerFormCreate() vmxt  Tool handle to bind to.

void MrgnManagerFormClearTool (  Widget  rmform  )

Clear GraphicTool tool bound to region manager form. Parameters: rmform  Form created by MrgnManagerFormCreate()

void MrgnManagerFormUpdateTool (  Widget  rmform  )

Update GraphicTool (ERegion) bound to form. Parameters: rmform  Form created by MrgnManagerFormCreate()

int MrgnManagerFree (  RGNMANHANDLE  vpdp  )

Free up the region manager toolkit. Parameters: vpdp  Region manager handle

int MrgnManagerGetRegion (  RGNMANHANDLE  vpdp, INT32  ListNum, REGION2D &  region )

Get a region from the region manager. Returns: 1 if region returned, 0 if no region exists, < 0 error code. Parameters: vpdp  Region manager handle ListNum  Number of region to get, -1 for current region region  Region structure RETURNED

int MrgnManagerHasRegion (  RGNMANHANDLE  vpdp  )

Returns TRUE if a current region exists. Returns: 1 if region exists, 0 if no region exists. Parameters: vpdp  Region manager handle

int MrgnManagerInit (  RGNMANHANDLE *  vpdp  )

Initialize region manager toolkit and return handle. Parameters: vpdp  Region manager handle RETURNED

void MrgnManagerRemoveCallback (  RGNMANHANDLE  vpdp, void(*  CallbackFunc)(MrgnManagerCallbackStruct *, void *), void *  udata, UINT32  reason )

Remove callbacks from the region manager. See MrgnManagerAddCallback() for a list of callback reasons. Parameters: vpdp  Region manager handle udata  Mcb callback function User data passed in callback reason  Callback reasons

int MrgnManagerSave (  RGNMANHANDLE  vpdp, void *  Widget, UINT32  flags )

Save the region manager.

---