API Reference

Unit CastleControls

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

Standard 2D controls: buttons, labels, sliders etc.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class TCastleUserInterfaceFont Base class for all user interface controls using a font.
Class TCastleButton Clickable button.
Class TCastlePanel Panel or a toolbar control.
Class TCastleImageControl Image control.
Class TCastleRectangleControl Fill a rectangle on screen with given color or theme image.
Class TCastleShape Draw a simple shape (rectangle, circle, triangle) with given color and optional outline.
Class TCastleSimpleBackground Fill the whole window with a simple color.
Class TCastleLabel Label with possibly multiline text.
Class TCastleCrosshair Display a simple crosshair in the middle of the parent control.
Class TCastleAbstractSlider An abstract slider user interface.
Class TCastleFloatSlider Slider to change a float value within a given range.
Class TCastleIntegerSlider Slider to change an integer value within a given range.
Class TCastleScrollViewCustom Abstract user interface with a scrollbar.
Class TCastleScrollArea Class that represents scrollable area inside TCastleScrollView.ScrollArea.
Class TCastleScrollView Container for a user interface children that can be scrolled vertically.
Class TCastleScrollViewManual Control with a scrollbar.
Class TCastleCheckbox Checkbox with a caption.
Class TCastleTimer Timer, running the OnTimer event periodically.
Class TCastleEdit Edit box to input a single line of text.
Class TCastleFloatEdit Descendant of TCastleEdit specialized for editing floating-point numbers.
Class TCastleIntegerEdit Descendant of TCastleEdit specialized for editing integer numbers.
Class TCastlePackedGroup Abstract ancestor for containers that pack children, like TCastleHorizontalGroup and TCastleVerticalGroup.
Class TCastleHorizontalGroup Container that packs the children horizontally.
Class TCastleVerticalGroup Container that packs the children vertically.
Class EMaximumDesignDepth Copyright 2018-2024 Michalis Kamburelis.
Class TCastleDesign Contents of this user-interface control are loaded from an indicated file (by the Url property).
Class TCastleMask Limit the visibility of children by an arbitrary (defined using an arbitrary UI) mask.
Class TCastleClipboard Clipboard to cut / copy / paste the text.

Functions and Procedures

function FallbackFont: TCastleFont;
procedure ForceFallbackLook(const Ui: TCastleUserInterface);
function Clipboard: TCastleClipboard;
procedure RegisterClipboard(const AClipboard: TCastleClipboard);

Types

TUIControlFont = TCastleUserInterfaceFont deprecated 'use TCastleUserInterfaceFont';
TCastleButtonImageLayout = (...);
TProportionalScaling = (...);
TShapeType = (...);
TCastleCrosshairShape = (...);
TMaskRendering = (...);

Variables

property UIFont: TCastleAbstractFont read InternalGetUIFont write InternalSetUIFont;

Description

Functions and Procedures

function FallbackFont: TCastleFont;

The default font, used throughout the engine as a fallback. This is a modern sans-serif font hardcoded into the engine.

procedure ForceFallbackLook(const Ui: TCastleUserInterface);

Force using FallbackFont (thus, ignore TCastleContainer.DefaultFont) and FallbackTheme (thus, disable any Theme customizations) in this UI. This guarantees the same UI look, ignoring user's UI font and theme customizations.

function Clipboard: TCastleClipboard;

Single global instance of TCastleClipboard. Automatically created / destroyed by this unit.

procedure RegisterClipboard(const AClipboard: TCastleClipboard);

Register custom TCastleClipboard implementation, that replaces the global Clipboard. The instance given here becomes owned by this unit (we will free it automatically).

Types

TUIControlFont = TCastleUserInterfaceFont deprecated 'use TCastleUserInterfaceFont';

Warning: this symbol is deprecated: use TCastleUserInterfaceFont

This item has no description.

TCastleButtonImageLayout = (...);

Possible image placement for a button, see TCastleButton.ImageLayout.

Values
  • ilTop
  • ilBottom
  • ilLeft
  • ilRight
TProportionalScaling = (...);

Indicate stretching approach for TCastleImageControl.ProportionalScaling.

Values
  • psNone: Adjust to the requested area, ignoring proportions.
  • psEnclose: Adjust to the requested area, honoring proportions, such that the image may be larger than the requested area.
  • psFit: Adjust to the requested area, honoring proportions, such that the image may be smaller than the requested area.
TShapeType = (...);

Possible shape type, for TCastleShape.ShapeType.

Values
  • stRectangle
  • stCircle
  • stTriangleUp
  • stTriangleDown
  • stTriangleRight
  • stTriangleLeft
TCastleCrosshairShape = (...);

Possible crosshair shape, for TCastleCrosshair.Shape.

Values
  • csCross
  • csCrossRect
TMaskRendering = (...);

Effect of mask over rendering, used by TCastleMask.MaskRendering.

Values
  • mrChildrenWhereNoMask
  • mrChildrenWhereMask
  • mrChildrenIgnoreMask
  • mrMask

Variables

property UIFont: TCastleAbstractFont read InternalGetUIFont write InternalSetUIFont;

The default font, used throughout the engine as a fallback. By default, this is a modern sans-serif font hardcoded into the engine.

Better use FallbackFont now, or use your own font, or render text using TCastleLabel.

You can assign your own font here, to make this the new default font.

Although in most cases it is better to leave UIFont unchanged (treat it like "engine default font"), and instead set your default font by setting Window.Container.DefaultFont. You can do it by code, or by editing CastleSettings.xml (this way editor will be aware of this new default), see https://castle-engine.io/manual_castle_settings.php .

Note that assigning font here does not make it automatically freed. Use the ownership mechanism to make sure it is freed, i.e. assign some owner to your font instance, like this: 

MyFont := TCastleFont.Create({ owner } Application);
MyFont.Load(TextureFont_Xxxx);
UIFont := MyFont;

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.