ranger - mirror of ranger - a simple, vim-like file manager

	Commit message (Expand)	Author	Age	Files	Lines
*	rebuilt pydoc	hut	2010-03-31	1	-1/+2
*	updated TODO and pydoc	hut	2010-03-21	1	-10/+9
*	updated pydoc	hut	2010-03-12	1	-1/+1
*	updated pydoc	hut	2010-03-12	1	-2/+4
*	incremented version number and updated pydoc html files v1.0.3	hut	2010-02-16	1	-10/+24
*	1.0.2! v1.0.2	hut	2010-01-14	1	-3/+1
*	updated pydoc documentation	hut	2010-01-13	1	-4/+17
*	updated pydoc documentation	hut	2010-01-02	1	-0/+164

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><title>Python: module ranger.actions</title> </head><body bgcolor="#f0f0f8"> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> <tr bgcolor="#7799ee"> <td valign=bottom>    <big><big><a href="ranger.html">ranger</a>.actions</big></big></td ><td align=right valign=bottom ><a href=".">index</a> <a href="file:/home/hut/ranger/ranger/actions.py">/home/hut/ranger/ranger/actions.py</a></td></tr></table> <tt># Copyright (c) 2009, 2010 hut <hut@lavabit.com> # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</tt> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#aa55cc"> <td colspan=3 valign=bottom>  <big>Modules</big></td></tr> <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td> <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ranger.gui.widgets.console_mode.html">ranger.gui.widgets.console_mode</a> <a href="ranger.fsobject.html">ranger.fsobject</a> </td><td width="25%" valign=top><a href="os.html">os</a> <a href="ranger.html">ranger</a> </td><td width="25%" valign=top><a href="shutil.html">shutil</a> </td><td width="25%" valign=top></td></tr></table></td></tr></table> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ee77aa"> <td colspan=3 valign=bottom>  <big>Classes</big></td></tr> <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td> <td width="100%"><dl> <dt><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>(<a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>) </dt><dd> <dl> <dt><a href="ranger.actions.html#Actions">Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt></dl> </dd> <dt><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>(<a href="__builtin__.html#object">__builtin__.object</a>) </dt><dd> <dl> <dt><a href="ranger.actions.html#Actions">Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>) </dt></dl> </dd> </dl> <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> <tr bgcolor="#ffc8d8"> <td colspan=3 valign=bottom>  <a name="Actions">class Actions</a>(<a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>, <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>)</td></tr> <tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td> <td width="100%"><dl><dt>Method resolution order:</dt> <dd><a href="ranger.actions.html#Actions">Actions</a></dd> <dd><a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a></dd> <dd><a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a></dd> <dd><a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a></dd> <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> </dl> <hr> Methods defined here: <dl><dt><a name="Actions-cd">cd</a>(self, path, remember=True)</dt><dd><tt>enter the directory at the given path, remember=True</tt></dd></dl> <dl><dt><a name="Actions-copy">copy</a>(self)</dt><dd><tt>Copy the selected items</tt></dd></dl> <dl><dt><a name="Actions-cut">cut</a>(self)</dt></dl> <dl><dt><a name="Actions-delete">delete</a>(self)</dt></dl> <dl><dt><a name="Actions-display_command_help">display_command_help</a>(self, console_widget)</dt></dl> <dl><dt><a name="Actions-display_file">display_file</a>(self)</dt></dl> <dl><dt><a name="Actions-display_help">display_help</a>(self, topic='index', narg=None)</dt></dl> <dl><dt><a name="Actions-display_log">display_log</a>(self)</dt></dl> <dl><dt><a name="Actions-edit_file">edit_file</a>(self, file=None)</dt><dd><tt>Calls execute_file with the current file and app='editor'</tt></dd></dl> <dl><dt><a name="Actions-enter_bookmark">enter_bookmark</a>(self, key)</dt><dd><tt>Enter the bookmark with the name <key></tt></dd></dl> <dl><dt><a name="Actions-enter_dir">enter_dir</a>(self, path, remember=False)</dt><dd><tt>Enter the directory at the given path</tt></dd></dl> <dl><dt><a name="Actions-execute_command">execute_command</a>(self, cmd, **kw)</dt></dl> <dl><dt><a name="Actions-execute_file">execute_file</a>(self, files, **kw)</dt><dd><tt>Execute a file. app is the name of a method in Applications, without the "app_" flags is a string consisting of runner.ALLOWED_FLAGS mode is a positive integer. Both flags and mode specify how the program is run.</tt></dd></dl> <dl><dt><a name="Actions-exit">exit</a>(self)</dt><dd><tt>Exit the program</tt></dd></dl> <dl><dt><a name="Actions-force_load_preview">force_load_preview</a>(self)</dt></dl> <dl><dt><a name="Actions-handle_mouse">handle_mouse</a>(self)</dt><dd><tt>Handle mouse-buttons if one was pressed</tt></dd></dl> <dl><dt><a name="Actions-history_go">history_go</a>(self, relative)</dt><dd><tt>Move back and forth in the history</tt></dd></dl> <dl><dt><a name="Actions-mark">mark</a>(self, all=False, toggle=False, val=None, movedown=None, narg=1)</dt><dd><tt>A wrapper for the directory.mark_xyz functions.   Arguments: all - change all files of the current directory at once? toggle - toggle the marked-status? val - mark or unmark?</tt></dd></dl> <dl><dt><a name="Actions-mkdir">mkdir</a>(self, name)</dt></dl> <dl><dt><a name="Actions-move_left">move_left</a>(self, narg=1)</dt><dd><tt>Enter the parent directory</tt></dd></dl> <dl><dt><a name="Actions-move_pointer">move_pointer</a>(self, relative=0, absolute=None, narg=None)</dt><dd><tt>Move the pointer down by <relative> or to <absolute></tt></dd></dl> <dl><dt><a name="Actions-move_pointer_by_pages">move_pointer_by_pages</a>(self, relative)</dt><dd><tt>Move the pointer down by <relative> pages</tt></dd></dl> <dl><dt><a name="Actions-move_pointer_by_percentage">move_pointer_by_percentage</a>(self, relative=0, absolute=None, narg=None)</dt><dd><tt>Move the pointer down by <relative>% or to <absolute>%</tt></dd></dl> <dl><dt><a name="Actions-move_right">move_right</a>(self, mode=0, narg=None)</dt><dd><tt>Enter the current directory or execute the current file</tt></dd></dl> <dl><dt><a name="Actions-notify">notify</a>(self, text, duration=4, bad=False)</dt></dl> <dl><dt><a name="Actions-open_console">open_console</a>(self, mode=':', string='')</dt><dd><tt>Open the console if the current UI supports that</tt></dd></dl> <dl><dt><a name="Actions-paste">paste</a>(self, overwrite=False)</dt><dd><tt>Paste the selected items into the current directory</tt></dd></dl> <dl><dt><a name="Actions-paste_symlink">paste_symlink</a>(self)</dt></dl> <dl><dt><a name="Actions-redraw_window">redraw_window</a>(self)</dt><dd><tt>Redraw the window</tt></dd></dl> <dl><dt><a name="Actions-reload_cwd">reload_cwd</a>(self)</dt></dl> <dl><dt><a name="Actions-rename">rename</a>(self, src, dest)</dt></dl> <dl><dt><a name="Actions-reset">reset</a>(self)</dt><dd><tt>Reset the filemanager, clearing the directory buffer</tt></dd></dl> <dl><dt><a name="Actions-resize">resize</a>(self)</dt><dd><tt>Update the size of the UI</tt></dd></dl> <dl><dt><a name="Actions-scroll">scroll</a>(self, relative)</dt><dd><tt>Scroll down by <relative> lines</tt></dd></dl> <dl><dt><a name="Actions-search">search</a>(self, order=None, forward=True)</dt></dl> <dl><dt><a name="Actions-set_bookmark">set_bookmark</a>(self, key)</dt><dd><tt>Set the bookmark with the name <key> to the current directory</tt></dd></dl> <dl><dt><a name="Actions-set_filter">set_filter</a>(self, fltr)</dt></dl> <dl><dt><a name="Actions-set_search_method">set_search_method</a>(self, order, forward=True)</dt></dl> <dl><dt><a name="Actions-sort">sort</a>(self, func=None, reverse=None)</dt></dl> <dl><dt><a name="Actions-tag_remove">tag_remove</a>(self, movedown=None)</dt></dl> <dl><dt><a name="Actions-tag_toggle">tag_toggle</a>(self, movedown=None)</dt></dl> <dl><dt><a name="Actions-toggle_boolean_option">toggle_boolean_option</a>(self, string)</dt><dd><tt>Toggle a boolean option named <string></tt></dd></dl> <dl><dt><a name="Actions-unset_bookmark">unset_bookmark</a>(self, key)</dt><dd><tt>Delete the bookmark with the name <key></tt></dd></dl> <hr> Data and other attributes defined here: <dl><dt>search_forward = False</dl> <dl><dt>search_method = 'ctime'</dl> <hr> Data and other attributes inherited from <a href="ranger.shared.html#EnvironmentAware">ranger.shared.EnvironmentAware</a>: <dl><dt>env = None</dl> <hr> Data descriptors inherited from <a href="ranger.shared.html#Awareness">ranger.shared.Awareness</a>: <dl><dt>__dict__</dt> <dd><tt>dictionary for instance variables (if defined)</tt></dd> </dl> <dl><dt>__weakref__</dt> <dd><tt>list of weak references to the object (if defined)</tt></dd> </dl> <hr> Data and other attributes inherited from <a href="ranger.shared.settings.html#SettingsAware">ranger.shared.settings.SettingsAware</a>: <dl><dt>settings = <ranger.ext.openstruct.OpenStruct object at 0xe2f090></dl> </td></tr></table></td></tr></table> </body></html>