Package peppy :: Module fundamental :: Class SpellingSuggestionAction

Class SpellingSuggestionAction

      object --+            
               |            
debug.debugmixin --+        
                   |        
actions.SelectAction --+    
                       |    
      actions.ListAction --+
                           |
                          SpellingSuggestionAction

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

Instance Methods

getItems(self)

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

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

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

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 actions.SelectAction: getHelp, setAcceleratorText, worksWithMajorMode

Inherited from debug.debugmixin: dprint

Class Variables
	name = `'Spelling...'` This is the name of the menu entry as it appears in the menu bar.
	inline = `True`
	menumax = `5`
	tooltip = `'Spelling suggestions for the current word'` Tooltip that is displayed when the mouse is hovering over the menu entry.
Inherited from `actions.ListAction`: `abbrev_width`, `localize_items` Inherited from `actions.SelectAction`: `alias`, `default_menu`, `default_toolbar`, `global_id`, `icon`, `key_bindings`, `keyboard`, `stock_id` Inherited from `debug.debugmixin`: `debuglevel`

Properties
Inherited from `object`: `__class__`

Method Details

getItems(self)

Overrides: actions.ListAction.getItems

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)

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)