aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/Shared/GUI/Properties.pm
blob: 27778da2392ecc2239b57f44d82b7c7b6e30d998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# vim: set et ts=4 sw=4:
package ManaTools::Shared::GUI::Properties;
#============================================================= -*-perl-*-

=head1 NAME

ManaTools::Shared::GUI::Properties - Class to manage a yui YProperties properly

=head1 SYNOPSIS

package FooProps;

with 'ManaTools::Shared::PropertiesRole';

...


use ManaTools::Shared::GUI::Properties;

my $hbox = ...
my $foo = FooProps->new();
my $properties = ManaTools::Shared::GUI::Properties->new(parentWidget => $hbox, properties => $foo);
$foo->prop('bar', 'baz');
$properties->refresh();
...

=head1 DESCRIPTION

This class wraps YProperties and it's child widgets to handle


=head1 SUPPORT

You can find documentation for this module with the perldoc command:

perldoc ManaTools::Shared::GUI::Properties

=head1 SEE ALSO

yui::YProperties

=head1 AUTHOR

Maarten Vanraes <alien@rmail.be>

=head1 COPYRIGHT and LICENSE

Copyright (C) 2015-2016, Maarten Vanraes.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2, as
published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA

=head1 FUNCTIONS

=cut


use Moose;

use ManaTools::Shared::GUI::ReplacePoint;

#=============================================================

=head2 new

=head3 INPUT

    hash ref containing
        parentWidget: the parent widget
        properties: the properties object

=head3 DESCRIPTION

    new is inherited from Moose, to create a Properties object

=cut

#=============================================================

has 'parentDialog' => (
    is => 'ro',
    isa => 'ManaTools::Shared::GUI::Dialog',
    required => 1,
);

has 'parentWidget' => (
    is => 'ro',
    isa => 'yui::YWidget',
    required => 1,
);

has 'properties' => (
    is => 'rw',
    does => 'Maybe[ManaTools::Shared::PropertiesRole]',
    trigger => \&refresh,
    default => undef,
);

has 'replacepoint' => (
    is => 'ro',
    isa => 'ManaTools::Shared::GUI::ReplacePoint',
    init_arg => undef,
    lazy => 1,
    default => sub {
        my $self = shift;
        my $rpl = ManaTools::Shared::GUI::ReplacePoint->new(eventHandler => $self->parentDialog(), parentWidget => $self->parentWidget());
        $rpl->finished();
        return $rpl;
    },
);

#=============================================================

=head2 refresh

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    rebuilds the properties

=cut

#=============================================================
sub refresh {
    my $self = shift;
    my $dialog = $self->parentDialog();
    my $factory = $dialog->factory();
    my $parentWidget = $self->parentWidget();
    my $replacepoint = $self->replacepoint();
    my $properties = $self->properties();

    # clear and start new changes on replacepoint
    $replacepoint->clear();
    if (defined $properties) {
        my $vbox = $factory->createVBox($replacepoint->container());
        # rebuild for all properties a hbox with label and outfield
        for my $key (sort $properties->properties()) {
            # $properties->prop($key)
            my $hbox = $factory->createHBox($vbox);
            $factory->createLabel($hbox, $key .': ');
            my $val = $properties->prop($key);
            $val = '' if (!defined($val));
            $val = '' if (ref($val) ne '');
            $val = ''. $val;
            $factory->createOutputField($hbox, $val);
            $factory->createHStretch($hbox);
        }
    }
    # finished
    $replacepoint->finished();
}

#=============================================================

no Moose;
__PACKAGE__->meta->make_immutable;


1;