diff options
author | Aylur <[email protected]> | 2024-10-23 20:37:32 +0000 |
---|---|---|
committer | Aylur <[email protected]> | 2024-10-23 20:37:32 +0000 |
commit | 306e64998c1bf1fb997c1098ae92d6edfef31cd2 (patch) | |
tree | 1f852514d269f9ad1d3523771e9119760ace6948 /lib/astal/gtk3/src/widget/circularprogress.vala | |
parent | 72670224a49cf22779b56eabce0d9ce71bfb5486 (diff) |
docs: astal3 and io comments
Diffstat (limited to 'lib/astal/gtk3/src/widget/circularprogress.vala')
-rw-r--r-- | lib/astal/gtk3/src/widget/circularprogress.vala | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/astal/gtk3/src/widget/circularprogress.vala b/lib/astal/gtk3/src/widget/circularprogress.vala index dd7c97b..a3ecdf1 100644 --- a/lib/astal/gtk3/src/widget/circularprogress.vala +++ b/lib/astal/gtk3/src/widget/circularprogress.vala @@ -1,8 +1,34 @@ +/** + * CircularProgress is a subclass of [[email protected]] which provides a circular progress bar + * with customizable properties such as starting and ending points, + * progress value, and visual features like rounded ends and inversion of progress direction. + */ public class Astal.CircularProgress : Gtk.Bin { + /** + * The starting point of the progress circle, + * where 0 represents 3 o'clock position or 0° degrees and 1 represents 360°. + */ public double start_at { get; set; } + + /** + * The cutoff point of the background color of the progress circle. + */ public double end_at { get; set; } + + /** + * The value which determines the arc of the drawn foreground color. + * Should be a value between 0 and 1. + */ public double value { get; set; } + + /** + * Inverts the progress direction, making it draw counterclockwise. + */ public bool inverted { get; set; } + + /** + * Renders rounded ends at both the start and the end of the progress bar. + */ public bool rounded { get; set; } construct { |