diff options
author | Maarten Vanraes <maarten@ba.be> | 2015-08-26 20:49:02 +0200 |
---|---|---|
committer | Maarten Vanraes <maarten@ba.be> | 2015-08-26 20:49:02 +0200 |
commit | b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce (patch) | |
tree | 8f1231143a4c08e63bb044b89c94c2c5a82455b5 /lib/ManaTools/Shared/ExtTab.pm | |
parent | 085e46e0dff5b409a4b9e60bd7ddad8c7885657c (diff) | |
download | manatools-b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce.tar manatools-b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce.tar.gz manatools-b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce.tar.bz2 manatools-b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce.tar.xz manatools-b3b32f7e239eaff0a2dcfc72141498ca1b7d91ce.zip |
Move ExtTab module to GUI subdir
Diffstat (limited to 'lib/ManaTools/Shared/ExtTab.pm')
-rw-r--r-- | lib/ManaTools/Shared/ExtTab.pm | 407 |
1 files changed, 0 insertions, 407 deletions
diff --git a/lib/ManaTools/Shared/ExtTab.pm b/lib/ManaTools/Shared/ExtTab.pm deleted file mode 100644 index 2dcf37de..00000000 --- a/lib/ManaTools/Shared/ExtTab.pm +++ /dev/null @@ -1,407 +0,0 @@ -# vim: set et ts=4 sw=4: -package ManaTools::Shared::ExtTab; -#============================================================= -*-perl-*- - -=head1 NAME - -ManaTools::Shared::ExtTab - Class to manage a yui YDumbTab properly - -=head1 SYNOPSIS - -use ManaTools::Shared::ExtTab; - -my $exttab = ManaTools::Shared::ExtTab->new(parentWidget => $widget, factory => $factory, optFactory => $optFactory, callback => { my $backenditem = $_; ... }); - -$exttab->addItem("Label 1", $backenditem1, sub { my ($factory, $optFactory, $parent, $backendItem) = @_; my $vbox = $factory->createVBox($parent); ... } ); -$exttab->addItem("Label 2", $backenditem2, sub { my ($factory, $optFactory, $parent, $backendItem) = @_; my $vbox = $factory->createVBox($parent); ... } ); -$exttab->addItem("Label 3", $backenditem3, sub { my ($factory, $optFactory, $parent, $backendItem) = @_; my $vbox = $factory->createVBox($parent); ... } ); -$exttab->addItem("Label 4", $backenditem4, sub { my ($factory, $optFactory, $parent, $backendItem) = @_; my $vbox = $factory->createVBox($parent); ... } ); -$exttab->finishedItems(); - -... - -while { - ... - $exttab->processEvents(); - ... -} - - -=head1 DESCRIPTION - -This class wraps YDumbTab with backend items to handle - - -=head1 SUPPORT - -You can find documentation for this module with the perldoc command: - -perldoc ManaTools::Shared::ExtTab - -=head1 SEE ALSO - -yui::YDumbTab - -=head1 AUTHOR - -Maarten Vanraes <alien@rmail.be> - -=head1 COPYRIGHT and LICENSE - -Copyright (C) 2015, 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 diagnostics; -use utf8; - -use yui; - -#============================================================= - -=head2 new - -=head3 INPUT - - hash ref containing - optfactory: optfactory needed to create a YDumbTab - callback: optional parameter to execute a callback - - -=head3 DESCRIPTION - - new is inherited from Moose, to create a ExtTab object - -=cut - -#============================================================= - -has 'factory' => ( - is => 'ro', - isa => 'yui::YWidgetFactory', - required => 1, -); - -has 'optFactory' => ( - is => 'ro', - isa => 'yui::YOptionalWidgetFactory', - required => 1, -); - -has 'parentWidget' => ( - is => 'ro', - isa => 'yui::YWidget', - required => 1, -); - -has 'callback' => ( - is => 'ro', - isa => 'Maybe[CodeRef]', - lazy => 1, - default => sub { - return undef; - } -); - -has 'items' => ( - is => 'ro', - isa => 'ArrayRef[ManaTools::Shared::ExtTab::Item]', - lazy => 1, - init_arg => undef, - default => sub { - return []; - } -); - -has 'container' => ( - is => 'rw', - isa => 'Maybe[yui::YReplacePoint]', - init_arg => undef, - default => sub { - return undef; - } -); - -has 'tab' => ( - is => 'ro', - isa => 'yui::YDumbTab', - init_arg => undef, - lazy => 1, - builder => 'buildTab', -); - -has 'lastItem' => ( - is => 'rw', - isa => 'Maybe[ManaTools::Shared::ExtTab::Item]', - init_arg => undef, - default => sub { - return undef; - } -); - -has 'itemcollection' => ( - is => 'ro', - isa => 'yui::YItemCollection', - init_arg => undef, - default => sub { - return new yui::YItemCollection(); - } -); - -#============================================================= - -=head2 buildTab - -=head3 INPUT - - $self: this object - -=head3 DESCRIPTION - - builds the YDumbTab widget - -=cut - -#============================================================= -sub buildTab { - my $self = shift; - my $tab = $self->optFactory->createDumbTab($self->parentWidget); - $self->{container} = $self->factory->createReplacePoint($tab); - return $tab; -} - -#============================================================= - -=head2 processEvents - -=head3 INPUT - - $self: this object - $event: yui::YEvent from $dlg->waitForEvent(); - -=head3 DESCRIPTION - - handles the YDumbTab events and executes callback if necessary - -=cut - -#============================================================= -sub processEvents { - my $self = shift; - my $event = shift; - my $items = $self->items(); - return if ($event->eventType() != $yui::YEvent::MenuEvent); - my $yitem = $event->item(); - my $item = $self->findItem($yitem); - return if !defined($item); - $self->buildItem($item); - $self->callback()->($item->backend()); - $self->lastItem($item); -} - -#============================================================= - -=head2 addItem - -=head3 INPUT - - $self: this object - $label: a label for the YItem - $backendItem: a backendItem needed to identify and/or handle the event - $buildWidget: a CodeRef to rebuild the widget when required - -=head3 OUTPUT - - the created ManaTools::Shared::ExtTab::Item - -=head3 DESCRIPTION - - Creates an item and adds it to the ExtTab. Internally, it creates a - yui::YItem and adds it to the YItemCollection. If it's the first item, - mark it as the lastitem. - -=cut - -#============================================================= -sub addItem { - my $self = shift; - my $label = shift; - my $backendItem = shift; - my $buildWidget = shift; - my $items = $self->items(); - my $item = ManaTools::Shared::ExtTab::Item->new(backend => $backendItem, builder => $buildWidget); - push @{$items}, $item; - $item->setLabel($label); - $item->addToCollection($self->itemcollection()); - if (scalar(@{$items}) == 1) { - $self->lastItem($item); - } - return $item; -} - -#============================================================= - -=head2 findItem - -=head3 INPUT - - $self: this object - $yitem: the YItem to be found - -=head3 DESCRIPTION - - returns a ManaTools::Shared::ExtTab::Item that has the YItem - -=cut - -#============================================================= -sub findItem { - my $self = shift; - my $yitem = shift; - # loop all the items - for my $i (@{$self->items()}) { - return $i if ($i->equals($yitem)); - } - return undef; -} - -#============================================================= - -=head2 buildItem - -=head3 INPUT - - $self: this object - $item: the item to be built (widgets from this tab will be recreated in the tab) - -=head3 DESCRIPTION - - builds an item on the internal replace point - -=cut - -#============================================================= -sub buildItem { - my $self = shift; - my $item = shift; - # clear out replacepoint - $self->container->deleteChildren(); - # build item's widgetbuilder - my $builder = $item->builder(); - $builder->($self->factory, $self->optFactory, $self->container, $item->backend()) if (defined $builder); - $self->container->showChild(); -} - -#============================================================= - -=head2 finishedItems - -=head3 INPUT - - $self: this object - -=head3 DESCRIPTION - - finalizes the items on the ExtTab - -=cut - -#============================================================= -sub finishedItems { - my $self = shift; - $self->tab->addItems($self->itemcollection); - my $item = $self->lastItem(); - $self->buildItem($item) if defined($item); -} - -#============================================================= - -no Moose; -__PACKAGE__->meta->make_immutable; - - -1; - -#============================================================= - -package ManaTools::Shared::ExtTab::Item; - -use Moose; -use diagnostics; -use utf8; - -use yui; - -has 'builder' => ( - is => 'ro', - isa => 'Maybe[CodeRef]', - lazy => 1, - default => sub { - return undef; - } -); - -has 'item' => ( - is => 'ro', - isa => 'yui::YItem', - init_arg => undef, - default => sub { - return new yui::YItem('', 0); - } -); - -has 'backend' => ( - is => 'rw', - isa => 'Maybe[Ref]', - lazy => 1, - default => sub { - return undef; - } -); - -#============================================================= - -sub setLabel { - my $self = shift; - my $label = shift; - my $yitem = $self->item(); - $yitem->setLabel($label); -} - -sub equals { - my $self = shift; - my $item = shift; - return ($self->item() == $item); -} - -sub addToCollection { - my $self = shift; - my $collection = shift; - my $yitem = $self->item(); - $yitem->DISOWN(); - $collection->push($yitem); -} - -#============================================================= - -no Moose; -__PACKAGE__->meta->make_immutable; - -1; |