Share via

CPen::CPen

  • Article

This constructor creates an instance of a CPen object. After constructing it, you must initialize it by using either the CPen::CreatePen or CPen::CreatePenIndirect methods, or by calling CGDI::CreateStockObject.

CPen( ); 

CPen (
int nPenStyle,
int nWidth,
COLORREF crColor );

Parameters

  • nPenStyle
    Specifies the pen style. This parameter in the first version of the constructor can be one of the following values:

    • PS_SOLID   Creates a solid pen.
    • PS_DASH   Creates a dashed pen. Valid only when the pen width is 1 or less, in device units.
    • PS_DOT   Creates a dotted pen. Valid only when the pen width is 1 or less, in device units.
    • PS_DASHDOT   Creates a pen with alternating dashes and dots. Valid only when the pen width is 1 or less, in device units.
    • PS_DASHDOTDOT   Creates a pen with alternating dashes and double dots. Valid only when the pen width is 1 or less, in device units.
    • PS_NULL   Creates a null pen.
    • PS_INSIDEFRAME   Creates a pen that draws a line inside the frame of closed shapes produced by the Windows GDI output functions that specify a bounding rectangle. For example, the Ellipse, Rectangle, RoundRect, Pie, and Chord methods, all specify bounding rectangles. When this style is used with Windows GDI output functions that do not specify a bounding rectangle, such as the LineTo method, the drawing area of the pen is not limited by a frame.

    The second version of the CPen constructor specifies a combination of type, style, end cap, and join attributes. The values from each category should be combined by using the bitwise OR operator (|). The pen type can be one of the following values:

    • PS_GEOMETRIC   Creates a geometric pen.
    • PS_COSMETIC   Creates a cosmetic pen.

    The second version of the CPen constructor adds the following pen styles for nPenStyle:

    • PS_ALTERNATE   Creates a pen that sets every other pixel. This style is applicable only for cosmetic pens.
    • PS_USERSTYLE   Creates a pen that uses a styling array supplied by the user.

    The end cap can be one of the following values:

    • PS_ENDCAP_ROUND   End caps are round.
    • PS_ENDCAP_SQUARE   End caps are square.
    • PS_ENDCAP_FLAT   End caps are flat.

    The join can be one of the following values:

    • PS_JOIN_BEVEL   Joins are beveled.
    • PS_JOIN_MITER   Joins are mitered when they are within the current limit set by the SetMiterLimit function. If the join exceeds this limit, it is beveled.
    • PS_JOIN_ROUND   Joins are round.

  • nWidth
    Specifies the width of the pen.

    • For the first version of the constructor, if this value is zero, the width in device units is always 1 pixel, regardless of the mapping mode.
    • For the second version of the constructor, if nPenStyle is PS_GEOMETRIC, the width is given in logical units. If nPenStyle is PS_COSMETIC, the width must be set to 1.

  • crColor
    Contains an RGB color for the pen.

Remarks

Windows CE does not support the following overloaded implementation of the CPen::CPen method:

CPen (
int nPenStyle,
int nWidth,
const LOGBRUSH* pLogBrush,
int nStyleCount = 0,
const DWORD* lpStyle = NULL )

In Windows CE version 1.0, only solid pens can draw wide lines.

Example

// Create a solid red pen of width 2.
CPen myPen1(PS_SOLID, 2, RGB(255,0,0));

// Create a geometric pen.
LOGBRUSH logBrush;
logBrush.lbStyle = BS_SOLID;
logBrush.lbColor = RGB(0,255,0);
CPen myPen2(PS_DOT|PS_GEOMETRIC|PS_ENDCAP_ROUND, 2, &logBrush);

Requirements

**  Windows CE versions:** 1.0 and later  
  Header file: Declared in Afxwin.h
  Platform: H/PC Pro, Palm-size PC, Pocket PC

See Also

CPen::CreatePen, CPen::CreatePenIndirect, CGdiObject::CreateStockObject