FBProgress Class Reference
Detailed Description
Progress bar.
Inheritance diagram for FBProgress:
Public Member Functions |
|
| __init__ () | |
| Constructor. |
|
| ProgressBegin () | |
| Start progress, must be called before set
Text & Percent property. |
|
| ProgressDone () | |
| End progress, must be called to reset
progress bar UI to normal status after finishing the task. |
|
| bool | UserRequestCancell () |
| Return true if User is pressing and holding
"ESC" key to request the cancellation. |
|
Public Attributes |
|
| FBPropertyString | Caption |
| Read Write Property: Caption to be
displayed for progress bar. |
|
| FBPropertyString | Text |
| Read Write Property: Text to display
on progress bar. |
|
| FBPropertyBase | Percent |
| Read Write Property: Percent
completed for the operation. |
|
Member Function Documentation
| __init__ | ( | ) |
Constructor.
| ProgressBegin | ( | ) |
Start progress, must be called before set Text & Percent property.
| ProgressDone | ( | ) |
End progress, must be called to reset progress bar UI to normal status after finishing the task.
| bool UserRequestCancell | ( | ) |
Return true if User is pressing and holding "ESC" key to request the cancellation.
Must be called in between ProgressBegin()/ProgressDone().
Member Data Documentation
Read Write Property: Caption to be displayed for progress bar.
Read Write Property: Text to display on progress bar.
Must be used in between ProgressBegin()/ProgressDone()
| FBPropertyBase Percent |
Read Write Property: Percent completed for the operation.
Must be used called in between ProgressBegin()/ProgressDone()
