LImageViewer::SetCellScaleMode

#include "ltwrappr.h"

L_INT LImageViewer::SetCellScaleMode(nCellIndex, nSubCellIndex, uScaleMode, uFlags)

L_INT nCellIndex;

/* index of a cell */

L_INT nSubCellIndex;

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

L_UINT uScaleMode;

/* flag */

L_UINT uFlags;

/* reserved for future use */

Sets the current scale mode for the specified 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 mode set. Pass -1 to set the scale mode for the sub-cell with nSubCellIndex for all cells managed by the container. Pass -2 to set the scale mode for the sub-cell with nSubCellIndex for the selected cells managed by the container.

nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. The sub-cell with nSubCellIndex, will have its scale mode set. Pass -2 to set the scale mode of the selected sub-cell.

uScaleMode

Flag that indicates the type of the scale.  Possible values are:

 

Value

Meaning

 

CONTAINER_SCALEMODE_NORMAL

[0x00000000] No scale mode applied. This is the defualt value.

 

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 the LImageViewer::SetCellProperties function. The other method is by using the LImageViewer::GetCellScale and LImageViewer::SetCellScale functions. 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 LImageViewer::GetCellScale function.

To set the scale of cell or sub-cell use the LImageViewer::SetCellScale function.

To set the properties of the scale action use the LImageViewer::SetActionProperties function.

To get the properties of the scale action use the LImageViewer::GetActionProperties function.

To set the scale mode of cell or sub-cell use the LImageViewer::SetCellScaleMode 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::SetCellScaleMode, LImageViewer::GetCellScale, 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.