L_UpdateMagGlassShape

#include "l_bitmap.h"

L_LTDIS_API L_INT L_UpdateMagGlassShape(hWnd, uMagGlassShape, hMagGlassRgn)

L_HWND hWnd;	/* handle to a window */
L_UINT uMagGlassShape;	/* flags that indicate the magnifying glass shape */
L_HRGN hMagGlassRgn;	/* handle to the Windows region */

Updates the Magnifying Glass shape.

Parameter	Description
hWnd	Handle of the window to which the Magnifying Glass is attached.
uMagGlassShape	Flags that indicate the magnifying glass shape. Possible values are:
	Value	Meaning
	MAGGLASS_SHAPE_RECT	[0] Rectangle shape of Magnifying Glass.
	MAGGLASS_SHAPE_ELLIPSE	[1] Ellipse shape of Magnifying Glass.
	MAGGLASS_SHAPE_HRGN	[2] User-defined shape of Magnifying Glass.
hMagGlassRgn	Handle to a Windows region that defines the Magnifying Glass shape. This parameter is used only if the uMagGlassShape parameter is MAGGLASS_SHAPE_HRGN.

Returns

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

Comments

The width and height of the Magnifying Glass will be changed according to the width and height of the passed hMagGlassRgn parameter if the uMagGlassShape parameter was set to MAGGLASS_SHAPE_HRGN.

The Magnifying Glass will stop and this function will return an error value in two cases:

1.	If the value passed in the uMagGlassShape parameter was outside the defined values.
2.	If the value passed in the uMagGlassShape parameter was MAGGLASS_SHAPE_HRGN and the value passed to the hMagGlassRgn parameter was NULL.

Required DLLs and Libraries

LTDIS

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Mobile.

See Also

Functions:	L_StartMagGlass, L_StartMagGlass, L_StopMagGlass, L_CreateZoomView, L_GetZoomViewProps, L_UpdateZoomView, L_DestroyZoomView, L_GetZoomViewsCount, L_WindowHasZoomView, ZOOMVIEWPROPS
Topics:	Using the Magnifying Glass
	Raster Image Functions: Displaying Images
	Using the Zoom View

Example

This example sets the shape of the Magnifying Glass to a round rect shape for an already started Magnifying Glass.

L_INT UpdateMagGlassShapeExample(L_HWND hWnd)
{
   L_INT nRet;
   HRGN  hRoundRectRgn;

   hRoundRectRgn = CreateRoundRectRgn(0, 0, 100, 100, 25, 25);

   nRet = L_UpdateMagGlassShape(hWnd, MAGGLASS_SHAPE_HRGN, hRoundRectRgn);
   if(nRet != SUCCESS)
      return nRet;

   DeleteRgn(hRoundRectRgn);
   return SUCCESS;
}