Castle Game Engine

Class TCastleOnScreenMenuItem

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleOnScreenMenu

Declaration

type TCastleOnScreenMenuItem = class(TCastleUserInterface)

Description

Clickable menu item of TCastleOnScreenMenu.

Hierarchy

Overview

Methods

Protected procedure DoClick; virtual;
Protected procedure BeforeSizing; override;
Protected procedure TranslateProperties(const TranslatePropertyEvent: TTranslatePropertyEvent); override;
Public constructor Create(AOwner: TComponent); override;
Public procedure Render; override;
Public procedure Update(const SecondsPassed: Single; var HandleInput: boolean); override;
Public function Press(const Event: TInputPressRelease): boolean; override;
Public function Release(const Event: TInputPressRelease): boolean; override;
Public function Motion(const Event: TInputMotion): boolean; override;

Properties

Published property AutoSizeToChildren default true;
Published property Caption: String read FCaption write SetCaption;
Published property CaptionTranslate: Boolean read FCaptionTranslate write FCaptionTranslate default true;
Published property OnClick: TNotifyEvent read FOnClick write FOnClick;
Published property Enabled: Boolean read FEnabled write SetEnabled default true;
Published property RightCaption: String read FRightCaption write SetRightCaption;

Description

Methods

Protected procedure DoClick; virtual;
 
Protected procedure BeforeSizing; override;
 
Protected procedure TranslateProperties(const TranslatePropertyEvent: TTranslatePropertyEvent); override;
 
Public constructor Create(AOwner: TComponent); override;
 
Public procedure Render; override;
 
Public procedure Update(const SecondsPassed: Single; var HandleInput: boolean); override;
 
Public function Press(const Event: TInputPressRelease): boolean; override;
 
Public function Release(const Event: TInputPressRelease): boolean; override;
 
Public function Motion(const Event: TInputMotion): boolean; override;
 

Properties

Published property AutoSizeToChildren default true;
 
Published property Caption: String read FCaption write SetCaption;

Text displayed by this on-screen menu item.

Published property CaptionTranslate: Boolean read FCaptionTranslate write FCaptionTranslate default true;

Should the Caption be localized (translated into other languages). Determines if the property is enumerated by TCastleComponent.TranslateProperties, which affects the rest of localization routines.

Published property OnClick: TNotifyEvent read FOnClick write FOnClick;

Event fired when user chooses this menu item in any way.

Published property Enabled: Boolean read FEnabled write SetEnabled default true;

Whether menu item is enabled.

Published property RightCaption: String read FRightCaption write SetRightCaption;

Additional text displayed on the right side.

Generated by PasDoc 0.16.0.