1Padre::Wx::Progress(3)User Contributed Perl DocumentationPadre::Wx::Progress(3)
2
3
4

NAME

6       Padre::Wx::Progress - Tell the user that we're doing something
7

SYNOPSIS

9         my $object = Padre::Wx::Progress->new($title, $max_count,
10                      modal => 1,
11                      lazy  => 1,
12                      );
13
14         $object->Update($done_count, $current_work_text);
15

DESCRIPTION

17       Shows a progress bar dialog to tell the user that we're doing
18       something.
19

METHODS

21   new
22         my $object = Padre::Wx::Progress->new($title, $max_count,
23                      message => $default_message # optional
24                      modal => 1, # optional
25                      lazy  => 1, # optional
26                      );
27
28       The "new" constructor lets you create a new "Padre::Wx::Progress"
29       object.
30
31       $title is the title of the new box.
32
33       $max_count contains the highest item-number being processed.
34
35       Options:
36
37       A default message could be set (in case "update" should be called
38       without text) with the message key. This is overridden by the newest
39       "update" text.  Default is an empty message.
40
41       Set modal to true to lock other application windows while the progress
42       box is displayed. Default is 0 (non-modal).
43
44       Set lazy to true to show the progress dialog only if the whole process
45       takes long enough that the progress box makes sense. Default if 1
46       (lazy-mode).
47
48       All options are optional, Padre will use fixed defaults if they're
49       missing.
50
51       Returns a new "Padre::Wx::Progress" or dies on error.
52
53   update
54         $progress->update($value,$text);
55
56       Updates the progress bar with a new value and optional with a new text
57       message.
58
59       The last message will stay if no new text is specified.
60

62       Copyright 2008-2011 The Padre development team as listed in Padre.pm.
63
64       This program is free software; you can redistribute it and/or modify it
65       under the same terms as Perl itself.
66
67       The full text of the license can be found in the LICENSE file included
68       with this module.
69
70
71
72perl v5.30.1                      2020-01-30            Padre::Wx::Progress(3)
Impressum