LImageViewer::RemoveAction

#include "ltwrappr.h"

L_INT LImageViewer::RemoveAction (nAction, uFlags);

L_INT nAction;	/* action ID */
L_UINT uFlags;	/* reserved for future use */

Removes the specified action from the container. This function is available only in the Medical Imaging Suite toolkits.

Parameter	Description
nAction	Value that represents the action to be removed. If nAction is equal to or greater than 100, it is a user-defined action. Otherwise, it should be one of these predefined actions.
	Value	Meaning
	CONTAINER_ACTION_WINDOWLEVEL	[1] Window leveling
	CONTAINER_ACTION_SCALE	[2] Scaling
	CONTAINER_ACTION_OFFSET	[3] Offset
	CONTAINER_ACTION_STACK	[4] Stacking
	CONTAINER_ACTION_MAG	[5] Magnifying glass
	CONTAINER_ACTION_ALPHA	[6] Alpha
uFlags	Reserved for future use. Must be zero.

Returns

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

Comments

When an action is removed from a container, all properties, mouse buttons, and keystroke combinations are also removed.

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::AddAction, LImageViewer::SetAction, LImageViewer::SetActionProperties, LImageViewer::GetActionProperties, LImageViewer::GetActionCount, LImageViewer::SetKeyboardAction, LImageViewer::GetKeyboardAction, LImageViewer::IsActionActive, LImageViewer::EnableActionCallBack, Class Members
Topics:	Applying Actions
	Window Control/Image Viewer Functions: Applying Actions

Example

// This function checks whether the action is active or not, if not the function will remove it.
void RemoveActionExample(LImageViewer& ImageViewer)
{
   L_INT nRet;
   L_BOOL bActive;
   L_INT nAction = CONTAINER_ACTION_OFFSET;
   L_UINT uVk1, uVk2, uVk3, uVk4, uModifiers;

   // Is the action attached to one of the mouse buttons.
   bActive = ImageViewer.IsActionActive( nAction , 0);
   if (!bActive)
   {
      // Check whether a keyboard shortcut is assigned to action or not.
      nRet = ImageViewer.GetKeyboardAction(nAction , CONTAINER_MOUSEMOVE_DOWN, &uVk1, &uModifiers, 0);
      nRet = ImageViewer.GetKeyboardAction(nAction , CONTAINER_MOUSEMOVE_DOWN, &uVk2, &uModifiers, 0);
      nRet = ImageViewer.GetKeyboardAction(nAction , CONTAINER_MOUSEMOVE_DOWN, &uVk3, &uModifiers, 0);
      nRet = ImageViewer.GetKeyboardAction(nAction , CONTAINER_MOUSEMOVE_DOWN, &uVk4, &uModifiers, 0);

      // If there is no keyboard shortcut assigned to the action the function will remove it.
      if ((!uVk1) && (!uVk2) && (!uVk3) && (!uVk4))
         nRet = ImageViewer.RemoveAction(nAction , 0);
   }
}