.\" 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 "Padre::Wx::StatusBar 3pm"
.TH Padre::Wx::StatusBar 3pm "2012-06-27" "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"
Padre::Wx::StatusBar \- Encapsulates status bar customizations
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Padre::Wx::StatusBar\*(C'\fR implements Padre's status bar. It is the bottom
pane holding various, err, status information on Padre.
.PP
The information shown are (in order):
.IP "\(bu" 4
File name of current document, with a leading star if file has
been updated and not saved
.IP "\(bu" 4
(Optional) Icon showing status of background tasks
.IP "\(bu" 4
(Optional) \s-1MIME\s0 type of current document
.IP "\(bu" 4
Type of end of lines of current document
.IP "\(bu" 4
Position in current document
.PP
It inherits from \f(CW\*(C`Wx::StatusBar\*(C'\fR, so check Wx documentation to see all
the available methods that can be applied to it besides the added ones
(see below).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 1
\&    my $statusbar = Padre::Wx::StatusBar\->new( $main );
.Ve
.PP
Create and return a new Padre status bar. One should pass the \f(CW$main\fR
Padre window as argument, to get a reference to the status bar parent.
.ie n .SS """clear"""
.el .SS "\f(CWclear\fP"
.IX Subsection "clear"
.Vb 1
\&    $statusbar\->clear;
.Ve
.PP
Clear all the status bar fields, i.e. they will display an empty string
in all fields.
.ie n .SS """say"""
.el .SS "\f(CWsay\fP"
.IX Subsection "say"
.Vb 1
\&    $statusbar\->say(\*(AqHello World!\*(Aq);
.Ve
.PP
Temporarily overwrite only the leftmost filename part of the status bar.
.PP
It will return to it's normal value when the status bar is next refreshed
for normal reasons (such as a keystroke or a file panel switch).
.ie n .SS """refresh"""
.el .SS "\f(CWrefresh\fP"
.IX Subsection "refresh"
.Vb 1
\&    $statusbar\->refresh;
.Ve
.PP
Force an update of the document fields in the status bar.
.ie n .SS """update_task_status"""
.el .SS "\f(CWupdate_task_status\fP"
.IX Subsection "update_task_status"
.Vb 1
\&    $statusbar\->update_task_status;
.Ve
.PP
Checks whether a task status icon update is in order and if so, changes
the icon to one of the other states
.ie n .SS """update_pos"""
.el .SS "\f(CWupdate_pos\fP"
.IX Subsection "update_pos"
.Vb 1
\&    $statusbar\->update_pos;
.Ve
.PP
Update the cursor position
.ie n .SS """on_resize"""
.el .SS "\f(CWon_resize\fP"
.IX Subsection "on_resize"
.Vb 1
\&    $statusbar\->on_resize( $event );
.Ve
.PP
Handler for the \f(CW\*(C`EVT_SIZE\*(C'\fR \f(CW$event\fR. Used to move the task load bitmap to
its position.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Icons for background status courtesy of Mark James, at
<http://www.famfamfam.com/lab/icons/silk/>.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2012 The Padre development team as listed in Padre.pm.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.