.\" 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::PluginManager 3pm"
.TH Padre::PluginManager 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::PluginManager \- Padre plug\-in manager
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`PluginManager\*(C'\fR class contains logic for locating and loading Padre
plug-ins, as well as providing part of the interface to plug-in writers.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
The constructor returns a new \f(CW\*(C`Padre::PluginManager\*(C'\fR object, but
you should normally access it via the main Padre object:
.PP
.Vb 1
\&  my $manager = Padre\->ide\->plugin_manager;
.Ve
.PP
First argument should be a Padre object.
.ie n .SS """parent"""
.el .SS "\f(CWparent\fP"
.IX Subsection "parent"
Stores a reference back to the parent \s-1IDE\s0 object.
.ie n .SS """plugin_dir"""
.el .SS "\f(CWplugin_dir\fP"
.IX Subsection "plugin_dir"
Returns the user plug-in directory (below the Padre configuration directory).
This directory was added to the \f(CW@INC\fR module search path.
.ie n .SS """plugins"""
.el .SS "\f(CWplugins\fP"
.IX Subsection "plugins"
Returns a hash (reference) of plug-in names associated with a
Padre::PluginHandle.
.PP
This hash is only populated after \f(CW\*(C`load_plugins()\*(C'\fR was called.
.SS "current"
.IX Subsection "current"
Gets a Padre::Current context for the plugin manager.
.ie n .SS """main"""
.el .SS "\f(CWmain\fP"
.IX Subsection "main"
A convenience method to get to the main window.
.ie n .SS """load_plugins"""
.el .SS "\f(CWload_plugins\fP"
.IX Subsection "load_plugins"
Scans for new plug-ins in the user plug-in directory, in \f(CW@INC\fR,
and in \fI.par\fR files in the user plug-in directory.
.PP
Loads any given module only once, i.e. does not refresh if the
plug-in has changed while Padre was running.
.ie n .SS """reload_plugins"""
.el .SS "\f(CWreload_plugins\fP"
.IX Subsection "reload_plugins"
For all registered plug-ins, unload them if they were loaded
and then reload them.
.ie n .SS """alert_new"""
.el .SS "\f(CWalert_new\fP"
.IX Subsection "alert_new"
The \f(CW\*(C`alert_new\*(C'\fR method is called by the main window post-initialisation and
checks for new plug-ins. If any are found, it presents a message to
the user.
.ie n .SS """failed"""
.el .SS "\f(CWfailed\fP"
.IX Subsection "failed"
Returns the list of all plugins that the editor attempted to load but
failed. Note that after a failed attempt, the plug-in is usually disabled
in the configuration and not loaded again when the editor is restarted.
.ie n .SS """load_plugin"""
.el .SS "\f(CWload_plugin\fP"
.IX Subsection "load_plugin"
Given a plug-in name such as \f(CW\*(C`Foo\*(C'\fR (the part after \f(CW\*(C`Padre::Plugin\*(C'\fR),
load the corresponding module, enable the plug-in and update the Plug-ins
menu, etc.
.ie n .SS """unload_plugin"""
.el .SS "\f(CWunload_plugin\fP"
.IX Subsection "unload_plugin"
Given a plug-in name such as \f(CW\*(C`Foo\*(C'\fR (the part after \f(CW\*(C`Padre::Plugin\*(C'\fR),
\&\fBdisable\fR the plug-in, \fBunload\fR the corresponding module, and update the Plug-ins
menu, etc.
.ie n .SS """reload_plugin"""
.el .SS "\f(CWreload_plugin\fP"
.IX Subsection "reload_plugin"
Reload a single plug-in whose name (without \f(CW\*(C`Padre::Plugin::\*(C'\fR)
is passed in as first argument.
.ie n .SS """reload_current_plugin"""
.el .SS "\f(CWreload_current_plugin\fP"
.IX Subsection "reload_current_plugin"
When developing a plug-in one usually edits the
files belonging to the plug-in (The \f(CW\*(C`Padre::Plugin::Wonder\*(C'\fR itself
or \f(CW\*(C`Padre::Documents::Wonder\*(C'\fR located in the same project as the plug-in
itself.
.PP
This call and the appropriate menu option should be able to load
(or reload) that plug-in.
.ie n .SS """on_context_menu"""
.el .SS "\f(CWon_context_menu\fP"
.IX Subsection "on_context_menu"
Called by \f(CW\*(C`Padre::Wx::Editor\*(C'\fR when a context menu is about to
be displayed. The method calls the context menu hooks in all plug-ins
that have one for plug-in specific manipulation of the context menu.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Padre, Padre::Config
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2008\-2013 The Padre development team as listed in Padre.pm.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl 5 itself.