Debian Codegraph @

Debconf/Element.pm

raw
1 #!/usr/bin/perl
2
3 =head1 NAME
4
5 Debconf::Element - Base input element
6
7 =cut
8
9 package Debconf::Element;
10 use warnings;
11 use strict;
12 use base qw(Debconf::Base);
13
14 =head1 DESCRIPTION
15
16 This is the base object on which many different types of input elements are
17 built. Each element represents one user interface element in a FrontEnd.
18
19 =head1 FIELDS
20
21 =over 4
22
23 =item value
24
25 The value the user entered into the element.
26
27 =head1 METHODS
28
29 =over 4
30
31 =item visible
32
33 Returns true if an Element is of a type that is displayed to the user.
34 This is used to let confmodules know if the elements they have caused to be
35 displayed are really going to be displayed, or not, so they can avoid loops
36 and other nastiness.
37
38 =cut
39
40 sub visible {
41 my $this=shift;
42
43 return 1;
44 }
45
46 =item show
47
48 Causes the element to be displayed, allows the user to interact with it.
49 Typically causes the value field to be set.
50
51 =cut
52
53 sub show {}
54
55 =back
56
57 =head1 AUTHOR
58
59 Joey Hess <[email protected]>
60
61 =cut
62
63 1