CustomPath¶

Qualified name: delphifmx.CustomPath

class CustomPath¶

Bases: Shape

TCustomPath is the base class for all 2D path-type shapes representing groups of connected curves and lines. TCustomPath renders the path Data graphics with the Paint method. Paint scales and positions the path graphics according to the WrapMode parameter. Paint draws the path contour and fills the background using the drawing pen and brush with the properties, color, and opacity defined by the Stroke and Fill properties of the TCustomPath object.

Methods

`AbsoluteToLocal`	Converts the screen coordinates of a specified point on the screen to client coordinates.
`BringToFront`	Puts the control in front of all other controls in its parent control.
`CanFocus`	Indicates whether a control can receive focus.
`LocalToAbsolute`	Translates a given point from client area coordinates to global screen coordinates.
`PointInObject`	Checks whether the specified point belongs to the path Data of the TCustomPath object.
`PrepareForPaint`	Prepares the current control for painting.
`Repaint`	Forces the control to repaint its image on the screen.
`ResetFocus`	Removes the focus from a control of from any children of the control.
`SendToBack`	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
`SetBounds`	Sets the Left, Top, Width, and Height properties all at once.
`SetFocus`	Gives the input focus to the control.

Attributes

`AbsoluteClipRect`	Specifies the absolute rectangle of the control after all its parent controls clip it.
`AbsoluteEnabled`	Specifies whether the control is absolutely enabled.
`AbsoluteHeight`	Specifies the absolute height of the control.
`AbsoluteMatrix`	Specifies the absolute transformation matrix of the control.
`AbsoluteOpacity`	Specifies the absolute opacity of the control.
`AbsoluteRect`	Specifies the absolute rectangle that bounds the control.
`AbsoluteScale`	Specifies the absolute scale of the control.
`AbsoluteWidth`	Specifies the absolute width of the control.
`ActionClient`	Specifies whether the component object has an associated action.
`Align`	Specifies the alignment options (top, left, client, and so on) of this control.
`Anchors`	Specifies how the control is anchored to its parent.
`ApplyingEffect`	A flag that signals when a control is in the process of applying an effect.
`AutoCapture`	Specifies whether the control captures mouse events.
`AxisAlignedRect`	A TRectF defined by the width and height of the control.
`BoundsRect`	Specifies the bounding rectangle of the control.
`CanParentFocus`	Specifies whether the parent of this control should be evaluated to receive focus.
`Canvas`	Provides the drawing surface of the control.
`Children`	Stores an array of children attached to this parent component.
`ChildrenCount`	Read-only property that specifies the number of children in the children list.
`ChildrenRect`	Specifies the bigger rectangle area occupied by parent and children controls.
`ClassName`	Returns the TObject.ClassName
`ClipChildren`	Specifies if children of the control should be clipped to the control's on-screen region.
`ClipParent`	Specifies whether the current control has clipped its parent.
`ClipRect`	Specifies the bound rectangle to be clipped.
`ComObject`	Specifies the interface reference implemented by the component.
`ComponentCount`	Returns the owned component count
`ComponentIndex`	Indicates the position of the component in its owner's Components property array.
`ComponentState`	Describes the current state of the component, indicating when a component needs to avoid certain actions.
`ComponentStyle`	Governs the behavior of the component.
`Components`	Returns an iterator over the owned components
`Controls`	Returns an iterator over contained controls
`ControlsCount`	Returns the count of contained controls
`Cursor`	Image to use to represent the mouse pointer when it passes into the region covered by the control.
`Data`	Specifies the SVG data used to build graphic shapes.
`DefaultSize`	Embarcadero Technologies does not currently have any additional information.
`DesignInfo`	Contains information used by the Form designer.
`DisableDisappear`	Embarcadero Technologies does not currently have any additional information.
`DisableFocusEffect`	Specifies whether the control has the focus effect disabled.
`DragMode`	Specifies how the control initiates drag-and-drop operations.
`EnableDragHighlight`	Specifies whether the control is highlighted when the dragged object is over it.
`Enabled`	Specifies whether the control responds to mouse, keyboard, and timer events.
`Fill`	Determines the color and pattern used to fill the shape background.
`FixedSize`	Embarcadero Technologies does not currently have any additional information.
`HasAfterPaintEffect`	Specifies whether the control has an effect that is applied after the control is painted.
`HasClipParent`	Control that is a direct child of this control and has clipped this control.
`HasDisablePaintEffect`	Specifies whether the control's effect is painted.
`HasEffect`	Specifies whether the control has an applied effect.
`Height`	Height specifies the vertical size of the control (in dp).
`Hint`	Specifies the text string that appears when the user moves the mouse over a control.
`HitTest`	Enables the control to capture mouse events.
`InPaintTo`	Specifies whether the control is currently being painted.
`Index`	Specifies the index of the child object in the children array attached to this object.
`InheritedCursor`	Image used to represent the mouse pointer when it passes into the region covered by the control.
`InvertAbsoluteMatrix`	Specifies the inverse matrix of AbsoluteMatrix.
`IsDragOver`	Specifies whether a dragged object is over the area of the current control.
`IsFocused`	Determines whether the control has input focus.
`IsInflated`	Whether the current style of this control has been actually applied to the control.
`IsMouseOver`	Specifies whether the mouse cursor is over the control.
`IsVisible`	Specifies whether the control is visible.
`LocalRect`	Specifies the local rectangle for painting the control.
`Locked`	Specifies whether the control is locked at design time.
`Margins`	Aligns the component to the margins points of other components.
`Name`	Specifies the name of the component as referenced in code.
`Observers`	Indicates the TObservers object added to the TComponent.
`OnGesture`	Callable[[Object, GestureEventInfo, bool], None]:
`Opacity`	Specifies the control opacity.
`Owner`	Returns the Component Owner
`Padding`	Aligns the component to the padding points of other components.
`Parent`	Returns/Sets the Control Visibility
`ParentControl`	Specifies the parent control of this control.
`ParentedRect`	Specifies the bounding rectangle of the control within its parent.
`ParentedVisible`	Specifies whether all the control's parents are visible.
`PopupMenu`	Specifies the context (pop-up) menu object.
`Position`	Returns an access to the position of the control inside its parent
`Pressed`	Indicates whether the control is currently pressed.
`PressedPosition`	A point that indicates where exactly on the control the click occured.
`Root`	Specifies the root parent of this object.
`Scene`	Specifies the current scene in which the control is drawn.
`ShapeRect`	Specifies the rectangle for drawing the shape.
`ShowHint`	Specifies whether the Hint can be shown.
`Size`	Specifies the vertical and horizontal size (Size.Height and Size.Width) of the control (in pixels).
`Stored`	Specifies whether this object is stored in the .XFM file.
`Stroke`	Determines the color and pattern of the drawing pen used to draw lines and shape contours of the graphical primitives.
`StyleName`	Specifies the style name for this FMX component.
`TabOrder`	Indicates the position of the control in its parent's tab order.
`TabStop`	Embarcadero Technologies does not currently have any additional information.
`Tag`	Stores a NativeInt integral value as a part of a component.
`TagFloat`	Custom property that stores any floating-point value.
`TagObject`	Custom property that stores any object value.
`TagString`	Custom property that stores any string value.
`Touch`	Specifies the touch manager component associated with the control.
`TouchTargetExpansion`	Set of optional pixel values you can specify to expand the touch target of a FireMonkey styled control.
`UpdateRect`	Specifies the rectangle area of the control that needs to be updated.
`VCLComObject`	Represents information used internally by components that support COM.
`Visible`	Returns/Sets the Control Visibility
`Width`	Specifies the horizontal size of the control (in pixels).
`WrapMode`	Specifies whether and how to resize, replicate, and position the graphical path representation for painting the area.

