c7e1aad418b8dd227e5230e06f702fcce9327335
[p5sagit/Excel-Template.git] / lib / Excel / Template / Container / Locked.pm
1 package Excel::Template::Container::Locked;
2
3 use strict;
4
5 BEGIN {
6     use vars qw(@ISA);
7     @ISA = qw( Excel::Template::Container::Format );
8
9     use Excel::Template::Container::Format;
10 }
11
12 sub new
13 {
14     my $class = shift;
15     my $self = $class->SUPER::new(@_);
16
17     $self->{LOCKED} = 1;
18
19     return $self;
20 }
21
22 1;
23 __END__
24
25 =head1 NAME
26
27 Excel::Template::Container::Locked - Excel::Template::Container::Locked
28
29 =head1 PURPOSE
30
31 To format all children in locked
32
33 =head1 NODE NAME
34
35 LOCKED
36
37 =head1 INHERITANCE
38
39 Excel::Template::Container::Format
40
41 =head1 ATTRIBUTES
42
43 None
44
45 =head1 CHILDREN
46
47 None
48
49 =head1 EFFECTS
50
51 None
52
53 =head1 DEPENDENCIES
54
55 You must have protected the worksheet containing any cells that are affected by
56 this format. Otherwise, this node will have no effect.
57
58 =head1 USAGE
59
60   <locked>
61     ... Children here
62   </locked>
63
64 In the above example, the children will be displayed (if they are displaying
65 elements) in a locked format. All other formatting will remain the same and the
66 "locked"-ness will end at the end tag.
67
68 =head1 AUTHOR
69
70 Rob Kinyon (rob.kinyon@gmail.com)
71
72 =head1 SEE ALSO
73
74 WORKSHEET, FORMAT
75
76 =cut