L_DispContainerIsCellFrozen

#include "ltivw.h"

L_LTIVW_API L_BOOL L_DispContainerIsCellFrozen(hCon, nCellIndex, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_INT nCellIndex;

/* index of the cell */

L_UINT uFlags;

/* reserved for future use */

Returns a value that indicates whether the specified cell is frozen.

Parameter

Description

hCon

Handle to the container.

nCellIndex

A zero-based index of the cell for which to determine the freeze status.

uFlags

Reserved for future use. Pass 0.

Returns

TRUE

The cell is frozen.

FALSE

The cell is not frozen, or an error occurred. To get extended error information, call GetLastError.

Comments

To freeze or un-freeze a cell, call L_DispContainerFreezeCell.

When a cell is frozen no actions using the mouse or the keyboard can be performed on the cell. Some cell properties can still be changed manually however, using L_DispContainerSetCellProperties, L_DispContainerSelectCell and L_DispContainerSetProperties. For more information on actions associated with a container, refer to Applying Actions.

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:

L_DispContainerFreezeCell, L_DispContainerSelectCell, L_DispContainerIsCellSelected, L_DispContainerCreate, L_DispContainerGetCellCount, L_DispContainerGetCellWindowHandle, L_DispContainerSetCellBitmapList, L_DispContainerSetCellTag, L_DispContainerSetCellProperties, L_DispContainerInsertCell, L_DispContainerRemoveCell, L_DispContainerGetCellProperties, L_DispContainerRepositionCell, L_DispContainerGetCellPosition, L_DispContainerGetCellBitmapList, L_DispContainerGetCellBounds

Topics:

Image Viewer Cells

 

Image Viewer Functions: Image Viewer Cells

Example

This procedure unfreezes any frozen cell

 L_INT DispContainerIsCellFrozenExample(HDISPCONTAINER hCon) 
{
   L_INT nRet;
   // Get the cells count. 
   L_INT nCount = L_DispContainerGetCellCount (hCon, 0); 
   L_INT nI; 

   for (nI = 0; nI < nCount; nI++)
   {
      // if there is a selected cell make it unselected and vice versa
      L_BOOL bFreezed = L_DispContainerIsCellFrozen (hCon, nI, 0); 
      if (bFreezed) 
      {
         nRet = L_DispContainerFreezeCell (hCon, nI, FALSE, 0); 
         if(nRet != SUCCESS)
            return nRet;
      }
   }
   return SUCCESS;
}