Package peppy :: Package hsi :: Module hsi_major_mode :: Class MedianFilterAction

Class MedianFilterAction

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

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

Instance Methods

isEnabled(self)
Override this to provide the enable/disable state of the item.

getIndex(self)

getItems(self)

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

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

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 = `'Median Filter'` This is the name of the menu entry as it appears in the menu bar.
	tooltip = `'Median filter'` Tooltip that is displayed when the mouse is hovering over the menu entry.
	default_menu = `('View', 301)` 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.
	items = `['No median', 'Median 3x1 pixel', 'Median 1x3 pixel', ...`
Inherited from `actions.RadioAction`: `inline`, `menumax` Inherited from `actions.ListAction`: `abbrev_width`, `localize_items` Inherited from `actions.SelectAction`: `alias`, `default_toolbar`, `global_id`, `icon`, `key_bindings`, `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

isEnabled(self)

Override this to provide the enable/disable state of the item.

The menu system will call this method before the menu is drawn (or periodically during idle time for toolbar items) to determine whether or not the item should be disabled (grayed out).

Default is to always enable the item.

Overrides: actions.SelectAction.isEnabled: (inherited documentation)

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 median',
 'Median 3x1 pixel',
 'Median 1x3 pixel',
 'Median 3x3 pixel',
 'Median 5x1 pixel',
 'Median 1x5 pixel',
 'Median 5x5 pixel']