diff options
Diffstat (limited to 'doc/pydoc/ranger.applications.html')
| -rw-r--r-- | doc/pydoc/ranger.applications.html | 103 |
1 files changed, 26 insertions, 77 deletions
diff --git a/doc/pydoc/ranger.applications.html b/doc/pydoc/ranger.applications.html index 7dd7e000..29755773 100644 --- a/doc/pydoc/ranger.applications.html +++ b/doc/pydoc/ranger.applications.html @@ -1,6 +1,6 @@ + <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.applications</title> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> @@ -8,8 +8,8 @@ <td valign=bottom> <br> <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.applications</strong></big></big></font></td ><td align=right valign=bottom -><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/applications.py">/home/hut/work/ranger/ranger/applications.py</a></font></td></tr></table> - <p><tt>This module faciliates starting of new processes.</tt></p> +><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/ranger/ranger/applications.pyc">/home/hut/ranger/ranger/applications.pyc</a></font></td></tr></table> + <p><tt>This module provides helper functions/classes for ranger.defaults.apps.</tt></p> <p> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> @@ -27,11 +27,10 @@ <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> <td width="100%"><dl> -<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a> +<dt><font face="helvetica, arial"><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) </font></dt><dd> <dl> -<dt><font face="helvetica, arial"><a href="ranger.applications.html#AppContext">AppContext</a> -</font></dt><dt><font face="helvetica, arial"><a href="ranger.applications.html#Applications">Applications</a> +<dt><font face="helvetica, arial"><a href="ranger.applications.html#Applications">Applications</a> </font></dt></dl> </dd> </dl> @@ -39,70 +38,7 @@ <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="AppContext">class <strong>AppContext</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> - -<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> -<td colspan=2><tt>An <a href="#AppContext">AppContext</a> <a href="builtins.html#object">object</a> abstracts the spawning of processes.<br> - <br> -At initialization of the <a href="builtins.html#object">object</a> you can define many high-level options.<br> -When you call the <a href="#AppContext-run">run</a>() function, those options are evaluated and<br> -translated into Popen() calls.<br> - <br> -An instances of this class is passed as the only argument to<br> -app_xyz calls of the <a href="#Applications">Applications</a> <a href="builtins.html#object">object</a>.<br> - <br> -Attributes:<br> -action -- a string with a command or a list of arguments for<br> - the Popen call.<br> -app -- the name of the app function. ("vim" for app_vim.)<br> - app is used to get an action if the user didn't specify one.<br> -mode -- a number, mainly used in determining the action in app_xyz()<br> -flags -- a string with flags which change the way programs are run<br> -files -- a list containing files, mainly used in app_xyz<br> -file -- an arbitrary file from that list (or None)<br> -fm -- the filemanager instance<br> -wait -- boolean, wait for the end or execute programs in parallel?<br> -stdout -- directly passed to Popen<br> -stderr -- directly passed to Popen<br> -stdin -- directly passed to Popen<br> -shell -- directly passed to Popen. Should the string be shell-interpreted?<br> - <br> -List of allowed flags:<br> -s: silent mode. output will be discarded.<br> -d: detach the process.<br> -p: redirect output to the pager<br> - <br> -An uppercase key ensures that a certain flag will not be used.<br> </tt></td></tr> -<tr><td> </td> -<td width="100%">Methods defined here:<br> -<dl><dt><a name="AppContext-__init__"><strong>__init__</strong></a>(self, app<font color="#909090">='default'</font>, files<font color="#909090">=None</font>, mode<font color="#909090">=0</font>, flags<font color="#909090">=''</font>, fm<font color="#909090">=None</font>, stdout<font color="#909090">=None</font>, stderr<font color="#909090">=None</font>, stdin<font color="#909090">=None</font>, shell<font color="#909090">=None</font>, wait<font color="#909090">=True</font>, action<font color="#909090">=None</font>)</dt><dd><tt>The necessary parameters are fm and action or app.</tt></dd></dl> - -<dl><dt><a name="AppContext-__iter__"><strong>__iter__</strong></a>(self)</dt><dd><tt>Iterates over all file paths</tt></dd></dl> - -<dl><dt><a name="AppContext-get_action"><strong>get_action</strong></a>(self, apps<font color="#909090">=None</font>)</dt><dd><tt>Get the action from app_xyz</tt></dd></dl> - -<dl><dt><a name="AppContext-run"><strong>run</strong></a>(self)</dt><dd><tt>Run the application in the way specified by the options.<br> - <br> -Returns False if nothing can be done, None if there was an error,<br> -otherwise the process <a href="builtins.html#object">object</a> returned by Popen().<br> - <br> -This function tries to find an action if none is defined.</tt></dd></dl> - -<dl><dt><a name="AppContext-squash_flags"><strong>squash_flags</strong></a>(self)</dt><dd><tt>Remove duplicates and lowercase counterparts of uppercase flags</tt></dd></dl> - -<hr> -Data descriptors defined here:<br> -<dl><dt><strong>__dict__</strong></dt> -<dd><tt>dictionary for instance variables (if defined)</tt></dd> -</dl> -<dl><dt><strong>__weakref__</strong></dt> -<dd><tt>list of weak references to the object (if defined)</tt></dd> -</dl> -</td></tr></table> <p> -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> -<tr bgcolor="#ffc8d8"> -<td colspan=3 valign=bottom> <br> -<font color="#000000" face="helvetica, arial"><a name="Applications">class <strong>Applications</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr> +<font color="#000000" face="helvetica, arial"><a name="Applications">class <strong>Applications</strong></a>(<a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>)</font></td></tr> <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> <td colspan=2><tt>This class contains definitions on how to run programs and should<br> @@ -117,7 +53,7 @@ the context and decide which program to use.< All app functions have a name starting with app_ and return a string<br> containing the whole command or a tuple containing a list of the<br> arguments. They are supplied with one argument, which is the<br> -<a href="#AppContext">AppContext</a> instance.<br> +AppContext instance.<br> <br> You should define at least app_default, app_pager and app_editor since<br> internal functions depend on those. Here are sample implementations:<br> @@ -137,17 +73,32 @@ def app_pager(self, context):<br> def app_editor(self, context):<br> return ('vim', ) + tuple(context)<br> </tt></td></tr> <tr><td> </td> -<td width="100%">Methods defined here:<br> +<td width="100%"><dl><dt>Method resolution order:</dt> +<dd><a href="ranger.applications.html#Applications">Applications</a></dd> +<dd><a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a></dd> +<dd><a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a></dd> +<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> +</dl> +<hr> +Methods defined here:<br> <dl><dt><a name="Applications-all"><strong>all</strong></a>(self)</dt><dd><tt>Returns a list with all application functions</tt></dd></dl> <dl><dt><a name="Applications-app_self"><strong>app_self</strong></a>(self, context)</dt><dd><tt>Run the file itself</tt></dd></dl> +<dl><dt><a name="Applications-apply"><strong>apply</strong></a>(self, app, context)</dt></dl> + +<dl><dt><a name="Applications-either"><strong>either</strong></a>(self, context, *args)</dt></dl> + <dl><dt><a name="Applications-get"><strong>get</strong></a>(self, app)</dt><dd><tt>Looks for an application, returns app_default if it doesn't exist</tt></dd></dl> <dl><dt><a name="Applications-has"><strong>has</strong></a>(self, app)</dt><dd><tt>Returns whether an application is defined</tt></dd></dl> <hr> -Data descriptors defined here:<br> +Data and other attributes inherited from <a href="ranger.shared.html#FileManagerAware">ranger.shared.FileManagerAware</a>:<br> +<dl><dt><strong>fm</strong> = None</dl> + +<hr> +Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>:<br> <dl><dt><strong>__dict__</strong></dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> @@ -161,7 +112,7 @@ Data descriptors defined here:<br> <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> <tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> -<td width="100%"><dl><dt><a name="-run"><strong>run</strong></a>(action<font color="#909090">=None</font>, **kw)</dt><dd><tt>Shortcut for creating and immediately running an <a href="#AppContext">AppContext</a>.</tt></dd></dl> +<td width="100%"><dl><dt><a name="-depends_on"><strong>depends_on</strong></a>(*args)</dt></dl> <dl><dt><a name="-tup"><strong>tup</strong></a>(*args)</dt><dd><tt>This helper function creates a tuple out of the arguments.<br> <br> ('a', ) + tuple(some_iterator)<br> @@ -174,7 +125,5 @@ is equivalent to:<br> <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> -<td width="100%"><strong>ALLOWED_FLAGS</strong> = 'sdpSDP'<br> -<strong>PIPE</strong> = -1<br> -<strong>devnull</strong> = <_io.TextIOWrapper name='/dev/null' encoding='UTF-8'></td></tr></table> +<td width="100%"><strong>PIPE</strong> = -1</td></tr></table> </body></html> \ No newline at end of file |