/ 
Padre-0.36
/ Padre::Wx::StatusBar

NAME

Padre::Wx::StatusBar - Encapsulates status bar customizations

DESCRIPTION

Padre::Wx::StatusBar implements Padre's statusbar. It is the bottom pane holding various, err, status information on Padre.

The information shown are (in order):

  • Filename of current document, with a leading star if file has been updated and not saved

  • (Optional) Icon showing status of background tasks

  • (Optional) Mimetype of current document

  • Type of end of lines of current document

  • Position in current document

It inherits from Wx::StatusBar, so check wx documentation to see all the available methods that can be applied to it besides the added ones (see below).

PUBLIC API

Constructor

There's only one constructor for this class.

  • my $statusbar = Padre::Wx::StatusBar->new( $main );

    Create and return a new Padre statusbar. One should pass the $main Padre window as argument, to get a reference to the statusbar parent.

Public Methods

  • $sb->clear;

    Clear all the status bar fields, ie, they will display an empty string in all fields.

  • my $main = $sb->main;

    Handy method to get a reference on Padre's main window.

  • my $current = $sb->current;

    Get a new Padre::Current object.

  • $sb->refresh;

    Force an update of the document fields in the statusbar.

  • $sb->update_task_status;

    Checks whether a task status icon update is in order and if so, changes the icon to one of the other states

Event handlers

Those methods handle various events happening to the statusbar.

  • $sb->on_resize( $event );

    Handler for the EVT_SIZE $event. Used to move the task load bitmap to its position.

SEE ALSO

Icons for background status courtesy of Mark James, at http://www.famfamfam.com/lab/icons/silk/.

COPYRIGHT & LICENSE

Copyright 2008-2009 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.