L_DispContainerGetCellScaleMode

#include "l_bitmap.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellScaleMode(hCon, nCellIndex, nSubCellIndex, puScaleMode, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of a cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
L_UINT * puScaleMode;	/* pointer to a variable to be updated */
L_UINT uFlags;	/* reserved for future use */

Retrieves the current scale mode for the specified cell or sub-cell.

Parameter	Description
hCon	Handle to the container.
nCellIndex	A zero-based index of the cell that contains the sub-cell, which is having its scale mode value retrieved.
nSubCellIndex	A zero-based index into the image list attached to the cell specified in nCellIndex. The function will retrieve the scale mode from the sub-cell with nSubCellIndex index. Pass -2 to retrieve the scale mode from the selected sub-cell.
puScaleMode	Address of the variable to be updated, with the scale mode. Possible values are:
	Value	Meaning
	CONTAINER_SCALEMODE_NORMAL	[0x00000000] No scale mode applied.
	CONTAINER_SCALEMODE_FIT	[0x00000001] The image will fit to the sub-cell boundaries.
	CONTAINER_SCALEMODE_FITWIDTH	[0x00000002] The image width will fit to the sub-cell boundaires.
	CONTAINER_SCALEMODE_FITHEIGHT	[0x00000003] The image height will fit to the image boundareis.
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Currently, there are two ways to fit an image to a cell. One is by setting the bIsFit value of DISPCELLPROPERTIES structure to true (also remembering to set the corresponding uMask value), and then sending this structure to L_DispContainerSetCellProperties. The other method is by using L_DispContainerGetCellScale and L_DispContainerSetCellScale. In order to be able to use these functions make sure that bIsFit is set to FALSE.

To get the scale of cell or sub-cell use the L_DispContainerGetCellScale function.
To set the scale of cell or sub-cell use the L_DispContainerSetCellScale function.
To set the properties of the scale action use the L_DispContainerSetActionProperties function.
To get the properties of the scale action use the L_DispContainerGetActionProperties function.
To set the scale mode of cell or sub-cell use the L_DispContainerSetCellScaleMode 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.

Platforms

Windows 95 / 98 / Me; Windows 2000 / XP; Windows CE.

See Also

Functions:	L_DispContainerSetCellScaleMode, L_DispContainerGetCellScale, L_DispContainerSetCellScale,L_DispContainerCreate, L_DispContainerRemoveCell, L_DispContainerInsertCell, L_DispContainerGetCellCount, L_DispContainerGetCellWindowHandle, L_DispContainerSetCellTag, L_DispContainerSetCellProperties, L_DispContainerAddAction, L_DispContainerSetAction, L_DispContainerGetActionProperties, L_DispContainerRemoveAction, L_DispContainerGetActionCount
Topics:	Applying Actions
	Image Viewer Functions: Applying Actions

Example

For an example, refer to L_DispContainerBeginUpdate.