Progressbar object
The Progressbar widget provides visual feedback for task completion
| Event | Description |
|---|---|
| Progressbar:onClick() | Event fired when the user clicks on the Progressbar |
| Progressbar:onContext() | Event fired when the user right click on the Progressbar |
| Progressbar:onCreate() | Event fired when Progressbar has just been created |
| Progressbar:onDrop() | Event fired when the Progressbar received a drag and drop content |
| Progressbar:onHide() | Event fired when the Progressbar is hidden |
| Progressbar:onHover() | Event fired when the user moves the mouse pointer over the Progressbar |
| Progressbar:onLeave() | Event fired when the mouse cursor leaves the Progressbar |
| Progressbar:onMouseDown() | Event fired when the user presses a mouse button over the Progressbar |
| Progressbar:onMouseUp() | Event fired when the user releases a mouse button over the Progressbar |
| Progressbar:onShow() | Event fired when the Progressbar is shown |
| Property | Description | Access | Type |
|---|---|---|---|
| Progressbar.align | Align the Progressbar relative to its parent | readwrite | boolean |
| Progressbar.allowdrop | Controls whether the Progressbar is a drag and drop target | readwrite | boolean |
| Progressbar.bgcolor | Get/set the Progressbar background color | readwrite | number |
| Progressbar.enabled | Controls whether the Progressbar responds to mouse and other events | readwrite | boolean |
| Progressbar.fgcolor | Get/set the Progressbar text color | readwrite | number |
| Progressbar.height | Get/set the Progressbar's height | readwrite | number |
| Progressbar.parent | Get the Progressbar's parent widget | readonly | |
| Progressbar.position | Get/set the Progressbar progression position | readwrite | number |
| Progressbar.range | Get/set the Progressbar range | readwrite | table |
| Progressbar.themed | Controls whether the Progressbar use custom theming | readwrite | boolean |
| Progressbar.visible | Controls whether the Progressbar appears on screen | readwrite | boolean |
| Progressbar.width | Get/set the Progressbar's width | readwrite | number |
| Progressbar.x | Get/set the Progressbar's horizontal position | readwrite | number |
| Progressbar.y | Get/set the Progressbar's vertical position | readwrite | number |
| Methods | Description | Return value |
|---|---|---|
| Progressbar:advance() | Advance the progression of the Progressbar | - |
| Progressbar:center() | Centers the Progressbar on the parent widget | - |
| Progressbar:constructor() | Progressbar object constructor | |
| Progressbar:hide() | Hides the Progressbar | - |
| Progressbar:show() | Shows the Progressbar | - |
| Progressbar:toback() | Puts the widget to the back | - |
| Progressbar:tofront() | Brings the widget in front | - |