Padre::Document - document abstraction layer
This is an internal module of Padre that provides a logical document abstraction, allowing Padre to associate several Wx elements with the one document.
The objective would be to allow the use of this module without loading Wx.
Currently there are still interdependencies that need to be cleaned.
my $doc = Padre::Document->new( editor => $editor, filename => $file, );
$editor is required and is a Padre::Wx::Editor object
$file is optional and if given it will be loaded in the document
mime-type is defined by the guess_mimetype function
Returns a true value if the class provides a method check_syntax for retrieving information on syntax errors and warnings in the current document.
check_syntax
The method in this base class returns false.
NOT IMPLEMENTED IN THIS BASE CLASS
An implementation in a derived class needs to return an arrayref of syntax problems. Each entry in the array has to be an anonymous hash with the following keys:
line
The line where the problem resides
msg
A short description of the problem
severity
A flag indicating the problem class: Either 'W' (warning) or 'E' (error)
desc
A longer description with more information on the error (currently not used but intended to be)
Returns an empty arrayref if no problems can be found.
Returns undef if nothing has changed since the last invocation.
Must return the problem list even if nothing has changed when a param is present which evaluates to true.
To install Padre, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Padre
CPAN shell
perl -MCPAN -e shell install Padre
For more information on module installation, please visit the detailed CPAN module installation guide.