DISPCONTAINERREGIONCALLBACK

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction(hRgn, nCellIndex, nSubCellIndex, uOperation, pUserData)

HRGN hRgn;

/* handle to the Windows region */

L_INT nCellIndex;

/* index of the cell */

L_INT nSubCellIndex;

/* index of the sub-cell */

L_UINT uOperation;

/* action taking regarding the existing region */

L_VOID * pUserData;

/* pointer to more parameters for the callback */

This callback is called every time the user creates, changes or removes a region from one of the bitmaps displayed in a cell.

Parameter

Description

hRgn

Handle to the Windows region.

nCellIndex

A zero-based index of the cell that contains the tag to be deleted. Pass -2 to delete the tag of the specific information in all selected cells in the container.

nSubCellIndex

A zero-based index of the sub-cell. This sub-cell contains the image that contains the region changed. Pass -2 to refer to the selected sub-cell.

uOperation

The action to take regarding the existing bitmap region, if one is defined. It can be one of the following value:

 

Value

Meaning

 

L_RGN_AND

[0] An AND operation has been applied to the existing region.

 

L_RGN_SET

[1] A new region has been created.

 

L_RGN_ANDNOTRGN

[3] The existing region has been reduced.

 

L_RGN_OR

[4] A new region has been combined with the existing one.

 

L_RGN_SETNOT

[6] An inverted region has been created.

 

L_RGN_REMOVE

[8] The existing region has been removed.

pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_DispContainerSetRegionCallBack.) Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To get the region callback, use L_DispContainerGetRegionCallBack. To set the region callback, use L_DispContainerSetRegionCallBack.

Required DLLs and Libraries

LTIVW
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

L_DispContainerGetRegionCallBack, L_DispContainerSetMouseCallBack, L_DispContainerSetActionCallBack, L_DispContainerSetTagCallBack, L_DispContainerGetTagCallBack, L_DispContainerSetAnnotationCallBack, L_DispContainerGetAnnotationCallBack, L_DispContainerGetAnnotationCreatedCallBack, L_DispContainerSetAnnotationCreatedCallBack, L_DispContainerSetPrePaintCallBack, L_DispContainerGetPrePaintCallBack, DISPCONTAINERPREPAINTCALLBACK, L_DispContainerGetPostPaintCallBack, L_DispContainerSetPostPaintCallBack, DISPCONTAINERPOSTPAINTCALLBACK, DISPCONTAINERANNOTATIONCALLBACK, DISPCONTAINERANNOTATIONCREATEDCALLBACK, DISPCONTAINERTAGCALLBACK, DISPCONTAINERACTIONCALLBACK

Topics:

Image Viewer Cells

 

Image Viewer Functions: Callbacks

 

Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerGetRegionCallBack.