.\" 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 "Padre::Wx::Role::Conduit 3pm"
.TH Padre::Wx::Role::Conduit 3pm "2014-09-11" "perl v5.20.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"
Padre::Wx::Role::Conduit \- Role to allow an object to receive Wx events
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package My::MainFrame;
\&  
\&  use strict;
\&  use Padre::Wx                ();
\&  use Padre::Wx::Role::Conduit ();
\&  use My::ChildHandler         ();
\&  
\&  our @ISA = qw{
\&      Padre::Wx::Role::Conduit
\&      Wx::Frame
\&  };
\&  
\&  sub new {
\&      my $class = shift;
\&      my $self  = $class\->SUPER::new(@_);
\&  
\&      # Register to receive events    
\&      $self\->conduit_init( My::ChildHander\->singleton );
\&  
\&      return $self;
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This role provides the functionality needed to receive Wx::PlThreadEvent
objects from child threads.
.PP
You should only use this role once and once only in the parent process,
and then allow that single event conduit to pass the events on to the other
parts of your program, or to some dispatcher object that will do so.
.PP
It is implemented as a role so that the functionality can be used across the
main process and various testing classes (and will be easier to turn into a
\&\s-1CPAN\s0 spinoff later).
.SH "PARENT METHODS"
.IX Header "PARENT METHODS"
.SS "conduit_init"
.IX Subsection "conduit_init"
.Vb 1
\&  $window\->conduit_init($handler);
.Ve
.PP
The \f(CW\*(C`conduit_init\*(C'\fR method is called on the parent receiving object once it
has been created.
.PP
It takes the handler that deserialised messages should be passed to once
they have been extracted from the incoming Wx::PlThreadEvent and
deserialised into a message structure.
.SS "handler"
.IX Subsection "handler"
.Vb 1
\&  $window\->handler($handler);
.Ve
.PP
The \f(CW\*(C`handler\*(C'\fR accessor is a convenience method that allows you to change
the message handler after the conduit has been initialised.
.SS "on_signal"
.IX Subsection "on_signal"
.Vb 1
\&  $window\->on_signal( $pl_thread_event );
.Ve
.PP
The \f(CW\*(C`on_signal\*(C'\fR method is called by the Wx system on the parent object
when a Wx::PlThreadEvent arrives from a child thread.
.PP
The default implementation will extra the packaged data for the event,
deserialise it, and then pass off the \f(CW\*(C`on_signal\*(C'\fR method of the handler.
.PP
You might overload this method if you need to something exotic with the
event handling, but this is highly unlikely and this documentation is
provided only for completeness.
.SS "signal"
.IX Subsection "signal"
.Vb 3
\&  Padre::Wx::Role::Conduit\->signal(
\&      Storable::freeze( [ \*(AqMy message\*(Aq ] )
\&  );
.Ve
.PP
The static \f(CW\*(C`signal\*(C'\fR method is called in child threads to send a message
to the parent window. The message can be any legal Perl structure that has
been serialised by the Storable module.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2013 The Padre development team as listed in Padre.pm.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl 5 itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.