In This Topic ▼

LBitmapWindow::UpdateMagGlassShape

Summary

Updates the Magnifying Glass shape.

Syntax

#include "ltwrappr.h"

L_INT LBitmapWindow::UpdateMagGlassShape(uMagGlassShape, hMagGlassRgn)

Parameters

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

L_HRGN 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

Value	Meaning
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:

If the value passed in the uMagGlassShape parameter was outside the defined values.
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.

Example

L_INT LBitmapWindow__UpdateMagGlassShapeExample(LBitmapWindow &LeadBWnd,HWND hWnd) 
{ 
   L_INT nRet; 
   HRGN  hRoundRectRgn; 
   hRoundRectRgn = CreateRoundRectRgn(0, 0, 100, 100, 25, 25); 
 
   nRet = LeadBWnd.SetWndHandle(hWnd); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   LeadBWnd.SetToolType(TOOL_MAGGLASS); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = LeadBWnd.UpdateMagGlassShape(MAGGLASS_SHAPE_HRGN, hRoundRectRgn); 
   if(nRet != SUCCESS) 
      return nRet; 
   DeleteRgn(hRoundRectRgn); 
 
   LeadBWnd.SetWndHandle(NULL); 
 
   return SUCCESS; 
}