.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::ProgressBar 3"
.TH Gtk2::ProgressBar 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gtk2::ProgressBar \- wrapper for GtkProgressBar
.SH HIERARCHY
.IX Header "HIERARCHY"
.Vb 6
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::Widget
\&                 +\-\-\-\-Glib::Object::_Unregistered::GtkProgress
\&                      +\-\-\-\-Gtk2::ProgressBar
.Ve
.SH INTERFACES
.IX Header "INTERFACES"
.Vb 2
\&  Glib::Object::_Unregistered::AtkImplementorIface
\&  Gtk2::Buildable
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "widget = Gtk2::ProgressBar\->\fBnew\fP"
.IX Subsection "widget = Gtk2::ProgressBar->new"
.ie n .SS "ellipsizemode = $pbar\->\fBget_ellipsize\fP"
.el .SS "ellipsizemode = \f(CW$pbar\fP\->\fBget_ellipsize\fP"
.IX Subsection "ellipsizemode = $pbar->get_ellipsize"
Since: gtk+ 2.6
.ie n .SS "$pbar\->\fBset_ellipsize\fP ($mode)"
.el .SS "\f(CW$pbar\fP\->\fBset_ellipsize\fP ($mode)"
.IX Subsection "$pbar->set_ellipsize ($mode)"
.IP \(bu 4
\&\f(CW$mode\fR (Pango::EllipsizeMode)
.PP
Since: gtk+ 2.6
.ie n .SS "double = $pbar\->\fBget_fraction\fP"
.el .SS "double = \f(CW$pbar\fP\->\fBget_fraction\fP"
.IX Subsection "double = $pbar->get_fraction"
.ie n .SS "$pbar\->\fBset_fraction\fP ($fraction)"
.el .SS "\f(CW$pbar\fP\->\fBset_fraction\fP ($fraction)"
.IX Subsection "$pbar->set_fraction ($fraction)"
.IP \(bu 4
\&\f(CW$fraction\fR (double)
.ie n .SS "progressbarorientation = $pbar\->\fBget_orientation\fP"
.el .SS "progressbarorientation = \f(CW$pbar\fP\->\fBget_orientation\fP"
.IX Subsection "progressbarorientation = $pbar->get_orientation"
.ie n .SS "$pbar\->\fBset_orientation\fP ($orientation)"
.el .SS "\f(CW$pbar\fP\->\fBset_orientation\fP ($orientation)"
.IX Subsection "$pbar->set_orientation ($orientation)"
.IP \(bu 4
\&\f(CW$orientation\fR (Gtk2::ProgressBarOrientation)
.ie n .SS $pbar\->\fBpulse\fP
.el .SS \f(CW$pbar\fP\->\fBpulse\fP
.IX Subsection "$pbar->pulse"
.ie n .SS "double = $pbar\->\fBget_pulse_step\fP"
.el .SS "double = \f(CW$pbar\fP\->\fBget_pulse_step\fP"
.IX Subsection "double = $pbar->get_pulse_step"
.ie n .SS "$pbar\->\fBset_pulse_step\fP ($fraction)"
.el .SS "\f(CW$pbar\fP\->\fBset_pulse_step\fP ($fraction)"
.IX Subsection "$pbar->set_pulse_step ($fraction)"
.IP \(bu 4
\&\f(CW$fraction\fR (double)
.ie n .SS "string or undef = $pbar\->\fBget_text\fP"
.el .SS "string or undef = \f(CW$pbar\fP\->\fBget_text\fP"
.IX Subsection "string or undef = $pbar->get_text"
.ie n .SS "$pbar\->\fBset_text\fP ($text)"
.el .SS "\f(CW$pbar\fP\->\fBset_text\fP ($text)"
.IX Subsection "$pbar->set_text ($text)"
.IP \(bu 4
\&\f(CW$text\fR (string or undef)
.SH PROPERTIES
.IX Header "PROPERTIES"
.IP "'activity\-blocks' (Glib::UInt : default 5 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'activity-blocks' (Glib::UInt : default 5 : readable / writable / private / static-nick / static-blurb)"
The number of blocks which can fit in the progress bar area in activity mode (Deprecated)
.IP "'activity\-step' (Glib::UInt : default 3 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'activity-step' (Glib::UInt : default 3 : readable / writable / private / static-nick / static-blurb)"
The increment used for each iteration in activity mode (Deprecated)
.IP "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private / static-nick / static-blurb)"
The GtkAdjustment connected to the progress bar (Deprecated)
.IP "'bar\-style' (Gtk2::ProgressBarStyle : default ""continuous"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'bar-style' (Gtk2::ProgressBarStyle : default ""continuous"" : readable / writable / private / static-nick / static-blurb)"
Specifies the visual style of the bar in percentage mode (Deprecated)
.IP "'discrete\-blocks' (Glib::UInt : default 10 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'discrete-blocks' (Glib::UInt : default 10 : readable / writable / private / static-nick / static-blurb)"
The number of discrete blocks in a progress bar (when shown in the discrete style)
.IP "'ellipsize' (Pango::EllipsizeMode : default ""none"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'ellipsize' (Pango::EllipsizeMode : default ""none"" : readable / writable / private / static-nick / static-blurb)"
The preferred place to ellipsize the string, if the progress bar does not have enough room to display the entire string, if at all.
.IP "'fraction' (double : default 0 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'fraction' (double : default 0 : readable / writable / private / static-nick / static-blurb)"
The fraction of total work that has been completed
.IP "'orientation' (Gtk2::ProgressBarOrientation : default ""left-to-right"" : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'orientation' (Gtk2::ProgressBarOrientation : default ""left-to-right"" : readable / writable / private / static-nick / static-blurb)"
Orientation and growth direction of the progress bar
.IP "'pulse\-step' (double : default 0.1 : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'pulse-step' (double : default 0.1 : readable / writable / private / static-nick / static-blurb)"
The fraction of total progress to move the bouncing block when pulsed
.IP "'text' (string : default undef : readable / writable / private / static-nick / static-blurb)" 4
.IX Item "'text' (string : default undef : readable / writable / private / static-nick / static-blurb)"
Text to be displayed in the progress bar
.SH "STYLE PROPERTIES"
.IX Header "STYLE PROPERTIES"
.IP "'min\-horizontal\-bar\-height' (integer : default 20 : readable / writable)" 4
.IX Item "'min-horizontal-bar-height' (integer : default 20 : readable / writable)"
Minimum horizontal height of the progress bar
.IP "'min\-horizontal\-bar\-width' (integer : default 150 : readable / writable)" 4
.IX Item "'min-horizontal-bar-width' (integer : default 150 : readable / writable)"
The minimum horizontal width of the progress bar
.IP "'min\-vertical\-bar\-height' (integer : default 80 : readable / writable)" 4
.IX Item "'min-vertical-bar-height' (integer : default 80 : readable / writable)"
The minimum vertical height of the progress bar
.IP "'min\-vertical\-bar\-width' (integer : default 22 : readable / writable)" 4
.IX Item "'min-vertical-bar-width' (integer : default 22 : readable / writable)"
The minimum vertical width of the progress bar
.IP "'xspacing' (integer : default 7 : readable / writable)" 4
.IX Item "'xspacing' (integer : default 7 : readable / writable)"
Extra spacing applied to the width of a progress bar.
.IP "'yspacing' (integer : default 7 : readable / writable)" 4
.IX Item "'yspacing' (integer : default 7 : readable / writable)"
Extra spacing applied to the height of a progress bar.
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::ProgressBarOrientation"
.IX Subsection "enum Gtk2::ProgressBarOrientation"
.IP \(bu 4
\&'left\-to\-right' / 'GTK_PROGRESS_LEFT_TO_RIGHT'
.IP \(bu 4
\&'right\-to\-left' / 'GTK_PROGRESS_RIGHT_TO_LEFT'
.IP \(bu 4
\&'bottom\-to\-top' / 'GTK_PROGRESS_BOTTOM_TO_TOP'
.IP \(bu 4
\&'top\-to\-bottom' / 'GTK_PROGRESS_TOP_TO_BOTTOM'
.SS "enum Gtk2::ProgressBarStyle"
.IX Subsection "enum Gtk2::ProgressBarStyle"
.IP \(bu 4
\&'continuous' / 'GTK_PROGRESS_CONTINUOUS'
.IP \(bu 4
\&'discrete' / 'GTK_PROGRESS_DISCRETE'
.SS "enum Pango::EllipsizeMode"
.IX Subsection "enum Pango::EllipsizeMode"
.IP \(bu 4
\&'none' / 'PANGO_ELLIPSIZE_NONE'
.IP \(bu 4
\&'start' / 'PANGO_ELLIPSIZE_START'
.IP \(bu 4
\&'middle' / 'PANGO_ELLIPSIZE_MIDDLE'
.IP \(bu 4
\&'end' / 'PANGO_ELLIPSIZE_END'
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Glib::Object::_Unregistered::GtkProgress
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the LGPL.  See Gtk2 for a full notice.