|
LibreOffice
LibreOffice 25.2 SDK API Reference
|
controls a status indicator which displays progress of longer actions to the user More...
import"XStatusIndicator.idl";
Public Member Functions | |
| void | start ([in] string Text, [in] long Range) |
| initialize and start the progress More... | |
| void | end () |
| stop the progress More... | |
| void | setText ([in] string Text) |
| update progress description More... | |
| void | setValue ([in] long Value) |
| update progress value More... | |
| void | reset () |
| clear progress value and description More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
controls a status indicator which displays progress of longer actions to the user
Such objects are provided by a XStatusIndicatorFactory.
| void end | ( | ) |
stop the progress
Further calls of XStatusIndicator::setText(), XStatusIndicator::setValue() or XStatusIndicator::reset() must be ignored. Only XStatusIndicator::start() can reactivate this indicator. It's not allowed to destruct the indicator inside this method. The instance must be gone by using ref count or disposing.
| void reset | ( | ) |
clear progress value and description
Calling of setValue(0) and setText("") should do the same. Stopped indicators must ignore this call.
| void setText | ( | [in] string | Text | ) |
update progress description
Initial value can be set during starting of the progress by calling XStatusIndicator::start(). Stopped indicators must ignore this call.
| Text | new value for progress description which should be shown now |
| void setValue | ( | [in] long | Value | ) |
update progress value
Wrong values must be ignored and stopped indicators must ignore this call generally.
| Value | new value for progress which should be shown now Must fit the range [0..Range] which was set during XStatusIndicator::start(). |
| void start | ( | [in] string | Text, |
| [in] long | Range | ||
| ) |
initialize and start the progress
It activates a new created or reactivate an already used indicator (must be finished by calling XStatusIndicator::end() before!). By the way it's possible to set first progress description and the possible range of progress value. That means that a progress can runs from 0 to Range.
| Text | initial value for progress description for showing Value can be updated by calling XStatusIndicator::setText(). |
| Range | means the maximum value of the progress which can be set by calling XStatusIndicator::setValue(). |
1.8.14