Padre::Wx::StatusBar(3pm)

NAME

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

DESCRIPTION

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

The information shown are (in order):

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

•: (Optional) Icon showing status of background tasks

•: (Optional) MIME type 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).

METHODS

"new"

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

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

"clear"

    $statusbar->clear;

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

"say"

    $statusbar->say('Hello World!');

Temporarily overwrite only the leftmost filename part of the status bar.

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).

"refresh"

    $statusbar->refresh;

Force an update of the document fields in the status bar.

"update_task_status"

    $statusbar->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

"update_pos"

    $statusbar->update_pos;

Update the cursor position

"on_resize"

    $statusbar->on_resize( $event );

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

COPYRIGHT & LICENSE

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.