LImageViewer::SetCellRegionHandle

#include "ltwrappr.h"

L_INT LImageViewer::SetCellRegionHandle(nCellIndex, nSubCellIndex, hRgn, uCombineMode, uFlags)

L_INT nCellIndex;

/* index of the cell */

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_HRGN hRgn;

/* handle to the Windows region */

L_UINT uCombineMode;

/* action to take regarding the existing region */

L_UINT uFlags;

/* reserved for future*/

Creates or updates the cell or sub-cell bitmap region by adding a region that is specified by a Windows region handle.

Parameter

Description

nCellIndex

A zero-based index of the cell for which to set the region handle to. Pass -2 to set the region of the selected cell.

nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell contains the image that contains the bitmap, which will contain the region handle. Pass -2 to refer to the selected sub-cell. If the cell contains 1 frame then the nSubCellIndex should be 0.

hRgn

Handle to the Windows region.

uCombineMode

The action to take regarding the existing bitmap region, if one is defined. For descriptions of the possible values, refer to Creating a Bitmap Region.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function sets the cell region handle. To get the bitmap region handle, use the LImageViewer::GetCellRegionHandle function.

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:

LImageViewer::GetCellRegionHandle, LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::GetWindowHandle, LImageViewer::SetCellBitmapList, LImageViewer::SetCellTag, LImageViewer::GetCellProperties, LImageViewer::GetCellPosition, LImageViewer::RepositionCell, LImageViewer::GetCellBitmapList, LImageViewer::GetCellBounds, LImageViewer::FreezeCell, LImageViewer::SelectCell, LImageViewer::IsCellSelected, LImageViewer::IsCellFrozen, Class Members

Topics:

Image Viewer Cells

 

Window Control/Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to LImageViewer::RegionCallBack.