.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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 "Tickit::Widget::Button 3pm"
.TH Tickit::Widget::Button 3pm "2020-11-04" "perl v5.30.3" "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"
"Tickit::Widget::Button" \- a widget displaying a clickable button
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&   use Tickit;
\&   use Tickit::Widget::Button;
\&
\&   my $button = Tickit::Widget::Button\->new(
\&      label => "Click Me!",
\&      on_click => sub {
\&         my ( $self ) = @_;
\&
\&         # Do something!
\&      },
\&   );
\&
\&   Tickit\->new( root => $button )\->run;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides a widget which displays a clickable area with a label.
When the area is clicked, a callback is invoked.
.SH "STYLE"
.IX Header "STYLE"
The default style pen is used as the widget pen. The following style keys are
used:
.IP "linetype => \s-1STRING\s0" 4
.IX Item "linetype => STRING"
What kind of border to draw around the button; one of
.Sp
.Vb 1
\& none single double thick
.Ve
.IP "marker_left => \s-1STRING\s0" 4
.IX Item "marker_left => STRING"
A two-character string to place just before the button label
.IP "marker_right => \s-1STRING\s0" 4
.IX Item "marker_right => STRING"
A two-character string to place just after the button label
.PP
The following style tags are used:
.IP ":active" 4
.IX Item ":active"
Set when the mouse is being held over the button, before it is released
.PP
The following style actions are used:
.IP "click" 4
.IX Item "click"
The main action to activate the \f(CW\*(C`on_click\*(C'\fR handler.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
.Vb 1
\&   $button = Tickit::Widget::Button\->new( %args )
.Ve
.PP
Constructs a new \f(CW\*(C`Tickit::Widget::Button\*(C'\fR object.
.PP
Takes the following named arguments:
.IP "label => \s-1STR\s0" 8
.IX Item "label => STR"
Text to display in the button area
.IP "on_click => \s-1CODE\s0" 8
.IX Item "on_click => CODE"
Optional. Callback function to invoke when the button is clicked.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "label"
.IX Subsection "label"
.Vb 1
\&   $label = $button\->label
.Ve
.SS "set_label"
.IX Subsection "set_label"
.Vb 1
\&   $button\->set_label( $label )
.Ve
.PP
Return or set the text to display in the button area.
.SS "on_click"
.IX Subsection "on_click"
.Vb 1
\&   $on_click = $button\->on_click
.Ve
.SS "set_on_click"
.IX Subsection "set_on_click"
.Vb 1
\&   $button\->set_on_click( $on_click )
.Ve
.PP
Return or set the \s-1CODE\s0 reference to be called when the button area is clicked.
.PP
.Vb 1
\& $on_click\->( $button )
.Ve
.SS "click"
.IX Subsection "click"
.Vb 1
\&   $button\->click
.Ve
.PP
Behave as if the button has been clicked; running its \f(CW\*(C`on_click\*(C'\fR handler.
This is provided for convenience of activating its handler programmatically
via other parts of code.
.SS "align"
.IX Subsection "align"
.SS "set_align"
.IX Subsection "set_align"
.SS "valign"
.IX Subsection "valign"
.SS "set_valign"
.IX Subsection "set_valign"
.Vb 1
\&   $align = $button\->align
\&
\&   $button\->set_align( $align )
\&
\&   $valign = $button\->valign
\&
\&   $button\->set_valign( $valign )
.Ve
.PP
Accessors for the horizontal and vertical alignment of the label text within
the button area. See also Tickit::WidgetRole::Alignable.
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>