Progress Indicators
PBProgressIndicator
Opaque object handle:
This is a subclass of PBElement. You can safely cast from PBProgressIndicator to PBElement. To cast from PBElement to PBProgressIndicator, call PBProgressIndicatorCast; this performs a runtime assertion to check the cast is possible. This function is thread-safe.
This object maintains an internal reference count. When the reference count reaches zero, the object will be automatically deallocated. To increment the reference count, call PBElementRetain; to decrement the reference count, call PBElementRelease. These functions are thread-safe.
PBProgressIndicatorFlags
Enumeration/bitset of type uint32_t:
Constants
Or any of the values from PBElementFlags.
PBProgressIndicatorCreate
Function:
Syntax (C/C++)
PBProgressIndicatorPtr _Nullable PBProgressIndicatorCreate(PBElementRef parent,
PBProgressIndicatorFlags flags);
Syntax (Python)
ProgressIndicatorCreate(parent, flags) -> (progressIndicator)
Parameters and Return Values
[in] parent (referenced PBElement):
[in] flags (PBProgressIndicatorFlags):
[out] progressIndicator (nullable owned PBProgressIndicator):
PBProgressIndicatorSetPosition
Function:
Syntax (C/C++)
void PBProgressIndicatorSetPosition(PBProgressIndicatorRef progressIndicator,
double position01);
Syntax (Python)
ProgressIndicatorSetPosition(progressIndicator, position01)
Parameters and Return Values
[in] progressIndicator (referenced PBProgressIndicator):
[in] position01 (double):
PBProgressIndicatorSetIndeterminate
Function:
Syntax (C/C++)
void PBProgressIndicatorSetIndeterminate(
PBProgressIndicatorRef progressIndicator, bool running);
Syntax (Python)
ProgressIndicatorSetIndeterminate(progressIndicator, running)
Parameters and Return Values
[in] progressIndicator (referenced PBProgressIndicator):
[in] running (bool):