diff options
| author | Tom Feist <shabble@cowu.be> | 2010-07-23 00:19:03 +0000 |
|---|---|---|
| committer | Tom Feist <shabble@cowu.be> | 2010-07-23 00:19:03 +0000 |
| commit | 5616936940e4bd5a987edda4f029ffa6265aaf48 (patch) | |
| tree | 45ec46050a6ade4810d1cd24f24bad839c9adefb /docs/Signals.pod | |
| parent | removed deprecated irssi::theme pod (diff) | |
| download | irssi-scripts-5616936940e4bd5a987edda4f029ffa6265aaf48.tar.gz irssi-scripts-5616936940e4bd5a987edda4f029ffa6265aaf48.zip | |
additional docs about some Irssi:: core funcs
Diffstat (limited to '')
| -rw-r--r-- | docs/Signals.pod | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/Signals.pod b/docs/Signals.pod index 2fcf913..93c79db 100644 --- a/docs/Signals.pod +++ b/docs/Signals.pod @@ -1614,7 +1614,7 @@ B<Requires to work properly:> =back -(Can be used to determine when all "gui print text"s are sent (not required)) +(Can be used to determine when all C<"gui print text">s are sent (not required)) =back @@ -1629,16 +1629,30 @@ B<Provides signals:> =over -=item arrayref of string C<$WHAT> B<TODO: ???> +=item arrayref of strings C<$strings_ref> + +An arrayref which can be modified to add additional completion candidates. + +For example: + + push @$strings_ref, "another_candidate"; =item L<Irssi::Window> C<$window> =item string C<$word> +The prefix of the word currently being typed. + =item string C<$linestart> +The contents of the input line up to (but not including) the current +word prefix C<$word>. + =item int C<$want_space> +A scalar reference which can be set to indicate if tab completion of these +candidates should be appended with a space. + =back =back |