Package ch.bailu.gtk.gtk

Class ProgressBar

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gobject.InitiallyUnowned
ch.bailu.gtk.gtk.Widget
ch.bailu.gtk.gtk.ProgressBar
All Implemented Interfaces:
PointerInterface
public class ProgressBar extends Widget
`GtkProgressBar` is typically used to display the progress of a long
running operation.

It provides a visual clue that processing is underway. `GtkProgressBar`
can be used in two different modes: percentage mode and activity mode.

![An example GtkProgressBar](progressbar.png)

When an application can determine how much work needs to take place
(e.g. read a fixed number of bytes from a file) and can monitor its
progress, it can use the `GtkProgressBar` in percentage mode and the
user sees a growing bar indicating the percentage of the work that
has been completed. In this mode, the application is required to call
[method@Gtk.ProgressBar.set_fraction] periodically to update the progress bar.

When an application has no accurate way of knowing the amount of work
to do, it can use the `GtkProgressBar` in activity mode, which shows
activity by a block moving back and forth within the progress area. In
this mode, the application is required to call [method@Gtk.ProgressBar.pulse]
periodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance
of the `GtkProgressBar`. Functions are provided to control the orientation
of the bar, optional text can be displayed along with the bar, and the
step size used in activity mode can be set.

# CSS nodes

```
progressbar[.osd]
├── [text]
╰── trough[.empty][.full]
╰── progress[.pulse]
```

`GtkProgressBar` has a main CSS node with name progressbar and subnodes with
names text and trough, of which the latter has a subnode named progress. The
text subnode is only present if text is shown. The progress subnode has the
style class .pulse when in activity mode. It gets the style classes .left,
.right, .top or .bottom added when the progress 'touches' the corresponding
end of the GtkProgressBar. The .osd class on the progressbar node is for use
in overlays like the one Epiphany has for page loading progress.

# Accessibility

`GtkProgressBar` uses the %GTK_ACCESSIBLE_ROLE_PROGRESS_BAR role.

https://docs.gtk.org/gtk4/class.ProgressBar.html

  • Constructor Details

    • ProgressBar

      public ProgressBar(PointerContainer pointer)

    • ProgressBar

      public ProgressBar()
      Creates a new `GtkProgressBar`.

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • getEllipsize

      public int getEllipsize()
      Returns the ellipsizing position of the progress bar.

      See [method@Gtk.ProgressBar.set_ellipsize].
      Returns:
      `PangoEllipsizeMode`

    • getFraction

      public double getFraction()
      Returns the current fraction of the task that’s been completed.
      Returns:
      a fraction from 0.0 to 1.0

    • getInverted

      public boolean getInverted()
      Returns whether the progress bar is inverted.
      Returns:
      %TRUE if the progress bar is inverted

    • getPulseStep

      public double getPulseStep()
      Retrieves the pulse step.

      See [method@Gtk.ProgressBar.set_pulse_step].
      Returns:
      a fraction from 0.0 to 1.0

    • getShowText

      public boolean getShowText()
      Returns whether the `GtkProgressBar` shows text.

      See [method@Gtk.ProgressBar.set_show_text].
      Returns:
      %TRUE if text is shown in the progress bar

    • getText

      public Str getText()
      Retrieves the text that is displayed with the progress bar.

      The return value is a reference to the text, not a copy of it,
      so will become invalid if you change the text in the progress bar.
      Returns:
      the text

    • pulse

      public void pulse()
      Indicates that some progress has been made, but you don’t know how much.

      Causes the progress bar to enter “activity mode,” where a block
      bounces back and forth. Each call to [method@Gtk.ProgressBar.pulse]
      causes the block to move by a little bit (the amount of movement
      per pulse is determined by [method@Gtk.ProgressBar.set_pulse_step]).

    • setEllipsize

      public void setEllipsize(int mode)
      Sets the mode used to ellipsize the text.

      The text is ellipsized if there is not enough space
      to render the entire string.
      Parameters:
      mode - a `PangoEllipsizeMode`

    • setFraction

      public void setFraction(double fraction)
      Causes the progress bar to “fill in” the given fraction
      of the bar.

      The fraction should be between 0.0 and 1.0, inclusive.
      Parameters:
      fraction - fraction of the task that’s been completed

    • setInverted

      public void setInverted(boolean inverted)
      Sets whether the progress bar is inverted.

      Progress bars normally grow from top to bottom or left to right.
      Inverted progress bars grow in the opposite direction.
      Parameters:
      inverted - %TRUE to invert the progress bar

    • setPulseStep

      public void setPulseStep(double fraction)
      Sets the fraction of total progress bar length to move the
      bouncing block.

      The bouncing block is moved when [method@Gtk.ProgressBar.pulse]
      is called.
      Parameters:
      fraction - fraction between 0.0 and 1.0

    • setShowText

      public void setShowText(boolean show_text)
      Sets whether the progress bar will show text next to the bar.

      The shown text is either the value of the [property@Gtk.ProgressBar:text]
      property or, if that is %NULL, the [property@Gtk.ProgressBar:fraction] value,
      as a percentage.

      To make a progress bar that is styled and sized suitably for containing
      text (even if the actual text is blank), set [property@Gtk.ProgressBar:show-text]
      to %TRUE and [property@Gtk.ProgressBar:text] to the empty string (not %NULL).
      Parameters:
      show_text - whether to show text

    • setText

      public void setText(@Nullable Str text)
      Causes the given @text to appear next to the progress bar.

      If @text is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
      the current value of [property@Gtk.ProgressBar:fraction] will be displayed
      as a percentage.

      If @text is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
      the text will be displayed. In this case, it will not display the progress
      percentage. If @text is the empty string, the progress bar will still
      be styled and sized suitably for containing text, as long as
      [property@Gtk.ProgressBar:show-text] is %TRUE.
      Parameters:
      text - a UTF-8 string

    • setText

      public void setText(String text)
      Causes the given @text to appear next to the progress bar.

      If @text is %NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
      the current value of [property@Gtk.ProgressBar:fraction] will be displayed
      as a percentage.

      If @text is non-%NULL and [property@Gtk.ProgressBar:show-text] is %TRUE,
      the text will be displayed. In this case, it will not display the progress
      percentage. If @text is the empty string, the progress bar will still
      be styled and sized suitably for containing text, as long as
      [property@Gtk.ProgressBar:show-text] is %TRUE.
      Parameters:
      text - a UTF-8 string

    • asAccessible

      public Accessible asAccessible()
      Implements interface Accessible. Call this to get access to interface functions.
      Overrides:
      asAccessible in class Widget
      Returns:
      Accessible

    • asBuildable

      public Buildable asBuildable()
      Implements interface Buildable. Call this to get access to interface functions.
      Overrides:
      asBuildable in class Widget
      Returns:
      Buildable

    • asConstraintTarget

      public ConstraintTarget asConstraintTarget()
      Implements interface ConstraintTarget. Call this to get access to interface functions.
      Overrides:
      asConstraintTarget in class Widget
      Returns:
      ConstraintTarget

    • asOrientable

      public Orientable asOrientable()
      Implements interface Orientable. Call this to get access to interface functions.
      Returns:
      Orientable

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()