Class: Gtk::ProgressBar
- Extended by:
- GLib::Deprecatable
- Defined in:
- lib/gtk3/deprecated.rb
Overview
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.
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.
Instance Method Summary collapse
-
#ellipsize ⇒ Pango::EllipsizeMode
The preferred place to ellipsize the string.
-
#ellipsize=(ellipsize) ⇒ Pango::EllipsizeMode
The preferred place to ellipsize the string.
-
#fraction ⇒ Float
The fraction of total work that has been completed.
-
#fraction=(fraction) ⇒ Float
The fraction of total work that has been completed.
-
#initialize ⇒ Gtk::Widget
constructor
Creates a new
GtkProgressBar. -
#inverted ⇒ Boolean
Returns whether the progress bar is inverted.
-
#inverted=(inverted) ⇒ Boolean
Invert the direction in which the progress bar grows.
-
#inverted? ⇒ Boolean
Invert the direction in which the progress bar grows.
-
#pulse ⇒ nil
Indicates that some progress has been made, but you don’t know how much.
-
#pulse_step ⇒ Float
The fraction of total progress to move the bounding block when pulsed.
-
#pulse_step=(pulse_step) ⇒ Float
The fraction of total progress to move the bounding block when pulsed.
-
#show_text ⇒ Boolean
Returns whether the
GtkProgressBarshows text. -
#show_text=(show_text) ⇒ Boolean
Sets whether the progress bar will show a text in addition to the bar itself.
-
#show_text? ⇒ Boolean
Sets whether the progress bar will show a text in addition to the bar itself.
-
#text ⇒ String
Text to be displayed in the progress bar.
-
#text=(text) ⇒ String
Text to be displayed in the progress bar.
Methods inherited from Widget
#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_events, #add_events_raw, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #drag_dest_set, #drag_dest_set_raw, #drag_source_set, #drag_source_set_raw, #error_bell, #events, #events_raw, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #render_icon_pixbuf, #render_icon_pixbuf_raw, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_allocation, set_connect_func, set_connect_func_raw, #set_events, #set_events_raw, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #style_get_property, #style_get_property_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=
Constructor Details
#initialize ⇒ Gtk::Widget
Creates a new GtkProgressBar.
Instance Method Details
#ellipsize ⇒ Pango::EllipsizeMode
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].
#ellipsize=(ellipsize) ⇒ Pango::EllipsizeMode
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].
#fraction ⇒ Float
The fraction of total work that has been completed.
#fraction=(fraction) ⇒ Float
The fraction of total work that has been completed.
#inverted ⇒ Boolean
Returns whether the progress bar is inverted.
#inverted=(inverted) ⇒ Boolean
Invert the direction in which the progress bar grows.
#inverted? ⇒ Boolean
Invert the direction in which the progress bar grows.
#pulse ⇒ nil
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]).
#pulse_step ⇒ Float
The fraction of total progress to move the bounding block when pulsed.
#pulse_step=(pulse_step) ⇒ Float
The fraction of total progress to move the bounding block when pulsed.
#show_text ⇒ Boolean
Returns whether the GtkProgressBar shows text.
See [methodGtk.ProgressBar.set_show_text].
#show_text=(show_text) ⇒ Boolean
Sets whether the progress bar will show a text in addition to the bar itself.
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 showing 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).
#show_text? ⇒ Boolean
Sets whether the progress bar will show a text in addition to the bar itself.
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 showing 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).
#text ⇒ String
Text to be displayed in the progress bar.
#text=(text) ⇒ String
Text to be displayed in the progress bar.