In This Topic ▼

LRasterPaint::DrawShapeLine

Summary

Draws a line between the specified points.

Syntax

#include "Ltwrappr.h"

L_INT LRasterPaint::DrawShapeLine(UserDC, nStartX, nStartY, nEndX, nEndY)

Parameters

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

L_INT nStartX

Specifies the x-coordinate of the start position, in logical units.

L_INT nStartY

Specifies the y-coordinate of the start position, in logical units.

L_INT nEndX

Specifies the x-coordinate of the end position, in logical units.

L_INT nEndY

Specifies the y-coordinate of the end position, in logical units.

Returns

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

Comments

The line will be drawn using the current shape properties. To determine the current shape properties, call LRasterPaint::GetProperty. To set or change the current shape properties, call LRasterPaint::SetProperty. For more information on the shape properties, refer to the PAINTSHAPE structure.

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

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

If a bitmap has been set using the LRasterPaint::SetMetrics function, the line will be drawn on the specified bitmap. If UserDC is not NULL and a bitmap has been set using the LRasterPaint::SetMetrics function, then the line 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

Example

L_INT LRasterPaint_DrawShapeLineExample( CWnd* pWnd )  
{ 
   L_INT          nRet; 
   LRasterPaint   rstp; 
   CDC*           pDC = pWnd->GetDC() ; 
   PAINTSHAPE     shape;  
   RECT           rcDCExtents ; 
 
   /* Initiate the Paint toolkit */ 
   nRet = rstp.Initialize (); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Get the current shape properties */ 
   nRet = rstp.GetProperty (PAINT_GROUP_SHAPE, &shape ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Set the required shape properties */ 
   shape.nSize                = sizeof ( PAINTSHAPE ) ; 
   shape.dwMask               = PSF_BORDERWIDTH | 
                                PSF_BORDERSTYLE | 
                                PSF_BORDERCOLOR | 
                                PSF_BORDERENDCAP ; 
   shape.nBorderWidth         = 10 ;  
   shape.nBorderStyle         = PAINT_SHAPE_BORDER_STYLE_DASHDOT ;  
   shape.crBorderColor        = RGB ( 255, 0, 0 ) ; 
   shape.nBorderEndCap        = PAINT_SHAPE_BORDER_ENDCAP_ROUND ; 
 
   /* Set the new shape properties */ 
   nRet = rstp.SetProperty (PAINT_GROUP_SHAPE, &shape ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Get the destination DC dimensions */   
   pWnd->GetClientRect ( &rcDCExtents ) ; 
 
   /* Set the toolkit user DC extents */ 
   nRet = rstp.SetDCExtents ( &rcDCExtents ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Use the current shape properties to draw a line to the DC (hDC) */ 
   nRet = rstp.DrawShapeLine ( pDC->m_hDC, 10, 10, 200, 200 ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   /* Free the paint tools handle */ 
   nRet = rstp.Free ( ) ; 
   if(nRet != SUCCESS) 
      return nRet; 
 
   pWnd->ReleaseDC( pDC ) ; 
 
   return SUCCESS ; 
}