L_PntDrawShapeRectangle

#include "LtPnt.h"

L_INT EXT_FUNCTION L_PntDrawShapeRectangle(pPaint, UserDC, prcRect)

pPAINTHANDLE pPaint;	/* pointer to a paint handle */
HDC UserDC;	/* handle to the device context */
LPRECT prcRect;	/* pointer to a RECT structure */

Draws a rectangle using the specified points.

Parameter	Description
pPaint	Pointer to a paint handle.
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 rectangle.

Returns

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

Comments

The rectangle will be drawn using the current shape properties. To determine the current shape properties, call L_PntGetProperty. To set or change the current shape properties, call L_PntSetProperty. For more information on the shape properties, refer to the PAINTSHAPE structure.

If UserDC is not NULL, the toolkit will paint the rectangle on the specified device context. If UserDC is NULL, the rectangle will not be painted on a device context.

If a bitmap has been set using the L_PntSetMetrics function, the rectangle will be drawn on the specified bitmap. If UserDC is not NULL and a bitmap has been set using the L_PntSetMetrics function, then the rectangle will be drawn to both the device context and the bitmap.

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:	L_PntGetProperty, L_PntSetProperty, L_PntSetTransformation, L_PntGetTransformation, L_PntGetClipRgn, L_PntSetClipRgn, L_PntSetMetrics, L_PntDlgShape, L_PntDrawShapeEllipse, L_PntDrawShapeLine, L_PntDrawShapePolyBezier, L_PntDrawShapePolygon, L_PntDrawShapeRoundRect
Topics:	DigitalPaint Functions: Painting Shapes and Text
	Painting a Shape

Example

L_INT DrawRectangleTest ( HWND hWnd )
{
   pPAINTHANDLE pPaint ;
   HDC          hDC ;
   PAINTSHAPE   shape ;
   RECT         rcShape ;


   /* Initiate the Paint toolkit */
  if ( SUCCESS != L_PntInit ( &pPaint ) )
  {
       return FAILURE ;
   }

   /* Get device context to draw on */
   hDC = GetDC ( hWnd ) ;

   /* Get the current shape properties */
   L_PntGetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ;

   /* Set the required shape properties */
   shape.nSize  = sizeof ( PAINTSHAPE ) ;
   shape.dwMask = PSF_BORDERWIDTH |
                               PSF_BORDERSTYLE |
                               PSF_BORDERCOLOR |
                               PSF_BORDERENDCAP ;
   shape.nBorderWidth   = 5 ;
   shape.nBorderStyle     = PAINT_SHAPE_BORDER_STYLE_DASH ;
   shape.crBorderColor   = RGB ( 255, 0, 0 ) ;
   shape.nBorderEndCap = PAINT_SHAPE_BORDER_ENDCAP_FLAT ;

   /* Set the new shape properties */
   L_PntSetProperty ( pPaint, PAINT_GROUP_SHAPE, &shape ) ;

  /* Set the rectangle coordinates with respect to the DC dimensions*/
   SetRect ( &rcShape, 10, 10, 100, 100 ) ;

   /* Use the current shape properties to draw a rectangle to the DC (hDC) */
  L_PntDrawShapeRectangle ( pPaint, hDC, &rcShape ) ;

   /* Release the device context */
   ReleaseDC ( hWnd, hDC ) ;

   /* Free the paint tools handle */
   L_PntFree ( pPaint ) ;

   return SUCCESS ;
}