From 3817c8b47e85d3644383182c2b3909a2dbdd0b3b Mon Sep 17 00:00:00 2001 From: hut Date: Mon, 21 Jun 2010 00:23:04 +0200 Subject: removed pydoc since it can be generated with "make doc" easily --- doc/pydoc/ranger.gui.colorscheme.html | 121 ---------------------------------- 1 file changed, 121 deletions(-) delete mode 100644 doc/pydoc/ranger.gui.colorscheme.html (limited to 'doc/pydoc/ranger.gui.colorscheme.html') diff --git a/doc/pydoc/ranger.gui.colorscheme.html b/doc/pydoc/ranger.gui.colorscheme.html deleted file mode 100644 index 771dee29..00000000 --- a/doc/pydoc/ranger.gui.colorscheme.html +++ /dev/null @@ -1,121 +0,0 @@ - -Python: module ranger.gui.colorscheme - - - - - -
 
- 
ranger.gui.colorscheme
index
/home/hut/code/ranger/ranger/gui/colorscheme.py
-

Colorschemes define colors for specific contexts.

-Generally, this works by passing a set of keywords (strings) to
-the colorscheme.get() method to receive the tuple (fg, bg, attr).
-fg, bg are the foreground and background colors and attr is the attribute.
-The values are specified in ranger.gui.color.

-A colorscheme must...

-1. be inside either of these directories:
-~/.ranger/colorschemes/
-path/to/ranger/colorschemes/

-2. be a subclass of ranger.gui.colorscheme.ColorScheme

-3. implement a use(self, context) method which returns (fg, bg, attr).
-context is a struct which contains all entries of CONTEXT_KEYS,
-associated with either True or False.

-define which colorscheme to use by having this to your options.py:
-from ranger import colorschemes
-colorscheme = colorschemes.filename

-If your colorscheme-file contains more than one colorscheme, specify it with:
-colorscheme = colorschemes.filename.classname

-

- - - - - -
 
-Modules
       
os
-
ranger
-

- - - - - -
 
-Classes
       
-
ranger.shared.settings.SettingsAware(builtins.object) -
-
-
ColorScheme -
-
-
-

- - - - - - - -
 
-class ColorScheme(ranger.shared.settings.SettingsAware)
   This is the class that colorschemes must inherit from.

-it defines get() 
-it defines the get() method, which returns the color tuple
-which fits to the given keys.
 
 
Method resolution order:
-
ColorScheme
-
ranger.shared.settings.SettingsAware
-
builtins.object
-
-
-Methods defined here:
-
__init__(self)
- -
get(self, *keys)
Returns the (fg, bg, attr) for the given keys.

-Using this function rather than use() will cache all
-colors for faster access.
- -
get_attr(self, *keys)
Returns the curses attribute for the specified keys

-Ready to use for curses.setattr()
- -
use(self, context)
Use the colorscheme to determine the (fg, bg, attr) tuple.

-When no colorscheme is found, ranger will fall back to this very
-basic colorscheme where directories are blue and bold, and
-selected files have the color inverted.

-Override this method in your own colorscheme.
- -
-Data descriptors inherited from ranger.shared.settings.SettingsAware:
-
__dict__
-
dictionary for instance variables (if defined)
-
-
__weakref__
-
list of weak references to the object (if defined)
-
-
-Data and other attributes inherited from ranger.shared.settings.SettingsAware:
-
settings = {}
- -

- - - - - -
 
-Functions
       
color_pair(...)
-
- \ No newline at end of file -- cgit 1.4.1-2-gfad0