In This Topic ▼

L_DispContainerGetCellScaleMode

Summary

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

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellScaleMode(hCellWnd, nSubCellIndex, puScaleMode, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT 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.

L_UINT * 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 boundaries.
CONTAINER_SCALEMODE_FITHEIGHT	[0x00000003] The image height will fit to the image boundaries.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value	Meaning
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.