ProgressBarProtocol

public protocol ProgressBarProtocol : OrientableProtocol, WidgetProtocol

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

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 [methodGtk.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 [methodGtk.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.

The ProgressBarProtocol protocol exposes the methods and properties of an underlying GtkProgressBar instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ProgressBar. Alternatively, use ProgressBarRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkProgressBar instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • progress_bar_ptr Default implementation

    Typed pointer to the underlying GtkProgressBar instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkProgressBar instance.

    Declaration

    Swift

    var progress_bar_ptr: UnsafeMutablePointer<GtkProgressBar>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ProgressBarProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ProgressBar Class

  • Bind a ProgressBarPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ProgressBarPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a ProgressBar property

    Declaration

    Swift

    @inlinable
func get(property: ProgressBarPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a ProgressBar property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: ProgressBarPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ProgressBar Class: ProgressBarProtocol extension (methods and fields)

  • getEllipsize() Extension method

    Returns the ellipsizing position of the progress bar.

    See [methodGtk.ProgressBar.set_ellipsize].

    Declaration

    Swift

    @inlinable
func getEllipsize() -> PangoEllipsizeMode
    Show on GitHub
  • getFraction() Extension method

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

    Declaration

    Swift

    @inlinable
func getFraction() -> CDouble
    Show on GitHub
  • getInverted() Extension method

    Returns whether the progress bar is inverted.

    Declaration

    Swift

    @inlinable
func getInverted() -> Bool
    Show on GitHub
  • getPulseStep() Extension method

    Retrieves the pulse step.

    See [methodGtk.ProgressBar.set_pulse_step].

    Declaration

    Swift

    @inlinable
func getPulseStep() -> CDouble
    Show on GitHub
  • getShowText() Extension method

    Returns whether the GtkProgressBar shows text.

    See [methodGtk.ProgressBar.set_show_text].

    Declaration

    Swift

    @inlinable
func getShowText() -> Bool
    Show on GitHub
  • getText() Extension method

    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.

    Declaration

    Swift

    @inlinable
func getText() -> String!
    Show on GitHub
  • pulse() Extension method

    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 [methodGtk.ProgressBar.pulse] causes the block to move by a little bit (the amount of movement per pulse is determined by [methodGtk.ProgressBar.set_pulse_step]).

    Declaration

    Swift

    @inlinable
func pulse()
    Show on GitHub
  • setEllipsize(mode:) Extension method

    Sets the mode used to ellipsize the text.

    The text is ellipsized if there is not enough space to render the entire string.

    Declaration

    Swift

    @inlinable
func setEllipsize(mode: PangoEllipsizeMode)
    Show on GitHub
  • set(fraction:) Extension method

    Causes the progress bar to “fill in” the given fraction of the bar.

    The fraction should be between 0.0 and 1.0, inclusive.

    Declaration

    Swift

    @inlinable
func set(fraction: CDouble)
    Show on GitHub
  • set(inverted:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func set(inverted: Bool)
    Show on GitHub
  • setPulseStep(fraction:) Extension method

    Sets the fraction of total progress bar length to move the bouncing block.

    The bouncing block is moved when [methodGtk.ProgressBar.pulse] is called.

    Declaration

    Swift

    @inlinable
func setPulseStep(fraction: CDouble)
    Show on GitHub
  • set(showText:) Extension method

    Sets whether the progress bar will show text next to the bar.

    The shown text is either the value of the [propertyGtk.ProgressBar:text] property or, if that is nil, the [propertyGtk.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 [propertyGtk.ProgressBar:show-text] to true and [propertyGtk.ProgressBar:text] to the empty string (not nil).

    Declaration

    Swift

    @inlinable
func set(showText: Bool)
    Show on GitHub
  • set(text:) Extension method

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

    If text is nil and [propertyGtk.ProgressBar:show-text] is true, the current value of [propertyGtk.ProgressBar:fraction] will be displayed as a percentage.

    If text is non-nil and [propertyGtk.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 [propertyGtk.ProgressBar:show-text] is true.

    Declaration

    Swift

    @inlinable
func set(text: UnsafePointer<CChar>? = nil)
    Show on GitHub
  • ellipsize Extension method

    The preferred place to ellipsize the string.

    The text will be ellipsized if the progress bar does not have enough room to display the entire string, specified as a PangoEllipsizeMode.

    Note that setting this property to a value other than PANGO_ELLIPSIZE_NONE 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 [methodGtk.Widget.set_size_request].

    Declaration

    Swift

    @inlinable
var ellipsize: PangoEllipsizeMode { get nonmutating set }
    Show on GitHub
  • fraction Extension method

    The fraction of total work that has been completed.

    Declaration

    Swift

    @inlinable
var fraction: CDouble { get nonmutating set }
    Show on GitHub
  • inverted Extension method

    Invert the direction in which the progress bar grows.

    Declaration

    Swift

    @inlinable
var inverted: Bool { get nonmutating set }
    Show on GitHub
  • pulseStep Extension method

    Retrieves the pulse step.

    See [methodGtk.ProgressBar.set_pulse_step].

    Declaration

    Swift

    @inlinable
var pulseStep: CDouble { get nonmutating set }
    Show on GitHub
  • showText Extension method

    Returns whether the GtkProgressBar shows text.

    See [methodGtk.ProgressBar.set_show_text].

    Declaration

    Swift

    @inlinable
var showText: Bool { get nonmutating set }
    Show on GitHub
  • text Extension method

    Text to be displayed in the progress bar.

    Declaration

    Swift

    @inlinable
var text: String! { get nonmutating set }
    Show on GitHub