Delphi Game Engine

Class TDGEFMXHelpBar

Description
Hierarchy
Fields
Methods
Properties

Unit

Gamolf.FMX.HelpBar

Declaration

type TDGEFMXHelpBar = class(TFMXObject)

Description

Help bar component

Attributes
ComponentPlatformsAttribute(pfidWindows or pfidOSX or pfidLinux or pfidAndroid or pfidiOS)

Hierarchy

Overview

Fields

Protected lGlobal: TLayout;
Protected lHelpBar: TLayout;
Protected lContent: TLayout;
Protected rBackground: TRectangle;
Protected imgImage: TImage;

Methods

Protected procedure GamepadLost(const GamepadID: integer);
Protected procedure GamepadDetected(const GamepadID: integer);
Protected function GetNewX(const WithRightMargin: boolean = true): single;
Public constructor Create(AOwner: TComponent); override;
Public procedure AfterConstruction; override;
Public destructor Destroy; override;
Public procedure RefreshHelpBar;
Public procedure OpenHelpBar;
Public procedure CloseHelpBar;
Public procedure AddItem(const SVGKeyIndex, SVGGamepadIndex: integer); overload;
Public procedure AddItem(const SVGKeyIndex, SVGGamepadIndex: integer; const Text: string); overload;
Public procedure Clear;

Properties

Public property GamepadMode: boolean read FGamepadMode write SetGamepadMode;
Public property TextSettings: TTextSettings read FTextSettings write SetTextSettings;
Published property IconMarginRight: single read FIconMarginRight write SetIconMarginRight;
Published property IconKeyBitmapListIndex: word read FIconKeyBitmapListIndex write SetIconKeyBitmapListIndex default 0;
Published property IconGamepadBitmapListIndex: word read FIconGamepadBitmapListIndex write SetIconGamepadBitmapListIndex default 0;
Published property TextMarginRight: single read FTextMarginRight write SetTextMarginRight;
Published property BackgroundFill: TBrush read FBackgroundFill write SetBackgroundFill;
Published property BackgroundOpacity: single read FBackgroundOpacity write SetBackgroundOpacity;
Published property BackgroundXRadius: single read FBackgroundXRadius write SetBackgroundXRadius;
Published property BackgroundYRadius: single read FBackgroundYRadius write SetBackgroundYRadius;
Published property BackgroundPadding: TBounds read FBackgroundPadding write SetBackgroundPadding;
Published property BackgroundStroke: TStrokeBrush read FBackgroundStroke write SetBackgroundStroke;
Published property HorzAlign: TDGEFMXHelpBarHorzAlign read FHorzAlign write SetHorzAlign default TDGEFMXHelpBarHorzAlign.Center;
Published property VertAlign: TDGEFMXHelpBarVertAlign read FVertAlign write SetVertAlign default TDGEFMXHelpBarVertAlign.Bottom;
Published property Margins: TBounds read FMargins write SetMargins;
Published property Height: single read FHeight write SetHeight;

Description

Fields

Protected lGlobal: TLayout;
 
Protected lHelpBar: TLayout;
 
Protected lContent: TLayout;
 
Protected rBackground: TRectangle;
 
Protected imgImage: TImage;
 

Methods

Protected procedure GamepadLost(const GamepadID: integer);
 
Protected procedure GamepadDetected(const GamepadID: integer);
 
Protected function GetNewX(const WithRightMargin: boolean = true): single;
 
Public constructor Create(AOwner: TComponent); override;

Public procedure AfterConstruction; override;

Public destructor Destroy; override;

Public procedure RefreshHelpBar;

Public procedure OpenHelpBar;

Clear the help bar content and show it

Public procedure CloseHelpBar;

Hide the help bar

Public procedure AddItem(const SVGKeyIndex, SVGGamepadIndex: integer); overload;

Add an image to the Help Bar

Public procedure AddItem(const SVGKeyIndex, SVGGamepadIndex: integer; const Text: string); overload;

Add an image and text to the Help Bar

Public procedure Clear;

Empty the Help bar content layout

Properties

Public property GamepadMode: boolean read FGamepadMode write SetGamepadMode;

Public property TextSettings: TTextSettings read FTextSettings write SetTextSettings;

Published property IconMarginRight: single read FIconMarginRight write SetIconMarginRight;

Icons properties <summary>

</summary>

Published property IconKeyBitmapListIndex: word read FIconKeyBitmapListIndex write SetIconKeyBitmapListIndex default 0;

Published property IconGamepadBitmapListIndex: word read FIconGamepadBitmapListIndex write SetIconGamepadBitmapListIndex default 0;

Published property TextMarginRight: single read FTextMarginRight write SetTextMarginRight;

Texts properties <summary>

</summary>

Published property BackgroundFill: TBrush read FBackgroundFill write SetBackgroundFill;

Background properties <summary>

</summary>

Published property BackgroundOpacity: single read FBackgroundOpacity write SetBackgroundOpacity;

Published property BackgroundXRadius: single read FBackgroundXRadius write SetBackgroundXRadius;

Published property BackgroundYRadius: single read FBackgroundYRadius write SetBackgroundYRadius;

Published property BackgroundPadding: TBounds read FBackgroundPadding write SetBackgroundPadding;

Published property BackgroundStroke: TStrokeBrush read FBackgroundStroke write SetBackgroundStroke;

Background stroke properties <summary>

</summary>

Published property HorzAlign: TDGEFMXHelpBarHorzAlign read FHorzAlign write SetHorzAlign default TDGEFMXHelpBarHorzAlign.Center;

Help bar properties <summary>

</summary>

Published property VertAlign: TDGEFMXHelpBarVertAlign read FVertAlign write SetVertAlign default TDGEFMXHelpBarVertAlign.Bottom;

Published property Margins: TBounds read FMargins write SetMargins;

Published property Height: single read FHeight write SetHeight;

Delphi Game Engine (c) 2021-2025 Patrick PREMARTIN - Powered by PasDoc
Generated by PasDoc 0.16.0.