Class TUIControlFont

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TUIControlFont = class(TUIRectangularControl)

Description

Base class for all controls inside an OpenGL context using a font.

Hierarchy

Overview

Methods

Protected function Font: TCastleFont; virtual;
Protected procedure FontChanged; virtual;
Public destructor Destroy; override;
Public procedure GLContextClose; override;
Public function TooltipExists: boolean; override;
Public procedure TooltipRender; override;
Public procedure Render; override;
Public procedure CheckFontChanged;

Properties

Published property Tooltip: string read FTooltip write FTooltip;
Published property CustomFont: TCastleFont read FCustomFont write SetCustomFont;
Published property OwnsCustomFont: boolean read FOwnsCustomFont write FOwnsCustomFont default false;

Description

Methods

Protected function Font: TCastleFont; virtual;

Font custom to this control. By default this returns UIFont, you can override this to return your font. It's OK to return here Nil if font is not ready yet, but during Render (when OpenGL context is available) font must be ready.

Protected procedure FontChanged; virtual;

Called when Font result changed, either by setting CustomFont or when UIFont assigned changed.

Public destructor Destroy; override;
 
Public procedure GLContextClose; override;
 
Public function TooltipExists: boolean; override;
 
Public procedure TooltipRender; override;
 
Public procedure Render; override;
 
Public procedure CheckFontChanged;

Check does currently used font (see CustomFont) changed, and eventually call FontChanged method now.

You only need to explicitly call this in very specific circumstances, when you just changed UIFont (changing CustomFont automatically immediately calls FontChanged) and you want control size to be updated immediately (for example, you need TCastleButton.Height to be immediately valid). Without calling this, it could be updated only at next Render call.

Properties

Published property Tooltip: string read FTooltip write FTooltip;

Tooltip string, displayed when user hovers the mouse over a control.

Note that you can override TUIControl.TooltipExists and TUIControl.TooltipStyle and TUIControl.TooltipRender to customize the tooltip drawing.

Published property CustomFont: TCastleFont read FCustomFont write SetCustomFont;

When non-nil, this font will be used to draw this control. Otherwise the default UIFont will be used.

Published property OwnsCustomFont: boolean read FOwnsCustomFont write FOwnsCustomFont default false;
 

Generated by PasDoc 0.14.0.