DISPCONTAINERACTIONPROPS

Summary

The DISPCONTAINERACTIONPROPS structure contains the "general properties" for controlling the behavior of various actions.

Syntax

typedef struct tagDISPCONTAINERACTIONPROPS 
{ 
   L_UINT uStructSize; 
   HCURSOR hCursor; 
   L_INT nChange; 
   L_BOOL bCircularMouseMove; 
} DISPCONTAINERACTIONPROPS, *pDISPCONTAINERACTIONPROPS; 

Members

uStructSize

The size of the action structure. You have to set the value of this member to the size of the structure that holds DISPCONTAINERACTIONPROPS. For example DISPWLEVELACTIONPROPS contain the structure member DISPCONTAINERACTIONPROPS so the uStructSize must be = sizeof(DISPWLEVELACTIONPROPS).

hCursor

Default cursor for the action. This parameter is applied at the container level. Default is the arrow cursor.

nChange

Percentage value that represents the mouse sensitivity. Possible values are >= 0. Default is 100. A value of 100 indicates that the amount of change in the action is equal to the amount of movement of the mouse. For example, if the mouse is moved 1 pixel, the action changes by 1 unit. A value of 50 indicates that the amount of change in the action is 50% of the amount of mouse movement. For example, if the mouse is moved 2 pixels, the action only changes by one unit.

This parameter is applied on the container level.

bCircularMouseMove

Boolean flag that indicates whether the mouse resets when it reaches the side of the container. If the mouse is reset, then when it is dragged to one side of the container, it will disappear from that side and reappear on the opposite side of the container. This also applies to the top and bottom of the container. This parameter is applied on the container level. Possible values are:

Comments

For each action supported by the image viewer, there are general properties and specific properties. The general properties are those that are common to all actions and are applied at the container level. Each structure specific for an action contains a member that is a DISPCONTAINERACTIONPROPS structure and one or more other members. The DISPCONTAINERACTIONPROPS structure contains "general properties" that are common to all actions. The other members of the structures are considered "general properties" or "specific properties", depending on whether they are applied at the container level or the cell level. Those members that are applied at the container level are also considered "general properties". Members that are applied at the cell level or the sub-cell level are considered "specific properties". For example, if the L_DispContainerGetActionProperties function is called to get the scale action properties, a variable of type DISPSCALEACTIONPROPS should be declared. Pass a pointer to the DISPSCALEACTIONPROPS structure for the pActionProperties parameter. To get only the general properties, set uFlags to CONTAINER_ACTION_CONTAINERLEVEL. To get the specific properties, set uFlags to CONTAINER_ACTION_CELLLEVEL.

To get only the general action properties for the container, call L_DispContainerGetActionProperties with the uFlags parameter set to CONTAINER_ACTION_CONTAINERLEVEL. To set only the general action properties for the container, call L_DispContainerSetActionProperties with the uFlags parameter set to CONTAINER_ACTION_CONTAINERLEVEL.

Usage

• DISPALPHAACTIONPROPS
• DISPMAGACTIONPROPS
• DISPOFFSETACTIONPROPS
• DISPOWNERACTIONPROPS
• DISPSCALEACTIONPROPS
• DISPSTACKACTIONPROPS
• DISPWLEVELACTIONPROPS