Interface IGDIPlus.IGPPen

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: SignalLabBasicPkg

Unit: IGDIPlus

Contents 1 Syntax 1.1 Delphi: 2 Summary 3 Description 4 Properties 5 Methods

Syntax

Delphi:

type IGPPen = interface

Summary

Interface to TGPPen object used to draw lines and curves.

Description

Use this interface to access the TGPPen objects used to draw lines and curves. Remarks A TGPPen object has attributes that can be set to adjust the width, color, and style used to draw lines and curves.

Properties

• PenType - Gets the type currently set for the TGPPen object.
• Width - Sets or gets the width for the TGPPen object.
• Color - Gets or sets the color currently set for this TGPPen object.
• Brush - Gets or sets the TGPBrush object for the TGPPen object.
• Alignment - Gets or sets the alignment currently set for this Pen object.
• MiterLimit - Gets or sets the miter length of the TGPPen object.
• DashOffset - Gets or sets the distance from the start of the line to the start of the first space in a dashed line.
• StartCap - Gets or sets the start cap of the TGPPen object.
• EndCap - Gets or sets the end cap of the TGPPen object.
• CustomStartCap - Gets or sets the custom start cap for the TGPPen object.
• CustomEndCap - Gets or sets the custom end cap for the TGPPen object.
• DashStyle - Sets or gets the dash style of the TGPPen object.
• DashCap - Gets or sets the dash cap style currently set for the TGPPen object.
• DashPattern - Gets or sets the array of custom dashes and spaces for the TGPPen object.
• LineJoin - Gets or sets the line join style currently set for this Pen object.
• CompoundArray - Sets or gets the compound array currently set for this Pen object.
• Transform - Gets or sets the world transformation matrix for the object.

Methods

• function GetNativePen() : GpPen
• function Clone() : TGPPen - Copies a Pen object.
• procedure SetWidthProp(width : Single)
• function SetWidth(width : Single) : TGPPen - Sets the width for the TGPPen object.
• function GetWidth() : Single - Returns the width currently set for the TGPPen object.
• function SetLineCap(startCap : TGPLineCap; endCap : TGPLineCap; dashCap : TGPDashCap) : TGPPen - Sets the cap styles for the start, end, and dashes in a line drawn with the pen.
• procedure SetStartCapProp(startCap : TGPLineCap)
• function SetStartCap(startCap : TGPLineCap) : TGPPen - Sets the start cap for the TGPPen object.
• function GetStartCap() : TGPLineCap - Returns the start cap currently set for the TGPPen object.
• procedure SetEndCapProp(endCap : TGPLineCap)
• function SetEndCap(endCap : TGPLineCap) : TGPPen - Sets the end cap for the TGPPen object.
• function GetEndCap() : TGPLineCap - Returns the end cap currently set for the TGPPen object.
• procedure SetDashCapProp(dashCap : TGPDashCap)
• function SetDashCap(dashCap : TGPDashCap) : TGPPen - Sets the dash cap style for the TGPPen object.
• function GetDashCap() : TGPDashCap - Returns the dash cap style currently set for the TGPPen object.
• procedure SetLineJoinProp(lineJoin : TGPLineJoin)
• function SetLineJoin(lineJoin : TGPLineJoin) : TGPPen - Sets the line join for the TGPPen object.
• function GetLineJoin() : TGPLineJoin - Returns the line join style currently set for this Pen object.
• procedure SetCustomStartCapProp(customCap : IGPCustomLineCap)
• function SetCustomStartCap(customCap : IGPCustomLineCap) : TGPPen - Sets the custom start cap for the TGPPen object.
• function GetCustomStartCap() : IGPCustomLineCap - Returns the custom start cap for the TGPPen object.
• procedure SetCustomEndCapProp(customCap : IGPCustomLineCap)
• function SetCustomEndCap(customCap : IGPCustomLineCap) : TGPPen - Sets the custom end cap for the TGPPen object.
• function GetCustomEndCap() : IGPCustomLineCap - Returns the custom end cap for the TGPPen object.
• procedure SetMiterLimitProp(miterLimit : Single)
• function SetMiterLimit(miterLimit : Single) : TGPPen - Sets the miter limit of the TGPPen object.
• function GetMiterLimit() : Single - Returns the miter length currently set for the TGPPen object.
• procedure SetAlignmentProp(penAlignment : TGPPenAlignment)
• function SetAlignment(penAlignment : TGPPenAlignment) : TGPPen - Sets the alignment for this Pen object relative to the line.
• function GetAlignment() : TGPPenAlignment - Returns the alignment currently set for this Pen object.
• function SetTransform(matrix : IGPMatrix) : TGPPen - Sets the world transformation of the TGPPen object.
• procedure SetTransformProp(matrix : IGPMatrix)
• function GetTransform() : IGPMatrix - Returns the world transformation matrix currently set for the TGPPen object.
• function ResetTransform() : TGPPen - Sets the world transformation matrix of the TGPPen object to the identity matrix.
• function MultiplyTransform(matrix : IGPMatrix; order : TGPMatrixOrder) : TGPPen - Updates the world transformation matrix of the TGPPen object with the product of itself and another matrix.
• function TranslateTransform(dx : Single; dy : Single; order : TGPMatrixOrder) : TGPPen - Updates the TGPPen object's world transformation matrix with the product of itself and a translation matrix.
• function ScaleTransform(sx : Single; sy : Single; order : TGPMatrixOrder) : TGPPen - Sets the TGPPen object's world transformation matrix equal to the product of itself and a scaling matrix.
• function RotateTransform(angle : Single; order : TGPMatrixOrder) : TGPPen - Updates the world transformation matrix of the TGPPen object with the product of itself and a rotation matrix.
• function GetPenType() : TGPPenType - Returns the type currently set for the TGPPen object.
• procedure SetColorProp(color : TGPColor)
• function SetColor(color : TGPColor) : TGPPen - Sets the color for the TGPPen object.
• function GetColor() : TGPColor - Returns the color currently set for this Pen object.
• procedure SetBrushProp(brush : IGPBrush)
• function SetBrush(brush : IGPBrush) : TGPPen - Sets the TGPBrush object that a TGPpen uses to fill a line.
• function GetBrush() : IGPBrush - Returns the TGPBrush object that is currently set for the TGPPen object.
• procedure SetDashStyleProp(dashStyle : TGPDashStyle)
• function SetDashStyle(dashStyle : TGPDashStyle) : TGPPen - Sets the dash style for the TGPPen object.
• function GetDashStyle() : TGPDashStyle - Returns the dash style currently set for the TGPPen object.
• procedure SetDashOffsetProp(dashOffset : Single)
• function SetDashOffset(dashOffset : Single) : TGPPen - Sets the distance from the start of the line to the start of the first dash in a dashed line.
• function GetDashOffset() : Single - Returns the distance from the start of the line to the start of the first space in a dashed line.
• function GetDashPatternCount() : Integer - Returns the number of elements in a dash pattern array.
• function SetDashPattern(dashArray : array) : TGPPen
• procedure SetDashPatternProp(dashArray : TGPSingleArray)
• function GetDashPattern() : TGPSingleArray - Returns an array of custom dashes and spaces currently set for the TGPPen object.
• function GetCompoundArrayCount() : Integer - Returns the number of elements in a compound array.
• function SetCompoundArray(compoundArray : array) : TGPPen
• procedure SetCompoundArrayProp(compoundArray : TGPSingleArray)
• function GetCompoundArray() : TGPSingleArray - Returns the compound array currently set for this Pen object.