LImageViewer::GetCellScale

#include "ltwrappr.h"

L_INT LImageViewer::GetCellScale(nCellIndex, nSubCellIndex, pdScale, uFlags)

L_INT nCellIndex;	/* index of a cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
L_DOUBLE * pdScale;	/* pointer to a variable to be updated */
L_UINT uFlags;	/* reserved for future use */

Gets the current scale value of the speifcied cell or sub-cell. This feature is available in version 16 or higher.

Parameter	Description
nCellIndex	A zero-based index of the cell that contains the sub-cell, which is having its scale value obtained.
nSubCellIndex	A zero-based index into the image list attached to the cell specified in nCellIndex. The scale for this sub-cell will be retrieved. This sub-cell scale will be retrieved. Pass -2 to retrieve the scale of the selected sub-cell.
pdScale	Address of the variable to be updated with the scale value.
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 the DISPCELLPROPERTIES structure to true (also remembering to set the corresponding uMask value), and then send this structure to the LImageViewer::SetCellProperties function. The other method is by using the LImageViewer::GetCellScale and LImageViewer::SetCellScale functions. If using these make sure that bIsFit is set to FALSE.

To set the scale of a cell or sub-cell call LImageViewer::SetCellScale function, and to set the properties of the scale action use the LImageViewer::SetActionProperties function. To retrieve the properties of the scale action use the LImageViewer::GetActionProperties function. To set the scale mode of a cell or sub-cell call the LImageViewer::SetCellScaleMode function and to get it call the LImageViewer::GetCellScaleMode 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::GetCellScaleMode, LImageViewer::SetCellScaleMode, LImageViewer::SetCellScale, LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::GetCellWindowHandle, LImageViewer::SetCellTag, LImageViewer::SetCellProperties, LImageViewer::AddAction, LImageViewer::SetAction, LImageViewer::GetActionProperties, LImageViewer::RemoveAction, LImageViewer::GetActionCount, Class Members
Topics:	Applying Actions
	Image Viewer Functions: Applying Actions

Example

For an example, refer to LImageViewer::BeginUpdate.