#include "ltwrappr.h"
L_INT LImageViewerCell::GetCellScaleMode(nSubCellIndex, puScaleMode, uFlags)
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. This feature is available in version 16 or higher.
Parameter | Description | |
nSubCellIndex | A zero-based index into the image list attached to the cell. 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. This is the default 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. |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
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 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 scale of cell or sub-cell use the LImageViewerCell::SetCellScale 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.
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. |
For an example, refer to LImageViewerCell::BeginUpdate.