LImageViewerCell::GetAnnotationContainer

#include "ltwrappr.h"

L_INT LImageViewerCell::GetAnnotationContainer(nSubCellIndex, PhAnnContainer, uFlags)

L_INT nSubCellIndex;	/* index into the image list attached to the cell */
HANNOBJECT * PhAnnContainer;	/* address of the variable to be updated */
L_UINT uFlags;	/* reserved for future */

Gets the annotation container for the specific frame.

Parameter	Description
nSubCellIndex	A zero-based index into the image list attached to the cell. This sub-cell contains the image that contains the annotation container. Pass -2 to refer to the selected sub-cell.

PhAnnContainer	Address of the variable to be updated with the handle to the annotation container that is found at the specified sub-cell.
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function gets a copy of the annotation container. You must free it once it is no longer needed.

This function gets the annotation container. To set the annotation container use the LImageViewerCell::SetAnnotationContainer 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::RotateAnnotationContainer, LImageViewerCell::SetAnnotationContainer, LImageViewerCell::AnnToRgn, LImageViewerCell::GetSelectedAnnotationAttributes, LImageViewerCell::AnnotationCreatedCallBack, LImageViewerCell::AnnotationCallBack, Class Members
Topics:	Image Viewer Cells
	Window Control/Image Viewer Functions: Image Viewer Cells

Example

This example will copy the annotation container from the specified sub-cell clicked by the user using the left mouse button, and paste the annotation container on the specified sub-cell clicked by the user using the right mouse button.

#if defined LTV17_CONFIG
class LImageViewerChild4:public LImageViewerCell
{
   virtual L_INT MouseCallBack(L_UINT                 uMessage,
                               pDISPCONTAINERCELLINFO pCellInfo);
};
HANNOBJECT hContainer;
L_INT LImageViewerChild4::MouseCallBack(L_UINT                 uMessage,
                                 pDISPCONTAINERCELLINFO pCellInfo)
{
   UNREFERENCED_PARAMETER(pCellInfo);
   switch(uMessage)
   {
   case WM_LBUTTONUP:
         GetAnnotationContainer(pCellInfo->nSubCellIndex, &hContainer, 0);
      break;
   case WM_RBUTTONUP:
         SetAnnotationContainer(pCellInfo->nSubCellIndex, hContainer, 0);
      break;
   }
   return SUCCESS;
}
L_INT LImageViewer_GetAnnotationContainerExample(LImageViewerCell& ImageViewerCell)
{
   ImageViewerCell.EnableMouseCallBack( TRUE);
   return SUCCESS;
}
#else
class LImageViewerChild4:public LImageViewer
{
   virtual L_INT MouseCallBack(L_UINT                 uMessage,
                               pDISPCONTAINERCELLINFO pCellInfo);
};
HANNOBJECT hContainer;
L_INT LImageViewerChild4::MouseCallBack(L_UINT                 uMessage,
                                 pDISPCONTAINERCELLINFO pCellInfo)
{
   UNREFERENCED_PARAMETER(pCellInfo);
   switch(uMessage)
   {
   case WM_LBUTTONUP:
         GetAnnotationContainer( pCellInfo->nCellIndex, pCellInfo->nSubCellIndex, &hContainer, 0);
      break;
   case WM_RBUTTONUP:
         SetAnnotationContainer( pCellInfo->nCellIndex, pCellInfo->nSubCellIndex, hContainer, 0);
      break;
   }
   return SUCCESS;
}
L_INT LImageViewer_GetAnnotationContainerExample(LImageViewer& ImageViewer)
{
   ImageViewer.EnableMouseCallBack( TRUE);
   return SUCCESS;
}
#endif // LTV17_CONFIG