Castle Game EngineIntroduction Units Class Hierarchy Classes, Interfaces, Objects and Records Types Variables Constants Functions and Procedures Identifiers
|
Class TUIControlFont
Unit
CastleControls
Declaration
type TUIControlFont = class(TUIControl)
Description
Base class for all user interface controls using a font. Allows to customize font and font size per-control, or use defaults.
Hierarchy
Overview
Methods
Properties
 |
property OutlineColor: TCastleColor read FOutlineColor write SetOutlineColor; |
 |
property Tooltip: string read FTooltip write FTooltip; |
 |
property CustomFont: TCastleFont
read FCustomFont write SetCustomFont; |
 |
property OwnsCustomFont: boolean
read FOwnsCustomFont write FOwnsCustomFont default false; deprecated 'use TCastleFont (inherited from TComponent) owner mechanism'; |
 |
property FontSize: Single read FFontSize write SetFontSize default 0.0; |
 |
property SmallFont: boolean read FSmallFont write SetSmallFont default false; deprecated 'use "FontScale := 0.5" or "CustomFont := MySmalFont" instead of "SmallFont := true", this is more flexible'; |
 |
property FontScale: Single read FFontScale write SetFontScale default 1.0; |
 |
property Outline: Cardinal read FOutline write SetOutline default 0; |
 |
property OutlineHighQuality: boolean
read FOutlineHighQuality write SetOutlineHighQuality default false; |
Description
Methods
 |
procedure UIScaleChanged; override; |
|
 |
procedure Notification(AComponent: TComponent; Operation: TOperation); override; |
|
 |
constructor Create(AOwner: TComponent); override; |
|
 |
destructor Destroy; override; |
|
 |
procedure GLContextClose; override; |
|
 |
function TooltipExists: boolean; override; |
|
 |
procedure TooltipRender; override; |
|
 |
procedure Render; override; |
|
 |
function Font: TCastleFont; |
Font used for rendering and measuring this control. Depending on various properties of this class, this method returns UIFont or CustomFont or a TCustomizedFont instance that wraps (and scales) one of them.
|
 |
procedure CheckFontChanged; |
Check does currently used font (see Font) 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 calls this automatically) and you want control size to be updated immediately (for example, you need CalculatedHeight to be immediately valid). Without calling this, it could be updated only at next Render call.
|
 |
procedure FontChanged; virtual; |
Force considering font changed (font instance, or glyphs, or sizes changed).
Usually, you don't need to call this explicitly from the outside. Changing font, like UIFont or CustomFont, or any property that may affect the font is automatically applied.
But there are exceptions: right now, if you call Load on a font, it's measurements will change but some controls using it will not recalculate sizes automatically. In this case, call this method.
|
Properties
 |
property OutlineColor: TCastleColor read FOutlineColor write SetOutlineColor; |
Outline color, used only if Outline <> 0. Default is black.
See also
- Outline
- Outline size around the font.
|
 |
property CustomFont: TCastleFont
read FCustomFont write SetCustomFont; |
When non-nil, this font will be used to draw this control. Otherwise the global UIFont will be used.
|
 |
property OwnsCustomFont: boolean
read FOwnsCustomFont write FOwnsCustomFont default false; deprecated 'use TCastleFont (inherited from TComponent) owner mechanism'; |
Warning: this symbol is deprecated: use TCastleFont (inherited from TComponent) owner mechanism |
 |
property FontSize: Single read FFontSize write SetFontSize default 0.0; |
Use given font size when drawing. Leave at default zero to use the default size of the font (may still be scaled by TUIControl.UIScale, but this happens only if TUIContainer.UIScaling is set to something else than default usNone). Font itself is taken from CustomFont or, if not set, from UIFont.
|
 |
property SmallFont: boolean read FSmallFont write SetSmallFont default false; deprecated 'use "FontScale := 0.5" or "CustomFont := MySmalFont" instead of "SmallFont := true", this is more flexible'; |
Warning: this symbol is deprecated: use "FontScale := 0.5" or "CustomFont := MySmalFont" instead of "SmallFont := true", this is more flexible
Use smaller font. Right now this just says to scale font by 0.5.
|
 |
property FontScale: Single read FFontScale write SetFontScale default 1.0; |
Scale the font. This additionally scales the font defined by all other properties of this class, thus you can use it to reliably scale the font (regardless if you use CustomFont or not, regardless if you set FontSize or not).
|
 |
property Outline: Cardinal read FOutline write SetOutline default 0; |
Outline size around the font. Note that the current implementation is very simple, it will only look sensible for small outline values (like 1 or 2).
See TCastleFont.Outline for more details.
Specifying a non-zero outline for a label overrides the default outline settings for the current font. By default, fonts do not have an outline.
See also
- OutlineHighQuality
- Optionally force better outline quality.
|
 |
property OutlineHighQuality: boolean
read FOutlineHighQuality write SetOutlineHighQuality default false; |
Optionally force better outline quality. Used only if Outline <> 0. High quality outline looks better, but is about 2x more expensive to draw.
See also
- Outline
- Outline size around the font.
|
Generated by PasDoc 0.15.0.
|