Package peppy :: Package hsi :: Module hsi_major_mode :: Class ContrastFilterAction

Class ContrastFilterAction

                  object --+    
                           |    
              HSIActionMixin --+
                               |
      object --+               |
               |               |
debug.debugmixin --+           |
                   |           |
actions.SelectAction --+       |
                       |       |
      actions.ListAction --+   |
                           |   |
         actions.RadioAction --+
                               |
                              ContrastFilterAction

Nested Classes
Inherited from `actions.ListAction`: `IdCache`

Instance Methods

getIndex(self)

getItems(self)

action(self, index=-1, multiplier=1)
Override this to provide the functionality of the action.

processMinibuffer(self, minibuffer, mode, percentage)

setContrast(self, mode)

Inherited from actions.RadioAction: __init__, insertIntoMenu, showCheck, showEnable

Inherited from actions.ListAction: dynamic, getHash, getIcons, getIndexOfId, getSubIds

Inherited from actions.SelectAction: __call__, getMenuItemName, getTooltip, initPostHook, initPreHook, insertIntoToolbar, isEnabled

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Methods

Inherited from HSIActionMixin: worksWithMajorMode

Inherited from actions.SelectAction: getHelp, setAcceleratorText

Inherited from debug.debugmixin: dprint

Class Variables
	name = `'Contrast'` This is the name of the menu entry as it appears in the menu bar.
	tooltip = `'Contrast adjustment method'` Tooltip that is displayed when the mouse is hovering over the menu entry.
	default_menu = `('View', -300)` The default menu location is specified here as a tuple containing the menu path (separated by / characters) and a number between 1 and 1000 representing the position within the menu.
	icon = `'icons/hsi-cube-next.png'` If there is an icon associated with this action, name it here.
	items = `['No stretching', '1% Stretching', '2% Stretching', 'U...`
Inherited from `actions.RadioAction`: `inline`, `menumax` Inherited from `actions.ListAction`: `abbrev_width`, `localize_items` Inherited from `actions.SelectAction`: `alias`, `default_toolbar`, `global_id`, `key_bindings`, `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

getIndex(self)

Overrides: actions.RadioAction.getIndex

getItems(self)

Overrides: actions.ListAction.getItems

action(self, index=-1, multiplier=1)

Override this to provide the functionality of the action.

This method gets called when the user initiates the action, whether it be from the menu bar, toolbar, or keyboard.

Parameters:

index - The index of the item in the list. This is only useful for list or radio items.
multiplier - the multiplier supplied by the keyboard handler. The keyboard handler allows for emacs-style repeat commands. For some actions, it makes sense to allow repetition of the command. For instance, in a command that uppercases words, the multiplier could be 4, would mean that the next 4 words get uppercased. The default is 1.

Overrides: actions.SelectAction.action

(inherited documentation)

Class Variable Details

items

Value:

['No stretching', '1% Stretching', '2% Stretching', 'User-defined']