Class TStateDialogInput

Fields

Unit

CastleDialogStates

Declaration

type TStateDialogInput = class(TStateDialog)

Description

Ask user to input a string, or cancel. See unit CastleDialogStates documentation for example usage.

Hierarchy

TObject
TPersistent
TComponent
TCastleComponent
TCastleUserInterface
TUIState
TStateDialog
TStateDialogInput

Overview

Methods

	`procedure InitializeButtons(var Buttons: TStateDialog.TButtonArray); override;`
	`function DrawInputText: boolean; override;`
	`function Press(const Event: TInputPressRelease): boolean; override;`

Properties

	`property AllowedChars: TSetOfChars read FAllowedChars write FAllowedChars;`
	`property MinLength: Cardinal read FMinLength write FMinLength default 0;`
	`property MaxLength: Cardinal read FMaxLength write FMaxLength default 0;`
	`property CanCancel: boolean read FCanCancel write FCanCancel default false;`
	`property AnswerCancelled: boolean read FAnswerCancelled;`
	`property Answer: string read GetAnswer write SetAnswer;`

Description

Methods

	`procedure InitializeButtons(var Buttons: TStateDialog.TButtonArray); override;`

	`function DrawInputText: boolean; override;`

	`function Press(const Event: TInputPressRelease): boolean; override;`

Properties

	`property AllowedChars: TSetOfChars read FAllowedChars write FAllowedChars;`
Allowed characters that user can input.

	`property MinLength: Cardinal read FMinLength write FMinLength default 0;`
Min length of user input.

	`property MaxLength: Cardinal read FMaxLength write FMaxLength default 0;`
Max length of user input. Value of 0 (default) means "no limit".

	`property CanCancel: boolean read FCanCancel write FCanCancel default false;`
User can cancel the input by pressing a button like "cancel".

	`property AnswerCancelled: boolean read FAnswerCancelled;`
User clicked "cancel" instead of accepting an answer. This is defined only when Answered. This is possible only if CanCancel.

	`property Answer: string read GetAnswer write SetAnswer;`
The user input. May be set before starting the state. After the state stopped, if Answered, then this contains user `answer`. You should ignore it if AnswerCancelled.

Generated by PasDoc 0.16.0.