TProgressIndicator Class Reference

Provides methods to display upload and download progress. More...

List of all members.

Public Member Functions
	Reset ()
	Reset the progress indicator.
	Start ()
	Start the progress indicator.
Public Attributes
Int64	Current
	The current progress value.
Int64	Maximum
	The maximum progress value.
TFtpProgressEvent	OnShowProgress
	Event which can be used to display current and total number of files.
Protected Member Functions
TProgressInfo	GetProgressInfo (const Integer DoneSize)
	This function returns informations about the current progress state.

---

Detailed Description

Provides methods to display upload and download progress.

See also:

IProgressIndicator

Remarks:

The TBTVisualFTP component has two event handlers, which can be connected to a ProgressBar component: TBTVisualFTP.OnFileProgress and TBTVisualFTP.OnFilesProgress.

See also:

TBTVisualFTP.OnFileProgress

TBTVisualFTP.OnFilesProgress

---

Member Function Documentation

TProgressIndicator::Reset

(

)

Reset the progress indicator.

This method sets the Current property to 0. This will also call the OnShowProgress event handler.

References Current.

Referenced by Start().

TProgressIndicator::Start

(

)

Start the progress indicator.

This method calls Reset and sets the StartTime property to the current GetTickCount() value. This will also call the OnShowProgress event handler.

References Reset().

---

Member Data Documentation

TProgressIndicator::Current

The current progress value.

See also:

FCurrent For reading

FCurrent For writing

Referenced by Reset().

TProgressIndicator::Maximum

The maximum progress value.

See also:

GetMaximum For reading

FMaximum For writing

Referenced by GetProgressInfo().

TProgressIndicator::OnShowProgress

Event which can be used to display current and total number of files.

See also:

GetOnShowProgress For reading

SetOnShowProgress For writing