Public Member Functions | Public Attributes

FBProgress Class Reference

This reference page is linked to from the following overview topics: Motion Capture Devices.


Search for all occurrences

Detailed Description

Progress bar.

Definition at line 1948 of file fbcontrols.h.

#include <fbcontrols.h>

Inheritance diagram for FBProgress:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBProgress ()
 Constructor.
void ProgressBegin ()
 Start progress, must be called before set Text & Percent property.
void 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.
FBPropertyInt Percent
 Read Write Property: Percent completed for the operation.

Constructor & Destructor Documentation

Constructor.


Member Function Documentation

void ProgressBegin ( )

Start progress, must be called before set Text & Percent property.

void 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.

Reimplemented from FBVisualComponent.

Definition at line 1967 of file fbcontrols.h.

Read Write Property: Text to display on progress bar.

Must be used in between ProgressBegin()/ProgressDone()

Definition at line 1968 of file fbcontrols.h.

Read Write Property: Percent completed for the operation.

Must be used called in between ProgressBegin()/ProgressDone()

Definition at line 1969 of file fbcontrols.h.


The documentation for this class was generated from the following file:

FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress
FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress