padre::desktop(3pm) [debian man page]

Padre::Desktop(3pm)					User Contributed Perl Documentation				       Padre::Desktop(3pm)

NAME

       Padre::Desktop - Support library for Padre desktop integration

DESCRIPTION

       This module provides a collection of functionality related to operating system integration. It is intended to serve as a repository for
       code relating to file extensions, desktop shortcuts, and so on.

       This module is intended to be loadable without having to load the main Padre code tree.

       The workings of this module are currently undocumented.

       "find_padre_location"

       Note: this only works under WIN32

       Returns Padre's executable path and parent folder as "(padre_exe, padre_exe_dir)".  Returns "undef" if not found.

COPYRIGHT

       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::Desktop(3pm)

Padre::Help(3pm)					User Contributed Perl Documentation					  Padre::Help(3pm)

NAME

       Padre::Help - Padre Help Provider API

DESCRIPTION

       The "Padre::Help" class provides a base class, default implementation and API documentation for help provision support in Padre.

       In order to setup a help system for a document type called "XYZ" one has to do the following: Create a module called "Padre::Help::XYZ"
       that subclasses the "Padre::Help" module and override 3 methods: "help_init", "help_list" and "help_render".

       In the class representing the Document ("Padre::Document::XYZ") one should override the "get_help_provider" method and return an object of
       the help provide module.  In our case it should contain

	       require Padre::Help::XYZ;
	       return Padre::Help::XYZ->new;

       (TO DO: Maybe it should only return the name of the module)

       The "help_init" method is called by the new method of "Padre::Help" once for every document of "XYZ" kind. (TO DO: maybe it should be only
       once for every document type, and not once for every document of that type).

       "help_list" should return a reference to an array holding the possible strings the system can provide help for.

       "help_render" is called by one of the keywords, it should return the HTML to be displayed as help and another string which is the location
       of the help. Usually a path to a file that will be used in the title of the window.

perl v5.14.2							    2012-06-27							  Padre::Help(3pm)