TPen class

In unit Graphics

Represents a pen used to draw on a canvas.

Declaration

pascal

TPen = class(TFPCustomPen)

Inheritance

TPen
TFPCustomPen

Description

TPen is a TFPCustomPen descendant which contains settings for a pen used to draw lines and shapes on a canvas. It includes properties that define the color for the pen, the end cap and join style used for line segments, and a pattern used for user-defined line drawing styles.

Essentially, TPen maps the types used for properties in the FCL ancestor class to the types used in the LCL.

TPen is the type used to implement the Pen property in TCanvas.

Properties

`Reference`	public	A Reference made to this Pen.
`Color`	published	The Color of the current Pen.
`Cosmetic`	published	Indicates whether the Pen is Cosmetic (non-geometric).
`EndCap`	published	The sort of EndCap used on the Pen.
`JoinStyle`	published	JoinStyle - the style of joint where two lines meet or cross.
`Mode`	published	Pen mode for the class instance.
`Style`	published	Contains the line drawing style for the pen.
`Width`	published	Width for lines drawn using the Pen.

Methods

`DoAllocateResources`	protected	Performs actions needed to allocate resources for the class instance.
`DoDeAllocateResources`	protected	Performs actions to free resources allocated for the class instance.
`DoCopyProps`	protected	Copies properties from the specified source to the class instance.
`SetColor`	protected	Sets the value for the Color property.
`SetFPColor`	protected	Sets the pen Color to the specified TFPColor value.
`SetEndCap`	protected	Specifies the type of end cap used for the pen if it is a geometric pen.
`SetJoinStyle`	protected	Sets the value for the JoinStyle property.
`SetMode`	protected	Sets the value for the Mode property.
`SetStyle`	protected	Sets the value for the Style property.
`SetWidth`	protected	Sets the value for the Width property.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`Assign`	public	Copies property values from the specified persistent object.
`GetPattern`	public	Gets the Pattern used in the Pen.
`SetPattern`	public	SetPattern - specifies the pattern for the pen used when the Pen.Style is psPattern.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.