.\" 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::CheckButton 3pm" .TH Tickit::Widget::CheckButton 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::CheckButton" \- a widget allowing a toggle true/false option .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Tickit; \& use Tickit::Widget::CheckButton; \& use Tickit::Widget::VBox; \& \& my $vbox = Tickit::Widget::VBox\->new; \& $vbox\->add( Tickit::Widget::CheckButton\->new( \& label => "Check button $_", \& ) ) for 1 .. 5; \& \& Tickit\->new( root => $vbox )\->run; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class provides a widget which allows a true/false selection. It displays a clickable indication of status and a caption. Clicking on the status or caption inverts the status of the widget. .PP This widget is part of an experiment in evolving the design of the Tickit::Style widget integration code, and such is subject to change of details. .SH "STYLE" .IX Header "STYLE" The default style pen is used as the widget pen. The following style pen prefixes are also used: .IP "check => \s-1PEN\s0" 4 .IX Item "check => PEN" The pen used to render the check marker .PP The following style keys are used: .IP "check => \s-1STRING\s0" 4 .IX Item "check => STRING" The text used to indicate the active status .IP "spacing => \s-1INT\s0" 4 .IX Item "spacing => INT" Number of columns of spacing between the check mark and the caption text .PP The following style tags are used: .IP ":active" 4 .IX Item ":active" Set when this button's status is true .PP The following style actions are used: .IP "toggle" 4 .IX Item "toggle" 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 \& $checkbutton = Tickit::Widget::CheckButton\->new( %args ) .Ve .PP Constructs a new \f(CW\*(C`Tickit::Widget::CheckButton\*(C'\fR object. .PP Takes the following named argmuents .IP "label => \s-1STRING\s0" 8 .IX Item "label => STRING" The label text to display alongside this button. .IP "on_toggle => \s-1CODE\s0" 8 .IX Item "on_toggle => CODE" Optional. Callback function to invoke when the check state is changed. .SH "ACCESSORS" .IX Header "ACCESSORS" .SS "label" .IX Subsection "label" .SS "set_label" .IX Subsection "set_label" .Vb 1 \& $label = $checkbutton\->label \& \& $checkbutton\->set_label( $label ) .Ve .PP Returns or sets the label text of the button. .SS "on_toggle" .IX Subsection "on_toggle" .Vb 1 \& $on_toggle = $checkbutton\->on_toggle .Ve .SS "set_on_toggle" .IX Subsection "set_on_toggle" .Vb 1 \& $checkbutton\->set_on_toggle( $on_toggle ) .Ve .PP Return or set the \s-1CODE\s0 reference to be called when the button state is changed. .PP .Vb 1 \& $on_toggle\->( $checkbutton, $active ) .Ve .SH "METHODS" .IX Header "METHODS" .SS "activate" .IX Subsection "activate" .Vb 1 \& $checkbutton\->activate .Ve .PP Sets this button's active state to true. .SS "deactivate" .IX Subsection "deactivate" .Vb 1 \& $checkbutton\->deactivate .Ve .PP Sets this button's active state to false. .SS "is_active" .IX Subsection "is_active" .Vb 1 \& $active = $checkbutton\->is_active .Ve .PP Returns this button's active state. .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans