1Padre::Document::Perl(3U)ser Contributed Perl DocumentatiPoandre::Document::Perl(3)
2
3
4
5   get_command
6       Returns the full command (interpreter, file name (maybe temporary) and
7       arguments for both of them) for running the current document.
8
9       Optionally accepts a hash reference with the following boolean
10       arguments:
11         'debug' - return a command where the debugger is started
12         'trace' - activates diagnostic output
13
14   get_inc
15       Returns the @INC of the designated perl interpreter - not necessarily
16       our own
17
18   get_interpreter
19       Returns the Perl interpreter for running the current document.
20
21   beginner_check
22       Run the beginner error checks on the current document.
23
24       Shows a pop-up message for the first error.
25
26       Always returns 1 (true).
27
28   autocomplete
29       This method is called on two events:
30
31       Manually using the "autocomplete-action" (via menu, toolbar, hot key)
32       on every char typed by the user if the "autocomplete-always"
33       configuration option is active
34
35       Arguments: The event object (optional)
36
37       Returns the prefix length and an array of suggestions. "prefix_length"
38       is the number of characters left to the cursor position which need to
39       be replaced if a suggestion is accepted.
40
41       If there are no suggestions, the functions returns an empty list.
42
43       In case of error the function returns the error string as the first
44       parameter.  Hence users of this subroution need to check if the value
45       returned in the first position is undef meaning no result or a string
46       (including non digits) which means a failure or a number which means
47       the prefix length.
48
49       WARNING: This method runs very often (on each keypress), keep it as
50       efficient
51                and fast as possible!
52
53   event_on_char
54       This event fires once for every char which should be added to the
55       editor window.
56
57       Typing this line fired it about 41 times!
58
59       Arguments: Current editor object, current event object
60
61       Returns nothing useful.
62
63       Notice: The char being typed has not been inserted into the editor at
64       the run
65               time of this method. It could be read using
66       "$event->GetUnicodeKey"
67
68       WARNING: This method runs very often (on each keypress), keep it as
69       efficient
70                and fast as possible!
71
72   project_tagsfile
73       No arguments.
74
75       Returns the full path and file name of the Perl tags file for the
76       current document.
77
78   project_create_tagsfile
79       Creates a tags file for the project of the current document. Includes
80       all Perl source files within the project excluding blib.
81
82
83
84perl v5.32.1                      2021-01-27          Padre::Document::Perl(3)