GI.Gtk.Objects.ProgressBar

The ProgressBar is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The GtkProgressBar can be used in two different modes: percentage mode and activity mode.

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 progressBarSetFraction 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 ProgressBar 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 progressBarPulse periodically to update the progress bar.

There is quite a bit of flexibility provided to control the appearance of the ProgressBar. 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

plain code

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.

Exported types

newtype ProgressBar

Memory-managed wrapper type.

Constructors

ProgressBar (ManagedPtr ProgressBar)

Instances

GObject ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

Methods

gobjectType :: ProgressBar -> IO GType

IsImplementorIface ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

IsObject ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

IsBuildable ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

IsOrientable ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

IsWidget ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

IsProgressBar ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

class GObject o => IsProgressBar o

Type class for types which can be safely cast to ProgressBar, for instance with toProgressBar.

Instances

(GObject a, (UnknownAncestorError ProgressBar a :: Constraint)) => IsProgressBar a

Defined in GI.Gtk.Objects.ProgressBar

IsProgressBar ProgressBar

Defined in GI.Gtk.Objects.ProgressBar

toProgressBar :: (MonadIO m, IsProgressBar o) => o -> m ProgressBar

Cast to ProgressBar, for types for which this is known to be safe. For general casts, use castTo.

noProgressBar :: Maybe ProgressBar

A convenience alias for Nothing :: Maybe ProgressBar.

Methods

getEllipsize

progressBarGetEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m EllipsizeMode

Returns: EllipsizeMode

Returns the ellipsizing position of the progress bar. See progressBarSetEllipsize.

Since: 2.6

getFraction

progressBarGetFraction

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m Double

Returns: a fraction from 0.0 to 1.0

Returns the current fraction of the task that’s been completed.

getInverted

progressBarGetInverted

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m Bool

Returns: True if the progress bar is inverted

Gets the value set by progressBarSetInverted.

getPulseStep

progressBarGetPulseStep

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m Double

Returns: a fraction from 0.0 to 1.0

Retrieves the pulse step set with progressBarSetPulseStep.

getShowText

progressBarGetShowText

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m Bool

Returns: True if text is shown in the progress bar

Gets the value of the ProgressBar:show-text property. See progressBarSetShowText.

Since: 3.0

getText

progressBarGetText

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m (Maybe Text)

Returns: text, or Nothing; this string is owned by the widget and should not be modified or freed.

Retrieves the text that is displayed with the progress bar, if any, otherwise Nothing. 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.

new

progressBarNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ProgressBar

Returns: a ProgressBar.

Creates a new ProgressBar.

pulse

progressBarPulse

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> m ()

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 progressBarPulse causes the block to move by a little bit (the amount of movement per pulse is determined by progressBarSetPulseStep).

setEllipsize

progressBarSetEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> EllipsizeMode

mode: a EllipsizeMode

-> m ()

Sets the mode used to ellipsize (add an ellipsis: "...") the text if there is not enough space to render the entire string.

Since: 2.6

setFraction

progressBarSetFraction

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> Double

fraction: fraction of the task that’s been completed

-> m ()

Causes the progress bar to “fill in” the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.

setInverted

progressBarSetInverted

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> Bool

inverted: True to invert the progress bar

-> m ()

Progress bars normally grow from top to bottom or left to right. Inverted progress bars grow in the opposite direction.

setPulseStep

progressBarSetPulseStep

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> Double

fraction: fraction between 0.0 and 1.0

-> m ()

Sets the fraction of total progress bar length to move the bouncing block for each call to progressBarPulse.

setShowText

progressBarSetShowText

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> Bool

showText: whether to show text

-> m ()

Sets whether the progress bar will show text next to the bar. The shown text is either the value of the ProgressBar:text property or, if that is Nothing, the 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 ProgressBar:show-text to True and ProgressBar:text to the empty string (not Nothing).

Since: 3.0

setText

progressBarSetText

Arguments

:: (HasCallStack, MonadIO m, IsProgressBar a)

=> a

pbar: a ProgressBar

-> Maybe Text

text: a UTF-8 string, or Nothing

-> m ()

Causes the given text to appear next to the progress bar.

