LImageViewerCell::SetCellScale

#include "ltwrappr.h"

L_INT LImageViewerCell::SetCellScale (nSubCellIndex, dScale, uFlags)

L_INT nSubCellIndex;

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

L_DOUBLE dScale;

/* scale value */

L_UINT uFlags;

/* reserved for future use */

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

Parameter

Description

nSubCellIndex

A zero-based index into the image list attached to the cell. This image will be scaled. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

dScale

Value that represent the new scale value to be set.

uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

 

Value

Meaning

 

CELL_APPLYTOTHIS

[0x00000000] Apply the feature to this cell only.

 

CELL_APPLYTOALL

[0x10000000] Apply the feature to all the cells in the Image Viewer.

 

CELL_APPLYTOSELECTED

[0x20000000] Apply the feature to the selected cells in the Image Viewer.

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

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

To retrieve the properties of the scale action use the LImageViewerCell::GetActionProperties function.

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

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

To set the scale mode of cell or sub-cell use the LImageViewerCell::SetCellScaleMode function.

To get the scale mode of cell or sub-cell use the LImageViewerCell::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:

LImageViewerCell::GetCellScaleMode, LImageViewerCell::SetCellScaleMode, LImageViewerCell::GetCellScale,LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::GetCellWindowHandle, LImageViewerCell::SetCellTag, LImageViewerCell::SetCellProperties, LImageViewerCell::AddAction, LImageViewerCell::SetAction, LImageViewerCell::GetActionProperties, LImageViewerCell::RemoveAction, LImageViewerCell::GetActionCount, Class Members

Topics:

Applying Actions

 

Image Viewer Functions: Applying Actions

Example

For an example, refer to LImageViewerCell::BeginUpdate.