LImageViewerCell::IsButtonValid

#include "ltwrappr.h"

L_INT LImageViewerCell::IsButtonValid(nAction, nMouseButton, uFlags)

Checks the validity of assigning a button to a specific action.

Parameters

L_INT nAction

Value that represents the action, which the user wants to check the validity of assigning a button to it. If nAction is equal to or greater than 100 then it's a user-defined action. Otherwise it should be one of the following predefined actions:

L_INT nMouseButton

Pointer to a variable to be updated with the mouse button value. Possible values are:

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

This function is preferred to use before calling the LImageViewerCell::SetAction function to check the validity of assigning a button to a specific action. For example, if the user passed CONTAINER_MOUSE_WHEEL to the nMouseButton parameter and CONTAINER_ACTION_MAG to the nAction parameter of the LImageViewerCell::SetAction function, it will return ERROR_INV_PARAMETER, while if the same values are passed as parameters to this function, it will return 0 as an indication that the mouse button is not valid for this action.

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.

L_INT LImageViewer_IsButtonValidExample(LImageViewerCell& ImageViewerCell)  
{ 
   L_INT  nButton;  
   L_UINT uFlag;  
   L_INT nRet;  
 
   L_INT nMouseButton = CONTAINER_MOUSE_BUTTON_LEFT; 
 
   nRet = ImageViewerCell.GetActionButton(CONTAINER_ACTION_MAG, &nButton, &uFlag);  
   if (nRet != SUCCESS)  
      return nRet;  
 
   if (!nButton)  
   { 
      if (ImageViewerCell.IsButtonValid(CONTAINER_ACTION_MAG, nMouseButton, 0))  
      { 
         nRet = ImageViewerCell.SetAction (CONTAINER_ACTION_MAG, nMouseButton, 0);  
         if (nRet != SUCCESS)  
            return nRet;  
      } 
   } 
   return SUCCESS;  
}