Class TxomProgressController

Unit

xomProgress

Declaration

type TxomProgressController = class(TXOMObject)

Description

TxomProgressController

Hierarchy

• TXOMObject
• TxomProgressController

Overview

Methods

	procedure AfterConstruction; override;
	procedure BeforeDestruction; override;
	procedure Lock; virtual;
	procedure Unlock; virtual;
	function ProgressItemExists (const AID: String): Boolean; virtual;
	function CreateProgressItem (const AProgress: TxomProgress; const AID: String; const AText: WideString; const AProgressText: WideString = ''; const AShowPercentage: Boolean = True; const ACanPause: Boolean = False; const ACanClose: Boolean = True; const AAutoClose: Boolean = True; const AAnimated: Boolean = True; const AContinuous: Boolean = False): TxomProgressItem; virtual;
	procedure UpdateProgress (const AID: String; const APercentage: Single); virtual;
	procedure UpdateText (const AID: String; const AText: WideString); virtual;
	procedure UpdateContinuous (const AID: String; const AContinuous: Boolean); virtual;
	procedure UpdateProgressText (const AID: String; const AProgressText: WideString); virtual;
	procedure Hide (const AID: String); virtual;
	procedure Show (const AID: String); virtual;
	procedure HideProgress (const AID: String); virtual;
	procedure ShowProgress (const AID: String); virtual;
	procedure CloseProgress (const AID: String); virtual;
	procedure PauseProgress (const AID: String); virtual;
	procedure ResumeProgress (const AID: String); virtual;
	procedure CanPauseProgress (const AID: String; const ASetting: Boolean); virtual;
	procedure CanCloseProgress (const AID: String; const ASetting: Boolean); virtual;
	procedure AutoCloseProgress (const AID: String; const ASetting: Boolean); virtual;

Properties

	property Enabled: Boolean read FEnabled write FEnabled;
	property ProgressItems: TxomProgressItems read FProgressItems;

Description

Methods

	procedure AfterConstruction; override;

	procedure BeforeDestruction; override;

	procedure Lock; virtual;

	procedure Unlock; virtual;

	function ProgressItemExists (const AID: String): Boolean; virtual;

	function CreateProgressItem (const AProgress: TxomProgress; const AID: String; const AText: WideString; const AProgressText: WideString = ''; const AShowPercentage: Boolean = True; const ACanPause: Boolean = False; const ACanClose: Boolean = True; const AAutoClose: Boolean = True; const AAnimated: Boolean = True; const AContinuous: Boolean = False): TxomProgressItem; virtual;

	procedure UpdateProgress (const AID: String; const APercentage: Single); virtual;

	procedure UpdateText (const AID: String; const AText: WideString); virtual;

	procedure UpdateContinuous (const AID: String; const AContinuous: Boolean); virtual;

	procedure UpdateProgressText (const AID: String; const AProgressText: WideString); virtual;

	procedure Hide (const AID: String); virtual;

	procedure Show (const AID: String); virtual;

	procedure HideProgress (const AID: String); virtual;

	procedure ShowProgress (const AID: String); virtual;

	procedure CloseProgress (const AID: String); virtual;

	procedure PauseProgress (const AID: String); virtual;

	procedure ResumeProgress (const AID: String); virtual;

	procedure CanPauseProgress (const AID: String; const ASetting: Boolean); virtual;

	procedure CanCloseProgress (const AID: String; const ASetting: Boolean); virtual;

	procedure AutoCloseProgress (const AID: String; const ASetting: Boolean); virtual;

Properties

	property Enabled: Boolean read FEnabled write FEnabled;

	property ProgressItems: TxomProgressItems read FProgressItems;