LRasterPaint::RegionRect

#include "Ltwrappr.h"

L_INT LRasterPaint::RegionRect(UserDC, prcRect, phDestRgn)

HDC UserDC;	/* handle to the device context */
LPRECT prcRect;	/* pointer to a RECT structure */
pHRGN phDestRgn;	/* pointer to a region handle */

Creates a rectangular region using the specified points.

Parameter	Description
UserDC	Handle to a device context, such as a screen, to use as a display surface. This parameter can also be NULL. The mapping mode of the device context must be MM_TEXT.
prcRect	Pointer to a RECT structure that specifies the region boundaries.
phDestRgn	Pointer to the region handle to be updated with the resulting region.

Returns

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

Comments

The region creation procedure will be carried out using the current region properties. To determine the current region properties, call LRasterPaint::GetProperty. To set or change the current region properties, call LRasterPaint::SetProperty. For more information on the region properties, refer to the PAINTREGION structure.

This function will also use the current painting transformation information when creating the new region. To get the current painting transformation information, call LRasterPaint::GetTransformation. To change or set the painting transformation information, call LRasterPaint::SetTransformation.

If the user has set a bitmap in the toolkit, using the function LRasterPaint::SetMetrics, then the toolkit will create the region for the bitmap. Otherwise, the toolkit will create the region for the specified device context.

Required DLLs and Libraries

LTPNT

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:

LRasterPaint::SetProperty, LRasterPaint::SetTransformation, LRasterPaint::SetDCExtents, LRasterPaint::SetMetrics, LRasterDialog::DoModalRegion, LRasterPaint::GetClipRgn, LRasterPaint::OffsetClipRgn, LRasterPaint::RegionBorder, LRasterPaint::RegionColor, LRasterPaint::RegionEllipse, LRasterPaint::RegionPolygon, LRasterPaint::RegionRoundRect, LRasterPaint::RegionScale, LRasterPaint::RegionSurface, LRasterPaint::RegionTranslate, LRasterPaint::SetClipRgn, Class Members

Topics:

Creating a Region

Example

L_INT LRasterPaint_RegionRectExample( CWnd* pWnd )
{
   L_INT          nRet;
   LRasterPaint   rstp;
   CDC*           pDC = pWnd->GetDC( ) ;
   RECT           rcRegion ;
   HRGN           hDestRgn ;
   /* Initiate the Paint toolkit */
   nRet = rstp.Initialize ( );
   if(nRet != SUCCESS)
      return nRet;
   /* Set the painting transformations to their default values */
   nRet = rstp.SetTransformation (NULL ) ; 
   if(nRet != SUCCESS)
      return nRet;
   /* Set the coordinates with respect to the DC dimensions*/
   SetRect ( &rcRegion, 10, 10, 100, 100 ) ;
   /* Use the current region properties and the current painting 
       transformations to create a rectangular region  */
   nRet = rstp.RegionRect ( pDC->m_hDC, &rcRegion, &hDestRgn) ;
   if(nRet != SUCCESS)
      return nRet;
   /* Display the resulted region */
   FrameRgn ( pDC->m_hDC, hDestRgn, ( HBRUSH ) GetStockObject ( BLACK_BRUSH ), 1, 1 ) ;
   /*Delete the region */
   DeleteObject ( hDestRgn ) ;
   /* Free the paint tools handle */
   nRet = rstp.Free ( ) ;
   if(nRet != SUCCESS)
      return nRet;
   pWnd->ReleaseDC( pDC ) ;
   return SUCCESS ;
}