ranger.gui.colorscheme
index
/home/hut/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

 
Classes
       
__builtin__.object
ColorScheme

 
class ColorScheme(__builtin__.object)
    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.
 
  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.
This is a dummy function which always returns default_colors.
Override this in your custom colorscheme!

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
Functions
       
color_pair(...)