.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Tk::DoubleClick 3pm"
.TH Tk::DoubleClick 3pm "2015-12-06" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Tk::DoubleClick \- Correctly handle single\-click vs double\-click events,
.SH "VERSION"
.IX Header "VERSION"
Version 0.04
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Tk::Doubleclick;
\&
\&    bind_clicks(
\&        $widget,
\&        [ \e&single_callback, @args ],    # Single callback with args
\&        \e&double_callback,               # Double callback without args
\&        \-delay  => 500,
\&        \-button => \*(Aqright\*(Aq,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Tk::DoubleClick module correctly handle single-click vs double-click events,
calling only the appropriate callback for the given event.
.PP
This module always exports \f(CW\*(C`bind_clicks()\*(C'\fR.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "\fIbind_clicks()\fP"
.IX Subsection "bind_clicks()"
Required parameters:
.ie n .IP "$widget" 5
.el .IP "\f(CW$widget\fR" 5
.IX Item "$widget"
Widget to bind to mousebuttons.  Typically a Tk::Button object, but could
actually be almost any widget.
.ie n .IP "[ \e&single_click_callback, @single_click_args ]," 5
.el .IP "[ \e&single_click_callback, \f(CW@single_click_args\fR ]," 5
.IX Item "[ &single_click_callback, @single_click_args ],"
The callback subroutine to invoke when the event is a single-click, along
with the arguments to pass.  When no arguments are passed, the brackets
can be omitted.
.ie n .IP "[ \e&double_click_callback, @double_click_args ]," 5
.el .IP "[ \e&double_click_callback, \f(CW@double_click_args\fR ]," 5
.IX Item "[ &double_click_callback, @double_click_args ],"
The callback subroutine to invoke when the event is a double-click, along
with the arguments to pass.  When no arguments are passed, the brackets
can be omitted.
.PP
Options:
.IP "\-delay" 5
.IX Item "-delay"
Maximum delay time detween clicks in milliseconds. Default is 300.
If the second click of a two proximate mouse clicks occurs within the given
delay time, the event is considered a double-click.  If not, the two clicks
are considered two separate (albeit nearly simultaneous) single-clicks.
.IP "\-button" 5
.IX Item "-button"
Mouse button to bind. Options are 1, 2, 3, or the corresponding synonyms
\&'left', 'middle', or 'right'.  The default is 1 ('left').
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 5
\&    # Libraries
\&    use strict;
\&    use warnings;
\&    use Tk;
\&    use Tk::DoubleClick;
\&
\&    # User\-defined
\&    my $a_colors  = [
\&        [ \*(Aq#8800FF\*(Aq, \*(Aq#88FF88\*(Aq, \*(Aq#88FFFF\*(Aq ],
\&        [ \*(Aq#FF0000\*(Aq, \*(Aq#FF0088\*(Aq, \*(Aq#FF00FF\*(Aq ],
\&        [ \*(Aq#FF8800\*(Aq, \*(Aq#FF8888\*(Aq, \*(Aq#FF88FF\*(Aq ],
\&        [ \*(Aq#FFFF00\*(Aq, \*(Aq#FFFF88\*(Aq, \*(Aq#FFFFFF\*(Aq ],
\&    ];
\&
\&    # Main program
\&    my $nsingle = my $ndouble = 0;
\&    my $mw      = new MainWindow(\-title => "Double\-click example");
\&    my $f1      = $mw\->Frame\->pack(\-expand => 1, \-fill => \*(Aqboth\*(Aq);
\&    my @args    = qw( \-width 12 \-height 2 \-relief groove \-borderwidth 4 );
\&    my @pack    = qw( \-side left \-expand 1 \-fill both );
\&
\&    # Display single/double click counts
\&    my $lb1 = $f1\->Label(\-text    => "Single Clicks", @args);
\&    my $lb2 = $f1\->Label(\-textvar => \e$nsingle,       @args);
\&    my $lb3 = $f1\->Label(\-text    => "Double Clicks", @args);
\&    my $lb4 = $f1\->Label(\-textvar => \e$ndouble,       @args);
\&    $lb1\->pack($lb2, $lb3, $lb4, @pack);
\&
\&    # Create button for each color, and bind single/double clicks to it
\&    foreach my $a_color (@$a_colors) {
\&        my $fr = $mw\->Frame\->pack(\-expand => 1, \-fill => \*(Aqboth\*(Aq);
\&        foreach my $bg (@$a_color) {
\&            my $b = $fr\->Button(\-bg => $bg, \-text => $bg, @args);
\&            $b\->pack(@pack);
\&            bind_clicks($b, [\e&single, $lb2, $bg], [\e&double, $lb4, $bg]);
\&        }
\&    }
\&
\&    # Make \*(AqEscape\*(Aq quit the program
\&    $mw\->bind("<Escape>" => sub { exit });
\&
\&    MainLoop;
\&
\&
\&    # Callbacks
\&    sub single {
\&        my ($lbl, $color) = @_;
\&        $lbl\->configure(\-bg => $color);
\&        ++$nsingle;
\&    }
\&
\&    sub double {
\&        my ($lbl, $color) = @_;
\&        $lbl\->configure(\-bg => $color);
\&        ++$ndouble;
\&    }
.Ve
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Mark Freeman for numerous great suggestions and documentation help.
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Norton, \f(CW\*(C`<jchnorton at verizon.net>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-tk\-doubleclick at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Tk\-DoubleClick>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Tk::DoubleClick
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Tk\-DoubleClick>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Tk\-DoubleClick>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Tk\-DoubleClick>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Tk\-DoubleClick/>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to Mark Freeman for numerous great suggestions and documentation help.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009 John C. Norton.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.