CalloutRectangle¶

Qualified name: delphifmx.CalloutRectangle

class CalloutRectangle¶

Bases: Rectangle

A rectangle with a triangular “peak” on one of four sides, used primarily to render a TCalloutPanel. Because TCalloutRectangle inherits from TRectangle, TCalloutRectangle provides all the properties (Corners, CornerType, Sides, XRadius, YRadius, and others) and methods to define the shape of the rectangle itself. A call-out often takes the form of a pull-quote, in which a particular snippet of text in a document is duplicated to attract attention: in a larger size, with a different typeface, in a colored box, with stylized quote marks, and so on. With illustrations, boxed text will refer to different elements of interest, and each box will be drawn with extra lines that point to its element. TCalloutRectangle is a rectangle with an isosceles triangle on one of its four sides, used to point at something else. The triangle is included in the bounding rectangle of the object: the longer its length, the shorter the rectangle shape will be, and vice versa. Keeping the rectangle the same size while changing the length of the triangle requires changing the height or width of the object, depending on which side the triangle appears.

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.
`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.
`CalloutLength`	The length of the callout pointer.
`CalloutOffset`	The position of the callout pointer, relative to the center or edges of the side on which it appears.
`CalloutPosition`	Specifies the side of the rectangle where the callout pointer appears.
`CalloutWidth`	The width of the callout pointer.
`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
`CornerType`	Specifies the type of the corner shape's customization in the rectangle.
`Corners`	Specifies shapes of which corners in the TRectangle rectangle object are customized according to the CornerType, XRadius, and YRadius properties.
`Cursor`	Image to use to represent the mouse pointer when it passes into the region covered by the control.
`Data`	Stores a Tvalue, which is a data structure that can store different kinds of data types.
`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.
`OnDragDrop`	Callable[[Object, DragObject, PointF], None]:
`OnDragEnter`	Callable[[Object, DragObject, PointF], None]:
`OnDragOver`	Callable[[Object, DragObject, PointF, DragOperation], None]:
`OnGesture`	Callable[[Object, GestureEventInfo, bool], None]:
`OnPaint`	Callable[[Object, Canvas, RectF], None]:
`OnPainting`	Callable[[Object, Canvas, RectF], 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.
`ParentShowHint`	If True, the value of the ShowHint property of this control inherits the value of the ShowHint property of the parent 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.
`RotationAngle`	Specifies the amount (in degrees) by which the control is rotated from the x-axis.
`RotationCenter`	Specifies the position of the pivot point of the control.
`Scale`	Specifies the scale of the control.
`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.
`Sides`	Specifies which sides of the TRectangle rectangle to display.
`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).
`XRadius`	Specifies the distance from a corner to the start point of the corner shape customization, on the horizontal sides of TRectangle.
`YRadius`	Specifies the distance from a corner to the start point of the corner shape customization, on the vertical sides of TRectangle.

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.

CalloutLength¶

The length of the callout pointer. TCalloutRectangle renders the callout pointer as an isosceles triangle on one of its sides. CalloutLength is the height of this triangle. The triangle is included in the bounding rectangle ShapeRect of the TCalloutRectangle object; therefore, the longer CalloutLength is, the smaller the height (or width) of the callout rectangle itself is, and vice versa. Keeping the bounding rectangle the same size while changing the length of the triangle CalloutLength requires changing the height or width of the callout rectangle TCalloutRectangle itself, depending on which side the triangle appears.

Type:: float

CalloutOffset¶

The position of the callout pointer, relative to the center or edges of the side on which it appears. TCalloutRectangle renders the callout pointer as an isosceles triangle on one of its sides. The CalloutPosition defines the side on which the triangle appears. CalloutOffset is the triangle offset implemented according to the following conditions:

If CalloutOffset is zero, then the triangle is centered on the specified side. If CalloutOffset is positive, then the closest point of the callout pointer to a corner of the triangle has the CalloutOffset offset on the following sides: Top–offset to the right from the upper-left corner. Left–offset to the bottom from the upper-left corner. Right–offset to the bottom from the upper-right corner. Bottom–offset to the right from the lower-left corner. If CalloutOffset is negative, then the closest point of the callout pointer to a corner of the triangle has the CalloutOffset offset on the following sides: Top–offset to the left from the upper-right corner. Left–offset to the top from the lower-left corner. Right–offset to the top from the lower-right corner. Bottom–offset to the left from the lower-right corner.

Type:: float

CalloutPosition¶

Specifies the side of the rectangle where the callout pointer appears. TCalloutRectangle renders its callout pointer as an isosceles triangle on one of its four sides. Set CalloutPosition to one of the Top, Left, Bottom, or Right constants predefined in TCalloutPosition to define the side on which the callout pointer should appear. By default, the callout pointer appears on the top side CalloutPosition = Top.

Type:: CalloutPosition

CalloutWidth¶

The width of the callout pointer. TCalloutRectangle renders its callout pointer as an isosceles triangle on one of its sides. CalloutWidth is the length of the base of the triangle.

Type:: float

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

Controls¶: Returns an iterator over contained controls

ControlsCount¶: Returns the count of contained controls

Fill¶

Determines the color and pattern used to fill the shape background. The value of Fill is an FMX.Graphics.TBrush object. It can define the gradient, brush pattern, brush color, opacity, and other parameters to fill the shape background.

Type:: Brush

IsFocused¶: Determines whether the control has input focus.

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

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.

Stroke¶

Determines the color and pattern of the drawing pen used to draw lines and shape contours of the graphical primitives. The value of Stroke is an FMX.Graphics.TStrokeBrush object. To customize the outline pen, change the Thickness, Cap, Dash, and Join properties of the TStrokeBrush object.

Type:: StrokeBrush

Visible¶: Returns/Sets the Control Visibility