Class TfrmProgressMM

Unit

frmProgressUnit

Declaration

type TfrmProgressMM = class(TfrmCustomGoPhast)

Description

TfrmProgressMM is used to display a progress bar to the user with extra information displayed in memoMessages about what is happening.

Hierarchy

TForm
TfrmCustomGoPhast
TfrmProgressMM

Overview

Fields

	`lblProgress: TLabel;`
	`memoMessages: TMemo;`
	`pbProgress: TProgressBar;`
	`pnlTop: TPanel;`
	`btnAbort: TBitBtn;`
	`FPrefix: string;`
	`LastTime: TDateTime;`
	`LastMessageTime: TDateTime;`
	`FShouldContinue: Boolean;`

Methods

	`procedure FormShow(Sender: TObject);`
	`procedure btnAbortClick(Sender: TObject);`
	`procedure SetPrefix(const Value: string);`
	`procedure SetProgressLabelCaption(const Value: string);`
	`function GetProgressLabelCaption: string;`
	`function GetShouldContinue: Boolean;`
	`procedure StepIt;`
	`procedure AddMessage(Const AMessage: string; AllowUpdate: boolean = True);`

Properties

	`property ShouldContinue: Boolean read GetShouldContinue write FShouldContinue;`
	`property ProgressLabelCaption: string read GetProgressLabelCaption write SetProgressLabelCaption;`
	`property Prefix: string read FPrefix write SetPrefix;`

Description

Fields

	`lblProgress: TLabel;`
`lblProgress`: TLabel; `lblProgress` displays the amount of progress. See StepIt and Prefix.

	`memoMessages: TMemo;`
`memoMessages`: TMemo; `memoMessages` displays messages to the user.

	`pbProgress: TProgressBar;`
`pbProgress`: TProgressBar; `pbProgress` displays the amount of progress. See StepIt.

	`pnlTop: TPanel;`
`pnlTop`: TPanel; `pnlTop` holds the controls at the top of `TfrmProgressMM`.

	`btnAbort: TBitBtn;`

	`FPrefix: string;`
`FPrefix`: string; See Prefix.

	`LastTime: TDateTime;`

	`LastMessageTime: TDateTime;`

	`FShouldContinue: Boolean;`

Methods

	`procedure FormShow(Sender: TObject);`
`FormShow` initializes `TfrmProgressMM`.

	`procedure btnAbortClick(Sender: TObject);`

	`procedure SetPrefix(const Value: string);`
See Prefix.

	`procedure SetProgressLabelCaption(const Value: string);`

	`function GetProgressLabelCaption: string;`

	`function GetShouldContinue: Boolean;`

	`procedure StepIt;`
`StepIt` advances pbProgress and sets the caption of lblProgress based on Prefix and the amount of progress.

	`procedure AddMessage(Const AMessage: string; AllowUpdate: boolean = True);`

Properties

	`property ShouldContinue: Boolean read GetShouldContinue write FShouldContinue;`
Private declarations

	`property ProgressLabelCaption: string read GetProgressLabelCaption write SetProgressLabelCaption;`

	`property Prefix: string read FPrefix write SetPrefix;`
`Prefix` is used in StepIt to help set the caption of lblProgress. See StepIt.

Generated by PasDoc 0.12.1 on 2013-05-13 15:41:39