L_VecDlgNewLayer

Summary

Brings up the Vector New Layer dialog. This function is available in the LEADTOOLS Vector Imaging Toolkit.

Syntax

L_LVDLG_API L_INT L_VecDlgNewLayer(hWnd, pVector, pLayerDesc, pLayer, pbActiveLayer, dwFlags, pfnCallback, pUserData)

Parameters

L_HWND hWnd

Handle of the window that owns the dialog.

pVECTORHANDLE pVector

Pointer to the vector handle that references the vector image to be affected by the new layer dialog.

pVECTORLAYERDESC pLayerDesc

Pointer to a VECTORLAYERDESC structure that contains new layer parameters. 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, default values are used to initialize the dialog. When this function returns, if this parameter is not NULL, the structure pointed to by pLayerDesc is updated with the values entered through the dialog.

pVECTORLAYER pLayer

Pointer to a VECTORLAYER structure. If this parameter is not NULL and VECTOR_DLG_AUTO_PROCESS is specified in dwFlags, the structure pointed to by pLayer will be updated with the newly added layer structure.

L_BOOL * pbActiveLayer

Pointer to an L_BOOL variable that indicates whether or not to use the active layer. The value present in the variable, when the function is called, is used to initialize the dialog. If this parameter is NULL when the function is called, a default value (TRUE) is used to initialize the dialog. When this function returns, if this parameter is not NULL, the variable will be updated with the value entered through the dialog.

L_UINT32 dwFlags

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

LVCOMMDLGHELPCB 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.

L_VOID * 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

Comments

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_VecDlgEditAllLayers
• L_VecDlgEditLayer.

Topics

• Vector Common Dialogs

Example

This example will add a new layer to the given vector handle.

L_INT VecDlgNewLayerExample( 
   HWND hWnd, 
   pVECTORHANDLE pVector) 
{ 
   L_INT nRet; 
 
   nRet = L_VecDlgNewLayer( 
      hWnd, 
      pVector, 
      NULL, 
      NULL, 
      NULL, 
      VECTOR_DLG_AUTO_PROCESS, 
      NULL, 
      NULL); 
 
   return nRet; 
}