mi32/rgnman.h File Reference

<mi32/rgnman.h> More...

#include <mi32/trans2dc.h>
#include <mi32/xdefns.h>

Include dependency graph for rgnman.h:

Go to the source code of this file.

Classes
struct	MrgnManagerCallbackStruct
Namespaces
namespace	RVC
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::DESCRIPTOR &Descriptor, REGION2D &region)
void	MrgnManagerFormBindTool (Widget rmform, void *vmxt)
void	MrgnManagerFormClearTool (Widget rmform)
Widget	MrgnManagerFormCreate (RGNMANHANDLE vpdp, Widget parent, UINT32 flags, Arg *formarg, int formn)
void	MrgnManagerFormUpdateTool (Widget rmform)
int	MrgnManagerFree (RGNMANHANDLE vpdp)
int	MrgnManagerGetRegion (RGNMANHANDLE vpdp, INT32 ListNum, REGION2D &region)
void	MrgnManagerGetRegionList (RGNMANHANDLE vpdp, RVC::OBJITEMLIST &list)
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

---

Define Documentation

#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

---

Typedef Documentation

typedef void* RGNMANHANDLE

---

Function Documentation

void MrgnManagerAddCallback	(	RGNMANHANDLE	vpdp,
		void(*)(MrgnManagerCallbackStruct *, void *)	CallbackFunc,
		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::DESCRIPTOR &	Descriptor,
		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()

Widget MrgnManagerFormCreate	(	RGNMANHANDLE	vpdp,
		Widget	parent,
		UINT32	flags,
		Arg *	formarg,
		int	formn
	)

Create region manager form with region list and widgets.

Returns:

Form widget or NULL if error.

Parameters:

	vpdp	Region manager handle
	parent	Parent widget for form
	flags	For expansion
	formarg	XT Args for form
	formn	Number of XT Args

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

void MrgnManagerGetRegionList	(	RGNMANHANDLE	vpdp,
		RVC::OBJITEMLIST &	list
	)

Get currently-active regions as objitemlist.

Parameters:

vpdp

Region manager handle

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(*)(MrgnManagerCallbackStruct *, void *)	CallbackFunc,
		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.