.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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::Context 3pm"
.TH Padre::Wx::Role::Context 3pm "2012-06-27" "perl v5.14.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"
Padre::Wx::Role::Context \- Role for Wx objects that implement context menus
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "METHODS"
.IX Header "METHODS"
.SS "context_bind"
.IX Subsection "context_bind"
.Vb 3
\&    sub new {
\&        my $class = shift;
\&        my $self  = $class\->SUPER::new(@_);
\&    
\&        $self\->context_bind(\*(Aqmy_menu\*(Aq);
\&    
\&        return $self;
\&    }
\&    
\&    sub my_menu {
\&        # Fill the menu here
\&    }
.Ve
.PP
The \f(CW\*(C`context_bind\*(C'\fR method binds an context menu event to default
menu creation and popup logic, and specifies the method that should be
called to fill the context menu with the menu entries.
.PP
It takes a single optional parameter of the method to be called to fill
the menu.
.PP
If no method is provided then the method \f(CW\*(C`context_menu\*(C'\fR will be bound
to the context menu event by default.
.SS "context_popup"
.IX Subsection "context_popup"
.Vb 1
\&    $self\->context_popup(\*(Aqcontext_menu\*(Aq);
.Ve
.PP
The \f(CW\*(C`context_popup\*(C'\fR menu triggers the immediate display of the popup
menu for the object. It takes a compulsory single parameter, which should
be the method to be used to fill the menu with entries.
.SS "context_menu"
.IX Subsection "context_menu"
The \f(CW\*(C`context_menu\*(C'\fR method is the default method called to fill a context
menu with menu entries.
.PP
It should be overloaded in any class that uses the context menu role.
.PP
A minimalist default implementation is provided which will show a single
meny entry to launch the \f(CW\*(C`About Padre\*(C'\fR dialog.
.SS "context_append_function"
.IX Subsection "context_append_function"
.Vb 7
\&    $self\->context_append_function(
\&        $menu,
\&        Wx::gettext(\*(AqDo Something\*(Aq),
\&        sub {
\&            # Do something
\&        },
\&    );
.Ve
.PP
The \f(CW\*(C`context_append_function\*(C'\fR method adds a menu entry bound to an
arbitrary function call.
.PP
The function will be passed the parent object (\f(CW$self\fR in the above
example) and the event object.
.SS "context_append_method"
.IX Subsection "context_append_method"
.Vb 5
\&    $self\->context_append_method
\&        $menu,
\&        Wx::gettext(\*(AqDo Something\*(Aq),
\&        \*(Aqmy_method\*(Aq,
\&    );
.Ve
.PP
The \f(CW\*(C`context_append_method\*(C'\fR method adds a mene entry bound to a named
method on the object.
.PP
The method will be passed the event object.
.SS "context_append_action"
.IX Subsection "context_append_action"
.Vb 4
\&    $self\->context_append_action(
\&        $menu,
\&        \*(Aqhelp.about\*(Aq,
\&    );
.Ve
.PP
The \f(CW\*(C`context_append_action\*(C'\fR method adds a menu entry bound to execute a
named action from Padre::Wx::ActionLibrary.
.PP
The menu entry created as a result of this call is functionally identical
to a normal menu entry from the menu bar on the main window.
.SS "context_append_options"
.IX Subsection "context_append_options"
.Vb 4
\&    $self\->context_append_options(
\&        $menu,
\&        \*(Aqmain_functions_panel\*(Aq,
\&    );
.Ve
.PP
The \f(CW\*(C`context_append_options\*(C'\fR method adds a group of several radio menu
entries that allow changing a configuration preference immediately.
.PP
The current value of the configuration preference will be checked in the
radio group for information purposes.
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2008\-2012 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.