padre::pluginmanager(3pm) [debian man page]
Padre::PluginManager(3pm) User Contributed Perl Documentation Padre::PluginManager(3pm) NAME
Padre::PluginManager - Padre plug-in manager DESCRIPTION
The "PluginManager" class contains logic for locating and loading Padre plug-ins, as well as providing part of the interface to plug-in writers. METHODS
"new" The constructor returns a new "Padre::PluginManager" object, but you should normally access it via the main Padre object: my $manager = Padre->ide->plugin_manager; First argument should be a Padre object. "parent" Stores a reference back to the parent IDE object. "plugin_dir" Returns the user plug-in directory (below the Padre configuration directory). This directory was added to the @INC module search path. "plugins" Returns a hash (reference) of plug-in names associated with a Padre::PluginHandle. This hash is only populated after "load_plugins()" was called. current Gets a Padre::Current context for the plugin manager. "main" A convenience method to get to the main window. "load_plugins" Scans for new plug-ins in the user plug-in directory, in @INC, and in .par files in the user plug-in directory. Loads any given module only once, i.e. does not refresh if the plug-in has changed while Padre was running. "reload_plugins" For all registered plug-ins, unload them if they were loaded and then reload them. "alert_new" The "alert_new" 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. "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. "load_plugin" Given a plug-in name such as "Foo" (the part after "Padre::Plugin"), load the corresponding module, enable the plug-in and update the Plug- ins menu, etc. "unload_plugin" Given a plug-in name such as "Foo" (the part after "Padre::Plugin"), disable the plug-in, unload the corresponding module, and update the Plug-ins menu, etc. "reload_plugin" Reload a single plug-in whose name (without "Padre::Plugin::") is passed in as first argument. "reload_current_plugin" When developing a plug-in one usually edits the files belonging to the plug-in (The "Padre::Plugin::Wonder" itself or "Padre::Documents::Wonder" located in the same project as the plug-in itself. This call and the appropriate menu option should be able to load (or reload) that plug-in. "on_context_menu" Called by "Padre::Wx::Editor" 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. SEE ALSO
Padre, Padre::Config COPYRIGHT
Copyright 2008-2012 The Padre development team as listed in Padre.pm. LICENSE
This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself. perl v5.14.2 2012-06-27 Padre::PluginManager(3pm)
Check Out this Related Man Page
Padre::Current(3pm) User Contributed Perl Documentation Padre::Current(3pm) NAME
Padre::Current - A context object, for centralising the concept of what is "current" DESCRIPTION
The "Padre::Current" detectes and returns whatever is current. Use it whenever you need to do something with anything which might get a focus or be selectable otherwise All methods could be called as functions, methods or class methods. CLASS METHODS
"config" my $config = Padre::Current->config; Returns a Padre::Config object for the current document. Padre has three types of configuration: User-specific, host-specific and project-specific, this method returnsa config object which includes the current values - ne need to for you to care about which config is active and which has priority. "document" my $document = Padre::Current->document; Returns a Padre::Document object for the current document. "editor" my $editor = Padre::Current->editor; Returns a Padre::Editor object for the current editor (containing the current document). "filename" my $filename = Padre::Current->filename; Returns the filename of the current document. "ide" my $ide = Padre::Current->ide; Returns a Padre::Wx object of the current ide. "main" my $main = Padre::Current->main; Returns a Padre::Wx::Main object of the current ide. "notebook" my $main = Padre::Current->notebook; Returns a Padre::Wx::Notebook object of the current notebook. "project" my $main = Padre::Current->project; Returns a Padre::Project object of the current project. "text" my $main = Padre::Current->text; Returns the current selection (selected text in the current document). "title" my $main = Padre::Current->title; Returns the title of the current editor window. NAME
Padre::Current - convenient access to current objects within Padre SYNOPSIS
my $main = Padre::Current->main; # ... DESCRIPTION
Padre uses lots of objects from different classes. And one needs to have access to the current object of this sort or this other to do whatever is need at the time. Instead of poking directly with the various classes to find the object you need, "Padre::Current" provides a bunch of handy methods to retrieve whatever current object you need. METHODS
new # Vanilla constructor Padre::Current->new; # Seed the object with some context Padre::Current->new( document => $document ); The "new" constructor creates a new context object, it optionally takes one or more named parameters which should be any context the caller is aware of before he calls the constructor. Providing this seed context allows the context object to derive parts of the current context from other parts, without the need to fall back to the last-resort "Padre->ide" singleton-fetching method. Many objects in Padre that are considered to be part of them context will have a "current" method which automatically creates the context object with it as a seed. Returns a new Padre::Current object. "ide" Return the Padre singleton for the IDE instance. "config" Returns the current Padre::Config configuration object for the IDE. "main" Returns the Padre::Wx::Main object for the main window. "notebook" Returns the Padre::Wx::Notebook object for the main window. "document" Returns the active Padre::Document document object. "editor" Returns the Padre::Editor editor object for the active document. "filename" Returns the file name of the active document, if it has one. "title" Return the title of current editor window. "project" Return the "Padre::Project" project object for the active document. "text" Returns the selected text, or a null string if nothing is selected. COPYRIGHT &; LICENSE Copyright 2008-2012 The Padre development team as listed in Padre.pm. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module. perl v5.14.2 2012-06-27 Padre::Current(3pm)