If text is Nothing and ProgressBar:show-text is True, the current value of ProgressBar:fraction will be displayed as a percentage.

If text is non-Nothing and 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 ProgressBar:show-text is True.

Properties

ellipsize

The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, specified as a EllipsizeMode.

Note that setting this property to a value other than EllipsizeModeNone has the side-effect that the progress bar requests only enough space to display the ellipsis ("..."). Another means to set a progress bar's width is widgetSetSizeRequest.

Since: 2.6

constructProgressBarEllipsize :: IsProgressBar o => EllipsizeMode -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ellipsize” property. This is rarely needed directly, but it is used by new.

getProgressBarEllipsize :: (MonadIO m, IsProgressBar o) => o -> m EllipsizeMode

Get the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

get progressBar #ellipsize

setProgressBarEllipsize :: (MonadIO m, IsProgressBar o) => o -> EllipsizeMode -> m ()

Set the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

set progressBar [ #ellipsize := value ]

fraction

No description available in the introspection data.

constructProgressBarFraction :: IsProgressBar o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “fraction” property. This is rarely needed directly, but it is used by new.

getProgressBarFraction :: (MonadIO m, IsProgressBar o) => o -> m Double

Get the value of the “fraction” property. When overloading is enabled, this is equivalent to

get progressBar #fraction

setProgressBarFraction :: (MonadIO m, IsProgressBar o) => o -> Double -> m ()

Set the value of the “fraction” property. When overloading is enabled, this is equivalent to

set progressBar [ #fraction := value ]

inverted

No description available in the introspection data.

constructProgressBarInverted :: IsProgressBar o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “inverted” property. This is rarely needed directly, but it is used by new.

getProgressBarInverted :: (MonadIO m, IsProgressBar o) => o -> m Bool

Get the value of the “inverted” property. When overloading is enabled, this is equivalent to

get progressBar #inverted

setProgressBarInverted :: (MonadIO m, IsProgressBar o) => o -> Bool -> m ()

Set the value of the “inverted” property. When overloading is enabled, this is equivalent to

set progressBar [ #inverted := value ]

pulseStep

No description available in the introspection data.

constructProgressBarPulseStep :: IsProgressBar o => Double -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pulse-step” property. This is rarely needed directly, but it is used by new.

getProgressBarPulseStep :: (MonadIO m, IsProgressBar o) => o -> m Double

Get the value of the “pulse-step” property. When overloading is enabled, this is equivalent to

get progressBar #pulseStep

setProgressBarPulseStep :: (MonadIO m, IsProgressBar o) => o -> Double -> m ()

Set the value of the “pulse-step” property. When overloading is enabled, this is equivalent to

set progressBar [ #pulseStep := value ]

showText

Sets whether the progress bar will show a text in addition to the bar itself. The shown text is either the value of the ProgressBar:text property or, if that is Nothing, the ProgressBar:fraction value, as a percentage.

To make a progress bar that is styled and sized suitably for showing text (even if the actual text is blank), set ProgressBar:show-text to True and ProgressBar:text to the empty string (not Nothing).

Since: 3.0

constructProgressBarShowText :: IsProgressBar o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-text” property. This is rarely needed directly, but it is used by new.

getProgressBarShowText :: (MonadIO m, IsProgressBar o) => o -> m Bool

Get the value of the “show-text” property. When overloading is enabled, this is equivalent to

get progressBar #showText

setProgressBarShowText :: (MonadIO m, IsProgressBar o) => o -> Bool -> m ()

Set the value of the “show-text” property. When overloading is enabled, this is equivalent to

set progressBar [ #showText := value ]

text

No description available in the introspection data.

clearProgressBarText :: (MonadIO m, IsProgressBar o) => o -> m ()

Set the value of the “text” property to Nothing. When overloading is enabled, this is equivalent to

clear #text

constructProgressBarText :: IsProgressBar o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.

getProgressBarText :: (MonadIO m, IsProgressBar o) => o -> m (Maybe Text)

Get the value of the “text” property. When overloading is enabled, this is equivalent to

get progressBar #text

setProgressBarText :: (MonadIO m, IsProgressBar o) => o -> Text -> m ()

Set the value of the “text” property. When overloading is enabled, this is equivalent to

set progressBar [ #text := value ]