Tickit-Widget-FloatBox-0.03000755001750001750 012511244764 14347 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/LICENSE000444001750001750 4376212511244764 15545 0ustar00leoleo000000000000This software is copyright (c) 2015 by Paul Evans . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2015 by Paul Evans . This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Artistic License 1.0 --- This software is Copyright (c) 2015 by Paul Evans . This is free software, licensed under: The Artistic License 1.0 The Artistic License Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: - "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. - "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder. - "Copyright Holder" is whoever is named in the copyright or copyrights for the package. - "You" is you, if you're thinking about copying or distributing this Package. - "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) - "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as ftp.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Tickit-Widget-FloatBox-0.03/Build.PL000444001750001750 102312511244764 15774 0ustar00leoleo000000000000use strict; use warnings; use Module::Build; my $build = Module::Build->new( module_name => 'Tickit::Widget::FloatBox', requires => { 'Tickit::ContainerWidget' => 0, }, build_requires => { 'Test::Identity' => 0, 'Test::More' => '0.88', # done_testing 'Tickit::Test' => 0, }, auto_configure_requires => 0, # Don't add M::B to configure_requires license => 'perl', create_makefile_pl => 'traditional', create_license => 1, create_readme => 1, ); $build->create_build_script; Tickit-Widget-FloatBox-0.03/MANIFEST000444001750001750 31512511244764 15614 0ustar00leoleo000000000000Build.PL Changes examples/demo.pl lib/Tickit/Widget/FloatBox.pm LICENSE Makefile.PL MANIFEST This list of files META.json META.yml README t/00use.t t/01base-child.t t/02float.t t/03hide-show.t t/99pod.t Tickit-Widget-FloatBox-0.03/META.json000444001750001750 173112511244764 16127 0ustar00leoleo000000000000{ "abstract" : "manage a collection of floating widgets", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.421", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Tickit-Widget-FloatBox", "prereqs" : { "build" : { "requires" : { "Test::Identity" : "0", "Test::More" : "0.88", "Tickit::Test" : "0" } }, "runtime" : { "requires" : { "Tickit::ContainerWidget" : "0" } } }, "provides" : { "Tickit::Widget::FloatBox" : { "file" : "lib/Tickit/Widget/FloatBox.pm", "version" : "0.03" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.03" } Tickit-Widget-FloatBox-0.03/Changes000444001750001750 102412511244764 15774 0ustar00leoleo000000000000Revision history for Tickit-Widget-FloatBox 0.03 2015/04/08 16:30:39 [CHANGES] * Added $float->is_visible * Set WIDGET_PEN_FROM_STYLE to quiet Tickit 0.51 deprecation warning 0.02 2014/08/05 19:57:59 [CHANGES] * Allow floats to be made hidden [BUGFIXES] * Use the ContainerWidget ->add/->remove API properly, ensuring the ->parent is properly set on child widgets 0.01 2014/08/04 23:57:31 First version, released on an unsuspecting world. Tickit-Widget-FloatBox-0.03/Makefile.PL000444001750001750 76012511244764 16441 0ustar00leoleo000000000000# Note: this file was auto-generated by Module::Build::Compat version 0.4210 use ExtUtils::MakeMaker; WriteMakefile ( 'NAME' => 'Tickit::Widget::FloatBox', 'VERSION_FROM' => 'lib/Tickit/Widget/FloatBox.pm', 'PREREQ_PM' => { 'Test::Identity' => 0, 'Test::More' => '0.88', 'Tickit::ContainerWidget' => 0, 'Tickit::Test' => 0 }, 'INSTALLDIRS' => 'site', 'EXE_FILES' => [], 'PL_FILES' => {} ) ; Tickit-Widget-FloatBox-0.03/README000444001750001750 605712511244764 15374 0ustar00leoleo000000000000NAME `Tickit::Widget::FloatBox' - manage a collection of floating widgets SYNOPSIS TODO DESCRIPTION This container widget maintains a collection of floating widgets that can be displayed over the top of a single base widget. The box itself is entirely occupied by the base widget, and by default when no floats are created or displayed it will behave essentially invisibly, as though the box were not there and the base widget was an immediate child of the container the floatbox is inside. CONSTRUCTOR $floatbox = Tickit::Widget::FloatBox->new( %args ) Constructs a new `Tickit::Widget::FloatBox' object. Takes the following named arguments in addition to those taken by the base Tickit::ContainerWidget constructor. base_child => Tickit::Widget The main Tickit::Widget instance to use as the base. ACCESSORS $base_child = $floatbox->base_child $floatbox->set_base_child( $base_child ) Returns or sets the base widget to use. $float = $floatbox->add_float( %args ) Adds a widget as a floating child and returns a new `Float' object. Takes the following arguments: child => Tickit::Widget The child widget top, bottom, left, right => INT The initial geometry of the floating area. These follow the same behaviour as the `move' method on the Float object. hidden => BOOL Optional. If true, the float starts off hidden initally, and must be shown by the `show' method before it becomes visible. FLOATS The following objects represent a floating region as returned by the `add_float' method. $child = $float->child Returns the child widget in the region. $float->move( %args ) Redefines the area geometry of the region. Takes arguments named `top', `bottom', `left' and `right', each of which should either be a numeric value, or `undef'. The region must have at least one of `top' or `bottom' and at least one of `left' or `right' defined, which will then fix the position of one corner of the region. If the size is not otherwise determined by the geometry, it will use the preferred size of the child widget. Any geometry argument may be negative to count backwards from the limits of the parent. For example, # top-left corner $float->move( top => 0, left => 0 ) # top-right corner $float->move( top => 0, right => -1 ) # bottom 3 lines, flush left $float->move( left => 0, top => -3, bottom => -1 ) Any arguments not passed will be left unchanged; to specifically clear the current value pass a value of `undef'. $float->remove Removes the float from the FloatBox. $float->hide Hide the float by hiding the window of its child widget. $float->show Show the float by showing the window of its child widget. Undoes the effect of `hide'. $visible = $float->is_visible Return true if the float is currently visible. TODO * Support adjusting stacking order of floats. AUTHOR Paul Evans Tickit-Widget-FloatBox-0.03/META.yml000444001750001750 116412511244764 15757 0ustar00leoleo000000000000--- abstract: 'manage a collection of floating widgets' author: - 'Paul Evans ' build_requires: Test::Identity: '0' Test::More: '0.88' Tickit::Test: '0' dynamic_config: 1 generated_by: 'Module::Build version 0.421, CPAN::Meta::Converter version 2.142690' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Tickit-Widget-FloatBox provides: Tickit::Widget::FloatBox: file: lib/Tickit/Widget/FloatBox.pm version: '0.03' requires: Tickit::ContainerWidget: '0' resources: license: http://dev.perl.org/licenses/ version: '0.03' Tickit-Widget-FloatBox-0.03/examples000755001750001750 012511244764 16165 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/examples/demo.pl000555001750001750 143212511244764 17606 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Tickit; use Tickit::Widgets qw( Placegrid Box FloatBox ); my $tickit = Tickit->new( root => my $fb = Tickit::Widget::FloatBox->new( base_child => Tickit::Widget::Placegrid->new, ) ); my $float = $fb->add_float( child => Tickit::Widget::Box->new( child => Tickit::Widget::Placegrid->new( grid_fg => "red" ), child_lines => 5, child_cols => 20, ), top => 1, left => 1, ); $tickit->bind_key( Up => sub { $float->move( top => 1, bottom => undef ) } ); $tickit->bind_key( Down => sub { $float->move( top => undef, bottom => -2 ) } ); $tickit->bind_key( Left => sub { $float->move( left => 1, right => undef ) } ); $tickit->bind_key( Right => sub { $float->move( left => undef, right => -2 ) } ); $tickit->run; Tickit-Widget-FloatBox-0.03/lib000755001750001750 012511244764 15115 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/lib/Tickit000755001750001750 012511244764 16344 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/lib/Tickit/Widget000755001750001750 012511244764 17567 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/lib/Tickit/Widget/FloatBox.pm000444001750001750 2012412511244764 22017 0ustar00leoleo000000000000# You may distribute under the terms of either the GNU General Public License # or the Artistic License (the same terms as Perl itself) # # (C) Paul Evans, 2014-2015 -- leonerd@leonerd.org.uk package Tickit::Widget::FloatBox; use strict; use warnings; use base qw( Tickit::ContainerWidget ); our $VERSION = '0.03'; use Carp; # We don't actually have a pen, but then we don't actually have any style # either. This keeps deprecation warnings happy use constant WIDGET_PEN_FROM_STYLE => 1; =head1 NAME C - manage a collection of floating widgets =head1 SYNOPSIS TODO =head1 DESCRIPTION This container widget maintains a collection of floating widgets that can be displayed over the top of a single base widget. The box itself is entirely occupied by the base widget, and by default when no floats are created or displayed it will behave essentially invisibly, as though the box were not there and the base widget was an immediate child of the container the floatbox is inside. =cut =head1 CONSTRUCTOR =cut =head2 $floatbox = Tickit::Widget::FloatBox->new( %args ) Constructs a new C object. Takes the following named arguments in addition to those taken by the base L constructor. =over 8 =item base_child => Tickit::Widget The main L instance to use as the base. =back =cut sub new { my $class = shift; my %args = @_; my $self = $class->SUPER::new( %args ); $self->set_base_child( $args{base_child} ) if $args{base_child}; $self->{floats} = []; return $self; } =head1 ACCESSORS =cut sub children { my $self = shift; my @children; push @children, $self->base_child if $self->base_child; push @children, $_->child for @{ $self->{floats} }; return @children; } sub lines { my $self = shift; return $self->base_child ? $self->base_child->requested_lines : 1; } sub cols { my $self = shift; return $self->base_child ? $self->base_child->requested_cols : 1; } =head2 $base_child = $floatbox->base_child =head2 $floatbox->set_base_child( $base_child ) Returns or sets the base widget to use. =cut sub base_child { my $self = shift; return $self->{base_child}; } sub set_base_child { my $self = shift; my ( $new ) = @_; if( my $old = $self->{base_child} ) { $self->remove( $old ); } $self->{base_child} = $new; $self->add( $new ); if( my $win = $self->window ) { $new->set_window( $win->make_sub( 0, 0, $win->lines, $win->cols ) ); } } sub reshape { my $self = shift; return unless my $win = $self->window; if( my $child = $self->base_child ) { if( $child->window ) { $child->window->resize( $win->lines, $win->cols ); } else { $child->set_window( $win->make_sub( 0, 0, $win->lines, $win->cols ) ); } } $self->_reshape_float( $_, $win ) for @{ $self->{floats} }; $self->redraw; } sub _reshape_float { my $self = shift; my ( $float, $win ) = @_; my $child = $float->child; my @geom = $float->_get_geom( $win->lines, $win->cols ); if( my $childwin = $child->window ) { $childwin->expose; $childwin->change_geometry( @geom ); $childwin->expose; } else { # TODO: Ordering? # TODO: I want a ->make_hidden_float $child->set_window( $win->make_float( @geom ) ); $child->window->hide if $float->{hidden}; } } sub render_to_rb { my $self = shift; my ( $rb, $rect ) = @_; return if $self->base_child; $rb->eraserect( $rect ); } =head2 $float = $floatbox->add_float( %args ) Adds a widget as a floating child and returns a new C object. Takes the following arguments: =over 8 =item child => Tickit::Widget The child widget =item top, bottom, left, right => INT The initial geometry of the floating area. These follow the same behaviour as the C method on the Float object. =item hidden => BOOL Optional. If true, the float starts off hidden initally, and must be shown by the C method before it becomes visible. =back =cut sub add_float { my $self = shift; my %args = @_; my $float = Tickit::Widget::FloatBox::Float->new( $self, delete $args{child}, %args ); push @{ $self->{floats} }, $float; $self->add( $float->child ); if( my $win = $self->window ) { $self->_reshape_float( $float, $win ); } return $float; } sub _remove_float { my $self = shift; my ( $float ) = @_; my $idx; $self->{floats}[$_] == $float and $idx = $_, last for 0 .. $#{ $self->{floats} }; defined $idx or croak "Cannot remove float - not a member of the FloatBox"; splice @{ $self->{floats} }, $idx, 1, (); $self->remove( $float->child ); } =head1 FLOATS The following objects represent a floating region as returned by the C method. =cut package # hide Tickit::Widget::FloatBox::Float; use Carp; sub new { my $class = shift; my ( $fb, $child, %args ) = @_; my $self = bless { fb => $fb, child => $child, hidden => delete $args{hidden} || 0, }, $class; $self->move( %args ); return $self; } =head2 $child = $float->child Returns the child widget in the region. =cut sub child { shift->{child} } =head2 $float->move( %args ) Redefines the area geometry of the region. Takes arguments named C, C, C and C, each of which should either be a numeric value, or C. The region must have at least one of C or C and at least one of C or C defined, which will then fix the position of one corner of the region. If the size is not otherwise determined by the geometry, it will use the preferred size of the child widget. Any geometry argument may be negative to count backwards from the limits of the parent. For example, # top-left corner $float->move( top => 0, left => 0 ) # top-right corner $float->move( top => 0, right => -1 ) # bottom 3 lines, flush left $float->move( left => 0, top => -3, bottom => -1 ) Any arguments not passed will be left unchanged; to specifically clear the current value pass a value of C. =cut sub move { my $self = shift; my %args = @_; exists $args{$_} and $self->{$_} = $args{$_} for qw( top bottom left right ); defined $self->{top} or defined $self->{bottom} or croak "A Float needs at least one of 'top' or 'bottom'"; defined $self->{left} or defined $self->{right} or croak "A Float needs at least one of 'left' or 'right'"; if( my $win = $self->{fb}->window ) { $self->{fb}->_reshape_float( $self, $win ); } } sub _get_geom { my $self = shift; my ( $lines, $cols ) = @_; my $clines = $self->child->requested_lines; my $ccols = $self->child->requested_cols; my ( $top, $bottom ) = _alloc_dimension( $self->{top}, $self->{bottom}, $lines, $clines ); my ( $left, $right ) = _alloc_dimension( $self->{left}, $self->{right}, $cols, $ccols ); return ( $top, $left, $bottom-$top, $right-$left ); } sub _alloc_dimension { my ( $start, $end, $parentsz, $childsz ) = @_; # Need to off-by-one to allow -1 == right, etc.. defined and $_ < 0 and $_ += $parentsz+1 for $start, $end; $end = $start + $childsz if !defined $end; $start = $end - $childsz if !defined $start; return ( $start, $end ); } =head2 $float->remove Removes the float from the FloatBox. =cut sub remove { my $self = shift; $self->{fb}->_remove_float( $self ); } =head2 $float->hide Hide the float by hiding the window of its child widget. =cut sub hide { my $self = shift; $self->{hidden} = 1; $self->child->window->hide if $self->child->window; } =head2 $float->show Show the float by showing the window of its child widget. Undoes the effect of C. =cut sub show { my $self = shift; $self->{hidden} = 0; $self->child->window->show if $self->child->window; } =head2 $visible = $float->is_visible Return true if the float is currently visible. =cut sub is_visible { my $self = shift; return !$self->{hidden}; } =head1 TODO =over 4 =item * Support adjusting stacking order of floats. =back =cut =head1 AUTHOR Paul Evans =cut 0x55AA Tickit-Widget-FloatBox-0.03/t000755001750001750 012511244764 14612 5ustar00leoleo000000000000Tickit-Widget-FloatBox-0.03/t/03hide-show.t000444001750001750 355112511244764 17172 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Test::Identity; use Tickit::Test; use Tickit::Widget::FloatBox; use Tickit::Widget::Static; my $win = mk_window; my $widget = Tickit::Widget::FloatBox->new( base_child => TestWidget->new, ); $widget->set_window( $win ); { my $float = $widget->add_float( child => Tickit::Widget::Static->new( text => "Hello, world!" ), top => 0, left => 0, ); flush_tickit; is_display( [ [TEXT("Hello, world!"), TEXT("C" x 67)], ( [TEXT("C" x 80)] ) x 24 ], 'Display with single float' ); ok ( $float->is_visible, '$float->is_visible true initially' ); $float->hide; flush_tickit; is_display( [ ( [TEXT("C" x 80)] ) x 25 ], 'Display after hiding float' ); ok ( !$float->is_visible, '$float->is_visible false after hiding float' ); $float->show; flush_tickit; is_display( [ [TEXT("Hello, world!"), TEXT("C" x 67)], ( [TEXT("C" x 80)] ) x 24 ], 'Display after showing float again' ); $float->remove; } # initially-hidden { my $float = $widget->add_float( child => Tickit::Widget::Static->new( text => "Hello, world!" ), top => 0, right => -1, hidden => 1, ); flush_tickit; is_display( [ ( [TEXT("C" x 80)] ) x 25 ], 'Display after creating initially-hidden float' ); $float->show; flush_tickit; is_display( [ [TEXT("C" x 67), TEXT("Hello, world!")], ( [TEXT("C" x 80)] ) x 24 ], 'Display after showing float again' ); $float->remove; } done_testing; package TestWidget; use base qw( Tickit::Widget ); use constant WIDGET_PEN_FROM_STYLE => 1; sub render_to_rb { my $self = shift; my ( $rb, $rect ) = @_; foreach my $line ( $rect->linerange ) { $rb->text_at( $line, $rect->left, "C" x $rb->cols ); } } sub lines { 1 } sub cols { 1 } Tickit-Widget-FloatBox-0.03/t/00use.t000444001750001750 16212511244764 16047 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use_ok( 'Tickit::Widget::FloatBox' ); done_testing; Tickit-Widget-FloatBox-0.03/t/01base-child.t000444001750001750 244312511244764 17273 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Test::Identity; use Tickit::Test; use Tickit::Widget::FloatBox; my $win = mk_window; my ( $child_lines, $child_cols ); my $child_render_rect; my $widget = Tickit::Widget::FloatBox->new( base_child => TestWidget->new, ); ok( defined $widget, 'defined $widget' ); is( scalar $widget->children, 1, 'scalar $widget->children' ); identical( ( $widget->children )[0], $widget->base_child, '$widget->children[0]' ); identical( ( $widget->children )[0]->parent, $widget, '$widget->children[0]->parent' ); $child_lines = 3; $child_cols = 10; is( $widget->lines, 3, '$widget->lines with no bounds' ); is( $widget->cols, 10, '$widget->cols with no bounds' ); $widget->set_window( $win ); flush_tickit; is( $child_render_rect, Tickit::Rect->new( top => 0, left => 0, lines => 25, cols => 80 ), 'child render rect' ); resize_term( 30, 100 ); flush_tickit; is( $child_render_rect, Tickit::Rect->new( top => 0, left => 0, lines => 30, cols => 100 ), 'child render rect after term resize' ); done_testing; package TestWidget; use base qw( Tickit::Widget ); use constant WIDGET_PEN_FROM_STYLE => 1; sub render_to_rb { my $self = shift; $child_render_rect = $self->window->rect; } sub lines { $child_lines } sub cols { $child_cols } Tickit-Widget-FloatBox-0.03/t/02float.t000444001750001750 350512511244764 16406 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; use Test::Identity; use Tickit::Test; use Tickit::Widget::FloatBox; use Tickit::Widget::Static; my $win = mk_window; my ( $child_lines, $child_cols ); my $widget = Tickit::Widget::FloatBox->new( base_child => TestWidget->new, ); $widget->set_window( $win ); flush_tickit; is_display( [ ( [TEXT("C" x 80)] ) x 25 ], 'Display initially' ); my $float; $float = $widget->add_float( child => Tickit::Widget::Static->new( text => "Hello, world!" ), top => 0, left => 0, ); flush_tickit; ok( defined $float, '$float defined' ); identical( $float->child->parent, $widget, '$float->child->parent' ); is_display( [ [TEXT("Hello, world!"), TEXT("C" x 67)], ( [TEXT("C" x 80)] ) x 24 ], 'Display with single float in top-left' ); $float->move( left => undef, right => -1 ); flush_tickit; is_display( [ [TEXT("C" x 67), TEXT("Hello, world!")], ( [TEXT("C" x 80)] ) x 24 ], 'Display after moving float to top-right' ); $float->move( top => undef, bottom => -1, left => 0, right => -1 ); flush_tickit; is_display( [ ( [TEXT("C" x 80)] ) x 24, [TEXT("Hello, world!")] ], 'Display after moving float to bottom fullwidth' ); resize_term( 15, 45 ); flush_tickit; is_display( [ ( [TEXT("C" x 45)] ) x 14, [TEXT("Hello, world!")] ], 'Display after resizing terminal' ); $float->remove; flush_tickit; is_display( [ ( [TEXT("C" x 45)] ) x 15 ], 'Display after $float->remove' ); done_testing; package TestWidget; use base qw( Tickit::Widget ); use constant WIDGET_PEN_FROM_STYLE => 1; sub render_to_rb { my $self = shift; my ( $rb, $rect ) = @_; foreach my $line ( $rect->linerange ) { $rb->text_at( $line, $rect->left, "C" x $rb->cols ); } } sub lines { $child_lines } sub cols { $child_cols } Tickit-Widget-FloatBox-0.03/t/99pod.t000444001750001750 25712511244764 16064 0ustar00leoleo000000000000#!/usr/bin/perl use strict; use warnings; use Test::More; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok();