about summary refs log tree commit diff stats
path: root/apidocs/python
diff options
context:
space:
mode:
authorJames Booth <boothj5@gmail.com>2016-10-10 22:28:23 +0100
committerJames Booth <boothj5@gmail.com>2016-10-10 22:28:23 +0100
commitdcc2123ec4d2210c8631b181cae9d817504e8b48 (patch)
treea8bb9c746aa6b2739e0ef6af9ce01f9966bff1bd /apidocs/python
parentd485588a07f9d4a477a7615fee926fcfee44b29e (diff)
downloadprofani-tty-dcc2123ec4d2210c8631b181cae9d817504e8b48.tar.gz
Allow filepath autocompletion in plugins
closes #858
Diffstat (limited to 'apidocs/python')
-rw-r--r--apidocs/python/src/prof.py14
1 files changed, 14 insertions, 0 deletions
diff --git a/apidocs/python/src/prof.py b/apidocs/python/src/prof.py
index 789e1f3e..69d5aaea 100644
--- a/apidocs/python/src/prof.py
+++ b/apidocs/python/src/prof.py
@@ -182,6 +182,20 @@ def completer_clear(key):
     pass
 
 
+def filepath_completer_add(prefix):
+    """Add filepath autocompletion for a command, or command argument.
+
+    :param prefix: the prefix from which filepath autocompletion will be triggered
+
+    Examples:
+    ::
+        prof.filepath_completer_add("/filecmd")
+
+        prof.filepath_completer_add("/mycommand open")
+    """
+    pass
+
+
 def send_line(line): 
     """Send a line of input to Profanity to execute.