L_VecDlgHitTest

#include "lvdlg.h"

L_LVDLG_API L_INT L_VecDlgHitTest(hWnd, pVector, pHitTest, dwFlags, pfnCallback, pUserData)

HWND hWnd;

/* window handle */

pVECTORHANDLE pVector;

/* pointer to a vector handle */

pVECTORHITTEST pHitTest;

/* hit test options */

L_UINT32 dwFlags;

/* user interface flags for dialog */

LVCOMMDLGHELPCB pfnCallback;

/* pointer to a help callback function */

L_VOID * pUserData;

/* pointer to more parameters for the callback */

Brings up the Vector Hit Test Options dialog.

Parameter

Description

hWnd

Handle of the window that owns the dialog.

pVector

Pointer to the vector handle that references the vector image to be affected by the hit test options.

pHitTest

Pointer to a VECTORHITTEST structure that contains hit test options. The values present in the structure when the function is called are used to initialize the dialog. If this parameter is NULL when the function is called, the values used to initialize the dialog will come from the vector handle. When this function returns, if this parameter is not NULL, the structure pointed to by pHitTest is updated with the values entered through the dialog.

dwFlags

User interface flags for dialog. Determines the layout and action of the dialog.

 

Value

Meaning

 

VECTOR_DLG_AUTO_PROCESS

[0x80000000] Process the image on OK.

 

VECTOR_DLG_SHOW_PREVIEW

[0x40000000] Show preview of image in dialog.

 

VECTOR_DLG_ENABLE_HELPBUTTON

[0x00000002] Enable Help button.

pfnCallback

Pointer to an optional help callback function.

 

If you do not wish to provide help to this dialog, use NULL as the value of this parameter.

 

To provide help to this dialog, use the function pointer as the value of this parameter.

 

The callback function must adhere to the prototype described in LVCOMMDLGHELPCB.

pUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs.

 

To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure.

 

If the additional parameters are not needed, you can pass NULL in this parameter.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To get the current hit test settings use L_VecGetHitTest.

Hit test settings can also be set by calling L_VecSetHitTest.

The hit test can be performed by calling L_VecHitTest.

Required DLLs and Libraries

LVDLG

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:

L_VecGetHitTest, L_VecSetHitTest, L_VecHitTest.

Topics:

Vector Common Dialogs

Example

This example will run the common hit test options dialog. 

L_INT VecDlgHitTestExample(
   HWND hWnd,
   pVECTORHANDLE pVector)
{
   L_INT nRet;
   VECTORHITTEST  Hittest;

   nRet = L_VecGetHitTest( pVector, &Hittest );
   if(nRet != SUCCESS)
      return nRet;

   nRet = L_VecDlgHitTest (
      hWnd,
      pVector,
      &Hittest,
      VECTOR_DLG_AUTO_PROCESS |
      VECTOR_DLG_SHOW_PREVIEW ,
      NULL,
      NULL);

   return nRet;
}