1Padre::Wx::StatusBar(3)User Contributed Perl DocumentatioPnadre::Wx::StatusBar(3)
2
3
4

NAME

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

DESCRIPTION

9       "Padre::Wx::StatusBar" implements Padre's status bar. It is the bottom
10       pane holding various, err, status information on Padre.
11
12       The information shown are (in order):
13
14       ·   File name of current document, with a leading star if file has been
15           updated and not saved
16
17       ·   (Optional) Icon showing status of background tasks
18
19       ·   (Optional) MIME type of current document
20
21       ·   Type of end of lines of current document
22
23       ·   Position in current document
24
25       It inherits from "Wx::StatusBar", so check Wx documentation to see all
26       the available methods that can be applied to it besides the added ones
27       (see below).
28

METHODS

30   "new"
31           my $statusbar = Padre::Wx::StatusBar->new( $main );
32
33       Create and return a new Padre status bar. One should pass the $main
34       Padre window as argument, to get a reference to the status bar parent.
35
36   "clear"
37           $statusbar->clear;
38
39       Clear all the status bar fields, i.e. they will display an empty string
40       in all fields.
41
42   "say"
43           $statusbar->say('Hello World!');
44
45       Temporarily overwrite only the leftmost filename part of the status
46       bar.
47
48       It will return to it's normal value when the status bar is next
49       refreshed for normal reasons (such as a keystroke or a file panel
50       switch).
51
52   "refresh"
53           $statusbar->refresh;
54
55       Force an update of the document fields in the status bar.
56
57   "update_task_status"
58           $statusbar->update_task_status;
59
60       Checks whether a task status icon update is in order and if so, changes
61       the icon to one of the other states
62
63   "update_pos"
64           $statusbar->update_pos;
65
66       Update the cursor position
67
68   "on_resize"
69           $statusbar->on_resize( $event );
70
71       Handler for the "EVT_SIZE" $event. Used to move the task load bitmap to
72       its position.
73

SEE ALSO

75       Icons for background status courtesy of Mark James, at
76       <http://www.famfamfam.com/lab/icons/silk/>.
77
79       Copyright 2008-2011 The Padre development team as listed in Padre.pm.
80
81       This program is free software; you can redistribute it and/or modify it
82       under the same terms as Perl itself.
83
84       The full text of the license can be found in the LICENSE file included
85       with this module.
86
87
88
89perl v5.28.0                      2011-08-16           Padre::Wx::StatusBar(3)
Impressum