LImageViewer::IsCellFrozen

#include "ltwrappr.h"

L_BOOL LImageViewer::IsCellFrozen (nCellIndex, uFlags);

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
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 LImageViewer::FreezeCell.

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 LImageViewer::SetCellProperties, LImageViewer::SelectCell and LImageViewer::SetProperties. 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:	LImageViewer::FreezeCell, LImageViewer::SelectCell, LImageViewer::IsCellSelected, LImageViewer::Create, LImageViewer::GetCellCount, LImageViewer::GetCellWindowHandle, LImageViewer::SetCellBitmapList, LImageViewer::SetCellTag, LImageViewer::SetCellProperties, LImageViewer::InsertCell, LImageViewer::RemoveCell, LImageViewer::GetCellProperties, LImageViewer::RepositionCell, LImageViewer::GetCellPosition, LImageViewer::GetCellBitmapList, LImageViewer::GetCellBounds, Class Members
Topics:	Image Viewer Cells
	Window Control/Image Viewer Functions: Image Viewer Cells

Example

This procedure unfreezes any frozen cell.

L_INT LImageViewer_IsCellFrozenExample(LImageViewer& ImageViewer) 
{
   // Get the cells count. 
   L_INT    nCount = ImageViewer.GetCellCount(0); 
   L_INT    nI; 
   L_INT    nRet = 0 ; 
   // if there is a Frozen cell, make it unFrozen and vice versa
   for (nI = 0; nI < nCount; nI++)
   {
      nRet = ImageViewer.FreezeCell(nI, !ImageViewer.IsCellFrozen(nI, 0), 0); 
      if(nRet != SUCCESS)
         return nRet;
   }
   return SUCCESS;
}