LRasterPaint::RegionColor

#include "Ltwrappr.h"

L_INT LRasterPaint::RegionColor(UserDC, crColor, phDestRgn)

HDC UserDC;	/* handle to the device context */
COLORREF crColor;	/* color used to create the region */
pHRGN phDestRgn;	/* pointer to a region handle */

Creates a region that contains the specified color.

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.
crColor	The COLORREF value that specifies the color to use to create the region.
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.

If the UserDC is not NULL, the user should set the DC boundaries before calling this function, by calling LRasterPaint::SetDCExtents.

The images below show the region created by clicking inside the yellow area.

$image\g5.gif$

$image\g6.gif$

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::RegionEllipse, LRasterPaint::RegionPolygon, LRasterPaint::RegionRect, LRasterPaint::RegionRoundRect, LRasterPaint::RegionScale, LRasterPaint::RegionSurface, LRasterPaint::RegionTranslate, LRasterPaint::SetClipRgn, Class Members

Topics:

Creating a Region

Example

L_INT LRasterPaint_RegionColorExample( CWnd* pWnd ) 
{
   L_INT          nRet;
   LRasterPaint   LRsPaint ;
   CDC*           pDC = pWnd->GetDC( ) ;
   PAINTSHAPE     shape ;
   RECT           rcShape ;
   RECT           rcDCExtents ;
   HRGN           hDestRgn;
   /* Initiate the Paint toolkit */
   nRet = LRsPaint.Initialize ( );
   if(nRet != SUCCESS)
      return nRet;
   /* Set the required shape properties */
   shape.nSize                = sizeof ( PAINTSHAPE ) ;
   shape.dwMask               = PSF_BORDERWIDTH       |
                                PSF_BORDERCOLOR       |
                                PSF_BORDERENDCAP      |
                                PSF_BACKGROUNDSTYLE   |
                                PSF_GRADIENTSTARTCOLOR|
                                PSF_GRADIENTENDCOLOR  ;
   shape.nBorderWidth         = 10 ;
   shape.crBorderColor        = RGB ( 0, 255, 0 ) ;
   shape.nBorderEndCap         = PAINT_SHAPE_BORDER_ENDCAP_ROUND ;
   shape.nBackgroundStyle     = PAINT_SHAPE_BACK_STYLE_GRADIENT ;
   shape.crGradientStartColor = RGB ( 255, 255, 255 ) ;
   shape.crGradientEndColor   = RGB ( 255, 255, 0 ) ;
   /* Set the new shape properties */
   nRet = LRsPaint.SetProperty (PAINT_GROUP_SHAPE, &shape ) ;
   if(nRet != SUCCESS)
      return nRet;
   /* Set the coordinates with respect to the DC dimensions */
   SetRect ( &rcShape, 10, 10, 60, 60 ) ;
   /* Use the current shape properties to draw an ellipse to the DC (hDC) */
   nRet = LRsPaint.DrawShapeEllipse ( pDC->m_hDC, &rcShape ) ;
   if(nRet != SUCCESS)
      return nRet;
   SetRect ( &rcShape, 100, 10, 150, 60 ) ;
   nRet = LRsPaint.DrawShapeEllipse ( pDC->m_hDC, &rcShape ) ;
   if(nRet != SUCCESS)
      return nRet;
   SetRect ( &rcShape, 60, 60, 95, 95 ) ;
   nRet = LRsPaint.DrawShapeRectangle ( pDC->m_hDC, &rcShape ) ;
   if(nRet != SUCCESS)
      return nRet;
   SetRect ( &rcShape, 10, 100, 60, 150 ) ;
   nRet = LRsPaint.DrawShapeEllipse ( pDC->m_hDC, &rcShape ) ;
   if(nRet != SUCCESS)
      return nRet;
   SetRect ( &rcShape, 100, 100, 150, 150 ) ;
   nRet = LRsPaint.DrawShapeEllipse ( pDC->m_hDC, &rcShape ) ;
   if(nRet != SUCCESS)
      return nRet;
   /* Get the destination DC dimensions */  
   pWnd->GetClientRect ( &rcDCExtents ) ;
   /* Set the toolkit user DC extents */
   nRet = LRsPaint.SetDCExtents (&rcDCExtents ) ;
   if(nRet != SUCCESS)
      return nRet;
   /* Create the region */
   nRet = LRsPaint.RegionColor ( pDC->m_hDC, RGB ( 0, 255, 0 ), &hDestRgn) ; 
   if(nRet != SUCCESS)
      return nRet;
   /* Display the create region */
   FrameRgn ( pDC->m_hDC, hDestRgn, ( HBRUSH ) GetStockObject ( BLACK_BRUSH ), 1, 1 ) ;
   /*Delete the region */
   DeleteObject ( hDestRgn ) ;
   /* Free the paint tools handle */
   nRet = LRsPaint.Free ( ) ;
   if(nRet != SUCCESS)
      return nRet;
   pWnd->ReleaseDC( pDC ) ;
   return SUCCESS ;
}