.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Gtk2::ProgressBar 3pm" .TH Gtk2::ProgressBar 3pm "2015-02-24" "perl v5.14.2" "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)" 4 .IX Item "'activity-blocks' (Glib::UInt : default 5 : readable / writable / private)" 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)" 4 .IX Item "'activity-step' (Glib::UInt : default 3 : readable / writable / private)" The increment used for each iteration in activity mode (Deprecated) .IP "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private)" 4 .IX Item "'adjustment' (Gtk2::Adjustment : default undef : readable / writable / private)" The GtkAdjustment connected to the progress bar (Deprecated) .ie n .IP "'bar\-style' (Gtk2::ProgressBarStyle : default ""continuous"" : readable / writable / private)" 4 .el .IP "'bar\-style' (Gtk2::ProgressBarStyle : default ``continuous'' : readable / writable / private)" 4 .IX Item "'bar-style' (Gtk2::ProgressBarStyle : default continuous : readable / writable / private)" Specifies the visual style of the bar in percentage mode (Deprecated) .IP "'discrete\-blocks' (Glib::UInt : default 10 : readable / writable / private)" 4 .IX Item "'discrete-blocks' (Glib::UInt : default 10 : readable / writable / private)" The number of discrete blocks in a progress bar (when shown in the discrete style) .ie n .IP "'ellipsize' (Pango::EllipsizeMode : default ""none"" : readable / writable / private)" 4 .el .IP "'ellipsize' (Pango::EllipsizeMode : default ``none'' : readable / writable / private)" 4 .IX Item "'ellipsize' (Pango::EllipsizeMode : default none : readable / writable / private)" 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)" 4 .IX Item "'fraction' (double : default 0 : readable / writable / private)" The fraction of total work that has been completed .ie n .IP "'orientation' (Gtk2::ProgressBarOrientation : default ""left-to-right"" : readable / writable / private)" 4 .el .IP "'orientation' (Gtk2::ProgressBarOrientation : default ``left-to-right'' : readable / writable / private)" 4 .IX Item "'orientation' (Gtk2::ProgressBarOrientation : default left-to-right : readable / writable / private)" Orientation and growth direction of the progress bar .IP "'pulse\-step' (double : default 0.1 : readable / writable / private)" 4 .IX Item "'pulse-step' (double : default 0.1 : readable / writable / private)" The fraction of total progress to move the bouncing block when pulsed .IP "'text' (string : default undef : readable / writable / private)" 4 .IX Item "'text' (string : default undef : readable / writable / private)" 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' / '\s-1GTK_PROGRESS_LEFT_TO_RIGHT\s0' .IP "\(bu" 4 \&'right\-to\-left' / '\s-1GTK_PROGRESS_RIGHT_TO_LEFT\s0' .IP "\(bu" 4 \&'bottom\-to\-top' / '\s-1GTK_PROGRESS_BOTTOM_TO_TOP\s0' .IP "\(bu" 4 \&'top\-to\-bottom' / '\s-1GTK_PROGRESS_TOP_TO_BOTTOM\s0' .SS "enum Gtk2::ProgressBarStyle" .IX Subsection "enum Gtk2::ProgressBarStyle" .IP "\(bu" 4 \&'continuous' / '\s-1GTK_PROGRESS_CONTINUOUS\s0' .IP "\(bu" 4 \&'discrete' / '\s-1GTK_PROGRESS_DISCRETE\s0' .SS "enum Pango::EllipsizeMode" .IX Subsection "enum Pango::EllipsizeMode" .IP "\(bu" 4 \&'none' / '\s-1PANGO_ELLIPSIZE_NONE\s0' .IP "\(bu" 4 \&'start' / '\s-1PANGO_ELLIPSIZE_START\s0' .IP "\(bu" 4 \&'middle' / '\s-1PANGO_ELLIPSIZE_MIDDLE\s0' .IP "\(bu" 4 \&'end' / '\s-1PANGO_ELLIPSIZE_END\s0' .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 \s-1LGPL\s0. See Gtk2 for a full notice.