.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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::Event 3pm" .TH Tickit::Event 3pm "2023-02-06" "perl v5.36.0" "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::Event" \- event information structures .SH "DESCRIPTION" .IX Header "DESCRIPTION" When event handlers bound to Tickit::Term or Tickit::Window instances are invoked they receive an object instance to contain information about the event. Details of the event can be accessed as via accessor methods on these instances. .SH "ACCESSORS" .IX Header "ACCESSORS" The following methods are shared between \f(CW\*(C`Tickit::Event::Key\*(C'\fR and \&\f(CW\*(C`Tickit::Event::Mouse\*(C'\fR instances. .SS "mod_is_alt" .IX Subsection "mod_is_alt" .SS "mod_is_ctrl" .IX Subsection "mod_is_ctrl" .SS "mod_is_shift" .IX Subsection "mod_is_shift" Convenient shortcuts to tests on the \f(CW\*(C`mod\*(C'\fR bitmask to test if each of the modifiers is set. .SH "Tickit::Event::Expose" .IX Header "Tickit::Event::Expose" .SS "rb" .IX Subsection "rb" The Tickit::RenderBuffer instance containing the buffer for this redraw cycle. .SS "rect" .IX Subsection "rect" A Tickit::Rect instance containing the region of the window that needs repainting. .SH "Tickit::Event::Focus" .IX Header "Tickit::Event::Focus" .SS "type" .IX Subsection "type" This accessor has two forms of operation. .PP The new behaviour is that it returns a dualvar giving the focus event type as an integer or a string event name (\f(CW\*(C`in\*(C'\fR or \f(CW\*(C`out\*(C'\fR). This behaviour is selected if the method is invoked with any true value as an argument. .PP The legacy behaviour is that it returns a simple boolean giving the focus direction; \f(CW1\fR for in, \f(CW0\fR for out. This legacy behaviour will be removed in a later version. .SS "win" .IX Subsection "win" The child Tickit::Window instance for child-focus notify events. .SH "Tickit::Event::Key" .IX Header "Tickit::Event::Key" .SS "type" .IX Subsection "type" A dualvar giving the key event type as an integer or string event name (\f(CW\*(C`text\*(C'\fR or \f(CW\*(C`key\*(C'\fR). .SS "str" .IX Subsection "str" A string containing the key event string. .SS "mod" .IX Subsection "mod" An integer bitmask indicating the modifier state. .SH "Tickit::Event::Mouse" .IX Header "Tickit::Event::Mouse" .SS "type" .IX Subsection "type" A dualvar giving the mouse event type as an integer or string event name (\f(CW\*(C`press\*(C'\fR, \f(CW\*(C`drag\*(C'\fR, \f(CW\*(C`release\*(C'\fR or \f(CW\*(C`wheel\*(C'\fR). .SS "button" .IX Subsection "button" An integer for non-wheel events or a dualvar for wheel events giving the wheel direction (\f(CW\*(C`up\*(C'\fR or \f(CW\*(C`down\*(C'\fR). .SS "line" .IX Subsection "line" .SS "col" .IX Subsection "col" Integers giving the mouse position. .SS "mod" .IX Subsection "mod" An integer bitmask indicating the modifier state. .SH "Tickit::Event::Resize" .IX Header "Tickit::Event::Resize" .SS "lines" .IX Subsection "lines" .SS "cols" .IX Subsection "cols" Integers giving the new size. .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans