aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/Shared/GUI/EventHandlerRole.pm
blob: 852c97a1e8443e2c384f77a35009d132102ef2cc (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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
# vim: set et ts=4 sw=4:
package ManaTools::Shared::GUI::EventHandlerRole;

#============================================================= -*-perl-*-

=head1 NAME

    ManaTools::Shared::GUI::EventHandlerRole - a Properties Moose::Role

=head1 SYNOPSIS
    package Foo;

    with 'ManaTools::Shared::GUI::EventHandlerRole';

    1;

    ...

    my $f = Foo->new(...);
    $f->addEvent($event);
    ...
    while(1) {
        ...
        last if (!$f->processEvents($yevent));
    }
    ...
    $f->clearEvents();


=head1 DESCRIPTION

    This Role is to specify an EventHandler Role, specifically, to handle multiple sub-Events

=head1 SUPPORT

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

    perldoc ManaTools::Shared::GUI::EventHandlerRole


=head1 AUTHOR

    Maarten Vanraes <alien@rmail.be>

=head1 COPYRIGHT and LICENSE

Copyright (c) 2015-2016 Maarten Vanraes <alien@rmail.be>

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 METHODS

=cut

use Moose::Role;

has 'parentEventHandler' => (
    is => 'rw',
    isa => 'Maybe[ManaTools::Shared::GUI::EventHandlerRole]',
    default => undef,
);

has 'eventHandlers' => (
    is => 'ro',
    isa => 'ArrayRef[ManaTools::Shared::GUI::EventHandlerRole]',
    init_arg => undef,
    default => sub {
        return [];
    }
);

has 'events' => (
    is => 'ro',
    isa => 'HashRef[ManaTools::Shared::GUI::EventRole]',
    default => sub {
        return {};
    }
);

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

=head2 addEventHandler

=head3 INPUT

    $self: this object
    $eventHandler: an EventHandlerRole to be added

=head3 DESCRIPTION

    add an EventHandler to the events list

=cut

#=============================================================
sub addEventHandler {
    my $self = shift;
    my $eventHandler = shift;
    my $eventHandlers = $self->eventHandlers();
    push @{$eventHandlers}, $eventHandler;
    $eventHandler->parentEventHandler($self);
}

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

=head2 delEventHandler

=head3 INPUT

    $self: this object
    $eventHandler: an EventHandlerRole to be removed

=head3 DESCRIPTION

    del an eventHandler from the events list

=cut

#=============================================================
sub delEventHandler {
    my $self = shift;
    my $eventHandler = shift;
    my $eventHandlers = $self->eventHandlers();
    my $i = scalar(@{$eventHandlers});
    while ($i > 0) {
        $i = $i - 1;
        if ($eventHandlers->[$i] == $eventHandler) {
            $eventHandler->parentEventHandler(undef);
            # splice the eventHandler out of it
            splice @{$eventHandlers}, $i, 1;
            return ;
        }
    }
}

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

=head2 addEvent

=head3 INPUT

    $self: this object
    $name: a name to identify the event
    $event: an EventRole to be added
    @args: extra optional arguments

=head3 DESCRIPTION

    add an Event to the events list

=cut

#=============================================================
sub addEvent {
    my $self = shift;
    my $name = shift;
    my $event = shift;
    my $events = $self->events();
    die "event named '$name' already exists!" if defined($events->{$name});
    $events->{$name} = $event;
}

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

=head2 delEvent

=head3 INPUT

    $self: this object
    $name: a name to identify the event

=head3 DESCRIPTION

    del an event from the events list

=cut

#=============================================================
sub delEvent {
    my $self = shift;
    my $name = shift;
    my $events = $self->events();
    delete $events->{$name} if (defined $events->{$name});
}

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

=head2 hasEvent

=head3 INPUT

    $self: this object
    $name: the event identified by $name

=head3 DESCRIPTION

    1 if the event exists, 0 otherwise

=cut

#=============================================================
sub hasEvent {
    my $self = shift;
    my $name = shift;
    my $events = $self->events();
    return defined($events->{$name});
}

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

=head2 getEvent

=head3 INPUT

    $self: this object
    $name: the event identified by $name

=head3 OUTPUT

    an ManaTools::Shared::GUI::EventRole

=head3 DESCRIPTION

    returns an event, depending on the name

=cut

#=============================================================
sub getEvent {
    my $self = shift;
    my $name = shift;
    my $events = $self->events();
    die "event named '$name' does not exist!" if !defined($events->{$name});
    return $events->{$name};
}

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

=head2 clearEvents

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    clears all events

=cut

#=============================================================
sub clearEvents {
    my $self = shift;
    my $events = $self->events();
    for my $name (keys %{$events}) {
        $self->delEvent($name);
    }
}

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

=head2 findEvent

=head3 INPUT

    $self: this object
    $callback: CodeRef to be executed for each event
    @args: extra arguments for the callback

=head3 OUTPUT

    an event if it's found, or undef otherwise

=head3 DESCRIPTION

    returns an Event from the list, according to a callback function, or undef

=cut

#=============================================================
sub findEvent {
    my $self = shift;
    my $callback = shift;
    my @args = @_;
    my $events = $self->events();
    # loop all the items
    for my $event (values %{$events}) {
        return $event if ($callback->($event, @args));
    }
    return undef;
}

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

=head2 addWidget

=head3 INPUT

    $self: this object
    $name: a name to identify the widget
    $widget: a yui widget
    $event: an optional CodeRef that will be executed when an Event triggers
    $backend: an optional backend object that will be present in the event handler

=head3 DESCRIPTION

    add a widget event handler to the events list

=cut

#=============================================================
sub addWidget {
    my $self = shift;
    my $name = shift;
    my $widget = shift;
    my $event = shift;
    my $backend = shift;
    return ManaTools::Shared::GUI::Event->new(name => $name, eventHandler => $self, eventType => $yui::YEvent::WidgetEvent, widget => $widget, event => $event, backend => $backend);
}

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

=head2 delWidget

=head3 INPUT

    $self: this object
    $widget: a yui widget

=head3 DESCRIPTION

    del a widget event handler from the events list

=cut

#=============================================================
sub delWidget {
    my $self = shift;
    my $widget = shift;
    my $event = $self->findWidget($widget);
    $self->delEvent($event->name()) if (defined $event);
}

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

=head2 widget

=head3 INPUT

    $self: this object
    $name: the widget identified by $name

=head3 DESCRIPTION

    returns a yui::YWidget

=cut

#=============================================================
sub widget {
    my $self = shift;
    my $name = shift;
    return undef if (!$self->hasEvent($name));
    my $event = $self->getEvent($name);
    return undef if ($event->eventType() != $yui::YEvent::WidgetEvent);
    return undef if (!$event->isa('ManaTools::Shared::GUI::Event'));
    return $event->widget();
}

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

=head2 findWidget

=head3 INPUT

    $self: this object
    $widget: the yui::YWidget to be found

=head3 DESCRIPTION

    returns a ManaTools::Shared::GUI::Dialog::Event that has the widget

=cut

#=============================================================
sub findWidget {
    my $self = shift;
    my $widget = shift;
    return $self->findEvent(sub {
        my $event = shift;
        my $widget = shift;
        return 0 if ($event->eventType() != $yui::YEvent::WidgetEvent);
        return 0 if (!$event->isa('ManaTools::Shared::GUI::Event'));
        return $event->equalsWidget($widget);
    }, $widget);
}

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

=head2 addItem

=head3 INPUT

    $self: this object
    $name: a name to identify the item
    $item: a yui item
    $event: an optional CodeRef that will be executed when an Event triggers
    $backend: an optional backend object that will be present in the event handler

=head3 DESCRIPTION

    add a item event handler to the events list

=cut

#=============================================================
sub addItem {
    my $self = shift;
    my $name = shift;
    my $item = shift;
    my $event = shift;
    my $backend = shift;
    return ManaTools::Shared::GUI::Event->new(name => $name, eventHandler => $self, eventType => $yui::YEvent::MenuEvent, item => $item, event => $event, backend => $backend);
}

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

=head2 delItem

=head3 INPUT

    $self: this object
    $item: a yui item

=head3 DESCRIPTION

    del a item event handler from the events list

=cut

#=============================================================
sub delItem {
    my $self = shift;
    my $item = shift;
    my $event = $self->findItem($item);
    $self->delEvent($event->name()) if (defined $event);
}

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

=head2 item

=head3 INPUT

    $self: this object
    $name: the item identified by $name

=head3 DESCRIPTION

    returns a yui::YItem

=cut

#=============================================================
sub item {
    my $self = shift;
    my $name = shift;
    return undef if (!$self->hasEvent($name));
    my $event = $self->getEvent($name);
    return undef if ($event->eventType() != $yui::YEvent::MenuEvent);
    return undef if (!$event->isa('ManaTools::Shared::GUI::Event'));
    return $event->item();
}

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

=head2 findItem

=head3 INPUT

    $self: this object
    $item: the yui::YItem to be found

=head3 DESCRIPTION

    returns a ManaTools::Shared::GUI::Dialog::Event that has the item

=cut

#=============================================================
sub findItem {
    my $self = shift;
    my $item = shift;
    return $self->findEvent(sub {
        my $event = shift;
        my $item = shift;
        return 0 if ($event->eventType() != $yui::YEvent::MenuEvent);
        return 0 if (!$event->isa('ManaTools::Shared::GUI::Event'));
        return $event->equalsItem($item);
    }, $item);
}

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

=head2 processEvents

=head3 INPUT

    $self: this object
    $yevent: the yui::YEvent

=head3 OUTPUT

    0 if the loop should end, positive if handled, negative otherwise

=head3 DESCRIPTION

    returns an Event from the list, according to a callback function, or undef

=cut

#=============================================================
sub processEvents {
    my $self = shift;
    my $yevent = shift;

    # first check the other eventHandlers
    my $eventHandlers = $self->eventHandlers();
    for my $eventHandler (@{$eventHandlers}) {
        my $processed = $eventHandler->processEvents($yevent);
        return $processed if $processed >= 0;
    }

    # loop all the items
    my $events = $self->events();
    for my $event (values %{$events}) {
        my $processed = $event->processEvent($yevent);
        return $processed if $processed >= 0;
    }

    return -1;
}

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

=head2 parentDialog

=head3 INPUT

    $self: this object

=head3 DESCRIPTION

    finds the parent Dialog

=cut

#=============================================================
sub parentDialog {
    my $self = shift;
    return $self if $self->isa('ManaTools::Shared::GUI::Dialog');
    my $eventHandler = $self->parentEventHandler();
    return $eventHandler->parentDialog() if defined $eventHandler;
    return undef;
}

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

1;