AbsoluteToLocal()¶: Converts the screen coordinates of a specified point on the screen to client coordinates.

BringToFront()¶: Puts the control in front of all other controls in its parent control.

CanFocus()¶: Indicates whether a control can receive focus.

Controls¶: Returns an iterator over contained controls

ControlsCount¶: Returns the count of contained controls

Data¶

Specifies the SVG data used to build graphic shapes. The Data property supports only a comma-separated list of instructions defined for the d attribute of the path element in SVG 1.0. In SVG 1.0, the d attribute contains the moveto, line, curve, arc, and closepath instructions. All instructions are expressed as one character (for example, a moveto is expressed as an M). For more information, see Scalable Vector Graphics (SVG) 1.0 Specification.

Example To clarify, consider the following code snippets that specify the SVG instructions at run time:

Delphi:

Path1.Data.Data := ‘M 1,0, L 2,1, L 1,2, L 0,1, L 1,0’;

C++Builder:

Path1->Data->Data = “M 1,0, L 2,1, L 1,2, L 0,1, L 1,0”;

An application that uses the above mentioned SVG instructions displays a rhomb:

Type:: PathData

IsFocused¶: Determines whether the control has input focus.

LocalToAbsolute()¶: Translates a given point from client area coordinates to global screen coordinates.

PointInObject(X: float, Y: float) → bool¶

Checks whether the specified point belongs to the path Data of the TCustomPath object. PointInObject calls the FMX.Graphics.TCanvas.PtInPath method of the TCanvas object to check whether the specified point belongs to the path Data of the TCustomPath object. X and Y are absolute pixel coordinates of the point to be checked:

X is the x-coordinate. Y is the y-coordinate.

Position¶: Returns an access to the position of the control inside its parent

PrepareForPaint()¶: Prepares the current control for painting.

Repaint()¶: Forces the control to repaint its image on the screen.

ResetFocus()¶: Removes the focus from a control of from any children of the control.

SendToBack()¶: Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

SetBounds(Left, Top, Width, Height)¶: Sets the Left, Top, Width, and Height properties all at once.

SetFocus()¶: Gives the input focus to the control.

Visible¶: Returns/Sets the Control Visibility

WrapMode¶

Specifies whether and how to resize, replicate, and position the graphical path representation for painting the area. The WrapMode property should be one of the constants defined in the TPathWrapMode type:

Stretch–stretches the path representation to fill the entire area. Default. Original–keeps the original path size. Fit–resizes the path representation (keeping proportions) to best fit the area. Tile–renders the path representation repeatedly to tile the area.

Type:: PathWrapMode